Developer Documentation
Developer Documentation
Home
PartPay
get

/v2.0/pos/order/{id}/status

Returns the status of a given instore order. This endpoint is used in a polling scenario when a merchant POS system is awaiting a user confirmation of an order.

Authorization

oauth2 - clientCredentials

Request Parameters

1 Path Parameter

Responses

Order found

1 Example
Schema
object
orderNumber
string

The human readable form of a PartPay order id - i.e. 180323-999999

status
string

The current status of the order.

  • pending - the order has been created, awaiting a user response
  • approved - the order has been approved and paid for by the users. This status is relevant to an order that has been created with the auth flow.
  • complete - the order has been paid and the order.
  • declined - the order was declined by the user
  • expired - the order has timed out.
  • cancelled The order has been either cancelled prior to the customer approving/declining, or the order has been rolled back by the merchant. This status is relevant to an order that has been created with the auth flow.

The latter 3 status are terminal states

1 validation + required

Send a Test Request

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