v1

latestOpenAPI 3.1.02026-07-136388308.2 KB

Direct Debits

List all direct debit mandates

This endpoint will list all mandates on your Fire account. You will need to enable PERM_BUSINESS_GET_MANDATES to use this endpoint.

get/v1/mandates

Response

List all direct debit mandates.

totalinteger

Number of direct debits found

Example response

{
  "total": 1,
  "mandates": [
    {
      "mandateUuid": "28d627c3-1889-44c8-ae59-6f6b20239260",
      "currency": {
        "code": "EUR",
        "description": "Euro"
      },
      "status": "RECIEVED",
      "originatorReference": "VODA-123456",
      "originatorName": "Vodafone PLC",
      "originatorAlias": "Vodaphone PLC",
      "originatorLogoUrlSmall": "originatorLogoSmall",
      "originatorLogoUrlLarge": "originatorLogoLarge",
      "mandateReference": "CRZ-102190123",
      "alias": "Vodaphone",
      "targetIcan": 1,
      "numberOfDirectDebitCollected": 2,
      "valueOfDirectDebitCollected": 2,
      "latestDirectDebitAmount": 2,
      "latestDirectDebitDate": "2016-12-15T22:56:05.937Z",
      "fireRejectionReason": "ACCOUNT_DOES_NOT_ACCEPT_DIRECT_DEBITS",
      "schemeCancelReason": "e.g. Instruction cancelled by payer",
      "schemeCancelReasonCode": "For BACS (ADDACS) - 0|1|2|3|B|C|D|E|R",
      "lastUpdated": "2016-12-15T22:56:05.937Z",
      "dateCreated": "2016-12-15T22:56:05.937Z",
      "dateCompleted": "2016-12-15T22:56:05.937Z",
      "dateCancelled": "2016-12-15T22:56:05.937Z"
    }
  ]
}