Merchant API
Update an order
api
patch
/api/orders/{order_id}

Update an order

Update the details of an order.

You can update an order and specific parameters based on the value of the state parameter:

State parameter valueModifiable parameters
pendingYou can modify all listed parameters.
authorisedYou can modify the following parameters:

  • merchant_order_data.reference
  • description
  • metadata
  • shipping_address
  • industry_data
  • cancel_authorised_after
completedYou can modify the following parameters:

  • merchant_order_data.reference
  • description
  • metadata
  • shipping_address
  • industry_data
processingYou cannot modify parameters.
info

For more information about the order lifecycle, see: Order and payment lifecycle.

Request​

Path Parameters
Path Parameters
Header Parameters
Header Parameters
Request body
Body object 

Response​

Order updated

Response body
Body object 
Was this page helpful?
PATCH
/api . /orders . /{order_id} . 
Revolut-Api-Version *header
Parameters
curl -L -g -X PATCH 'https://merchant.revolut.com/api/orders/{order_id}' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <yourSecretApiKey>' \
--data-raw '{
  "amount": 1000,
  "currency": "EUR",
  "settlement_currency": "GBP",
  "capture_mode": "manual",
  "cancel_authorised_after": "P3D",
  "metadata": {
    "example_key": "example_value"
  },
  "merchant_order_data": {
    "url": "https://example.com/orders/12345"
  },
  "statement_descriptor_suffix": "12345"
}'
Request body samples
{
  "amount": 1000,
  "currency": "EUR",
  "settlement_currency": "GBP",
  "capture_mode": "manual",
  "cancel_authorised_after": "P3D",
  "metadata": {
    "example_key": "example_value"
  },
  "merchant_order_data": {
    "url": "https://example.com/orders/12345"
  },
  "statement_descriptor_suffix": "12345"
}
Response body samples
{
  "id": "651a941a-02ef-af6f-9b6c-458c652e2c6a",
  "token": "0aa685ee-8d86-441d-bedd-3f7fbf41731b",
  "type": "payment",
  "state": "pending",
  "created_at": "2023-10-02T09:57:46.498026Z",
  "updated_at": "2023-10-02T11:54:46.648414Z",
  "amount": 1000,
  "currency": "EUR",
  "outstanding_amount": 1000,
  "settlement_currency": "GBP",
  "capture_mode": "manual",
  "cancel_authorised_after": "P3D",
  "checkout_url": "https://checkout.revolut.com/payment-link/0aa685ee-8d86-441d-bedd-3f7fbf41731b",
  "metadata": {
    "example_key": "example_value"
  },
  "enforce_challenge": "automatic",
  "merchant_order_data": {
    "url": "https://example.com/orders/12345"
  },
  "statement_descriptor_suffix": "12345"
}