authorizations

Update an authorization

Changed on

Update an authorization

patch/authorizations/{authorizationId}

Request

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

Path parameters

authorizationIdstring required

The resource's id

Request body

Example request

{
  "data": {
    "id": "XAyRWNUzyN",
    "attributes": {
      "_forward": true,
      "reference": "ANY-EXTERNAL-REFEFERNCE",
      "reference_origin": "ANY-EXTERNAL-REFEFERNCE-ORIGIN",
      "metadata": {
        "foo": "bar"
      },
      "_capture": true,
      "_capture_amount_cents": 500,
      "_void": true,
      "_cancel": true
    }
  }
}

Response

The updated authorization object

Changes

    • info

      added the optional property // to the response with the status

    • breaking

      request property / was restricted to a list of enum values

    • info

      added the new optional request property //

    • info

      added the new optional request property //

    • info

      added the new optional request property //

    • info

      the request property // became nullable

    • info

      the request property // became nullable

    • info

      the request property // became nullable

    • info

      the request property default value authorizations was removed

    • info

      added the new authorizations enum value to the request property /

    • info

      added the media type application/vnd.api+json for the response with the status