post

/terminal/order

This operation creates an order on PartPay. This is the first operation when creating a terminal order on PartPay. The response payload will include a QR code (either by Base64 image, or link) which will need to be presented to the customer, as part of their checkout with PartPay.

Request Parameters

1 Header

Request Body

Schema
object
amount
number

Amount for order to be charged to consumer.

1 validation + required
items
array[object]

An array of order items.

paymentTerminalId
string

Unique terminal device identifier (used for traceability)

gatewayReference
string

Unique transaction id generated by Payment Terminal Service (used for traceability)

qrCode
object
merchantReference
string

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

callbackUrl
string

URL for PartPay to POST to when order reaches a terminal state controlled from the customer (ie complete or cancelled). See more @ TBC

required

Responses

Schema
object
orderId
string

PartPay generated orderId uuid to correlate to this order

1 validation + required
qrCode
object
required

Send a Test Request

Send requests directly from the browser (CORS must be enabled)
$$.env
1 variable not set
host