Payments

get

Query parameters

filterstringOptional

orderbystringOptional

afterstringOptional

limitinteger · int32 · min: 1 · max: 100OptionalDefault: 20

Responses

200

OK

nextOffsetstring · nullableRead-onlyOptional

hasMorebooleanRead-onlyOptional

401

Unauthorized

403

Forbidden

429

Too Many Requests

500

Internal Server Error

get/Payments

GET /Payments HTTP/1.1
Accept: */*

{
  "results": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "paymentDate": "2026-01-01T00:00:00.000Z",
      "scheduleDate": "2026-01-01T00:00:00.000Z",
      "handle": "text",
      "description": "text",
      "reference": "text",
      "amount": 1,
      "currency": "text",
      "test": true,
      "status": "Pending",
      "settlementDate": "2026-01-01T00:00:00.000Z",
      "createdAt": "2026-01-01T00:00:00.000Z",
      "modifiedAt": "2026-01-01T00:00:00.000Z",
      "customer": {
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "name": "text"
      },
      "mandate": {
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "handle": "text",
        "scheme": "text"
      }
    }
  ],
  "nextOffset": "text",
  "hasMore": true
}

post

Body

mandatestring · nullableOptional

currencystring · nullableOptional

amountinteger · int32Optional

descriptionstring · nullableOptional

referencestring · nullableOptional

paymentDatestring · date-timeOptional

Responses

200

OK

idstring · uuidOptional

paymentDatestring · date-timeOptional

scheduleDatestring · date-time · nullableOptional

handlestring · nullableOptional

descriptionstring · nullableOptional

referencestring · nullableOptional

amountinteger · int32Optional

currencystring · nullableOptional

testbooleanOptional

statusstring · enumOptionalPossible values:

statusTextstring · nullableOptional

settlementDatestring · date-time · nullableOptional

createdAtstring · date-timeOptional

modifiedAtstring · date-time · nullableOptional

401

Unauthorized

403

Forbidden

404

Not Found

422

Unprocessable Content

428

Precondition Required

429

Too Many Requests

500

Internal Server Error

post/Payments

POST /Payments HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 128

{
  "mandate": "text",
  "currency": "text",
  "amount": 1,
  "description": "text",
  "reference": "text",
  "paymentDate": "2026-01-01T00:00:00.000Z"
}

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "paymentDate": "2026-01-01T00:00:00.000Z",
  "scheduleDate": "2026-01-01T00:00:00.000Z",
  "handle": "text",
  "description": "text",
  "reference": "text",
  "amount": 1,
  "currency": "text",
  "test": true,
  "status": "Pending",
  "statusText": "text",
  "settlementDate": "2026-01-01T00:00:00.000Z",
  "createdAt": "2026-01-01T00:00:00.000Z",
  "modifiedAt": "2026-01-01T00:00:00.000Z",
  "mandate": {
    "handle": "text",
    "scheme": "text",
    "status": "Created",
    "customerId": "123e4567-e89b-12d3-a456-426614174000"
  }
}