New payment request - Flashpay API

Request

Authorization

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

Authorization: Bearer ********************

Body Params application/json

amount

number

required

The amount of the transaction in 1/100 units (pence, cents etc)

Example:

1000

currency

enum<string>

required

Currency in which the payment should be made, in ISO 4217 format (3 uppercase letters). i.e NGN for Nigerian Naira

Allowed value:

NGN

description

string

optional

Payment description

Example:

Payment for groceries

reference

string

required

Payment reference

Example:

iausdfh12892j

expiresAt

string <date-time>

optional

Expiry date for a payment

Default:

2024-06-08T22:26:11.184Z

Example

{
    "amount": 9980000,
    "currency": "NGN",
    "description": "Watch purchase",
    "reference": "somerandomreferenceforwatch",
    "expiresAt": null
}

Request samples

Shell

JavaScript

Java

Swift

Go

PHP

Python

HTTP

C

C#

Objective-C

Ruby

OCaml

Dart

R

curl --location --request POST 'https://example.com/api/v1/payment/payments' \
--header 'Content-Type: application/json' \
--data-raw '{
    "amount": 9980000,
    "currency": "NGN",
    "description": "Watch purchase",
    "reference": "somerandomreferenceforwatch",
    "expiresAt": null
}'

Responses

🟢201Success

application/json

Body

id

string

required

amount

integer

required

ownerId

string

required

currency

string

required

reference

string

required

originBankId

null

optional

originAccount

null

optional

originAccountName

null

optional

destinationBankId

string

required

destinationAccount

string

required

destinationAccountName

string

required

description

string

required

status

string

required

callbackUrl

string

required

statusWebhook

string | null

optional

createdAt

string | null

optional

updatedAt

string | null

optional

expiresAt

string | null

optional

Example

{
    "id": "string",
    "amount": 0,
    "ownerId": "string",
    "currency": "string",
    "reference": "string",
    "originBankId": null,
    "originAccount": null,
    "originAccountName": null,
    "destinationBankId": "string",
    "destinationAccount": "string",
    "destinationAccountName": "string",
    "description": "string",
    "status": "string",
    "callbackUrl": "string",
    "statusWebhook": "string",
    "createdAt": "string",
    "updatedAt": "string",
    "expiresAt": "string"
}