Skip to main content
GET
Retrieve a payment method

Authorizations

Authorization
string
header
required

Basic HTTP authentication. Allowed headers-- Authorization: Basic <base64(api_key_id:api_key_secret)>

Path Parameters

payment_method_id
string
required

The unique identifier of the payment method

Example:

"9ED4FE47-8E9C-48E9-BBEF-094DF1789012"

Response

Payment method retrieved successfully

id
string
required

The unique ID Imprint assigns to the payment method.

Example:

"DCBFC736-2286-42DD-897D-160DCA80AED2"

type
enum<string>
required

The type of payment method

Available options:
CARD,
BANK_ACCOUNT,
LOAN
customer_id
string
required

The id of the Imprint customer that the payment method belongs to.

Example:

"B40A789E-BD46-4BB9-B63E-F9919582694C"

created_at
string
required

the RFC-3339 timestamp when the payment method was created

Example:

"2025-02-13T19:08:07.000Z"

status
enum<string>
required

Current status of the payment method

Available options:
ACTIVE,
INACTIVE,
CANCELED
metadata
object
required

Additional metadata for the payment method

Example:
card
object

When payment method is a CARD type, this object will have card specific data.

bank_account
object

When payment method is a BANK_ACCOUNT type, this object will have bank account specific data.

loan
object

When payment method is a LOAN type, this object will have loan specific data.

updated_at
string

the RFC-3339 timestamp when the payment method was last updated

Example:

"2025-02-13T19:08:07.000Z"