Mandates - Retrieve Mandate

Retrieve a mandate by its identifier.

Request

GET https://sandbox.hyperswitch.io/mandates/{mandate_id}

cURL

curl
curl --request GET \
  --url https://sandbox.hyperswitch.io/mandates/{mandate_id} \
  --header 'api-key: <api-key>'

Response (200)

application/json
{
  "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>"
    }
  }
}

Authorization

  • Header: api-key (string) — 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.

Do not expose your API key in client-side code or mobile applications.

Path Parameters

  • mandate_id (string) — required The identifier for the mandate.

Response Fields

  • mandate_id (string) — required The identifier for the mandate.

  • status (string, enum) — 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 the payment method.

  • payment_method (string) — required The payment method.

  • payment_method_type (string | null) The payment method type.

card (object)

Show card attributes

  • 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 (string) — example: Visa

  • card_type (string)

  • nick_name (string)

customer_acceptance (object)

This object represents how the customer accepted the mandate (usually passed by the SDK or client) and includes type, time, and mode of acceptance.

Show customer_acceptance attributes

  • acceptance_type (string) — example: online

  • accepted_at (string, timestamp) — example: 2022-09-10T10:11:12Z

  • online (object)

    • ip_address (string) — example: 123.32.25.123

    • user_agent (string)

Links

  • Documentation: https://api-reference.hyperswitch.io/introduction

  • Locker API Reference: https://api-reference.hyperswitch.io/locker-api-reference/overview

  • Intelligent Router API Reference: https://api-reference.hyperswitch.io/intelligent-router-api-reference/overview

Suggest edits: https://github.com/juspay/hyperswitch/edit/main/api-reference/v1/mandates/mandates--retrieve-mandate.mdx Raise issue: https://github.com/juspay/hyperswitch/issues/new?title=Issue%20on%20docs&body=Path:%20/v1/mandates/mandates--retrieve-mandate

PreviousmandatesNextmerchant-account