Sign in

v1

latestOpenAPI 3.0.02026-07-26168846732.2 KB
Mandates

Mandates - Retrieve Mandate

Retrieves a mandate created using the Payments/Create API

get/mandates/{mandate_id}

Path parameters

mandate_idstring required

The identifier for mandate

Response

The mandate was retrieved successfully

mandate_idstring required

The identifier for mandate

status'active' | 'inactive' | 'pending' | 'revoked' required

The status of the mandate, which indicates whether it can be used to initiate a payment.

payment_method_idstring required

The identifier for payment method

payment_methodstring required

The payment method

payment_method_typestring nullable

The payment method type

Example response

{
  "customer_acceptance": {
    "accepted_at": "2022-09-10T10:11:12Z",
    "online": {
      "ip_address": "123.32.25.123"
    }
  }
}