Update a payment method

How to update an existing payment method via API

To update an existing payment method, send a PATCH request to the /api/payment_methods/: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/payment_methods/:id

Arguments

Body ParameterTypeRequired

type

string

Required

id

string

Required

attributes.payment_source_type

string

Optional

attributes.currency_code

string

Optional

attributes.moto

boolean

Optional

attributes.require_capture

boolean

Optional

attributes.auto_place

boolean

Optional

attributes.auto_capture

boolean

Optional

attributes.price_amount_cents

integer

Optional

attributes.auto_capture_max_amount_cents

integer

Optional

attributes._disable

boolean

Optional

attributes._enable

boolean

Optional

attributes.reference

string

Optional

attributes.reference_origin

string

Optional

attributes.metadata

object

Optional

relationships.market

object

Optional

relationships.payment_gateway

object

Optional

Example

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

curl -g -X PATCH \
  'https://yourdomain.commercelayer.io/api/payment_methods/xYZkjABcde' \
  -H 'Accept: application/vnd.api+json' \
  -H 'Authorization: Bearer your-access-token' \
  -H 'Content-Type: application/vnd.api+json' \
  -d '{
  "data": {
    "type": "payment_methods",
    "id": "xYZkjABcde",
    "attributes": {
      "auto_capture_max_amount_cents": 0
    },
    "relationships": {
      "market": {
        "data": {
          "type": "markets",
          "id": "ABCRtyUpBa"
        }
      }
    }
  }
}'

Last updated