Sign in

v1

latestOpenAPI 3.1.02026-07-136388308.2 KB
Direct Debits

Get the details of a direct debit mandate

This endpoint will allow you to retrieve all details for a direct debit mandate. You will need to enable PERM_BUSINESS_GET_MANDATE to use this endpoint.

get/v1/mandates/{mandateUuid}

Path parameters

mandateUuidstring required

The uuid of the mandate to retrieve.

Example:4ADFB67A-0F5B-4A9A-9D74-34437250045C

Response

Retrieve all details for a direct debit mandate.

mandateUuidstring

The UUID for the mandate

status'CREATED' | 'LIVE' | 'REJECT_REQUESTED' | 'REJECT_RECORD_IN_PROGRESS' | 'REJECT_RECORDED' | 'REJECT_FILE_CREATED' | 'REJECT_FILE_SENT' | 'CANCEL_REQUESTED' | 'CANCEL_RECORD_IN_PROGRESS' | 'CANCEL_RECORDED' | 'CANCEL_FILE_CREATED' | 'CANCEL_FILE_SENT' | 'COMPLETE' | 'DORMANT'

The status of the mandate.

  • 'CREATED'
  • 'LIVE'
  • 'REJECT_REQUESTED'
  • 'REJECT_RECORD_IN_PROGRESS'
  • 'REJECT_RECORDED'
  • 'REJECT_FILE_CREATED'
  • 'REJECT_FILE_SENT'
  • 'CANCEL_REQUESTED'
  • 'CANCEL_RECORD_IN_PROGRESS'
  • 'CANCEL_RECORDED'
  • 'CANCEL_FILE_CREATED'
  • 'CANCEL_FILE_SENT'
  • 'COMPLETE'
  • 'DORMANT'
originatorReferencestring

Set by party who sets up the direct debit.

originatorNamestring

The creator of the party who sets up the direct debit.

originatorAliasstring

The name of the alias

originatorLogoUrlSmallstring

Logo url from party who sets up the direct debit.

originatorLogoUrlLargestring

Logo url from party who sets up the direct debit.

mandateReferencestring

the reference of the mandate

aliasstring

The name of the alias

targetIcaninteger

Identifier for the fire.com account (assigned by fire.com)

numberOfDirectDebitCollectedinteger

The number of direct debits collected

valueOfDirectDebitCollectedinteger

The value of direct debits collected

latestDirectDebitAmountinteger

The value of largest direct debit collected

latestDirectDebitDatestring date-time

The date of latest direct debit collected

fireRejectionReason'ACCOUNT_DOES_NOT_ACCEPT_DIRECT_DEBITS' | 'DDIC' | 'ACCOUNT_NOT_FOUND' | 'ACCOUNT_NOT_LIVE' | 'CUSTOMER_NOT_FOUND' | 'BUSINESS_NOT_LIVE' | 'BUSINESS_NOT_FULL' | 'PERSONAL_USER_NOT_LIVE' | 'PERSONAL_USER_NOT_FULL' | 'MANDATE_ALREADY_EXISTS' | 'MANDATE_WITH_DIFERENT_ACCOUNT' | 'NULL_MANDATE_REFERENCE' | 'INVALID_ACCOUNT_CURRENCY' | 'INVALID_MANDATE_REFERENCE' | 'REQUESTED_BY_CUSTOMER_VIA_SUPPORT' | 'CUSTOMER_ACCOUNT_CLOSED' | 'CUSTOMER_DECEASED' | 'ACCOUNT_TRANSFERRED' | 'MANDATE_NOT_FOUND' | 'ACCOUNT_TRANSFERRED_TO_DIFFERENT_ACCOUNT' | 'INVALID_ACCOUNT_TYPE' | 'MANDATE_EXPIRED' | 'MANDATE_CANCELLED' | 'REQUESTED_BY_CUSTOMER'

Rejection reason if transaction is rejected

schemeCancelReasonstring

Reason for cancelation

schemeCancelReasonCodestring

The cancelation code returned by the bank indicating an issue with the direct debit. Each ARRUD code represents a rejection reason.

lastUpdatedstring date-time

Date the direct debit was last updated. Milliseconds since the epoch (1970).

dateCreatedstring date-time

Date the direct debit was created. Milliseconds since the epoch (1970).

dateCompletedstring date-time

Date the direct debit was completed. Milliseconds since the epoch (1970).

dateCancelledstring date-time

Date the direct debit was canceled. Milliseconds since the epoch (1970).

Example response

{
  "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"
}