Query Collection Accounts
Retrieves collection accounts for a merchant within a specified time range, with optional filters and pagination.
Endpoint
POST /remittance/collection/query-collection-accounts
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. The fields below describe the decrypted biz_data object.
Encrypt biz_data, encrypt the AES key into random_key, and sign the request according to the Common request specification.
Request body
Decrypted biz_data fields
merchant_id
long
M
Pagsmile-assigned unique identifier of the merchant.
currency
string
O
Three-letter ISO 4217 code of the currency in which the collection account values are denominated.
account_no
string
O
Virtual collection account number used to receive and reconcile incoming funds.
start_date
string
M
Start of the query period, inclusive.
Format: yyyy-MM-dd HH:mm:ss.
end_date
string
M
End of the query period, inclusive.
Format: yyyy-MM-dd HH:mm:ss.
page_num
int
O
One-based page number of the result set.
Default: 1.
page_size
int
O
Maximum number of records returned on each page.
Default: 10.
Maximum: 30.
Plaintext biz_data example
{
"merchant_id": 100398,
"currency": "USD",
"account_no": "1234567890",
"start_date": "2026-07-20 00:00:00",
"end_date": "2026-07-20 23:59:59",
"page_num": 1,
"page_size": 10
}Request example
Response
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 for implementation details.
Encrypted response example
Decrypted data example
Response data fields
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
Payment route used to deliver funds to the recipient. See Payment Type for supported values.
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
Type of primary account identifier associated with the collection account.
Supported values:
1 — Account
2 — IBAN
3 — PIX
alternate_no
string
O
Alternative reference associated with the collection account or transaction.
alternate_no_type
integer
O
Type of alternate account identifier associated with the collection account.
Supported values:
1 — Account
2 — IBAN
3 — PIX
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
Date and time when the collection account was created.
Format: yyyy-MM-dd HH:mm:ss.
Related APIs
Last updated
Was this helpful?