Home
API Reference

Create Instore Order

post
https://zip.co/nz/api/pos/order

Creates an in-store order that is used to initiate the Zip payment. Zip uses the information in the order request to assist with the customer onboarding/approval process.

Body Params
string
required
Defaults to 123456

Unique 6-digit approval code that the customer will have as part of their pre-approval from Zip

string
required
Defaults to John

Current Point of Sale terminal operator

double
required
Defaults to 50

Amount to be charged to consumer

string
required
Defaults to reference

The merchant’s reference/id that this order corresponds to

string
Defaults to payment

The flow of the payment method. Allowed values are payment or auth

items
array of objects
items
Headers
boolean
Defaults to true

If supplied, a unique check will be applied to the order creation (based on the supplied merchantReference). If the order already exists, the API will respond with a 302 response

string

Uniquely identifies the Point of sale terminal being used as part of this request.

string

When using a merchant level scope, this is supplied to give traceability from what store the order originated

string
enum
Defaults to application/json

Generated from available response content types

Allowed:
Responses

Updated 3 months ago

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

Updated 3 months ago