POST
/
customers
/
{customer_id}
/
mandates
curl --request POST \
  --url https://sandbox.hyperswitch.io/customers/{customer_id}/mandates \
  --header 'api-key: <api-key>'
[
  {
    "mandate_id": "<string>",
    "status": "active",
    "payment_method_id": "<string>",
    "payment_method": "<string>",
    "payment_method_type": "<string>",
    "card": {
      "last4_digits": "<string>",
      "card_exp_month": "<string>",
      "card_exp_year": "<string>",
      "card_holder_name": "<string>",
      "card_token": "<string>",
      "scheme": "<string>",
      "issuer_country": "<string>",
      "card_fingerprint": "<string>",
      "card_isin": "<string>",
      "card_issuer": "<string>",
      "card_network": "Visa",
      "card_type": "<string>",
      "nick_name": "<string>"
    },
    "customer_acceptance": {
      "acceptance_type": "online",
      "accepted_at": "2022-09-10T10:11:12Z",
      "online": {
        "ip_address": "123.32.25.123",
        "user_agent": "<string>"
      }
    }
  }
]

Authorizations

​
api-key
string
header
required

Use the API key created under your merchant account from the HyperSwitch dashboard. API key is used to authenticate API requests from your merchant server only. Don't expose this key on a website or embed it in a mobile application.

Response

200
application/json
List of retrieved mandates for a customer
​
mandate_id
string
required

The identifier for mandate

​
status
enum<string>
required

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

Available options:
active,
inactive,
pending,
revoked
​
payment_method_id
string
required

The identifier for payment method

​
payment_method
string
required

The payment method

​
payment_method_type
string | null

The payment method type

​
card
object
​
customer_acceptance
object

This "CustomerAcceptance" object is passed during Payments-Confirm request, it enlists the type, time, and mode of acceptance properties related to an acceptance done by the customer. The customer_acceptance sub object is usually passed by the SDK or client.