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

# Get Pay Link Details | GET /v1/order/pay

> Retrieve checkout details for a collection order, including the deposit address, amount, and current status. Used to render the customer-facing checkout page.

Returns the checkout details for a collection order. This is the endpoint used by the hosted checkout page to render payment instructions, but you can also call it directly to retrieve order information for a customer-facing interface.

## Request

**`GET http://your-gateway:180/v1/order/pay?orderId={orderId}&sign={sign}`**

### Query Parameters

<ParamField query="orderId" type="string" required>
  The order identifier. Example: `order_1042`.
</ParamField>

<ParamField query="sign" type="string" required>
  HMAC-SHA256 signature computed over the `orderId` value. See [Authentication](/api-reference/authentication).
</ParamField>

### cURL

```bash theme={null}
curl "http://your-gateway:180/v1/order/pay?orderId=order_1042&sign=a1b2c3d4e5f6..."
```

***

## Response

A successful request returns HTTP `200` with the `R<PayinOrderVo>` envelope.

### PayinOrderVo Object

<ResponseField name="orderId" type="string">
  The order identifier.
</ResponseField>

<ResponseField name="chain" type="string">
  The blockchain network for this payment. Example: `"TRON"`.
</ResponseField>

<ResponseField name="symbol" type="string">
  The token symbol. Example: `"USDT"`.
</ResponseField>

<ResponseField name="address" type="string">
  The deposit address where the customer should send funds. Example: `"TWkKZkmuB8DpVeiMoHiKf99ZoFHzk73CqR"`.
</ResponseField>

<ResponseField name="amount" type="string">
  The requested amount as a decimal string. Example: `"250.00"`.
</ResponseField>

<ResponseField name="actualAmount" type="string">
  The actual amount received once payment is confirmed. `null` before payment.
</ResponseField>

<ResponseField name="expiredTime" type="integer">
  Unix timestamp when this payment request expires.
</ResponseField>

<ResponseField name="status" type="string">
  Current order status. See [Order Status](/api-reference/order/status) for possible values.
</ResponseField>

<ResponseField name="reason" type="string | null">
  Failure or expiry reason. `null` if the order is still valid.
</ResponseField>

### Example Response

```json theme={null}
{
  "code": 200,
  "msg": "success",
  "data": {
    "orderId": "order_1042",
    "chain": "TRON",
    "symbol": "USDT",
    "address": "TWkKZkmuB8DpVeiMoHiKf99ZoFHzk73CqR",
    "amount": "250.00",
    "actualAmount": null,
    "expiredTime": 1717086400,
    "status": "PENDING",
    "reason": null
  }
}
```
