Get payment method

GET

customers

{id}

payment-methods

{paymentMethodId}

curl --request GET \
  --url https://api.hyperline.co/v1/customers/{id}/payment-methods/{paymentMethodId} \
  --header 'Authorization: Bearer <token>'

{
  "id": "pm_1xMpj5bwRqN7LM",
  "status": "active",
  "type": "card",
  "last_4_digits": 2718,
  "expiration_date": "2026-11",
  "brand": "visa"
}

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

string

required

paymentMethodId

string

required

Response

200 - application/json

string

required

Payment method ID.

Example:

"pm_1xMpj5bwRqN7LM"

status

enum<string>

required

Payment method status.

active: The payment method is ready to be used.
pending: The payment method is pending activation or being validated.

Available options:

active,

pending

Example:

"active"

type

enum<string>

required

Payment method type.

card: Credit or debit card
direct_debit_sepa: SEPA Direct Debit
direct_debit_ach: ACH Direct Debit with an US bank account
direct_debit_bacs: Bacs Direct Debit with an UK bank account

Available options:

card

Example:

"card"

last_4_digits

number | null

required

Last four digits of the card.

Example:

2718

expiration_date

string | null

required

Expiration date of the card using YYYY-MM format.

Example:

"2026-11"

brand

string | null

required

Brand of the card.

Example:

"visa"

string

required

Payment method ID.

Example:

"pm_1xMpj5bwRqN7LM"

status

enum<string>

required

Payment method status.

active: The payment method is ready to be used.
pending: The payment method is pending activation or being validated.

Available options:

active,

pending

Example:

"active"

type

enum<string>

required

Payment method type.

card: Credit or debit card
direct_debit_sepa: SEPA Direct Debit
direct_debit_ach: ACH Direct Debit with an US bank account
direct_debit_bacs: Bacs Direct Debit with an UK bank account

Available options:

card

Example:

"card"

last_4_digits

number | null

required

Last four digits of the card.

Example:

2718

expiration_date

string | null

required

Expiration date of the card using YYYY-MM format.

Example:

"2026-11"

brand

string | null

required

Brand of the card.

Example:

"visa"

string

required

Payment method ID.

Example:

"pm_1xMpj5bwRqN7LM"

status

enum<string>

required

Payment method status.

errored: The payment method has failed and can no longer be used.

Example:

"errored"

type

enum<string>

required

Payment method type.

card: Credit or debit card
direct_debit_sepa: SEPA Direct Debit
direct_debit_ach: ACH Direct Debit with an US bank account
direct_debit_bacs: Bacs Direct Debit with an UK bank account

Available options:

card

Example:

"card"

last_4_digits

number | null

required

Last four digits of the card.

Example:

2718

expiration_date

string | null

required

Expiration date of the card using YYYY-MM format.

Example:

"2026-11"

brand

string | null

required

Brand of the card.

Example:

"visa"

error_type

enum<string>

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.

Available options:

authentication_required,

authorization_error,

declined,

expired,

fraud,

invalid,

not_supported,

unknown

Example:

"expired"

string

required

Payment method ID.

Example:

"pm_1xMpj5bwRqN7LM"

status

enum<string>

required

Payment method status.

active: The payment method is ready to be used.
pending: The payment method is pending activation or being validated.

Available options:

active,

pending

Example:

"active"

type

enum<string>

required

Payment method type.

card: Credit or debit card
direct_debit_sepa: SEPA Direct Debit
direct_debit_ach: ACH Direct Debit with an US bank account
direct_debit_bacs: Bacs Direct Debit with an UK bank account

Example:

"direct_debit"

last_4_digits

number | null

required

Last four digits of the card.

Example:

2718

expiration_date

string | null

required

Expiration date of the card using YYYY-MM format.

Example:

"2026-11"

brand

string | null

required

Brand of the card.

Example:

"visa"

account_number_ending

string | null

required

Last characters of the account number.

Example:

"6789"

string

required

Payment method ID.

Example:

"pm_1xMpj5bwRqN7LM"

status

enum<string>

required

Payment method status.

errored: The payment method has failed and can no longer be used.

Example:

"errored"

type

enum<string>

required

Payment method type.

