> For the complete documentation index, see [llms.txt](https://docs.pagsmile.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.pagsmile.com/reference/remittance-api/business/partner/query-topup-result.md).

# Query Topup Result

Retrieves the processing result and credited amount of a partner top-up order.

#### Endpoint

`POST /remittance/partner/query-topup-result`

**Sandbox base URL:** `https://rem-api-sandbox.pagsmile.com`\
**Content-Type:** `application/json; charset=UTF-8`

The request uses the standard [Remittance API request envelope](https://docs.pagsmile.com/remittance-api/common). The fields below describe the decrypted `biz_data` object.

{% hint style="info" %}
**Requirement:** `M` = Mandatory, `O` = Optional, and `C` = Conditional. A conditional field is mandatory only when the condition stated in its description applies.
{% endhint %}

{% hint style="warning" %}
Encrypt `biz_data`, encrypt the AES key into `random_key`, and sign the request according to the Common request specification.
{% endhint %}

#### Request body

**Decrypted `biz_data` fields**

| Field      | Type   | Requirement | Description                                                                          |
| ---------- | ------ | ----------- | ------------------------------------------------------------------------------------ |
| `order_no` | string | M           | Merchant-defined order number used to submit, query, and reconcile the top-up order. |

**Plaintext `biz_data` example**

{% hint style="info" %}
This example includes mandatory fields and representative optional or conditional fields. Submit fields marked `C` only when the condition in the field description applies.
{% endhint %}

```json
{
  "order_no": "ORDER_202607200001"
}
```

#### Request example

```bash
curl --request POST \
  --url https://rem-api-sandbox.pagsmile.com/remittance/partner/query-topup-result \
  --header 'Content-Type: application/json; charset=UTF-8' \
  --data '{
    "partner_id": "<your_partner_id>",
    "app_id": "<your_app_id>",
    "timestamp": "2026-07-20 10:30:00",
    "version": "2.0",
    "language": "en",
    "random_key": "<RSA-encrypted AES key>",
    "request_id": "<globally_unique_request_id>",
    "sign_type": "RSA",
    "biz_data": "<AES-encrypted biz_data>"
  }'
```

{% hint style="info" %}
Use the `partner_id` and `app_id` assigned to your integration. The values above are placeholders.
{% endhint %}

#### Response

{% tabs %}
{% tab title="Success" %}

```json
{
  "code": "10000",
  "msg": "Success",
  "data": {
    "topup_id": 100025,
    "order_no": "14FCD1f3-3B73-430b-",
    "order_status": 4,
    "pay_currency": "USD",
    "pay_amount": "0.00",
    "topup_currency": "USD",
    "topup_amount": "1.00",
    "created_at": "2026-07-20 10:30:00"
  },
  "total": 1,
  "random_key": "abssdddd2wdw==",
  "sign_type": "RSA",
  "app_id": "2017051914172236111"
}
```

{% endtab %}

{% tab title="Invalid signature" %}

```json
{
  "code": "40002",
  "msg": "Business Failed",
  "sub_code": "invalid-signature",
  "sub_msg": "invalid signature"
}
```

{% endtab %}
{% endtabs %}

**Response data fields**

| Field            | Type    | Requirement | Description                                                                                                                                                                                    |
| ---------------- | ------- | ----------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `topup_id`       | long    | O           | Pagsmile-assigned unique identifier of the top-up transaction.                                                                                                                                 |
| `order_no`       | string  | O           | Merchant-defined order number used to submit, query, and reconcile the top-up order.                                                                                                           |
| `order_status`   | integer | O           | <p>Current processing status of the order.<br>Supported values:<br><code>1</code> — Success<br><code>8</code> — Fail<br><code>4</code> — To be confirmed<br><code>11</code> — Under review</p> |
| `pay_currency`   | string  | O           | Three-letter ISO 4217 code of the currency debited for the transaction.                                                                                                                        |
| `pay_amount`     | string  | O           | Amount debited in the payment currency.                                                                                                                                                        |
| `topup_currency` | string  | O           | Three-letter ISO 4217 code of the currency credited by the top-up.                                                                                                                             |
| `topup_amount`   | string  | O           | Amount credited to the partner balance.                                                                                                                                                        |
| `created_at`     | string  | O           | Date and time when the top-up order was created. Format: `yyyy-MM-dd HH:mm:ss`.                                                                                                                |

#### Related APIs

* [Create Topup Order](https://docs.pagsmile.com/remittance-api/business/partner/create-topup-order)
* [Query Partner Balance](https://docs.pagsmile.com/remittance-api/business/partner/query-partner-balance)
* [Query Partner Transactions](https://docs.pagsmile.com/remittance-api/business/partner/query-partner-transactions)