Update a customer payment source

How to update an existing customer payment source via API

To update an existing customer payment source, send a PATCH request to the /api/customer_payment_sources/:id endpoint, where id is the ID of the resource that you want to update.

Here below the list of all the possible arguments that you can pass with the request body.

Request

PATCH https://yourdomain.commercelayer.io/api/customer_payment_sources/:id

Arguments

Body ParameterTypeRequired

type

string

Required

id

string

Required

attributes.customer_token

string

Optional

attributes.payment_source_token

string

Optional

attributes.reference

string

Optional

attributes.reference_origin

string

Optional

attributes.metadata

object

Optional

relationships.customer

object

Optional

relationships.payment_method

object

Optional

relationships.payment_source

object

Optional

Example

The following request updates the customer payment source identified by the ID "xYZkjABcde":

curl -g -X PATCH \
  'https://yourdomain.commercelayer.io/api/customer_payment_sources/xYZkjABcde' \
  -H 'Accept: application/vnd.api+json' \
  -H 'Authorization: Bearer your-access-token' \
  -H 'Content-Type: application/vnd.api+json' \
  -d '{
  "data": {
    "type": "customer_payment_sources",
    "id": "xYZkjABcde",
    "attributes": {
      "reference": "ANY-EXTERNAL-REFEFERNCE"
    },
    "relationships": {
      "customer": {
        "data": {
          "type": "customers",
          "id": "ABCRtyUpBa"
        }
      }
    }
  }
}'

Last updated