Sign in

v1

latestOpenAPI 3.1.02026-08-0670151364.9 KB
Direct debit mandates

Create a direct debit mandate

The request body is optional and may contain only a redirectUrl. Bank details cannot be submitted through the API: the customer authorises the mandate themselves via the url returned in the response. In staging, you can open that link yourself and complete it with test bank details.

put/customers/{id}/directdebitmandates

Path parameters

idstring required

The id of the customer for whom to create the mandate

The id of the customer for whom to create the mandate

Request body

redirectUrlstring

The redirect URL to redirect the user after they sign the mandate

Response

The direct debit mandate was created

idstring

The ID of the mandate

creationTimestring date-time

The creation time of the mandate

lastUpdateTimestring date-time

The last time when the mandate was updated

distributionTimestring date-time

The time when the mandate was sent to the customer

authorisationTimestring date-time

The time when the mandate was signed by the customer

submissionTimestring date-time

The time when the mandate was submitted to the payment provider

status'CREATED' | 'PENDING' | 'ACTIVE' | 'PENDING_CANCELLATION' | 'CANCELLED' | 'MIGRATING'

The mandate status

failureReasonstring

The reason for failing to set up the mandate

statusReasonCode'PENDING_DD_CAPABILITY' | 'PENDING_ACTIVATION' | 'MIGRATED' | 'BANK_ACCOUNT_CHANGED' | 'INCORRECT_BANK_DETAILS' | 'INSTRUCTION_CANCELLED_BY_PAYER' | 'PAYER_DECEASED' | 'ACCOUNT_TRANSFERRED' | 'ADVANCE_NOTICE_DISPUTED' | 'AMOUNT_DISPUTED' | 'MANDATE_NOT_FOUND' | 'DISPUTE_TOO_EARLY' | 'DISPUTE_TOO_LATE' | 'INVALID_SORT_CODE' | 'INVALID_ACC_NUMBER' | 'ACCOUNT_CLOSED' | 'CANCELLED_ON_DEMAND' | 'REINSTATED' | 'MIGRATION_TIMEOUT' | 'DISCARDED_BY_BILLER' | 'ACCEPTED_ON_CREATION' | 'OTHER'

The reason as predefined code why the mandate is in a certain status

statusReasonstring

Reason explaining the current status of the direct debit mandate, especially useful for failure cases.

urlstring

The URL where the customer can sign the direct debit mandate.

redirectUrlstring

The (optional) redirect URL to redirect the user after they sign the mandate

bankAccountNumberstring

The mandate bank account number

sortCodestring

The mandate sort code

bankAccountHolderNamestring

The mandate bank account holder name

mandateContactIdstring

The ID of the person linked as the mandate contact