Skip to main content

Purchase

Purchase Request#

Content-Type: application/json

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

Please select your platform type:

Purchase API

Keyonline?platformType=directinstore?platformType=instore-posinstore?platformType=instore-directTypeExample
merchantId

Note: This is a merchant identifier assigned to the merchant

Yes

Yes

Yes

string max length 128

T000400100

isTest

Note: set false for production set true for sandbox environment

Yes

Yes

Yes

boolean values: true, false

true

amount

Note: rounded to 2 decimal places total amount to be charged to the customer Includes totalShippingAmount (if totalShippingAmount is present)

Yes

Yes

Yes

float

320.00

currency

Note: ISO 4217 standard, currently restricted to "AUD" and "NZD"

Yes

Yes

Yes

string values AUD, NZD

AUD

merchantReference

Note: Unique reference of an order assigned by the merchant

Yes

Yes

Yes

string max length 128

9097775

promotionReference

Note: Not applicable as the options will be facilitated by Latitude Checkout

No

No

Yes

string max length 128

2012

totalShippingAmount

Note: rounded to 2 decimal places, Optional

No

No

No

float

20.00

platformType

Note: Meta data for merchant integration type

Yes, value direct

Yes, value instore-pos

Yes, value instore-direct

string max length 128

direct

platformVersion

Note: Meta data for merchant platform version eg. 0.0.1

No

No

No

string max length 128

0.0.1

salesId

Note: required for instore integrations only

Not applicable

Yes

Yes

string max length 10

Operator01

storeMid

Note: This ID will override the default settlement ID that is associated with the credentials. In some cases, this ID will be the store-level merchant ID used for settlement

No

Yes

Yes

string max length 15

123456789

terminalId

Note: required for instore integrations only

Not Applicable

Yes

Yes

string max length 8

T00101

autoCapture

Note: Only applicable for deferred settlement Merchants

Not Applicable

No

No

string max length 8. Values: full, partial

full

customer

See Customer Map

Yes

No

Yes

Object

See Customer Map

shippingAddress

See Address Map

Yes

No

No

Object

See Address Map

billingAddress

See Address Map

Yes

No

No

Object

See Address Map

orderLines

See Order Lines Map

Yes

Yes

No

Object

See Order Lines Map

merchantUrls

See URLs Map

Yes

No

No

Object

See URLs Map

Customer Map

Keyonline?platformType=directinstore?platformType=instore-posinstore?platformType=instore-directTypeExample
firstName

Yes

No

No

string max length 128

John

lastName

Yes

No

No

string max length 128

Citizen

phone

Note: Customer's mobile number Australian or NZ only.

Yes

No. Note: the Latitude Checkout Merchant Order Summary form will enable mobile number entry by the Sales Staff. AU numbers must start with 04 or 05, NZ numbers must start with 02

Yes. Note: the mobile number must include + sign and country code i.e. +61 for AU and +64 for NZ

string max length 128

AU 0404000000 / NZ 0220000000

email

Yes

No

No

string max length 128

john.citizen@email.com

Address Map

Keyonline?platformType=directinstore?platformType=instore-posinstore?platformType=instore-directTypeExample
name

Yes

No

No

string max length 128

John Doe

line1

Yes

No

No

string max length 128

100 Spencer Street

line2

Yes

No

No

string max length 128

city

Yes

No

No

string max length 128

Melbourne

postcode

Yes

No

No

integer

3000

state

No

No

No

string max length 128

Vic

countryCode

Note: iso-3166-1 alpha-2

Yes

No

No

string max length 128

AU

phone

Note: Recipient's mobile number Australian or NZ only. Do not include the Country Code

Yes

No

No

string max length 128

AU 0404000000 / NZ 0220000000

