Update Order Reference

In addition to update an order reference in the initialize checkout and order validation calls, it is also possible to update the order reference for a Checkout session after a purchase has been successfully completed

Please Note

It is only possible to update the Order Reference once after the Purchase has been completed, and it must be done before the order is captured.

Update Order Reference Examples

Request

PUT /checkouts/1eec44b5-66d3-4058-a31f-3444229fb727/reference HTTP/1.1
Host: api.uat.walleydev.com // (Please note! Different hostname in production)
Authorization: Bearer bXlVc2VybmFtZTpmN2E1ODA4MGQzZTk0M2VmNWYyMTZlMDE...
Content-Type: application/json

{
  "Reference": "ABCDEFGHJIKLMNOP"
}

Response

{
  "id": "f5f4e86d-95b1-4c1a-8ad0-1d5907236bd7",
  "data": null,
  "error": null
}

Request headers

Header	Required	Explanation
Authorization	Yes	Instructions on how to generate the authorization header value can be found here.

Request properties

Property	Required	Explanation
Reference	Yes	This is a reference to the order, like an order ID. If you update the reference after completing the purchase, the customer might not see it. However, you can still match it with the PurchaseIdentifier the customer sees. It has a 50-character limit.