{
  "id": "pmt_inst_pd788hPVhLT37",
  "account_id": "acc_GAzrD99cUqGEN",
  "type": "card",
  "card": {
    "number": "5555555555551580",
    "exp_month": "04",
    "exp_year": "2027"
  },
  "network_token": null,
  "chargeable": true,
  "status": "completed",
  "error": null,
  "created_at": "2025-04-03T19:30:56.039Z",
  "updated_at": "2025-04-03T19:30:56.039Z"
}

The PaymentInstrument endpoint allows the creation and retrieval of card credentials that can be used for checkout, such as card account details or a network token.

The PaymentInstrument endpoint is available as a:

TypeUse-Case
ProductOn-Demand view of an Account’s payment instruments.

​
Payment Instrument Objects

​
id
string

Unique identifier for the PaymentInstrument.

​
account_id
string

The ID of the associated Account.

​
type
enum
required

The type of PaymentInstrument.

​
card
object

Details of the PaymentInstrument. Present when type is card, null otherwise.

​
network_token
object

Details of the PaymentInstrument. Present when type is network_token, null otherwise.

​
chargeable
boolean
required

Whether the PaymentInstrument can be charged.

​
status
enum

Status of the PaymentInstrument.

​
error
object | null

An object representing an error that occurred while processing this PaymentInstrument. See PaymentInstrument errors.

​
created_at
string

Timestamp of when the PaymentInstrument was created.

​
updated_at
string

Timestamp of when the PaymentInstrument was last updated.

{
  "id": "pmt_inst_pd788hPVhLT37",
  "account_id": "acc_GAzrD99cUqGEN",
  "type": "card",
  "card": {
    "number": "5555555555551580",
    "exp_month": "04",
    "exp_year": "2027"
  },
  "network_token": null,
  "chargeable": true,
  "status": "completed",
  "error": null,
  "created_at": "2025-04-03T19:30:56.039Z",
  "updated_at": "2025-04-03T19:30:56.039Z"
}