Logo
GoCardless API API Documentation

Create a Mandate PDF

POST {{url}}/mandate_pdfs

Mandate PDFs allow you to easily display scheme-rules compliant Direct Debit mandates to your customers.

Generates a PDF mandate and returns its temporary URL.

Create a mandate PDF API Docs

 

Body PARAM

Key Datatype Required Description 



HEADERS

Key Datatype Required Description 
Accept-Language
string




RESPONSES

status OK

{ "mandate_pdfs": { "url": "https://mandate-previews-sandbox.gocardless.com/?token=eyJhbGciOiJkaXIiLCJlbmMiOiJBMjU2R0NNIn0..OriakeKjvnImJ5_P.r77ZWd9QnikAUA97OpjocecxW5vtztm1ktUURDWfWBjBeflYCELWX_J5YxEZDBmJkn2pK5PvDuaZxO1m5AewjrX0OVfWrSwQd_tnpdYR3xbH80aGeRUp449YFWtJmO3L6xRHtbA13YBTgT6ZesinEbpA_9MoLaDTvxltlWaUgyjkJcRedq8smLv1WH7Jwfg-63hLg1rIq4vkBpSRa9RS2rqaNKBLDGwtkY9OjzV-EThNDMFr5ZY04J0VAl2yqY2fX3XSU_Xk_af9b4fS2lZBrJEZQrYXiymze4bDZAXu8joNC73pI34PtntFb0nque9CGhHlZgGfrxYcbc5OhpsvKnyblwxpctIy5K0Z7Zt3nt1F3F1azgtEbCDfztsI0W9olagj20jRuaVPQne3GveXGxtIEW0xEW3tqdrtncYLYehkb9xCr00eusm4GLa_oY0n9-WgDWs1u5hdSIdorFrFlYI1Cpy7bMSqyiwI6zefV88lcLl_GMszPMtRQVKmI0qI01lqfPWZHvGY7MHcD-pWHD9m_aGp2jtPMC94T6bTDrx4F6gCGaSRG-hcy-yaUwHkgVe3DbkCYvOGye3X4nacIZESmYKkd6syKQIaa0HWdCnd_1XLDuWH67U2bq1MMVGsKnC7h5tyIKNzu7JVSl1Mq179IjRTBQdNfcV3TUka0xd0DXm7mD8s_uQxJBu8Hr-Sf2jeXYU45uo_iTB-36y2JllBk96pXFqBIKZytU89h4fWP-aOKUxcCuUBjOkN-8PXNptAe3b0EH5V4aHGXbAhG29apJ_KDF4SL8dL6kQrpFv3d2eqpsX5CTKWEJ3G-Prl0JyQ41epEJZcqK-IKbqTVhcyBPtGI4-zygKXObANZc03mkvOxfxY-YDRtC5VvpiA5BC9uTDftjOGKSML_UUoLsilYmbvFj9u8_eagxUPsITVbVHwUYKhLFVVW1TIwqdiSOW1lf0k5h2d40YP5sy__TRnpBVwXXFL5NJIKrW5hNQQqMjLZVJsaZviR3WiRdvUoi4xeliNSeAJKeBKjPJp1fptWjLNV81VI4S2TGYJ8O3xQclLPVJV74q50AG7qFuo-YhXi4MBp_zCCnooM7ZBUJoG3LC1cvu-apfN-cVUwQKtZI0H-GP40ZCqng9bgcRFkuvzZ2PlVYWV743E8C8DQDqv8daA_N-5fC26ggq0xjDzDjq8Gpw6KRbPBfvrLto1aEGxADkRInOjfKayCVYWcUGYPzKLwHSQdrAvFBY0AZo52TPyEh39TgvLisBfHcQIR8rwdfSGe9CB1StBvC0rIVJS7hRGpAaC9AnTZ98IlJ2hnBE4qbxRDj5TxW6J0-SFiZZjYUXTzqaIwNiDBBamfZFPG6uscOM_Hb0VMVIBryYPRNZd-b0WWVB2U_jYZraSxXsOURIR3bf1PLH_9UQzZvoNzg0qyI6U3x2o-fgctkgRHj1vD8Bz8Z8ThXIvbJvzgQVXwDaxRqifknn6i0GblCYbK4POGDayyj608Ld-4oAj3uDQh-Ry5A2IRElP5K9BD0KEqk4HA-aJ.ExIEVrt50s4KGFLUGEa2Pg", "expires_at": "2024-03-22T21:51:47.580Z" } }



Curl
curl -X POST 'https://api-sandbox.gocardless.com/mandate_pdfs' -H 'Accept-Language: en' -d '{"mandate_pdfs":{"links":{"mandate":"mandate"}}}'

ENDPOINTS