card: Credit or debit card
direct_debit_sepa: SEPA Direct Debit
direct_debit_ach: ACH Direct Debit with an US bank account
direct_debit_bacs: Bacs Direct Debit with an UK bank account

Example:

"direct_debit"

last_4_digits

number | null

required

Last four digits of the card.

Example:

2718

expiration_date

string | null

required

Expiration date of the card using YYYY-MM format.

Example:

"2026-11"

brand

string | null

required

Brand of the card.

Example:

"visa"

error_type

enum<string>

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.

Available options:

authentication_required,

authorization_error,

declined,

expired,

fraud,

invalid,

not_supported,

unknown

Example:

"expired"

account_number_ending

string | null

required

Last characters of the account number.

Example:

"6789"

string

required

Payment method ID.

Example:

"pm_1xMpj5bwRqN7LM"

status

enum<string>

required

Payment method status.

active: The payment method is ready to be used.
pending: The payment method is pending activation or being validated.

Example:

"active"

error_type

enum<string>

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.

Available options:

authentication_required,

authorization_error,

declined,

expired,

fraud,

invalid,

not_supported,

unknown

Example:

"expired"

type

enum<string>

required

Payment method type.

card: Credit or debit card
direct_debit_sepa: SEPA Direct Debit
direct_debit_ach: ACH Direct Debit with an US bank account
direct_debit_bacs: Bacs Direct Debit with an UK bank account

Available options:

card

Example:

"card"

last_4_digits

number | null

required

Last four digits of the card.

Example:

2718

expiration_date

string | null

required

Expiration date of the card using YYYY-MM format.

Example:

"2026-11"

brand

string | null

required

Brand of the card.

Example:

"visa"

string

required

Payment method ID.

Example:

"pm_1xMpj5bwRqN7LM"

status

enum<string>

required

Payment method status.

errored: The payment method has failed and can no longer be used.

Available options:

errored

Example:

"errored"

error_type

enum<string>

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.

Available options:

authentication_required,

authorization_error,

declined,

expired,

fraud,

invalid,

not_supported,

unknown

Example:

"expired"

type

enum<string>

required

Payment method type.

card: Credit or debit card
direct_debit_sepa: SEPA Direct Debit
direct_debit_ach: ACH Direct Debit with an US bank account
direct_debit_bacs: Bacs Direct Debit with an UK bank account

Available options:

card

Example:

"card"

last_4_digits

number | null

required

Last four digits of the card.

Example:

2718

expiration_date

string | null

required

Expiration date of the card using YYYY-MM format.

Example:

"2026-11"

brand

string | null

required

Brand of the card.

Example:

"visa"

string

required

Payment method ID.

Example:

"pm_1xMpj5bwRqN7LM"

status

enum<string>

required

Payment method status.

active: The payment method is ready to be used.
pending: The payment method is pending activation or being validated.

Example:

"active"

error_type

enum<string>

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.

Available options:

authentication_required,

authorization_error,

declined,

expired,

fraud,

invalid,

not_supported,

unknown

Example:

"expired"

type

enum<string>

required

Payment method type.

card: Credit or debit card
direct_debit_sepa: SEPA Direct Debit
direct_debit_ach: ACH Direct Debit with an US bank account
direct_debit_bacs: Bacs Direct Debit with an UK bank account

Example:

"direct_debit"

last_4_digits

number | null

required

Last four digits of the card.

Example:

2718

expiration_date

string | null

required

Expiration date of the card using YYYY-MM format.

Example:

"2026-11"

brand

string | null

required

Brand of the card.

Example:

"visa"

account_number_ending

string | null

required

Last characters of the account number.

Example:

"6789"

string

required

Payment method ID.

Example:

"pm_1xMpj5bwRqN7LM"

status

enum<string>

required

Payment method status.

errored: The payment method has failed and can no longer be used.

Available options:

errored

Example:

"errored"

error_type

enum<string>

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.

Available options:

authentication_required,

authorization_error,

declined,

expired,

fraud,

invalid,

not_supported,

unknown

Example:

"expired"

type

enum<string>

required

Payment method type.

card: Credit or debit card
direct_debit_sepa: SEPA Direct Debit
direct_debit_ach: ACH Direct Debit with an US bank account
direct_debit_bacs: Bacs Direct Debit with an UK bank account

