Mandate Pdf
Mandate PDFs allow you to easily display scheme-rules compliant Direct Debit mandates to your customers.
Create a mandate PDF#
/mandate_pdfsGenerates a PDF mandate and returns its temporary URL.
Customer and bank account details can be left blank (for a blank mandate), provided manually, or inferred from the ID of an existing mandate.
By default, we'll generate PDF mandates in English.
To generate a PDF mandate in another language, set the Accept-Language header when creating the PDF mandate to the relevant ISO 639-1 language code supported for the scheme.
| Scheme | Supported languages |
|---|---|
| ACH | English (en) |
| Autogiro | English (en), Swedish (sv) |
| Bacs | English (en) |
| BECS | English (en) |
| BECS NZ | English (en) |
| Betalingsservice | Danish (da), English (en) |
| PAD | English (en) |
| SEPA Core | Danish (da), Dutch (nl), English (en), French (fr), German (de), Italian (it), Portuguese (pt), Spanish (es), Swedish (sv) |
Request Body
mandate_pdfsobject27 properties
schemestring | null
Direct Debit scheme. Can be supplied or automatically detected from the bank account details provided. If you do not provide a scheme, you must provide either a mandate, an iban, or local details including a country_code.
country_codestring | null
ISO 3166-1 alpha-2 code. Required if providing local details.
ibanstring | null
International Bank Account Number. Alternatively you can provide local details. IBANs cannot be provided for Autogiro mandates.
bicstring | null
SWIFT BIC. Will be derived automatically if a valid iban or local details are provided.
account_numberstring | null
Bank account number - see local details for more information. Alternatively you can provide an iban.
bank_codestring | null
Bank code - see local details for more information. Alternatively you can provide an iban.
branch_codestring | null
Branch code - see local details for more information. Alternatively you can provide an iban.
account_holder_namestring | null
Name of the account holder, as known by the bank. Usually this matches the name of the customer. This field cannot exceed 18 characters.
given_namestring | null
The customer's given name (i.e. first name). Used to populate the "Customer Name or Company name" field on the PDF. Ignored if company_name is provided.
family_namestring | null
The customer's family name (i.e. last name). Used to populate the "Customer Name or Company name" field on the PDF. Ignored if company_name is provided.
company_namestring | null
The customer's company name. Used to populate the "Customer Name or Company name" field on the PDF.
mandate_referencestring | null
Unique 6 to 18 character reference. This may be left blank at the point of signing.
signature_datestring | null
If provided, a form will be generated with this date and no signature field.
phone_numberstring | null
The customer phone number. Should only be provided for BECS NZ mandates.
swedish_identity_numberstring | null
For Swedish customers only. The civic/company number (personnummer, samordningsnummer, or organisationsnummer) of the customer. Should only be supplied for Autogiro mandates.
danish_identity_numberstring | null
For Danish customers only. The civic/company number (CPR or CVR) of the customer. Should only be supplied for Betalingsservice mandates.
address_line1string | null
The first line of the customer's address.
address_line2string | null
The second line of the customer's address.
address_line3string | null
The third line of the customer's address.
citystring | null
The city of the customer's address.
regionstring | null
The customer's address region, county or department. For US customers a 2 letter ISO3166-2:US state code is required (e.g. CA for California).
postal_codestring | null
The customer's postal code.
account_typestring | null
Bank account type. Required for USD-denominated bank accounts. Must not be provided for bank accounts in other currencies. See local details for more information.
savingscheckingpayer_ip_addressstring | null
For American customers only. IP address of the computer used by the customer to set up the mandate. This is required in order to create compliant Mandate PDFs according to the ACH scheme rules.
subscription_amountstring | integer
For American customers only. Subscription amount being authorised by the mandate. In the lowest denomination for the currency (cents in USD). Is required if subscription_frequency has been provided.
subscription_frequencystring | null
For American customers only. Frequency of the subscription being authorised by the mandate. One of weekly, monthly or yearly. Is required if subscription_amount has been provided.
weeklymonthlyyearlylinksobject
Response 201
Resource created successfully
mandate_pdfsobject2 properties
urlstring
The URL at which this mandate PDF can be viewed until it expires at the date and time specified by expires_at. You should not store this URL or rely on its structure remaining the same.
expires_atstring
The date and time at which the url will expire (10 minutes after the original request).
Errors 400401404422500
Bad Request
Unauthorised
Not found
Validation Error
Internal Error
Error Body
errorobjectrequiredGeneric error
6 properties
codeintegerdocumentation_urlstringerrorsarrayrequired
6 properties
reasonstringfieldstringrequest_pointerstringmessagestringrequiredmetadataobjectlinksobjectmessagestringrequiredrequest_idstringrequiredtypestring