Skip to main content

Order Management APIs

Order Management Request - for Refunds, Voids and Captures#

Content-Type: application/json

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

KeyRequired for Online?Required for Instore?TypeExample
merchantId
Note: This is a merchant identifier assigned to the merchant
YesYesstring
max length 128
T123344
isTest
Note: set false for production
set true for sandbox environment
YesYesboolean
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
YesYesstring
max length 128
9097775
gatewayReference
Note: From the Purchase Response, reference to the original auth/purchase that is to be refunded/voided/captured
YesYesstring
max length 128
906f5b69-255d-4f26-a81f-ca0d2c47fe35
amount
Note: rounded to 2 decimal places
total amount to be charged to the customer
YesYesfloat320 or 320.00
currency
Note: ISO 4217 standard, currently restricted to "AUD" and "NZD"
YesYesstring
values AUD, NZD
AUD
type
Note: identified transaction type
valid values refund, void, capture
YesYesstring
max length 128
refund
description
Note: Merchant to capture reason for refund/void/capture
NoNostring
max length 128
Customer change of mind
platformType
Note: Meta data for merchant integration type
Yes, value directYes, value instore-posstring
max length 128
direct
orderLines object, see Order Lines Map
Note: only required for partial void/partial capture/partial refund
Yes for partialYes for partial

Order Lines Map (repeat for multiple orderLines)#

KeyRequired for online?
platformType=direct
Required for instore?
platformType=instore-pos
TypeExample
nameYesYesstring
max length 128
Nora Practice Tank
productUrlNoNostring
max length 255
https://store1.lmerchant.com/product/nora-practice-tank
skuNoNostring
max length 128
WT03-S-Purple
quantityYesYesinteger2
unitPrice
Note: rounded to 2 decimal places
tax inclusive
YesYesfloat
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
YesYesfloat
100.20

Order Management Response - for Refunds, Voids and Captures#

Content-Type: application/json

KeyPresent for Online?Present for Instore?TypeExample
merchantId
Note: This is a merchant identifier assigned to the merchant
YesYesstring
max length 128
T123344
merchantReference
Note: from Order Management request
YesYesstring
max length 128
9097775
gatewayReference
Note: from Order Management request
YesYesstring
max length 128
906f5b69-255d-4f26-a81f-ca0d2c47fe35
transactionReference
Note: unique reference of the order assigned by Latitude Checkout
YesYesstring
max length 128
abcd767623x
amount
Note: rounded to 2 decimal places, total amount to be charged to the customer
YesYesfloat320 or 320.00
currency
Note: echo from Order Management request
YesYesstring
values AUD, NZD
AUD
type
Note: echo from Order Management request
YesYesstring
max length 128
refund
result
YesYesstring
values completed, failed
completed
error
Note: populated if result is failed
YesYesstringerror text

one or more products are not valid for interest free purchase