Example:

"direct_debit"

last_4_digits

number | null

required

Last four digits of the card.

Example:

2718

expiration_date

string | null

required

Expiration date of the card using YYYY-MM format.

Example:

"2026-11"

brand

string | null

required

Brand of the card.

Example:

"visa"

account_number_ending

string | null

required

Last characters of the account number.

Example:

"6789"

string

required

Payment method ID.

Example:

"pm_1xMpj5bwRqN7LM"

status

enum<string>

required

Payment method status.

active: The payment method is ready to be used.
pending: The payment method is pending activation or being validated.

Available options:

active,

pending

Example:

"active"

type

enum<string>

required

Payment method type.

card: Credit or debit card
direct_debit_sepa: SEPA Direct Debit
direct_debit_ach: ACH Direct Debit with an US bank account
direct_debit_bacs: Bacs Direct Debit with an UK bank account

Example:

"card"

account_number_ending

string | null

required

Last characters of the account number.

Example:

"6789"

last_4_digits

number | null

required

Last four digits of the card.

Example:

2718

expiration_date

string | null

required

Expiration date of the card using YYYY-MM format.

Example:

"2026-11"

brand

string | null

required

Brand of the card.

Example:

"visa"

string

required

Payment method ID.

Example:

"pm_1xMpj5bwRqN7LM"

status

enum<string>

required

Payment method status.

errored: The payment method has failed and can no longer be used.

Example:

"errored"

type

enum<string>

required

Payment method type.

card: Credit or debit card
direct_debit_sepa: SEPA Direct Debit
direct_debit_ach: ACH Direct Debit with an US bank account
direct_debit_bacs: Bacs Direct Debit with an UK bank account

Example:

"card"

account_number_ending

string | null

required

Last characters of the account number.

Example:

"6789"

error_type

enum<string>

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.

Available options:

authentication_required,

authorization_error,

declined,

expired,

fraud,

invalid,

not_supported,

unknown

Example:

"expired"

last_4_digits

number | null

required

Last four digits of the card.

Example:

2718

expiration_date

string | null

required

Expiration date of the card using YYYY-MM format.

Example:

"2026-11"

brand

string | null

required

Brand of the card.

Example:

"visa"

string

required

Payment method ID.

Example:

"pm_1xMpj5bwRqN7LM"

status

enum<string>

required

Payment method status.

active: The payment method is ready to be used.
pending: The payment method is pending activation or being validated.

Available options:

active,

pending

Example:

"active"

type

enum<string>

required

Payment method type.

card: Credit or debit card
direct_debit_sepa: SEPA Direct Debit
direct_debit_ach: ACH Direct Debit with an US bank account
direct_debit_bacs: Bacs Direct Debit with an UK bank account

Available options:

direct_debit,

direct_debit_ach,

direct_debit_bacs

Example:

"direct_debit"

account_number_ending

string | null

required

Last characters of the account number.

Example:

"6789"

string

required

Payment method ID.

Example:

"pm_1xMpj5bwRqN7LM"

status

enum<string>

required

Payment method status.

errored: The payment method has failed and can no longer be used.

Example:

"errored"

type

enum<string>

required

Payment method type.

card: Credit or debit card
direct_debit_sepa: SEPA Direct Debit
direct_debit_ach: ACH Direct Debit with an US bank account
direct_debit_bacs: Bacs Direct Debit with an UK bank account

Available options:

direct_debit,

direct_debit_ach,

direct_debit_bacs

Example:

"direct_debit"

account_number_ending

string | null

required

Last characters of the account number.

Example:

"6789"

error_type

enum<string>

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.

Available options:

authentication_required,

authorization_error,

declined,

expired,

fraud,

invalid,

not_supported,

unknown

Example:

"expired"

string

required

Payment method ID.

Example:

"pm_1xMpj5bwRqN7LM"

status

enum<string>

required

Payment method status.

active: The payment method is ready to be used.
pending: The payment method is pending activation or being validated.

Example:

"active"

error_type

enum<string>

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.

Available options:

authentication_required,

authorization_error,

declined,

expired,

fraud,

