Skip to main content

Status

Status Request (the payment outcome can be obtained using either status request, or the statusUrl)#

Applicable only for instore integrations.

Content-Type: application/json All requests are via HTTPS GET

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

KeyRequired?TypeExample
gatewayReference
Note: unique reference of the payment assigned by Latitude Checkout.
Also used for order management requests - Void, Capture and Refund.
The "purchase" response will contain this field
Yesstring
max length 128
906f5b69-255d-4f26-a81f-ca0d2c47fe35

Status Response#

Content-Type: application/json

(Note: polling via statusUrl will return the same fields)

KeyTypeExample
merchantIdstring
max length 128
T123344
storeMid
Note: Echoed from Purchase Request
string
max lenght 15
12345678
isTest
Note: false for production
true for sandbox environment
boolean
values: true, false
true
amount
Note: rounded to 2 decimal places
float320.00
currency
Note: ISO 4217 standard
string
values: AUD, NZD
AUD
result
Note:
submitted - Payment request accepted
initiated - Payment in progress
completed – Payment approved
failed – Payment declined/has errors
cancelled – Payment cancelled
string
values: submitted, initiated, completed, cancelled, failed
completed
transactionReference
Note: unique reference of the transaction assigned by Latitude Checkout
string
max length 128
abcd767623x
gatewayReference
Note: unique reference of the payment assigned by Latitude Checkout.
also used for order management requests - Void, Capture and Refund
string
max length 128
906f5b69-255d-4f26-a81f-ca0d2c47fe35
merchantReference
Note: echo from purchase request
unique reference of an order assigned by the merchant
string
max length 128
9097775
transactionType
Note: sale – Instant payment flow (merchant is instant settlement)
authorization – Deferred payment flow (merchant is deferred settlement)
string
max length 128
values: sale, authorization
sale
maskedPan
Note: Customer’s 16-digit (masked) account number. For printing on Merchant Sales Receipt, first 6 digits and the last 4 digits
string
max length 16
521893XXXXXX1234
promotionReference
Note: The Interest Free Payment Plan (promotion)
string
max length 128
2012
authCode
Note: The Authorization Code for approved payment
string
fixed length 6
039488
message
Note: Valid values when result=failed are:
no-promotion, excluded-items, lest-than-minimum-purchase-amount, more-than-maximum-purchase-amount
string
max length 128
lest-than-minimum-purchase-amount

Sample status response
{"merchantId":"dev2-audirect","isTest":true,"amount":399.99,"currency":"AUD","result":"completed","transactionType":"authorization","message":"","gatewayReference":"96b6f573-df29-486b-b28e-7025bf6b79a3","promotionReference":"2012","merchantReference":"TEST001","transactionReference":"qe7qapl2fjlg","storeMid":"000412106","maskedPan":"437732XXXXXX9405","authCode":"039488"}