Sign in

v1

latestOpenAPI 3.0.12026-07-141671231.8 MB
Mandates

Get a Gocardless mandate

This endpoint allows you to retrieve a specific Gocardless mandate by ID.

ℹ️ This endpoint requires one of the following scopes: customer_mandates:all, customer_mandates:readonly

get/api/external/v2/gocardless_mandates/{id}

Path parameters

idinteger required

ID of the Gocardless mandate to retrieve

Response

A Gocardless mandate

idinteger required
external_referencestring nullable required

Unique external identifier for the Gocardless mandate.

status'pending_customer_approval' | 'pending_submission' | 'submitted' | 'active' | 'failed' | 'cancelled' | 'expired' | 'consumed' | 'replaced' | 'blocked' | 'bank_disconnected' required
external_customer_accountstring required

Identifier for the Gocardless customer account.

external_customer_labelstring nullable required

Label for the Gocardless customer account.

created_atstring date-time required

Creation date of the Gocardless mandate

updated_atstring date-time required

Last update date of the Gocardless mandate

Example response

{
  "id": 42,
  "external_reference": "MD000VDD0HN1RP",
  "customer": {
    "id": 42,
    "url": "https://app.pennylane.com/api/external/v2/customers/42"
  },
  "external_customer_account": "test_account_id",
  "external_customer_label": "test_label",
  "created_at": "2023-08-07T14:23:12.000Z",
  "updated_at": "2023-08-07T14:23:12.000Z"
}