List customer's payment methods

curl --request GET \
  --url https://dev.sbx.imprint.co/v2/customers/{customer_id}/payment_methods \
  --header 'Authorization: Bearer <token>'

{
  "data": [
    {
      "id": "DCBFC736-2286-42DD-897D-160DCA80AED2",
      "type": "CARD",
      "customer_id": "B40A789E-BD46-4BB9-B63E-F9919582694C",
      "created_at": "2025-02-13T19:08:07.000Z",
      "status": "ACTIVE",
      "metadata": {
        "platform_version": "2.1.0"
      },
      "card": {
        "last4": "1234",
        "network": "VISA",
        "card_type": "PHYSICAL",
        "card_design_id": "3b9c1f3e-52a0-44c1-b131-a7ab0099a214",
        "pci_details": {
          "pan": "5105105105105100",
          "exp_month": "06",
          "exp_year": "26",
          "cvv": "123"
        },
        "tokens": [
          {
            "type": "ADYEN",
            "token": "<string>",
            "created_at": "2025-02-13T19:08:07.000Z",
            "updated_at": "2025-02-13T19:08:07.000Z",
            "pan_reference_id": "<string>"
          }
        ]
      },
      "bank_account": {
        "last4": "1234",
        "routing_number": "<string>",
        "bank_name": "Wells Fargo",
        "account_type": "CHECKING"
      },
      "loan": {
        "amount": 10000,
        "term_months": 12,
        "currency": "USD",
        "remaining_balance": 123,
        "apr": "5.89",
        "loan_status": "PENDING"
      },
      "updated_at": "2025-02-13T19:08:07.000Z"
    }
  ]
}

GET

customers

{customer_id}

payment_methods

List customer's payment methods

curl --request GET \
  --url https://dev.sbx.imprint.co/v2/customers/{customer_id}/payment_methods \
  --header 'Authorization: Bearer <token>'

{
  "data": [
    {
      "id": "DCBFC736-2286-42DD-897D-160DCA80AED2",
      "type": "CARD",
      "customer_id": "B40A789E-BD46-4BB9-B63E-F9919582694C",
      "created_at": "2025-02-13T19:08:07.000Z",
      "status": "ACTIVE",
      "metadata": {
        "platform_version": "2.1.0"
      },
      "card": {
        "last4": "1234",
        "network": "VISA",
        "card_type": "PHYSICAL",
        "card_design_id": "3b9c1f3e-52a0-44c1-b131-a7ab0099a214",
        "pci_details": {
          "pan": "5105105105105100",
          "exp_month": "06",
          "exp_year": "26",
          "cvv": "123"
        },
        "tokens": [
          {
            "type": "ADYEN",
            "token": "<string>",
            "created_at": "2025-02-13T19:08:07.000Z",
            "updated_at": "2025-02-13T19:08:07.000Z",
            "pan_reference_id": "<string>"
          }
        ]
      },
      "bank_account": {
        "last4": "1234",
        "routing_number": "<string>",
        "bank_name": "Wells Fargo",
        "account_type": "CHECKING"
      },
      "loan": {
        "amount": 10000,
        "term_months": 12,
        "currency": "USD",
        "remaining_balance": 123,
        "apr": "5.89",
        "loan_status": "PENDING"
      },
      "updated_at": "2025-02-13T19:08:07.000Z"
    }
  ]
}

Authorizations

Authorization

string

header

required

Bearer HTTP authentication. Allowed headers-- Authorization: Bearer <api_key>

Path Parameters

customer_id

string

required

The unique identifier for the Imprint customer

Example:

"2EE24580-B97B-4949-A65C-929CCB9B9B8D"

Response

Customer rewards balance

data

object[]

Show child attributes

data.id

string

required

The unique ID Imprint assigns to the payment method.

Example:

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

data.type

enum<string>

required

The type of payment method

Available options:

CARD,

BANK_ACCOUNT,

LOAN

data.customer_id

string

required

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

Example:

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

data.created_at

string

required

the RFC-3339 timestamp when the payment method was created

Example:

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

data.status

enum<string>

required

Current status of the payment method

Available options:

ACTIVE,

INACTIVE,

CANCELED

data.metadata

object

required

Additional metadata for the payment method

Example:

{ "platform_version": "2.1.0" }

data.card

object

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

Show child attributes

data.card.last4

string

required

The last 4 digits of the card PAN

Required string length: 4

Example:

"1234"

data.card.network

enum<string>

Name of the card issuer

Available options:

VISA,

MASTERCARD,

AMEX,

data.card.card_type

enum<string>

The type of card

Available options:

PHYSICAL,

VIRTUAL

data.card.card_design_id

string

Imprint ID for the graphic design printed on the card

Example:

"3b9c1f3e-52a0-44c1-b131-a7ab0099a214"

data.card.pci_details

object

The pci details of the returned card. Only verified PCI compliant partners will be able to retrieve pci details in production environments.

Show child attributes

data.card.pci_details.pan

string

The unique 16-digit number printed on the front of a payment card, used to identify the cardholder's account.

Example:

"5105105105105100"

data.card.pci_details.exp_month

string

The month the card expires

Example:

"06"

data.card.pci_details.exp_year

string

The year the card expires

Example:

"26"

data.card.pci_details.cvv

string

A three- or four-digit security code used to verify card-not-present transactions and prevent fraud.

Example:

"123"

data.card.tokens

object[]

Payment method tokens that are defined by a third-party provider are included in this array by Imprint.

Show child attributes

data.card.tokens.type

enum<string>

required

Available options:

ADYEN,

APPLE_WALLET

data.card.tokens.token

string

required

The token, as defined by the processor

data.card.tokens.created_at

string

required

the RFC-3339 timestamp when the payment method was created

Example:

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

data.card.tokens.updated_at

string

required

the RFC-3339 timestamp when the payment method was updated

Example:

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

data.card.tokens.pan_reference_id

string

An ID that represents the PAN and is defined by the processor

data.bank_account

object

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

Show child attributes

data.bank_account.last4

string

required

Last 4 numbers of the account.

Required string length: 4

Example:

"1234"

data.bank_account.routing_number

string

required

The bank routing number assigned to this account.

data.bank_account.bank_name

string

required

Name of the banking institution

Example:

"Wells Fargo"

data.bank_account.account_type

enum<string>

Type of the account.

Available options:

CHECKING,

SAVINGS

data.loan

object

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

Show child attributes

data.loan.amount

integer

required

Amount in min units.

Example:

10000

data.loan.term_months

integer

required

Length of the loan term in months

Example:

12

data.loan.currency

string

The 3-character currency code of the amount in ISO 4217 format (e.g., "USD")

Example:

"USD"

data.loan.remaining_balance

integer

remaining unspent balance on the loan

data.loan.apr

string

Annual percentage rate of the loan in floating point

Example:

"5.89"

data.loan.loan_status

enum<string>

Current status of the loan

Available options:

PENDING,

APPROVED,

REJECTED,

ACTIVE,

CLOSED

data.updated_at

string

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

Example:

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

Get customer's current rewards balance List customer's transaction intents

⌘I

Basics

API Reference

List customer's payment methods

Authorizations

Path Parameters

Response