Query Payment Order Detail
Retrieves one payment order by order_no or payment_id. Provide at least one query identifier. Both identifiers may be supplied in the same request.
Endpoint
POST /remittance/payment/query-order
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
order_no
string
C
Merchant-defined order number. Required when payment_id is omitted. Provide at least one of order_no or payment_id. Both fields may be supplied in the same request.
Length: 16–36 characters.
payment_id
long
C
Pagsmile-assigned unique identifier of the payment. Required when order_no is omitted. Provide at least one of order_no or payment_id. Both fields may be supplied in the same request.
Plaintext biz_data example
{
"order_no": "ORDER_202610220001",
"payment_id": 200001
}Request example
curl --request POST \
--url https://rem-api-sandbox.pagsmile.com/remittance/payment/query-order \
--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>"
}'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
payment_id
long
M
Pagsmile-assigned unique identifier of the payment 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.
Length: 16–36 characters.
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
Last updated