invalid,

not_supported,

unknown

Example:

"expired"

type

enum<string>

required

Payment method type.

card: Credit or debit card
direct_debit_sepa: SEPA Direct Debit
direct_debit_ach: ACH Direct Debit with an US bank account
direct_debit_bacs: Bacs Direct Debit with an UK bank account

Example:

"card"

account_number_ending

string | null

required

Last characters of the account number.

Example:

"6789"

last_4_digits

number | null

required

Last four digits of the card.

Example:

2718

expiration_date

string | null

required

Expiration date of the card using YYYY-MM format.

Example:

"2026-11"

brand

string | null

required

Brand of the card.

Example:

"visa"

string

required

Payment method ID.

Example:

"pm_1xMpj5bwRqN7LM"

status

enum<string>

required

Payment method status.

errored: The payment method has failed and can no longer be used.

Available options:

errored

Example:

"errored"

error_type

enum<string>

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.

Available options:

authentication_required,

authorization_error,

declined,

expired,

fraud,

invalid,

not_supported,

unknown

Example:

"expired"

type

enum<string>

required

Payment method type.

card: Credit or debit card
direct_debit_sepa: SEPA Direct Debit
direct_debit_ach: ACH Direct Debit with an US bank account
direct_debit_bacs: Bacs Direct Debit with an UK bank account

Example:

"card"

account_number_ending

string | null

required

Last characters of the account number.

Example:

"6789"

last_4_digits

number | null

required

Last four digits of the card.

Example:

2718

expiration_date

string | null

required

Expiration date of the card using YYYY-MM format.

Example:

"2026-11"

brand

string | null

required

Brand of the card.

Example:

"visa"

string

required

Payment method ID.

Example:

"pm_1xMpj5bwRqN7LM"

status

enum<string>

required

Payment method status.

active: The payment method is ready to be used.
pending: The payment method is pending activation or being validated.

Example:

"active"

error_type

enum<string>

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.

Available options:

authentication_required,

authorization_error,

declined,

expired,

fraud,

invalid,

not_supported,

unknown

Example:

"expired"

type

enum<string>

required

Payment method type.

card: Credit or debit card
direct_debit_sepa: SEPA Direct Debit
direct_debit_ach: ACH Direct Debit with an US bank account
direct_debit_bacs: Bacs Direct Debit with an UK bank account

Available options:

direct_debit,

direct_debit_ach,

direct_debit_bacs

Example:

"direct_debit"

account_number_ending

string | null

required

Last characters of the account number.

Example:

"6789"

string

required

Payment method ID.

Example:

"pm_1xMpj5bwRqN7LM"

status

enum<string>

required

Payment method status.

errored: The payment method has failed and can no longer be used.

Available options:

errored

Example:

"errored"

error_type

enum<string>

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.

Available options:

authentication_required,

authorization_error,

declined,

expired,

fraud,

invalid,

not_supported,

unknown

Example:

"expired"

type

enum<string>

required

Payment method type.

card: Credit or debit card
direct_debit_sepa: SEPA Direct Debit
direct_debit_ach: ACH Direct Debit with an US bank account
direct_debit_bacs: Bacs Direct Debit with an UK bank account

Available options:

direct_debit,

direct_debit_ach,

direct_debit_bacs

Example:

"direct_debit"

account_number_ending

string | null

required

Last characters of the account number.

Example:

"6789"

Was this page helpful?

curl --request GET \
  --url https://api.hyperline.co/v1/customers/{id}/payment-methods/{paymentMethodId} \
  --header 'Authorization: Bearer <token>'

{
  "id": "pm_1xMpj5bwRqN7LM",
  "status": "active",
  "type": "card",
  "last_4_digits": 2718,
  "expiration_date": "2026-11",
  "brand": "visa"
}

API documentation

Integrations

Analytics

Billable events

Companies

Coupons

Custom properties

Customers

Customers > Credits

Customers > Payment methods

Integrations

Invoices

Invoices > Transactions

Invoicing entities

OAuth2

Organisations

Payments

Plans

Price configurations

Products

Quotes

Subscriptions

Taxes

Third-party apps

Wallets

Webhooks

Get payment method

Authorizations

Path Parameters

Response