Mandate PDF
Create a mandate PDF
Generates 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) |
post/mandate_pdfs
Request
- Base URLhttps://api.gocardless.com
- AuthHTTP bearer
Headers
GoCardless-Versionstring required
Request body
Example request
{
"mandate_pdfs": {
"scheme": "bacs",
"account_number": "55779912",
"bank_code": "20041",
"branch_code": "01005",
"account_holder_name": "Lando Calrissian",
"given_name": "Lando",
"family_name": "Calrissian",
"company_name": "Lando Corp",
"mandate_reference": "Foo Subscription",
"signature_date": "2014-01-18",
"phone_number": "+64 4 817 9999",
"swedish_identity_number": "556564-5404",
"danish_identity_number": "220550-6218",
"address_line1": "221B Baker Street",
"address_line2": "Marylebone",
"address_line3": "City of Westminster",
"city": "London",
"region": "Greater London",
"postal_code": "NW1 6XE",
"account_type": "savings",
"payer_ip_address": "127.0.0.1",
"subscription_frequency": "monthly"
}
}Response
Resource created successfully
Example response
{
"mandate_pdfs": {
"url": "https://api.gocardless.com/mandate_pdfs/wLJKzbG12uqcDly7t6L2",
"expires_at": "2014-01-01T12:00:00.000Z"
}
}Changes
No recorded changes to this operation across all 1 revision of this API.