Skip to main content
GET
/
payments
cURL
curl --request GET \
  --url https://api.spotflow.co/api/v1/payments \
  --header 'Authorization: Bearer <token>'
{
  "content": [
    {
      "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "reference": "REF123456789",
      "amount": 100,
      "currency": "USD",
      "status": "SUCCESS",
      "spotflowReference": "SPF-REF-001",
      "localAmount": 156000,
      "totalFees": 500,
      "localCurrency": "NGN",
      "channel": "card",
      "mode": "TEST",
      "rate": 1560,
      "region": "Nigeria",
      "authorization": {
        "mode": "Pin"
      },
      "ussd": {
        "code": "*737#",
        "paymentCode": "123456"
      },
      "bankDetails": {
        "accountName": "John Doe",
        "accountNumber": "0123456789",
        "bankName": "Access Bank"
      },
      "card": {
        "type": "VISA",
        "firstSix": "412345",
        "lastFour": "6789"
      },
      "createdAt": "2025-10-17T15:21:11.287Z",
      "metadata": {
        "orderId": "ORD-000123",
        "note": "First payment"
      },
      "totalTaxAmount": 50,
      "totalLocalAmount": 156050,
      "planId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "mobileMoney": {
        "otp": "1234",
        "code": "MTN",
        "name": "MTN Mobile Money",
        "phoneNumber": "+233540000000"
      }
    }
  ],
  "pageNumber": 1,
  "pageSize": 10,
  "totalElements": 100,
  "totalPages": 10
}

Documentation Index

Fetch the complete documentation index at: https://docs.spotflow.one/llms.txt

Use this file to discover all available pages before exploring further.

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