v1

latestOpenAPI 3.0.02026-07-26168846732.2 KB
Payment Methods

List customer saved payment methods for a Payment

Lists all the applicable payment methods for a particular payment tied to the client_secret.

get/customers/payment_methods

Query parameters

client_secretstring nullable

This is a token which expires after 15 minutes, used from the client to authenticate and create sessions from the SDK

accepted_countriesCountryAlpha2[] nullable

The two-letter ISO currency code

accepted_currenciesCurrency[] nullable

The three-letter ISO currency code

amountinteger nullable

The amount accepted for processing by the particular payment method.

recurring_enabledboolean nullable

Indicates whether the payment method is eligible for recurring payments

installment_payment_enabledboolean nullable

Indicates whether the payment method is eligible for installment payments

limitinteger nullable

Indicates the limit of last used payment methods

card_networksCardNetwork[] nullable

Indicates whether the payment method is eligible for card netwotks

Response

Payment Methods retrieved for customer tied to its respective client-secret passed in the param

Example response

{
  "customer_payment_methods": [
    {
      "id": "0a_pm_01926c58bc6e77c09e809964e72af8c8",
      "customer_id": "0a_cus_01926c58bc6e77c09e809964e72af8c8",
      "recurring_enabled": true,
      "payment_method_data": {
        "card": {
          "last4_digits": "4242",
          "expiry_month": "10",
          "expiry_year": "25",
          "card_holder_name": "John Doe",
          "card_fingerprint": "fingerprint_12345",
          "nick_name": "Card",
          "card_isin": "4567890",
          "card_issuer": "Issuer Bank",
          "card_type": "Credit",
          "saved_to_locker": true
        }
      },
      "created": "2023-01-18T11:04:09.922Z",
      "requires_cvv": true,
      "last_used_at": "2024-02-24T11:04:09.922Z",
      "is_default": true,
      "billing": {
        "address": {
          "city": "New York",
          "line1": "123, King Street",
          "line2": "Powelson Avenue",
          "line3": "Bridgewater",
          "zip": "08807",
          "state": "New York",
          "first_name": "John",
          "last_name": "Doe",
          "origin_zip": "08807"
        },
        "phone": {
          "number": "9123456789",
          "country_code": "+1"
        }
      },
      "network_tokenization": {
        "payment_method_data": {
          "last4_digits": "4242",
          "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_type": "Credit",
          "par": "522134KAVJ1JPZ8L77N0Z2LRYZS7J"
        }
      },
      "connector_tokens": [
        {
          "token": "pm_9UhMqBMEOooRIvJFFdeW"
        }
      ]
    }
  ]
}