CHcheckout
Payment instruments

Update payment instrument details

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.

patch/accounts/entities/{entityId}/payment-instruments/{id}

Request

Request body

labelstring

A reference that you can use to identify the payment instrument.

defaultboolean

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.

Example request

{
  "label": "Peter's Personal Account",
  "headers": {
    "if-match": "Y3Y9MCZydj0w"
  }
}

Response

Payment instrument updated successfully

_linksunknown
idstring

Example response

{
  "_links": {
    "self": {
      "href": "https://{prefix}.api.checkout.com/accounts/entities/ent_wxglze3wwywujg4nna5fb7ldli"
    }
  },
  "id": "ppi_qn4nis4k3ykpzzu7cvtuvhqqga"
}

Changes

No recorded changes to this operation across all 1 revision of this API.