Query Withdrawal Orders
Retrieves withdrawal orders for a merchant within a specified time range, with optional filters and pagination.
Endpoint
POST /remittance/withdrawal/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.
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
O
Pagsmile-assigned unique identifier of the merchant on whose behalf the request is submitted.
order_no
string
O
Merchant-defined order number used to submit, query, and reconcile the withdrawal order.
account_num
string
O
Registered bank account number to which the withdrawal is sent.
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
Request example
Response
Response data fields
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 withdrawal order.
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 withdrawal order.
order_status
integer
M
Current processing status of the withdrawal order. See Order Status for supported values.
audit_status
integer
O
Current compliance or material review status of the withdrawal order.
bank_country
string
O
Two-letter ISO 3166-1 alpha-2 code of the country where the bank account is held.
pay_currency
string
O
Three-letter ISO 4217 code of the currency debited for the transaction.
pay_amount
string
O
Amount debited 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
Unique identifier of the refund transaction.
refund_fee
string
O
Fee charged or returned as part of the refund.
refunded_at
string
O
Date and time when the refund was completed. Format: yyyy-MM-dd HH:mm:ss.
receive_currency
string
M
Three-letter ISO 4217 code of the currency credited to the recipient.
receive_amount
string
M
Amount credited in the receiving currency.
account_num
string
O
Registered bank account number to which the withdrawal is sent.
payee_name
string
O
Name of the payee or withdrawal beneficiary.
payee_id
long
O
Unique identifier of the payee or withdrawal beneficiary.
reference
string
O
Merchant-provided reference used to reconcile the withdrawal order 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 withdrawal order was created. Format: yyyy-MM-dd HH:mm:ss.
Related APIs
Last updated
Was this helpful?