Order Management APIs

Order Management Request - for Refunds, Voids and Captures

Content-Type: application/json

Fields marked as "No" (not required) are optional

Key	Online?	Instore?	Type	Example
merchantId Note: This is a merchant identifier assigned to the merchant	Yes	Yes	string max length 128	T123344
isTest Note: set false for production set true for sandbox environment	Yes	Yes	boolean values true, false	true
merchantReference Note: Merchant’s internal refund/void/capture ID or reference. Can be the same as the original Purchase Request or different Note: Supported Special Characters: ` % & ( ) - _ = + [ ]	: ' , . / ?	Yes	Yes	string max length 36
gatewayReference Note: From the Purchase Response, reference to the original auth/purchase that is to be refunded/voided/captured	Yes	Yes	string max length 128	906f5b69-255d-4f26-a81f-ca0d2c47fe35
amount Note: rounded to 2 decimal places total amount to be charged to the customer	Yes	Yes	float	320 or 320.00
currency Note: ISO 4217 standard, currently restricted to "AUD" and "NZD"	Yes	Yes	string values AUD, NZD	AUD
type Note: identified transaction type valid values refund, void, capture	Yes	Yes	string max length 128	refund
description Note: Merchant to capture reason for refund/void/capture	No	No	string max length 128	Customer change of mind
platformType Note: Meta data for merchant integration type, as per the Purchase Request	Yes	Yes	string max length 128	direct or instore-pos or instore-direct etc
orderLines object, see Order Lines Map Note: OrderLines are an optional field	No	No

Order Lines Map (repeat for multiple orderLines) *As of 1/8/2022, orderLines will be Optional

Key	Online?	Instore?	Type	Example
name	Yes	Yes	string max length 128	Nora Practice Tank
productUrl	No	No	string max length 255	https://store1.lmerchant.com/product/nora-practice-tank
sku	No	No	string max length 128	WT03-S-Purple
quantity	Yes	Yes	integer	2
unitPrice Note: rounded to 2 decimal places tax inclusive	Yes	Yes	float	50.10 0 (zero) is accepted if the unitPrice represents zero value products (eg. free shipping)
amount Note: rounded to 2 decimal places tax inclusive	Yes	Yes	float	100.20

Order Management Response - for Refunds, Voids and Captures

Content-Type: application/json

Key	Online?	Instore?	Type	Example
merchantId Note: This is a merchant identifier assigned to the merchant	Yes	Yes	string max length 128	T123344
merchantReference Note: from Order Management request	Yes	Yes	string max length 128	9097775
gatewayReference Note: from Order Management request	Yes	Yes	string max length 128	906f5b69-255d-4f26-a81f-ca0d2c47fe35
transactionReference Note: unique reference of the order assigned by Latitude Checkout	Yes	Yes	string max length 128	abcd767623x
amount Note: rounded to 2 decimal places, total amount to be charged to the customer	Yes	Yes	float	320 or 320.00
currency Note: echo from Order Management request	Yes	Yes	string values AUD, NZD	AUD
type Note: echo from Order Management request	Yes	Yes	string max length 128	refund
result	Yes	Yes	string values completed, failed	completed
error Note: populated if result is failed	Yes	Yes	string	error text one or more products are not valid for interest free purchase

---