COcommercelayer
payment_options

Update a payment option

Changed on

Update a payment option

patch/payment_options/{paymentOptionId}

Request

  • Base URL
    https://{your_organization_slug}.commercelayer.io/api
  • URL
    https://{your_organization_slug}.commercelayer.io/api/payment_options/{paymentOptionId}
  • Auth
    HTTP bearer

Path parameters

paymentOptionIdstring required

The resource's id

Request body

Example request

{
  "data": {
    "id": "XAyRWNUzyN",
    "attributes": {
      "name": "Stripe Payment Option",
      "data": {
        "application_fee_amount": 1000,
        "on_behalf_of": "pm_xxx"
      },
      "reference": "ANY-EXTERNAL-REFEFERNCE",
      "reference_origin": "ANY-EXTERNAL-REFEFERNCE-ORIGIN",
      "metadata": {
        "foo": "bar"
      }
    },
    "relationships": {
      "order": {
        "data": {
          "id": "XAyRWNUzyN"
        }
      }
    }
  }
}

Response

The updated payment option object

Changes