Fetch Web Pos Payment
Fetch a Web POS payment and track its status.
Required OAuth 2.0 scope: business/webpos:read
Path parameters
webpos_device_id
payment_id
Headers
Authorization
Bearer authentication of the form Bearer <token>, where token is your auth token.
Response
Successful Response
amount
The amount of money to charge the buyer.
client_reference
The reference value provided by the host POS when the Web POS payment was created.
created_at
The date and time the Web POS payment was created, in ISO 8601 format.
id
The unique ID for the Web POS payment. Can be used to fetch Web POS payment.
redirect_url
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.
status
The status of the Web POS payment.
Allowed values:
updated_at
The date and time the Web POS payment was last updated, in ISO 8601 format.
webpos_device_id
The Web POS Device which created the payment.
metadata
The metadata provided by the host POS when the Web POS payment was created.
payment_details
Payment outcome related details. Only available once the terminal has captured card data and submitted to upstream services.
terminal
The terminal that’s been selected to process this payment. Only available if a terminal has been chosen by an operator or auto-selected.