/order/merchant/{merchantReference}

Retrieve the details of a confirmed Laybuy order using merchant reference.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…

Overview

This method allows merchants to retrieve the details of a Laybuy order using the merchant reference.

Response data

See the response fields and data returned by the interface and their descriptions on the right - >

Example response - Error

{
	"result":"ERROR",
	"error":"Order not found"
}

Example response - Success

{
  "result": "SUCCESS",
  "orderId": "e930a4ad-5465-4468-9f9e-7120f8173f88",
  "token": "56e4d02d-f024-3cae-b989-26e3e72e1051",
  "amount": 154.98,
  "currency": "NZD",
  "merchantReference": "REF-ORD10001",
  "processed": "2024-12-20 12:28:54",
  "customer":{
		"firstname":"Jenny",
		"lastname":"Smith",
		"email":"[email protected]",
		"address1":"Level 4, Goodsmiths Building",
		"address2":"123 Crown Street",
		"suburb":"Redvale",
		"city":"Auckland",
		"postcode":"1010",
		"country":"New Zealand"
	},
  "refunds": [
    {
      "refundId": "a2e17116-de07-40cf-812b-30be2dfbf003",
      "dateTime": "2024-12-19T23:29:19.465Z",
      "amount": 10.99,
      "refundReference": "REF-REFUND0001",
      "user": null,
      "userNote": "Faulty item returned to store"
    }
  ]
}
Path Params
string
required

The merchant's reference from the original order.

Response

Language
Credentials
Basic
base64
:
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json