/order/refund

Process a full or partial refund of a confirmed Laybuy order.

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

Overview

This method allows merchants to wholly or partially refund a Laybuy order.

! Important: If specified, the refund reference must be unique across all of a merchant's refunds. This method is idempotent when a refund reference is provided, meaning any duplicate requests (by refund reference) will return the same response.

Example request

{
	"orderId": "e930a4ad-5465-4468-9f9e-7120f8173f88",
	"amount":35.95,
	"refundReference":"REF-REFUND0001",
	"note":"Faulty item returned to store"
}

Response data

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

Example response - Error

{
	"result":"ERROR",
	"error":"Failed to find order e930a4ad-5465-4468-9f9e-7120f8173f88"
}

Example response - Success

{
  "result": "SUCCESS",
  "merchantReference": "REF-REFUND0001"
}
Body Params
string
required

The Laybuy order id to process the refund for.

number
required

The amount to refund on the order, up to the order total.

string
required

The merchant's unique reference for the refund.

string

A brief description of the reason for the refund.

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