v1

latestOpenAPI 3.0.12026-07-2679100267.2 KB

Direct Debits

Debit a mandate

Debits a customer's account using an active mandate.

post/v1/direct-debits/debit-mandate

Headers

accountIdstring required

The vendor account ID

Request body

mandateIdstring required

Unique identifier of the mandate to debit

amountstring required

Amount to be debited

Response

Mandate debited successfully

codestring required

descriptionstring required

messagestring required

statusboolean required

Example response

{
  "code": "00",
  "description": "SUCCESS",
  "data": {
    "mandateId": "89b0efc0-dde5-49e2-8bde-5523ae081c43",
    "status": "SUCCESS",
    "amount": "110.00",
    "message": "Approved or completed successfully"
  },
  "message": "SUCCESS",
  "status": true
}