Skip to main content
GET
/
api
/
external
/
v2
/
gocardless_mandates
/
{id}
Get a Gocardless mandate
curl --request GET \
  --url https://app.pennylane.com/api/external/v2/gocardless_mandates/{id} \
  --header 'Authorization: Bearer <token>'
{
  "id": 42,
  "external_reference": "MD000VDD0HN1RP",
  "customer": {
    "id": 42,
    "url": "https://app.pennylane.com/api/external/v2/customers/42"
  },
  "status": "pending_customer_approval",
  "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"
}

Authorizations

​
Authorization
string
header
required

The access token received from the authorization server in the OAuth 2.0 flow.

Path Parameters

​
id
integer
required

ID of the Gocardless mandate to retrieve

Response

A Gocardless mandate

​
id
integer
required
Example:

42

​
external_reference
string | null
required

Unique external identifier for the Gocardless mandate.

Example:

"MD000VDD0HN1RP"

​
customer
object | null
required
​
status
enum<string>
required
Available options:
pending_customer_approval,
pending_submission,
submitted,
active,
failed,
cancelled,
expired,
consumed,
replaced,
blocked,
bank_disconnected
​
external_customer_account
string
required

Identifier for the Gocardless customer account.

Example:

"test_account_id"

​
external_customer_label
string | null
required

Label for the Gocardless customer account.

Example:

"test_label"

​
created_at
string<date-time>
required

Creation date of the Gocardless mandate

Example:

"2023-08-07T14:23:12.000Z"

​
updated_at
string<date-time>
required

Last update date of the Gocardless mandate

Example:

"2023-08-07T14:23:12.000Z"

⌘I