Developer Documentation
Developer Documentation
Home
PartPay
post

/pos/order

Authorization

oauth2 - clientCredentials

Request Parameters

1 Header

Request Body

1 Example
Schema
object
customerApprovalCode
string

Unique 4 or 6-character approval code that the customer will have as part of their pre-approval from PartPay.

required
operator
string

Current Point of Sale terminal operator.

required
amount
number

Amount to be charged to consumer.

required
merchantReference
string

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

required
items
string or array[object]
paymentFlow
string

The flow of the payment method. (more info here)

  • payment represents a payment solution
  • auth - represents an auth/capture solution
1 validation

Responses

Created. The order is created, and is now pending the customer’s authorisation. Your system should now poll the Order Status endpoint for this information. The header Operation-Location will be set to the status endpoint.

1 Example
Schema
object
orderId
string

The unqiue reference ID for this order within PartPay. This will need to be used as a parameter in the Order Status endpoint.

required

Send a Test Request

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