CHcheckout
Instruments

Update an instrument

Update the details of a payment instrument.

To replace the metadata stored with a card or bank account payment instrument, provide the full metadata object. You can send a request that only contains metadata, without changing any card or bank account details.

patch/instruments/{id}

Request

Path parameters

idstring required

The instrument ID

Request body

OR
OR
OR
OR

Example request

{
  "expiry_month": 6,
  "expiry_year": 2025,
  "name": "Mr. J Smith",
  "account_holder": {
    "first_name": "John",
    "last_name": "Smith",
    "billing_address": {
      "address_line1": "123 High St.",
      "address_line2": "Flat 456",
      "city": "London",
      "zip": "SW1A 1AA",
      "country": "GB"
    },
    "phone": {
      "country_code": "+1",
      "number": "415 555 2671"
    }
  },
  "customer": {
    "id": "cus_y3oqhf46pyzuxjbcn2giaqnb44",
    "default": true
  },
  "metadata": {
    "documentNumber": "12345678900",
    "partnerId": "partner_123"
  }
}

Response

Instrument updated successfully

OR
OR
OR
OR

Example response

{
  "fingerprint": "smoua2sbuqhupeofwbe77n5nsm"
}

Changes

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