Sign in

v1

latestOpenAPI 3.1.02026-07-2051132407.2 KB
Direct debit mandates

Get a specific mandate

Returns the details of the specified direct debit mandate.

get/mandates/{mandateId}

Path parameters

mandateIdstring required

The unique identifier of the mandate.

Response

OK - The request has succeeded

balanceAccountIdstring

The unique identifier of the balance account linked to the payment instrument.

createdAtstring date-time

The date when the mandate was created.

idstring

The unique identifier of the mandate.

paymentInstrumentIdstring

The unique identifier of the payment instrument linked to the mandate.

status'pending' | 'approved' | 'cancelled'
type'bacs'
updatedAtstring date-time

The date when the mandate was updated.