Query Payment Orders

Retrieves payment orders for a merchant within a specified time range, with optional filters and pagination.

Endpoint

POST /remittance/payment/query-orders

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.

Requirement: M = Mandatory, O = Optional, and C = Conditional. A conditional field is mandatory only when the condition stated in its description applies.

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

Field	Type	Requirement	Description
merchant_id	long	O	Pagsmile-assigned unique identifier of the merchant.
order_no	string	O	Merchant-defined order number used to submit, query, and reconcile the payment order.
order_status	integer	O	Current processing status of the order. See Order Status for supported values.
account_no	string	O	Merchant account number from which the payment amount is debited.
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.

query max time range 7 days

Plaintext biz_data example

This example includes mandatory fields and representative optional or conditional fields. Submit fields marked C only when the condition in the field description applies.

{
  "merchant_id": 100398,
  "order_no": "ORDER_202607200001",
  "order_status": 5,
  "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

curl --request POST \
  --url https://rem-api-sandbox.pagsmile.com/remittance/payment/query-orders \
  --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>"
  }'

Use the partner_id and app_id assigned to your integration. The values above are placeholders.

Response

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 for implementation details.

Encrypted response example

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

Decrypted data example

[
  {
    "order_id": 200002,
    "merchant_id": 100398,
    "account_no": "1234567890",
    "transaction_id": 300002,
    "order_no": "ORDER_202607200001",
    "order_status": 5,
    "audit_status": 2,
    "bank_country": "BR",
    "payment_currency": "USD",
    "payment_amount": "100.00",
    "fee": "2.50",
    "payed_at": "2026-07-20 10:35:00",
    "refund_transaction_id": 300003,
    "return_fee": "2.50",
    "refunded_at": "2026-07-20 11:00:00",
    "beneficiary_name": "Example Company",
    "beneficiary_id": 100001,
    "reference": "Invoice INV-20260720-001",
    "error_message": "",
    "created_at": "2026-07-20 10:30:00"
  }
]

Invalid signature

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

Response data fields

Field	Type	Requirement	Description
order_id	long	M	Pagsmile-assigned unique identifier of the order.
merchant_id	long	M	Pagsmile-assigned unique identifier of the merchant associated with the returned record.
account_no	string	M	Merchant account number from which the payment amount is debited.
transaction_id	long	O	Pagsmile-assigned unique identifier of the transaction.
order_no	string	M	Merchant-defined order number used to submit, query, and reconcile the payment order.
order_status	integer	M	Current processing status of the order. See Order Status for supported values.
audit_status	integer	O	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
bank_country	string	O	Two-letter ISO 3166-1 alpha-2 code of the country where the bank account is held.
payment_currency	string	O	Three-letter ISO 4217 code of the payment currency.
payment_amount	string	O	Payment amount expressed in the payment currency.
fee	string	O	Service fee charged for the transaction, expressed in the corresponding currency.
payed_at	string	O	Date and time when the order was paid. Format: yyyy-MM-dd HH:​mm:ss.
refund_transaction_id	long	O	Pagsmile-assigned unique identifier of the refund transaction.
return_fee	string	O	Fee returned as part of the refund or reversal.
refunded_at	string	O	Date and time when the refund was completed. Format: yyyy-MM-dd HH:​mm:ss.
beneficiary_name	string	O	Name of the payment beneficiary.
beneficiary_id	long	O	Pagsmile-assigned unique identifier of the payment beneficiary.
reference	string	O	Merchant-provided reference used to reconcile the transaction with the merchant's internal records.
error_message	string	O	Human-readable explanation provided when processing fails.
created_at	string	O	Date and time when the payment order was created. Format: yyyy-MM-dd HH:​mm:ss.

Related APIs

• Create Beneficiary

• Create Payment Order

• Delete Beneficiary

• Payment Result Notification

• Query Beneficiary Detail

• Query Payment Fields

• Update Beneficiary