Easy Labs
APIPaymentsPayment instrument

Update a payment instrument

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

PATCH
/v1/api/payment-instruments/{id}

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

Path Parameters

id*string
Length1 <= length

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

application/json

application/json

curl -X PATCH "https://loading/v1/api/payment-instruments/string" \  -H "Content-Type: application/json" \  -d '{    "tags": {      "status": "verified"    }  }'
{
  "success": true,
  "timestamp": "2026-02-06T12:00:00.000Z",
  "message": "Payment instrument updated",
  "data": {
    "id": "PIxxxxxxxxxxxxxxxxxx",
    "identity_id": "IDxxxxxxxxxxxxxxxxxx",
    "instrument_type": "PAYMENT_CARD",
    "type": "PAYMENT_CARD",
    "updated_at": "2026-02-06T12:00:00.000Z"
  }
}
{
  "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
  }
}
{
  "success": false,
  "timestamp": "2019-08-24T14:15:22Z",
  "error": {
    "code": "string",
    "message": "string",
    "details": null
  }
}

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).

Create a payment link

Create a payment link