Query Collections
Retrieves incoming collection transactions for a merchant within a specified time range, with optional account filters and pagination.
Endpoint
POST /remittance/collection/query-collections
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.
Request body
Decrypted biz_data fields
merchant_id
long
M
Pagsmile-assigned unique identifier of the merchant.
collection_account_no
string
O
Account number of the collection account.
collection_unique_no
string
O
Globally unique reference assigned to the collection transaction.
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
integer
O
One-based page number of the result set.
Default: 1.
page_size
integer
O
Maximum number of records returned on each page.
Default: 10.
Maximum: 30.
Plaintext biz_data example
{
"merchant_id": 100398,
"collection_account_no": "1234567890",
"collection_unique_no": "COLLECTION_202607200001",
"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_id
long
M
Pagsmile-assigned unique identifier of the collection transaction.
merchant_id
long
M
Pagsmile-assigned unique identifier of the merchant associated with the returned record.
material_id
long
O
Pagsmile-assigned unique identifier of the material record.
collection_account_no
string
M
Account number of the collection account.
receive_amount
string
M
Amount credited in the receiving currency.
receive_currency
string
M
Three-letter ISO 4217 code of the currency credited to the recipient.
fee
string
O
Service fee charged for the transaction, expressed in the corresponding currency.
arrived_at
string
M
Date and time when the funds arrived.
Format: yyyy-MM-dd HH:mm:ss.
collection_unique_no
string
M
Globally unique reference assigned to the collection transaction.
audit_status
integer
M
Current compliance or material review status of the record.
Supported values:
1 — Reviewing
2 — Approved
11 — Rejected
7 — To be linked
15 — To be supplemented
comments
string
O
Review comments or reason for rejection or failure, when provided.
sender.name
string
O
Name of the sender that originated the collection transaction.
sender.account_no
string
O
Account number from which the collection funds were sent.
sender.account_type
string
O
Type of the sender's bank account.
sender.descriptor
string
O
Statement descriptor or reference supplied for the sender.
sender.id_type
string
O
Type of identity document supplied for the sender.
sender.id_number
string
O
Identity document number supplied for the sender.
transaction_id
long
O
Pagsmile-assigned unique identifier of the transaction.
Related APIs
Last updated