Follow a payment or refund live

Returns a single payment or refund and then keeps delivering its status changes as they happen, so you can show the customer live progress on screen.

What to send: the identifier of the payment or refund you want to follow.

What you get back: first the full details — the amount, whether it is a sale or a refund, its current status, and, where relevant, the reason behind that status. After that, you keep receiving updates as the status changes (for example, waiting for the card, then the final result). Once it reaches a final outcome — successful, failed, or cancelled — the final details are sent and the connection closes. If it is already finished when you ask, you get the full details once and the connection closes straight away.

Required Scopes (one of the following):

• payment_requests/id (returned via the register API: POST /poslink/v1/epos/register)
• default_access (deprecated, will be removed in the future; included for backward compatibility with existing integrations)