Developers
Docs
  • Introduction
  • Welcome
  • Getting Started
    • Authentication
    • Errors
    • Idempotency
    • Pagination
    • Metadata
    • Versioning
    • Traceability
    • Limitations
  • API
    • API reference
      • Agreements
        • Agreement Object
        • List agreements
        • Get agreement
        • Get template
        • Create agreement
      • ApiKeys
        • ApiKey object
      • Customers
        • Customer object
        • List customers
        • Get customer
      • Mandates
        • Mandate object
      • Payments
        • Cancel
      • Webhooks
      • Merchants
        • Me
    • Specification
  • Webhooks
    • Events
Powered by GitBook
On this page
  1. API
  2. API reference

Payments

PreviousMandate objectNextCancel

Last updated 2 years ago

get
Query parameters
filterstringOptional
orderbystringOptional
afterstringOptional
limitinteger · int32 · min: 1 · max: 100OptionalDefault: 20
Responses
200
OK
401
Unauthorized
403
Forbidden
429
Too Many Requests
500
Internal Server Error
get
GET /Payments HTTP/1.1
Host: 
Accept: */*

{
  "results": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "paymentDate": "2025-06-07T05:00:08.793Z",
      "scheduleDate": "2025-06-07T05:00:08.793Z",
      "handle": "text",
      "description": "text",
      "reference": "text",
      "amount": 1,
      "currency": "text",
      "test": true,
      "status": "Pending",
      "settlementDate": "2025-06-07T05:00:08.793Z",
      "createdAt": "2025-06-07T05:00:08.793Z",
      "modifiedAt": "2025-06-07T05:00:08.793Z",
      "customer": {
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "name": "text"
      },
      "mandate": {
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "handle": "text",
        "scheme": "text"
      }
    }
  ],
  "nextOffset": "text",
  "hasMore": true
}
  • GET/Payments
  • POST/Payments
post
Body
mandatestring | nullableOptional
currencystring | nullableOptional
amountinteger · int32Optional
descriptionstring | nullableOptional
referencestring | nullableOptional
paymentDatestring · date-timeOptional
Responses
200
OK
401
Unauthorized
403
Forbidden
404
Not Found
422
Unprocessable Content
428
Precondition Required
429
Too Many Requests
500
Internal Server Error
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-07T05:00:08.793Z"
}
{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "paymentDate": "2025-06-07T05:00:08.793Z",
  "scheduleDate": "2025-06-07T05:00:08.793Z",
  "handle": "text",
  "description": "text",
  "reference": "text",
  "amount": 1,
  "currency": "text",
  "test": true,
  "status": "Pending",
  "statusText": "text",
  "settlementDate": "2025-06-07T05:00:08.793Z",
  "createdAt": "2025-06-07T05:00:08.793Z",
  "modifiedAt": "2025-06-07T05:00:08.793Z",
  "mandate": {
    "handle": "text",
    "scheme": "text",
    "status": "Created",
    "customerId": "123e4567-e89b-12d3-a456-426614174000"
  }
}