GoCardlessClient.Resources.MandatePDFs (GoCardlessClient v2.0.0)

Copy Markdown View Source

GoCardless Mandate PDFs API.

Generates a PDF copy of a mandate for record-keeping, compliance, or delivery to the customer. The response contains a time-limited download URL.

Example

{:ok, pdf} = GoCardlessClient.Resources.MandatePDFs.create(client, %{
  links: %{mandate: "MD123"}
})

IO.puts("Download PDF from: #{pdf["url"]} (expires at #{pdf["expires_at"]})")

Summary

Functions

create(client, params, opts \\ [])

Creates a mandate PDF and returns a time-limited download URL.

Functions

create(client, params, opts \\ [])

@spec create(GoCardlessClient.Client.t(), map(), keyword()) ::
  {:ok, map()}
  | {:error, GoCardlessClient.APIError.t() | GoCardlessClient.Error.t()}

Creates a mandate PDF and returns a time-limited download URL.

  • links.mandate — generate PDF for an existing mandate
  • links.billing_request — generate PDF from a billing request
  • :account_holder_name / :account_number / :branch_code / :iban — for pre-creation PDFs
  • :mandate_reference — reference to show on PDF
  • :scheme — scheme for pre-creation PDFs
  • :signatory_name — name of signatory
  • :signatory_address — address map
  • :subscription_amount — show subscription amount on PDF
  • :subscription_frequency — e.g. "monthly"