> 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/collection/query-collection-account-detail.md).

# Query Collection Account Detail

Retrieves the configuration and current status of a specific collection account.

**Endpoint**

`POST /remittance/collection/query-collection-account-detail`

**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                                                    |
| ----------------------- | ---- | ----------- | -------------------------------------------------------------- |
| `merchant_id`           | long | M           | Pagsmile-assigned unique identifier of the merchant.           |
| `collection_account_id` | long | M           | Pagsmile-assigned unique identifier of the collection account. |

**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
{
  "merchant_id": 100398,
  "collection_account_id": 100001
}
```

**Request example**

```bash
curl --request POST \
  --url https://rem-api-sandbox.pagsmile.com/remittance/collection/query-collection-account-detail \
  --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" %}
The `data` field in the response envelope is AES-encrypted. Decrypt `random_key` with your RSA private key, then use the resulting AES key to decrypt `data`. See [Security](https://docs.pagsmile.com/remittance-api/security) for implementation details.

**Encrypted response example**

```json
{
  "code": "10000",
  "msg": "Success",
  "data": "<AES-encrypted response data>",
  "total": 4,
  "random_key": "<RSA-encrypted AES key>",
  "sign_type": "RSA",
  "app_id": "2017051914172236111"
}
```

**Decrypted `data` example**

```json
{
  "collection_account_id": 100001,
  "merchant_id": 100398,
  "payment_type": 1,
  "account_name": "Example Commerce Ltd.",
  "account_label": "Brazil collections",
  "account_no": "1234567890",
  "account_no_type": 1,
  "alternate_no": "example-commerce@pix.example",
  "alternate_no_type": 3,
  "branch_code": "0001",
  "bank_name": "Banco Example S.A.",
  "bank_address": "100 Avenida Paulista, Sao Paulo",
  "bank_country": "BR",
  "routing_code": "12345678",
  "routing_code_type": "ISPB",
  "currency": "BRL",
  "created_at": "2026-07-20 10:30:00"
}
```

{% 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                                                                                                                                                                                               |
| ----------------------- | ------- | ----------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `collection_account_id` | long    | M           | Pagsmile-assigned unique identifier of the collection account.                                                                                                                                            |
| `merchant_id`           | long    | M           | Pagsmile-assigned unique identifier of the merchant associated with the returned record.                                                                                                                  |
| `payment_type`          | integer | M           | <p>Payment route used to deliver funds to the recipient.<br>See <a href="https://docs.pagsmile.com/reference/remittance-api/data/dictionary-item/payment-type">Payment Type</a> for supported values.</p> |
| `account_name`          | string  | M           | Name registered on the account.                                                                                                                                                                           |
| `account_label`         | string  | O           | Partner-defined label used to identify the collection account.                                                                                                                                            |
| `account_no`            | string  | M           | Virtual collection account number used to receive and reconcile incoming funds.                                                                                                                           |
| `account_no_type`       | integer | M           | <p>Type of primary account identifier associated with the collection account.<br>Supported values:<br><code>1</code> — Account<br><code>2</code> — IBAN<br><code>3</code> — PIX</p>                       |
| `alternate_no`          | string  | O           | Alternative reference associated with the collection account or transaction.                                                                                                                              |
| `alternate_no_type`     | integer | O           | <p>Type of alternate account identifier associated with the collection account.<br>Supported values:<br><code>1</code> — Account<br><code>2</code> — IBAN<br><code>3</code> — PIX</p>                     |
| `branch_code`           | string  | O           | Bank branch or clearing code required by the selected payment route.                                                                                                                                      |
| `bank_name`             | string  | O           | Name of the financial institution that holds the account.                                                                                                                                                 |
| `bank_address`          | string  | O           | Registered address of the financial institution that holds the account.                                                                                                                                   |
| `bank_country`          | string  | O           | Two-letter ISO 3166-1 alpha-2 code of the country where the bank account is held.                                                                                                                         |
| `routing_code`          | string  | O           | Bank routing or clearing code required by the selected payment route.                                                                                                                                     |
| `routing_code_type`     | string  | O           | Type of bank routing code associated with the collection account.                                                                                                                                         |
| `currency`              | string  | M           | Three-letter ISO 4217 code of the currency in which the collection account values are denominated.                                                                                                        |
| `created_at`            | string  | M           | <p>Date and time when the collection account was created.<br>Format: <code>yyyy-MM-dd HH:</code>​<code>mm:ss</code>.</p>                                                                                  |

**Related APIs**

* [Apply Collection Account](https://docs.pagsmile.com/remittance-api/business/collection/apply-collection-account)
* [Apply Collection Account Result Notification](https://docs.pagsmile.com/remittance-api/business/collection/apply-collection-account-result-notification)
* [Collection Notification](https://docs.pagsmile.com/remittance-api/business/collection/collection-notification)
* [Query Apply Collection Account Result](https://docs.pagsmile.com/remittance-api/business/collection/query-apply-collection-account-result)
* [Query Collection Accounts](https://docs.pagsmile.com/remittance-api/business/collection/query-collection-accounts)
* [Query Collections](https://docs.pagsmile.com/remittance-api/business/collection/query-collections)
