List payments - Flashpay API

Request

Authorization

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

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

Query Params

offset

number

optional

Example:

5

limit

number

optional

Example:

10

amountEquals

number

optional

Example:

1000

amountGreaterThan

number

optional

Example:

500

amountLessThan

number

optional

Example:

900

currency

enum<string>

optional

Allowed value:

NGN

originBankId

string

optional

Origin bank unique identity

Example:

12345

originAccount

string

optional

Origin account number / IBAN

Example:

1288398743

originAccountName

string

optional

Origin account name

Example:

12345

destinationBankId

string

optional

Destination bank unique identity

Example:

67890

destinationAccount

string

optional

Destination account number / IBAN

Example:

1288398743

destinationAccountName

string

optional

Destination account name

Example:

12345

description

string

optional

Transaction description

Example:

Payment for groceries

reference

string

optional

Transaction reference

Example:

iausdfh12892j

status

enum<string>

optional

Allowed values:

OPENSUCCESSPENDINGIN_PROGRESSFAILEDREVERSEDEXPIRED

Example:

SUCCESS

startDate

string <date-time>

optional

Default:

2024-01-01T00:00:00.000Z

endDate

string <date-time>

optional

Default:

2024-06-08T22:26:11.183Z

Request samples

Shell

JavaScript

Java

Swift

Go

PHP

Python

HTTP

C

C#

Objective-C

Ruby

OCaml

Dart

R

curl --location --request GET 'https://example.com/api/v1/payment?offset=5&limit=10&amountEquals=1000&amountGreaterThan=500&amountLessThan=900&currency&originBankId=12345&originAccount=1288398743&originAccountName=12345&destinationBankId=67890&destinationAccount=1288398743&destinationAccountName=12345&description=Payment for groceries&reference=iausdfh12892j&status=SUCCESS&startDate&endDate'

Responses

🟢200OK

application/json

Body

array of:

id

string

optional

amount

integer

optional

ownerId

string

optional

currency

string

optional

reference

string

optional

originBankId

null

optional

originAccount

null

optional

originAccountName

null

optional

destinationBankId

string

optional

destinationAccount

string

optional

destinationAccountName

string

optional

description

string

optional

status

string

optional

callbackUrl

string

optional

statusWebhook

null

optional

createdAt

string

optional

updatedAt

null

optional

expiresAt

null

optional

Example

[
  {
    "id": "szokiqnitlsqbi1g1fp9vhwo",
    "amount": 1080000,
    "ownerId": "k235v1ujhhnpwv0zmyk4by6t",
    "currency": "NGN",
    "reference": "somerandomreferenceforwatch2",
    "originBankId": null,
    "originAccount": null,
    "originAccountName": null,
    "destinationBankId": "dqv8ldz5mk4eu7ykcvrr8g84",
    "destinationAccount": "1234ABCXXX",
    "destinationAccountName": "Alphabets Inc",
    "description": "Watch purchase",
    "status": "OPEN",
    "callbackUrl": "https://pay.flashpayweb.com",
    "statusWebhook": null,
    "createdAt": "2024-06-24T16:09:59.085Z",
    "updatedAt": null,
    "expiresAt": null
  }
]