Easy Labs
APIPaymentsPayment instrument

List payment instruments

List payment instruments scoped to the authenticated company. Optional filters: `identity_id` (single id), `type` (PAYMENT_CARD/BANK_ACCOUNT), `role` (filters via the joined identity's `identity_roles`; values match the `finix_identity_role` DB enum). `include=identity` expands the joined identity row (default: only `company_id` is returned). Reads from the local Finix mirror (no PAN data exposed).

GET
/v1/api/payment-instruments/

Authorization

apiKey
x-easy-api-key<token>

Merchant API key. Publishable keys (pk_test_* / pk_live_) are safe for browser/frontend use and carry a limited scope set (sessions, payment_instruments, customers, orders writes; products, product_prices, payment_links reads). Secret keys (sk_test_ / sk_live_*) grant full admin access and must only be used server-side.

In: header

Query Parameters

limit?integer
Range1 <= value <= 100
offset?integer
Range0 <= value
identity_id?string
Length1 <= length
type?string
Value in"PAYMENT_CARD" | "BANK_ACCOUNT"
role?string
Value in"APPLICATION_OWNER" | "BENEFICIAL_OWNER" | "BUYER" | "PLATFORM_OWNER" | "RECIPIENT" | "SELLER" | "SENDER"
include?string
Value in"identity"

Response Body

application/json

application/json

application/json

curl -X GET "https://loading/v1/api/payment-instruments/"
{
  "success": true,
  "timestamp": "2019-08-24T14:15:22Z",
  "data": null,
  "message": "string"
}
{
  "success": false,
  "timestamp": "2019-08-24T14:15:22Z",
  "error": {
    "code": "string",
    "message": "string",
    "details": null
  }
}
{
  "success": false,
  "timestamp": "2019-08-24T14:15:22Z",
  "error": {
    "code": "string",
    "message": "string",
    "details": null
  }
}

Get a payment instrument by ID

Retrieve a single payment instrument's metadata. Scoped to the authenticated company via the identity → company_id chain. `include=identity` expands the joined identity row (default returns only `company_id` from the join).

Update a payment instrument

Update editable fields (tags, address, etc.) on a payment instrument.