API ReferenceWebpos

Create Web Pos Payment

Create Web POS payment requests. Used to initiate a new payment acceptance process.

Required OAuth 2.0 scopes: business/webpos:read, business/webpos:write

Path parameters

webpos_device_idstringRequiredformat: "uuid"

Headers

AuthorizationstringRequired

Bearer authentication of the form Bearer <token>, where token is your auth token.

Request

This endpoint expects an object.
amountobjectRequired
The amount of money to charge the buyer.
client_referencestringRequired>=1 character<=255 characters
Any reference value as determined by the host POS. It is associated with the payment and will be echoed back.
metadatamap from strings to strings or nullOptional
Any map of metadata as determined by the host POS. It is associated with the payment and will be echoed back.

Response

Successful Response
amountobject
The amount of money to charge the buyer.
client_referencestring
The reference value provided by the host POS when the Web POS payment was created.
created_atstringformat: "date-time"
The date and time the Web POS payment was created, in ISO 8601 format.
idstringformat: "uuid"
The unique ID for the Web POS payment. Can be used to fetch Web POS payment.
redirect_urlstring
The URL that can be loaded into an iFrame, window, or new tab to accept merchant input via their browser. The loaded web application can be used by the merchant to confirm the payment session and monitor its progress.
statusenum
The status of the Web POS payment.
Allowed values:
updated_atstringformat: "date-time"
The date and time the Web POS payment was last updated, in ISO 8601 format.
webpos_device_idstringformat: "uuid"
The Web POS Device which created the payment.
metadatamap from strings to strings or null
The metadata provided by the host POS when the Web POS payment was created.
payment_detailsobject or null
Payment outcome related details. Only available once the terminal has captured card data and submitted to upstream services.
terminalobject or null

The terminal that’s been selected to process this payment. Only available if a terminal has been chosen by an operator or auto-selected.

Errors