GET
/
direct-debits
{
  "status": "00",
  "message": "Payment successful",
  "data": {
    "mandates": [
      {
        "mandate_status": "ACTIVE",
        "mandate_id": "1234-4567-8901",
        "reference": "DD123456789",
        "narration": "Monthly subscription payment",
        "amount": 100,
        "start_date": "2024-03-20",
        "end_date": "2025-03-20",
        "next_possible_charge_date": "2014-11-10",
        "frequency": "MONTHLY",
        "destination_bank_code": "044",
        "destination_account": "0987654321",
        "destination_account_name": "Merchant Name Ltd",
        "callback_url": "https://api.merchant.com/webhooks/dd-status/DD123456789",
        "custom_properties": [
          {
            "id": "1",
            "description": "custom_property",
            "type": "string",
            "value": "custom_property"
          }
        ]
      }
    ]
  }
}

Authorizations

​
Authorization
string
header
required

The access token received from the authorization server in the OAuth 2.0 flow.

Headers

​
connection-id
string

Connection ID for the target bank

​
idempotency-key
string
required

Unique key to ensure idempotency of the request

​
signature
string
required

SHA-256 signature of client_secret + ";" + idempotency-key

Response

200 - application/json

Direct debit retrieved successfully

​
status
string
required
Example:

"00"

​
message
string
required
Example:

"Payment successful"

​
data
object
required
⌘I