ChargebeeAPI

Retrieve Direct Debit Agreement PDF

Idempotency Supported
Try in API Explorer

This is applicable only for Direct Debit via SEPA, Bacs, Bg Autogiro, BECS (for both Australia and New Zealand) and PAD. For Direct Debit, the customer needs to accept an agreement that allows the merchant to debit their bank account. This agreement PDF allows you to easily display scheme-rules compliant Direct Debit mandates to your customers.

This API retrieves the redirect link to the corresponding agreement for customers. The agreement PDF can be your "Thank You" page or sent by email to customers. Communicating this PDF to your customers is mandatory.

Customer locale is used to generate the PDF in the required language. If a customer language is not supported, the PDF is generated in English. Checkout the list of languages supported by GoCardless.

Sample Request

URL Format

POST https://[site].chargebee.com/api/v2/hosted_pages/retrieve_agreement_pdf

Input Parameters

payment_source_id
required, string, max chars=40

Payment source to be used for this payment.

Returns

hosted_pageHosted page object
Resource object representing hosted_page