Order Lines Map (repeat for multiple orderLines

Keyonline?platformType=directinstore?platformType=instore-posinstore?platformType=instore-directTypeExample
name

Yes

Yes

No

string max length 128

Nora Practice Tank

productUrl

No

No

No

string max length 255

https://store1.lmerchant.com/product/nora-practice-tank

sku

No

No

No

string max length 128

WT03-S-Purple

quantity

Yes

Yes

No

integer

2

unitPrice

Note: rounded to 2 decimal places, tax inclusive

Yes

Yes

No

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

No

No

No

float

100.20

requiresShipping

Note: if true, totalShippingAmount must be populated

Yes

Yes

No

boolean values. true / false

true

isGiftCard

Note: if applicable, giftcard exclusion rules will apply

Yes

Yes

No

boolean values. true / false

true

goodsTaken

Note: mandatory when autoCapture=partial to indicate which orderLines are 'taken now' by the Customer

Not applicable

No

No

string if present, values true, false

true

URLs Map

Keyonline?platformType=directinstore?platformType=instore-posinstore?platformType=instore-directTypeExample
complete

Note: used to redirect customer after payment is approved or declined

Yes

No

No

string max length 255

https://store1.lmerchant.com/payment/complete

cancel

Note: used to redirect customer back to shopping cart on merchant store

Yes

No

No

string max length 255

https://store1.lmerchant.com/payment/cancel

Purchase Response#

Content-Type: application/json

Please select your platform type:

Purchase Response

Keyonline?platformType=directinstore?platformType=instore-posinstore?platformType=instore-directTypeExample
merchantId

Note: echo from purchase request

Yes

Yes

Yes

string max length 128

T000400100

merchantReference

Note: Unique reference of an order assigned by the merchant

Yes

Yes

Yes

string max length 128

9097775

gatewayReference

Note: unique reference of the Payment assigned by the Latitude Checkout. also used for order management requests - Void, Capture and Refund

Yes

Yes

Yes

string max length 128

906f5b69-255d-4f26-a81f-ca0d2c47fe35

amount

Note: echo from purchase request

Yes

Yes

Yes

float

320.00

currency

Note: echo from purchase request

Yes

Yes

Yes

string values AUD, NZD

AUD

result

Note: pending - Purchase request accepted by Latitude but customer has not paid. (This status is prior to the transaction being submitted by the Customer). failed - Purchase request rejected by Latitude due to validation failure (eg. invalid products, config or cart total)

Yes

Yes

Yes

string values: pending / failed

pending

error

Note: populated if error occurred

Yes

Yes

Yes

string

error text: one or more products are not valid for interest free purchase

redirectUrl

Note: To load Latitude Checkout screen

Yes

Yes

Yes but always empty

string

statusUrl

Note: Meta data for merchant platform version eg. 0.0.1

No

Yes

Yes

string

manualPaymentUrl

Note: To load Manual Payment screen

No

Yes

Yes

string

Sample purchase response#

{
"merchantId": "000412106",
"merchantReference": "TEST009",
"gatewayReference": "34cbe705-abe9-4cb0-a4eb-51fb2f115664",
"amount": 187.4,
"currency": "AUD",
"result": "submitted",
"error": "",
"redirectUrl": "https://feature-sfpg-2746-corrected-instore-purchase-request.checkout.dev.merchant-services-np.lfscnp.com/merchant/pos/initiate?merchantId=000412106&token=eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJyZXNvdXJjZSI6IjAwMDQxMjEwNiIsInNjb3BlcyI6Im1lcmNoYW50OnJlYWQsd3JpdGUiLCJ1c2VyIjoiIiwiZXhwIjoxNjQyMDI3Mjc5LCJpc3MiOiJhcHBseWJ1eS1jaGVja291dC1zZXJ2aWNlIn0.Qf_3dpIYr3irQ6uVK6aZh100TbaXf1WThOCkpuu8JU3OUTY6N9HPjPPNgK_Sppztfu2wctnTs1GT3Z6hPFZr-WwNESo1hbW5ePdxCnA-OIaqussJqBxbp_YenVXOsy2EfJZak0g5J50Q-JH7WhdhE-G7aZCxAQxGIuWok3ojqIc&transactionId=34cbe705-abe9-4cb0-a4eb-51fb2f115664",
"statusUrl": "https://api.dev.latitudefinancial.com/v1/applybuy-checkout-service/dev2/purchase/34cbe705-abe9-4cb0-a4eb-51fb2f115664/status?merchantId=000412106&token=eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJyZXNvdXJjZSI6IjAwMDQxMjEwNiIsInNjb3BlcyI6Im1lcmNoYW50OnJlYWQsd3JpdGUiLCJ1c2VyIjoiIiwiZXhwIjoxNjQyMDI3Mjc5LCJpc3MiOiJhcHBseWJ1eS1jaGVja291dC1zZXJ2aWNlIn0.Qf_3dpIYr3irQ6uVK6aZh100TbaXf1WThOCkpuu8JU3OUTY6N9HPjPPNgK_Sppztfu2wctnTs1GT3Z6hPFZr-WwNESo1hbW5ePdxCnA-OIaqussJqBxbp_YenVXOsy2EfJZak0g5J50Q-JH7WhdhE-G7aZCxAQxGIuWok3ojqIc",
"manualPaymentUrl": "https://feature-sfpg-2746-corrected-instore-purchase-request.checkout.dev.merchant-services-np.lfscnp.com/purchase/initiate?isManual=true&token=eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJyZXNvdXJjZSI6IjM0Y2JlNzA1LWFiZTktNGNiMC1hNGViLTUxZmIyZjExNTY2NCIsInNjb3BlcyI6InRyYW5zYWN0aW9uOnJlYWQsd3JpdGUiLCJ1c2VyIjoiIiwiZXhwIjoxNjQyMDI3ODc5LCJpc3MiOiJhcHBseWJ1eS1jaGVja291dC1zZXJ2aWNlIn0.Ojx-VMeU8BMSFTc5hku3OdErdZBt3nOkVbgjHrZ9B27c8cia9f6qPvXsvgnLxhUZJj409Fqu37Wexqnf7uGFA5-uZ8jx184b1wGpfahMhx2hQdUAJKWmnLyD4xziOy-8n_360yofgWA1L5lGev1WR-Uwzd89pnc8klLhYaWj4pM&transactionId=34cbe705-abe9-4cb0-a4eb-51fb2f115664"
}