Payments

get
Query parameters
filterstringOptional
orderbystringOptional
afterstringOptional
limitinteger · int32 · min: 1 · max: 100OptionalDefault: 20
Responses
200
OK
get
GET /Payments HTTP/1.1
Host: 
Accept: */*
{
  "results": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "paymentDate": "2025-06-27T07:32:02.302Z",
      "scheduleDate": "2025-06-27T07:32:02.302Z",
      "handle": "text",
      "description": "text",
      "reference": "text",
      "amount": 1,
      "currency": "text",
      "test": true,
      "status": "Pending",
      "settlementDate": "2025-06-27T07:32:02.302Z",
      "createdAt": "2025-06-27T07:32:02.302Z",
      "modifiedAt": "2025-06-27T07:32:02.302Z",
      "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
post
POST /Payments HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 128

{
  "mandate": "text",
  "currency": "text",
  "amount": 1,
  "description": "text",
  "reference": "text",
  "paymentDate": "2025-06-27T07:32:02.302Z"
}
{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "paymentDate": "2025-06-27T07:32:02.302Z",
  "scheduleDate": "2025-06-27T07:32:02.302Z",
  "handle": "text",
  "description": "text",
  "reference": "text",
  "amount": 1,
  "currency": "text",
  "test": true,
  "status": "Pending",
  "statusText": "text",
  "settlementDate": "2025-06-27T07:32:02.302Z",
  "createdAt": "2025-06-27T07:32:02.302Z",
  "modifiedAt": "2025-06-27T07:32:02.302Z",
  "mandate": {
    "handle": "text",
    "scheme": "text",
    "status": "Created",
    "customerId": "123e4567-e89b-12d3-a456-426614174000"
  }
}

Last updated