PEpennylane
Mandates

Associate a GoCardless mandate to a customer

Changed on

This endpoint allows you to associate a GoCardless mandate to a customer.

ℹ️ This endpoint requires the following scope: customer_mandates:all

post/api/external/v2/gocardless_mandates/{gocardless_mandate_id}/associations

Request

  • Base URL
    https://app.pennylane.com
  • URL
    https://app.pennylane.com/api/external/v2/gocardless_mandates/{gocardless_mandate_id}/associations
  • Auth
    OAuth 2
    Authorization code: https://app.pennylane.com/oauth/authorize
    Token URL: https://app.pennylane.com/oauth/oauth/token scopes: customer_mandates:all

Path parameters

gocardless_mandate_idinteger required

GoCardless Mandate identifier

Headers

X-Company-Idstring
Example:12345

Numeric ID of the company to act on. Required when authenticating with a firm token. Ignored when the token is already bound to a company.

Request body

customer_idinteger required

Customer identifier

Example request

{
  "customer_id": 42
}

Response

Association created successfully.

Changes