/order/refund

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.

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

Example request

{
	"orderId":100036,
	"amount":35.95,
	"refundReference":"1728950142",
	"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 100036"
}

Example response - Success

{
	"result":"SUCCESS",
	"refundId":101318,
	"merchantReference":1728950142
}
Body Params
integer
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

The merchant's unique reference for the refund.

string

A brief description of the reason for the refund.

Response

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