Skip to main content
GET
cURL

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

page
integer<int32>
default:0

Page number for pagination (default is 0).

size
integer<int32>
default:10

Number of items per page for pagination (default is 10).

reference
number<int32>

The unique identifier of the payment.

query
string

Use this to get payments by any internal reference you set when creating/initializing payments

Example:

"ref-db15ac7a-78c4-480d-afc4-2be8b2325399"

status
string

This can either be successful, failed or pending.

channel
enum<string>

This can either be card, bank transfer, mobile_money, or eft for local currency payments.

Available options:
card,
bank_transfer,
mobile_money,
eft
provider
string

These are available payment providers on Spotflow.

from
string
to
string

Response

A JSON array of payment objects.

content
object[]
pageNumber
integer
Example:

1

pageSize
integer
Example:

10

totalElements
integer
Example:

100

totalPages
integer
Example:

10