Developer Documentation
Developer Documentation
Home
PartPay
post

/order

Creates an order that is used to initiate the partpay payment. Partpay uses the information in the order request to assist with the customer approval process.

Authorization

oauth2 - clientCredentials

Request Body

Schema
object
productType
string

Product type (“classic”, “plus”). Defaults to “classic”.

1 validation
amount
number

Amount for order to be charged to consumer.

1 validation + required
consumer
object

The consumer requesting the order.

billing
object
shipping
object
description
string

A description of the order. Is optional if items array is populated

items
array[object]

An array of order items.

merchant
object
merchantReference
string

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

taxAmount
number

The included tax amount after applying all discounts.

1 validation
shippingAmount
number

The shipping amount.

1 validation
token
string

The order token.

promotions
array[string]

The promotion(s) for the order.

pairing
object

This property relates to account pairing functionality.

paymentFlow
string
2 validations

Responses

Created

1 Header
Schema
object
token
string

The order token. A temporary token for an in-flight order. Expires in 1h

required
expiryDateTime
string

The time (utc) the token expires

1 validation
redirectUrl
string

The URL to redirect the user to, in order to complete the PartPay payment process

required
orderId
string

The durable order token, use to poll order status from PartPay GET /order operation

required
warnings
array[string]

Only present if there are warnings with data passed to the create the order.

errors
array[string]

Only present if there are errors with data passed to the create the order.

customerPairingTokenActive
boolean

A true response singifies that the customer currently has an active pairing token, and the pairing token @ the pairing token This property is only populated for merchants who are active with account pairing

Send a Test Request

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