Payment Method - Retrieve

GET /v2/payment-methods/{id}

Try it

Example: cURL

cURL
curl --request GET \
  --url https://sandbox.hyperswitch.io/v2/payment-methods/{id} \
  --header 'api-key: <api-key>'

Example Response (200)

application/json
{
  "id": "12345_pm_01926c58bc6e77c09e809964e72af8c8",
  "merchant_id": "merchant_1671528864",
  "customer_id": "12345_cus_01926c58bc6e77c09e809964e72af8c8",
  "payment_method_type": "card",
  "payment_method_subtype": "ach",
  "recurring_enabled": true,
  "created": "2023-01-18T11:04:09.922Z",
  "last_used_at": "2024-02-24T11:04:09.922Z",
  "payment_method_data": {
    "card": {
      "saved_to_locker": true,
      "issuer_country": "AF",
      "last4_digits": "4242",
      "expiry_month": "10",
      "expiry_year": "25",
      "card_holder_name": "John Doe",
      "card_fingerprint": "fingerprint_12345",
      "nick_name": "Card",
      "card_network": "Visa",
      "card_isin": "4567890",
      "card_issuer": "Issuer Bank",
      "card_type": "Credit"
    }
  },
  "connector_tokens": [
    {
      "token": "pm_9UhMqBMEOooRIvJFFdeW",
      "connector_token_request_reference_id": "<string>"
    }
  ],
  "network_token": {
    "payment_method_data": {
      "last4_digits": "4242",
      "issuer_country": "AF",
      "network_token_expiry_month": "05",
      "network_token_expiry_year": "27",
      "nick_name": "Card",
      "card_holder_name": "John Doe",
      "card_isin": "16712672",
      "card_issuer": "Bank of America",
      "card_network": "Visa",
      "card_type": "Credit",
      "saved_to_locker": true
    }
  },
  "storage_type": "volatile",
  "card_cvc_token_storage": {
    "is_stored": true,
    "expires_at": "2024-02-24T11:04:09.922Z"
  }
}

Authorizations

  • 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.

Path Parameters

  • id (string) — required The unique identifier for the Payment Method

Response (200) — Payment Method Retrieved

Fields described below.

  • id (string, required) The unique identifier of the Payment Method. Example: "12345_pm_01926c58bc6e77c09e809964e72af8c8"

  • merchant_id (string, required) Unique identifier for a merchant. Example: "merchant_1671528864"

  • customer_id (string, required) The unique identifier of the customer. Required string length: 32 - 64 Example: "12345_cus_01926c58bc6e77c09e809964e72af8c8"

  • payment_method_type (enum, required) Indicates the type of payment method. Eg: 'card', 'wallet', etc.

Available options (click to expand)

card, card_redirect, pay_later, wallet, bank_redirect, bank_transfer, crypto, bank_debit, reward, real_time_payment, upi, voucher, gift_card, open_banking, mobile_payment, network_token

  • payment_method_subtype (enum) Indicates the sub type of payment method. Eg: 'google_pay' & 'apple_pay' for wallets.

Available options (click to expand)

ach, affirm, afterpay_clearpay, alfamart, ali_pay, ali_pay_hk, alma, amazon_pay, paysera, apple_pay, atome, bacs, bancontact_card, becs, benefit, bizum, blik, bluecode, boleto, bca_bank_transfer, bni_va, breadpay, bri_va, bhn_card_network, card_redirect, cimb_va, classic, credit, crypto_currency, cashapp, dana, danamon_va, debit, duit_now, efecty, eft, eps, flexiti, fps, evoucher, giropay, givex, google_pay, go_pay, gcash, ideal, interac, indomaret, klarna, kakao_pay, local_bank_redirect, mandiri_va, knet, mb_way, mobile_pay, momo, momo_atm, multibanco, online_banking_thailand, online_banking_czech_republic, online_banking_finland, online_banking_fpx, online_banking_poland, online_banking_slovakia, oxxo, pago_efectivo, permata_bank_transfer, open_banking_uk, pay_bright, payjustnow, paypal, paze, pix, pay_safe_card, przelewy24, prompt_pay, pse, red_compra, red_pagos, samsung_pay, sepa, sepa_bank_transfer, sepa_guarenteed_debit, skrill, sofort, swish, touch_n_go, trustly, twint, upi_collect, upi_intent, upi_qr, vipps, viet_qr, venmo, walley, we_chat_pay, seven_eleven, lawson, mini_stop, family_mart, seicomart, pay_easy, local_bank_transfer, mifinity, open_banking_pis, direct_carrier_billing, instant_bank_transfer, instant_bank_transfer_finland, instant_bank_transfer_poland, revolut_pay, indonesian_bank_transfer, open_banking, network_token

  • recurring_enabled (boolean | null) Indicates whether the payment method supports recurring payments. Optional. Example: true

  • created (string | null) A timestamp (ISO 8601) that determines when the payment method was created. Example: "2023-01-18T11:04:09.922Z"

  • last_used_at (string | null) A timestamp (ISO 8601) that determines when the payment method was last used. Example: "2024-02-24T11:04:09.922Z"

  • payment_method_data (object) Object containing payment method specific data (e.g., card). See example response for details.

  • connector_tokens (object[] | null) The connector token details if available. Example element:

    • token

    • connector_token_request_reference_id

  • network_token (object) Network token object. See example response for payment_method_data inside network_token.

  • storage_type (enum) Available options: volatile, persistent

  • card_cvc_token_storage (object) Child attributes:

    • is_stored (boolean)

    • expires_at (string)

Was this page helpful?

  • Yes / No

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

Related:

  • Payment Method - Update: https://api-reference.hyperswitch.io/v2/payment-methods/payment-method--update

  • Payment Method - Delete: https://api-reference.hyperswitch.io/v2/payment-methods/payment-method--delete

PreviousSubscription - Resume SubscriptionNextMerchant Connector - Update