Sign in

v1

latestOpenAPI 3.1.02026-07-136388308.2 KB
Direct Debits

Get the details of a direct debit

This endpoint will retrieve all details of a single direct debit collection/payment, whether successful or not. You will need to enable PERM_BUSINESS_GET_DIRECT_DEBIT to use this endpoint.

get/v1/directdebits/{directDebitUuid}

Path parameters

directDebitUuidstring required

The uuid of the direct debit to retrieve.

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

Response

Retrieve all details of a single direct debit collection/payment

directDebitUuidstring

The UUID for the direct debit payment

status'RECIEVED' | 'REJECT_REQUESTED' | 'REJECT_READY_FOR_PROCESSING' | 'REJECT_RECORD_IN_PROGRESS' | 'REJECT_RECORDED' | 'REJECT_FILE_CREATED' | 'REJECT_FILE_SENT' | 'COLLECTED' | 'REFUND_REQUESTED' | 'REFUND_RECORD_IN_PROGRESS' | 'REFUND_RECORDED' | 'REFUND_FILE_CREATED' | 'REFUND_FILE_SENT'

The statuses of the direct debit payments associated with the mandate.

  • 'RECIEVED' - Direct Debit has been recieved
  • 'REJECT_REQUESTED' - The direct debit has a rejected request associated with it
  • 'REJECT_READY_FOR_PROCESSING'
  • 'REJECT_RECORD_IN_PROGRESS'
  • 'REJECT_RECORDED'
  • 'REJECT_FILE_CREATED'
  • 'REJECT_FILE_SENT'
  • 'COLLECTED' - Direct debit collected
  • 'REFUND_REQUESTED' - Refund requested on direct debit
  • 'REFUND_RECORD_IN_PROGRESS' - Refund in progress on direct debit
  • 'REFUND_RECORDED'
  • 'REFUND_FILE_CREATED'
  • 'REFUND_FILE_SENT'
type'FIRST_COLLECTION' | 'ONGOING_COLLECTION' | 'REPRESENTED_COLLECTION' | 'FINAL_COLLECTION'

The type of the direct debit.

mandateUUidstring

The UUID for the mandate

originatorReferencestring

Set by party who sets up the direct debit.

originatorNamestring

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

originatorAliasstring

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

directDebitReferencestring

The direct debit reference.

targetIcaninteger

The ican of your fire account that the money was taken from

targetPayeeIdinteger

The payee that was created when the DD was processed

isDDICboolean

DDIC is a Direct Debit Indemnity Claim (i.e.a refund). If if the DD is requested to be refunded it is marked isDDIC true.

amountinteger

Value of the payment

schemeRejectReasonstring

Reason why rejected

schemeRejectReasonCode'0' | '1' | '2' | '3' | '4' | '5' | '6' | '7' | '8' | '9' | 'A' | 'B'

The reject 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).

Example response

{
  "directDebitUuid": "42de0705-e3f1-44fa-8c41-79973eb80eb2",
  "currency": {
    "code": "EUR",
    "description": "Euro"
  },
  "status": "RECIEVED",
  "type": "FIRST_COLLECTION",
  "mandateUUid": "f171b143-e3eb-47de-85a6-1c1f1108c701",
  "originatorReference": "VODA-123456",
  "originatorName": "Vodafone PLC",
  "originatorAlias": "Three",
  "directDebitReference": "VODA-ABC453-1",
  "targetIcan": 42,
  "targetPayeeId": 12,
  "amount": 100,
  "schemeRejectReason": "eg. Instruction cancelled by payer",
  "schemeRejectReasonCode": "for BACS (ARUDD) 0|1|2|3|5|6|7|8|9|A|B",
  "lastUpdated": "2016-12-15T22:56:05.937Z",
  "dateCreated": "2016-12-15T22:56:05.937Z"
}