---
title: "Get payment method"
method: GET
path: "/v1/customers/{id}/payment-methods/{paymentMethodId}"
tags: ["Customers > Payment methods"]
---

# Get payment method

`GET /v1/customers/{id}/payment-methods/{paymentMethodId}`

Retrieve the details of an existing customer payment method.

## Path parameters

- `id` string, required
- `paymentMethodId` string, required

## Response `200`

- union
  - object
    - `id` string, required — Payment method ID.
    - `status` 'active' | 'pending' | 'expired' | 'errored', required — Payment method status. - `active`: The payment method is ready to be used. - `pending`: The payment method is pending activation or being validated.
    - `type` 'card' | 'apple_pay' | 'google_pay', required — Payment method type. - `card`: Credit or debit card - `apple_pay`: Apple Pay - `google_pay`: Google Pay - `direct_debit_sepa`: SEPA Direct Debit - `direct_debit_ach`: ACH Direct Debit - `direct_debit_bacs`: Bacs Direct Debit - `stripe_link`: Stripe Link
    - `last_4_digits` number, nullable, required — Last four digits of the card.
    - `expiration_date` string, nullable, required — Expiration date of the card using YYYY-MM format.
    - `brand` string, nullable, required — Brand of the card.
    - `integration` object, nullable, required — Reference to the entity in an external provider.
      - `entity_id` string, required — ID of the entity in the provider.
      - `provider_name` 'adyen' | 'stripe' | 'mollie' | 'gocardless' | 'airwallex' | 'salesforce' | 'hubspot' | 'attio' | 'xero' | 'pennylane' | 'zoho-books' | 'exact-online' | 'quickbooks' | 'netsuite' | 'anrok' | 'chargebee' | 'slack' | 'plain' | 'zendesk' | 'pylon' | 'intercom' | 'front' | 'claap' | 'grain', required — Provider name.
      - `provider_account_id` string, required — ID of the connected provider account.
  - object
    - `id` string, required — Payment method ID.
    - `status` 'errored', required — Payment method status. - `errored`: The payment method has failed and can no longer be used.
    - `error_type` 'authentication_required' | 'authorization_error' | 'insufficient_funds' | 'declined' | 'expired' | 'fraud' | 'invalid' | 'mandate_invalid' | 'not_supported' | 'unknown', required — Payment method error type. - `authentication_required`: The card was declined as the transaction requires authentication (e.g. 3-D Secure). The customer should go to their portal page and authenticate their card. If the error happened on an already authenticated transaction, the customer needs to contact their card issuer for more information. - `authorization_error`: A transaction authorization cannot be created for a variety of reasons such as the card issuer couldn't be reached, or the card requires a PIN. - `declined`: The payment method was declined for a variety of reasons such as a card reported as lost or stolen, insufficient funds or reaching the limit available on the method to complete the purchase, a payment method on a known block list, etc. - `expired`: The payment method is expired. The customer should go to their portal page and change their payment method. - `fraud`: The payment provider suspected the payment method was fraudulent and has been blocked. Don't report more detailed information to your customer, and check on your provider account. - `invalid`: The payment method is invalid in most cases because of incorrect details (card/account number, CVC, expiration date, postal code). - `not_supported`: The payment method doesn't support this type of purchase (e.g. currency, online payment). - `unknown`: A generic error happened on the payment provider side.
    - `type` 'card' | 'apple_pay' | 'google_pay', required — Payment method type. - `card`: Credit or debit card - `apple_pay`: Apple Pay - `google_pay`: Google Pay - `direct_debit_sepa`: SEPA Direct Debit - `direct_debit_ach`: ACH Direct Debit - `direct_debit_bacs`: Bacs Direct Debit - `stripe_link`: Stripe Link
    - `last_4_digits` number, nullable, required — Last four digits of the card.
    - `expiration_date` string, nullable, required — Expiration date of the card using YYYY-MM format.
    - `brand` string, nullable, required — Brand of the card.
    - `integration` object, nullable, required — Reference to the entity in an external provider.
      - `entity_id` string, required — ID of the entity in the provider.
      - `provider_name` 'adyen' | 'stripe' | 'mollie' | 'gocardless' | 'airwallex' | 'salesforce' | 'hubspot' | 'attio' | 'xero' | 'pennylane' | 'zoho-books' | 'exact-online' | 'quickbooks' | 'netsuite' | 'anrok' | 'chargebee' | 'slack' | 'plain' | 'zendesk' | 'pylon' | 'intercom' | 'front' | 'claap' | 'grain', required — Provider name.
      - `provider_account_id` string, required — ID of the connected provider account.
  - object
    - `id` string, required — Payment method ID.
    - `status` 'active' | 'pending' | 'expired' | 'errored', required — Payment method status. - `active`: The payment method is ready to be used. - `pending`: The payment method is pending activation or being validated.
    - `type` 'direct_debit' | 'direct_debit_ach' | 'direct_debit_bacs', required — Payment method type. - `card`: Credit or debit card - `apple_pay`: Apple Pay - `google_pay`: Google Pay - `direct_debit_sepa`: SEPA Direct Debit - `direct_debit_ach`: ACH Direct Debit - `direct_debit_bacs`: Bacs Direct Debit - `stripe_link`: Stripe Link
    - `account_number_ending` string, nullable, required — Last characters of the account number.
    - `integration` object, nullable, required — Reference to the entity in an external provider.
      - `entity_id` string, required — ID of the entity in the provider.
      - `provider_name` 'adyen' | 'stripe' | 'mollie' | 'gocardless' | 'airwallex' | 'salesforce' | 'hubspot' | 'attio' | 'xero' | 'pennylane' | 'zoho-books' | 'exact-online' | 'quickbooks' | 'netsuite' | 'anrok' | 'chargebee' | 'slack' | 'plain' | 'zendesk' | 'pylon' | 'intercom' | 'front' | 'claap' | 'grain', required — Provider name.
      - `provider_account_id` string, required — ID of the connected provider account.
  - object
    - `id` string, required — Payment method ID.
    - `status` 'errored', required — Payment method status. - `errored`: The payment method has failed and can no longer be used.
    - `error_type` 'authentication_required' | 'authorization_error' | 'insufficient_funds' | 'declined' | 'expired' | 'fraud' | 'invalid' | 'mandate_invalid' | 'not_supported' | 'unknown', required — Payment method error type. - `authentication_required`: The card was declined as the transaction requires authentication (e.g. 3-D Secure). The customer should go to their portal page and authenticate their card. If the error happened on an already authenticated transaction, the customer needs to contact their card issuer for more information. - `authorization_error`: A transaction authorization cannot be created for a variety of reasons such as the card issuer couldn't be reached, or the card requires a PIN. - `declined`: The payment method was declined for a variety of reasons such as a card reported as lost or stolen, insufficient funds or reaching the limit available on the method to complete the purchase, a payment method on a known block list, etc. - `expired`: The payment method is expired. The customer should go to their portal page and change their payment method. - `fraud`: The payment provider suspected the payment method was fraudulent and has been blocked. Don't report more detailed information to your customer, and check on your provider account. - `invalid`: The payment method is invalid in most cases because of incorrect details (card/account number, CVC, expiration date, postal code). - `not_supported`: The payment method doesn't support this type of purchase (e.g. currency, online payment). - `unknown`: A generic error happened on the payment provider side.
    - `type` 'direct_debit' | 'direct_debit_ach' | 'direct_debit_bacs', required — Payment method type. - `card`: Credit or debit card - `apple_pay`: Apple Pay - `google_pay`: Google Pay - `direct_debit_sepa`: SEPA Direct Debit - `direct_debit_ach`: ACH Direct Debit - `direct_debit_bacs`: Bacs Direct Debit - `stripe_link`: Stripe Link
    - `account_number_ending` string, nullable, required — Last characters of the account number.
    - `integration` object, nullable, required — Reference to the entity in an external provider.
      - `entity_id` string, required — ID of the entity in the provider.
      - `provider_name` 'adyen' | 'stripe' | 'mollie' | 'gocardless' | 'airwallex' | 'salesforce' | 'hubspot' | 'attio' | 'xero' | 'pennylane' | 'zoho-books' | 'exact-online' | 'quickbooks' | 'netsuite' | 'anrok' | 'chargebee' | 'slack' | 'plain' | 'zendesk' | 'pylon' | 'intercom' | 'front' | 'claap' | 'grain', required — Provider name.
      - `provider_account_id` string, required — ID of the connected provider account.
  - object
    - `id` string, required — Payment method ID.
    - `status` 'active' | 'pending' | 'expired' | 'errored', required — Payment method status. - `active`: The payment method is ready to be used. - `pending`: The payment method is pending activation or being validated.
    - `type` 'stripe_link', required — Payment method type. - `card`: Credit or debit card - `apple_pay`: Apple Pay - `google_pay`: Google Pay - `direct_debit_sepa`: SEPA Direct Debit - `direct_debit_ach`: ACH Direct Debit - `direct_debit_bacs`: Bacs Direct Debit - `stripe_link`: Stripe Link
    - `integration` object, nullable, required — Reference to the entity in an external provider.
      - `entity_id` string, required — ID of the entity in the provider.
      - `provider_name` 'adyen' | 'stripe' | 'mollie' | 'gocardless' | 'airwallex' | 'salesforce' | 'hubspot' | 'attio' | 'xero' | 'pennylane' | 'zoho-books' | 'exact-online' | 'quickbooks' | 'netsuite' | 'anrok' | 'chargebee' | 'slack' | 'plain' | 'zendesk' | 'pylon' | 'intercom' | 'front' | 'claap' | 'grain', required — Provider name.
      - `provider_account_id` string, required — ID of the connected provider account.
  - object
    - `id` string, required — Payment method ID.
    - `status` 'errored', required — Payment method status. - `errored`: The payment method has failed and can no longer be used.
    - `error_type` 'authentication_required' | 'authorization_error' | 'insufficient_funds' | 'declined' | 'expired' | 'fraud' | 'invalid' | 'mandate_invalid' | 'not_supported' | 'unknown', required — Payment method error type. - `authentication_required`: The card was declined as the transaction requires authentication (e.g. 3-D Secure). The customer should go to their portal page and authenticate their card. If the error happened on an already authenticated transaction, the customer needs to contact their card issuer for more information. - `authorization_error`: A transaction authorization cannot be created for a variety of reasons such as the card issuer couldn't be reached, or the card requires a PIN. - `declined`: The payment method was declined for a variety of reasons such as a card reported as lost or stolen, insufficient funds or reaching the limit available on the method to complete the purchase, a payment method on a known block list, etc. - `expired`: The payment method is expired. The customer should go to their portal page and change their payment method. - `fraud`: The payment provider suspected the payment method was fraudulent and has been blocked. Don't report more detailed information to your customer, and check on your provider account. - `invalid`: The payment method is invalid in most cases because of incorrect details (card/account number, CVC, expiration date, postal code). - `not_supported`: The payment method doesn't support this type of purchase (e.g. currency, online payment). - `unknown`: A generic error happened on the payment provider side.
    - `type` 'stripe_link', required — Payment method type. - `card`: Credit or debit card - `apple_pay`: Apple Pay - `google_pay`: Google Pay - `direct_debit_sepa`: SEPA Direct Debit - `direct_debit_ach`: ACH Direct Debit - `direct_debit_bacs`: Bacs Direct Debit - `stripe_link`: Stripe Link
    - `integration` object, nullable, required — Reference to the entity in an external provider.
      - `entity_id` string, required — ID of the entity in the provider.
      - `provider_name` 'adyen' | 'stripe' | 'mollie' | 'gocardless' | 'airwallex' | 'salesforce' | 'hubspot' | 'attio' | 'xero' | 'pennylane' | 'zoho-books' | 'exact-online' | 'quickbooks' | 'netsuite' | 'anrok' | 'chargebee' | 'slack' | 'plain' | 'zendesk' | 'pylon' | 'intercom' | 'front' | 'claap' | 'grain', required — Provider name.
      - `provider_account_id` string, required — ID of the connected provider account.

---

[API](https://skmtc.dev/hyperline/apis/hyperline-api.md) · [All operations](https://skmtc.dev/hyperline/apis/hyperline-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/hyperline/hyperline-api/revisions/19fa5f22e39b/schema)