---
title: "Update payment instrument details"
method: PATCH
path: "/accounts/entities/{entityId}/payment-instruments/{id}"
tags: ["Payment instruments"]
---

# Update payment instrument details

`PATCH /accounts/entities/{entityId}/payment-instruments/{id}`

## Request

- Base URL: `https://{prefix}.api.sandbox.checkout.com`
- URL: `https://{prefix}.api.sandbox.checkout.com/accounts/entities/{entityId}/payment-instruments/{id}`
- Auth: one of:
  - OAuth 2
    - Client credentials
    - Token URL: `string` scopes: `accounts`
  - API key in header `Authorization`
- TypeScript: <https://skmtc.dev/checkout/apis/checkout-com-api-reference/docs/accounts/entities/:entityId/payment-instruments/:id/patch.ts> (a function with typed inputs; its response is checked against the schema)

Set an existing payment instrument as default. This will make it the destination instrument when a scheduled payout is made. You can also update the label of a payment instrument.

## Request body

- PlatformsPaymentInstrumentUpdate
  - `label` string: A reference that you can use to identify the payment instrument.
  - `default` boolean: For ad-hoc payouts, the payment instrument is explicitly specified in the payout request. For scheduled payouts, the first payment instrument created for a given currency will be used for that currency's payout schedule. To change the payment instrument associated with a payout schedule, update the payout schedule. (Deprecated) Specifies whether the payment instrument should be set as the default payout destination.
  - `headers` object
    - `if-match` string, required: The payment instrument ETag value

## Response `200`

Payment instrument updated successfully

- object
  - `_links` unknown
  - `id` string

## Other responses

- `401`: Unauthorized
- `422`: Unprocessable entity
- `428`: Precondition required

---

[API](https://skmtc.dev/checkout/apis/checkout-com-api-reference.md) - [All operations](https://skmtc.dev/checkout/apis/checkout-com-api-reference/llms.txt) - [OpenAPI document](https://skmtc.dev/checkout/apis/checkout-com-api-reference/revisions/0f1abdb1c3e9?raw)