Payments

get

Query parameters

filterstringoptional

orderbystringoptional

afterstringoptional

limitinteger · int32 · min: 1 · max: 100 · default: 20optional

Responses

text/plainapplication/jsontext/json

text/plainapplication/jsontext/json

text/plainapplication/jsontext/json

text/plainapplication/jsontext/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url '/Payments'

200

401

403

429

500

200

text/plain

application/json

text/json

text/plain

{
  "results": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "paymentDate": "2025-04-03T06:21:52.515Z",
      "scheduleDate": "2025-04-03T06:21:52.515Z",
      "handle": "text",
      "description": "text",
      "reference": "text",
      "amount": 1,
      "currency": "text",
      "test": true,
      "status": "Pending",
      "settlementDate": "2025-04-03T06:21:52.515Z",
      "createdAt": "2025-04-03T06:21:52.515Z",
      "modifiedAt": "2025-04-03T06:21:52.515Z"
    }
  ],
  "nextOffset": "text",
  "hasMore": true
}

OK

post

Body

application/jsontext/jsonapplication/*+json

mandatestring | nullableoptional

currencystring | nullableoptional

amountinteger · int32optional

descriptionstring | nullableoptional

referencestring | nullableoptional

paymentDatestring · date-timeoptional

Responses

text/plainapplication/jsontext/json

text/plainapplication/jsontext/json

text/plainapplication/jsontext/json

text/plainapplication/jsontext/json

text/plainapplication/jsontext/json

text/plainapplication/jsontext/json

text/plainapplication/jsontext/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url '/Payments' \
  --header 'Content-Type: application/json' \
  --data '{
    "mandate": "text",
    "currency": "text",
    "amount": 1,
    "description": "text",
    "reference": "text",
    "paymentDate": "2025-04-03T06:21:52.515Z"
  }'

application/jsontext/jsonapplication/*+json

200

401

403

404

422

428

429

500

200

text/plain

application/json

text/json

text/plain

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "paymentDate": "2025-04-03T06:21:52.515Z",
  "scheduleDate": "2025-04-03T06:21:52.515Z",
  "handle": "text",
  "description": "text",
  "reference": "text",
  "amount": 1,
  "currency": "text",
  "test": true,
  "status": "Pending",
  "statusText": "text",
  "settlementDate": "2025-04-03T06:21:52.515Z",
  "createdAt": "2025-04-03T06:21:52.515Z",
  "modifiedAt": "2025-04-03T06:21:52.515Z",
  "mandate": {
    "handle": "text",
    "scheme": "text",
    "status": "Created",
    "customerId": "123e4567-e89b-12d3-a456-426614174000"
  }
}

OK