> ## Documentation Index
> Fetch the complete documentation index at: https://apidocs.hopnow.io/llms.txt
> Use this file to discover all available pages before exploring further.

# Get Payment Link

> Read a payment link's checkout status and settlement

Requires `payins:read`. Supply the `preq_` ID returned by [Create Payment Link](/fx/api-reference/payment-link-wallets/create-payment-link). Returns HTTP `200` with the same resource fields as creation.

| Status | Meaning |
| - | - |
| `creating` | The checkout is still being registered; read again shortly. |
| `pending` | The checkout is open and unpaid. |
| `processing` | A payment was detected and is being confirmed. |
| `held` | Funds arrived but did not settle automatically, for example an under- or overpayment or a late payment. Support reviews held payments. |
| `expired` | No payment arrived before `expires_at`. Create a new payment link. |
| `cancelled` | The checkout was cancelled. Create a new payment link. |
| `completed` | Settled. `received_amount`, `settled_amount` and `payin_id` are set and the account balance is credited. |

Poll with a delay and backoff while the status is `pending` or `processing`, or rely on `payin.received` to learn about the credit. An unknown ID, or one belonging to a different account, returns `404`.


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.