> ## Documentation Index
> Fetch the complete documentation index at: https://docs.bridge.linkio.world/llms.txt
> Use this file to discover all available pages before exploring further.

# Get a payment

> Get one payment by ID, including its current state.

Requires the **Ramps, banks & methods** scope (payments read).

## Headers

**API-Version** `string` *required* (default: 2026-10-29-atlas)

Your account's API version.

## Path

**paymentId** `string` *required*

The payment ID, starting with `pay_`.

## Query

**decode** `string` (default: false)

`true` to include the `quote` and `customer` details.

## Response

`200 OK`

**status** `string`

`success`

**message** `string`

`Payment retrieved`

**payment** `object`

**fields**

**id** `string`

Payment ID.

**customer\_id** `string | null`

The customer.

**reference\_id** `string`

The payment's reference, starting with `ref_`.

**quote\_id** `string`

The quote used.

**quote** `object`

Only with `decode=true`. `source_amount`, `source_currency`, `target_amount`, `target_currency`, `network`, `rate`, `payment_method`, `payout_method`.

**customer** `object`

Only with `decode=true`. `id`, `name`, `email`.

**type** `string`

`onramp` or `offramp`.

**status** `string`

`pending`, `success`, or `failed`.

**state** `string`

The exact step. See [onramp states](https://docs.bridge.linkio.world/flows/onramp.md#every-state) and [offramp states](https://docs.bridge.linkio.world/flows/offramp.md#every-state).

**transaction\_hash** `string | null`

The blockchain transaction, once the stablecoin has moved.

**created\_at** `string`

When it was created.

**updated\_at** `string`

When it last changed.

## Errors

| Status | Code | Why |
| - | - | - |
| `404` | `payment_not_found` | No payment with this ID in your business. |
| `422` | `validation_failed` | The ID isn't in the right format. |

```bash cURL theme={null}
curl "https://sandbox.core.linkio.world/api/payments/pay_8fK2mQ9xLp3VnR7tY1wZ4cB6dE/details?decode=true" \
  -H "X-BRIDGE-API-Key: $BRIDGE_API_KEY" \
  -H "API-Version: 2026-10-29-atlas"
```

```json 200 theme={null}
{
  "status": "success",
  "message": "Payment retrieved",
  "payment": {
    "id": "pay_8fK2mQ9xLp3VnR7tY1wZ4cB6dE",
    "customer_id": "cus_4hT9pL2mQx8VnR3tY7wZ1cB5dE",
    "reference_id": "ref_7tY1wZ4cB6dE8fK2mQ9xLp3VnR",
    "quote_id": "qte_9xLp3VnR7tY1wZ4cB6dE8fK2mQ",
    "type": "onramp",
    "status": "success",
    "state": "completed",
    "transaction_hash": "8c1f0e9a…",
    "created_at": "2026-10-28T10:15:02.000Z",
    "updated_at": "2026-10-28T10:21:17.000Z"
  }
}
```

```json 404 theme={null}
{
  "error": {
    "type": "resource_not_found",
    "code": "payment_not_found",
    "message": "Payment pay_8fK2mQ9xLp3VnR7tY1wZ4cB6dE not found",
    "request_id": "req_3VnR7tY1wZ4cB6dE8fK2mQ9xLp",
    "status": 404
  }
}
```


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