Payments

GET/Payments

Query parameters

Response

200401403429500

OK

Body

text/plainapplication/jsontext/json

resultsnullable array of PaymentListItem (object)

nextOffsetnullable string

hasMoreboolean

Request

JavaScriptCurlPython

const response = await fetch('/Payments', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200401403429

{
  "results": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "paymentDate": "2024-11-21T06:38:03.790Z",
      "scheduleDate": "2024-11-21T06:38:03.790Z",
      "handle": "text",
      "description": "text",
      "reference": "text",
      "currency": "text",
      "test": false,
      "status": "Pending",
      "settlementDate": "2024-11-21T06:38:03.790Z",
      "createdAt": "2024-11-21T06:38:03.790Z",
      "modifiedAt": "2024-11-21T06:38:03.790Z"
    }
  ],
  "nextOffset": "text",
  "hasMore": false
}

POST/Payments

Body

application/jsontext/jsonapplication/*+json

mandatenullable string

currencynullable string

amountinteger (int32)

descriptionnullable string

referencenullable string

paymentDatestring (date-time)

Response

200401403404422428429500

OK

Body

text/plainapplication/jsontext/json

idstring (uuid)

paymentDatestring (date-time)

scheduleDatenullable string (date-time)

handlenullable string

descriptionnullable string

referencenullable string

amountinteger (int32)

currencynullable string

testboolean

statusPaymentStatusEnum (enum)

PendingSettledScheduledRejectedCancelledChargebackPendingCancel

statusTextnullable string

settlementDatenullable string (date-time)

createdAtstring (date-time)

modifiedAtnullable string (date-time)

mandatePaymentMandate (object)

Request

JavaScriptCurlPython

const response = await fetch('/Payments', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

200401403404422428429

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "paymentDate": "2024-11-21T06:38:03.790Z",
  "scheduleDate": "2024-11-21T06:38:03.790Z",
  "handle": "text",
  "description": "text",
  "reference": "text",
  "currency": "text",
  "test": false,
  "status": "Pending",
  "statusText": "text",
  "settlementDate": "2024-11-21T06:38:03.790Z",
  "createdAt": "2024-11-21T06:38:03.790Z",
  "modifiedAt": "2024-11-21T06:38:03.790Z",
  "mandate": {
    "handle": "text",
    "scheme": "text",
    "status": "Created",
    "customerId": "123e4567-e89b-12d3-a456-426614174000"
  }
}