Skip to content
For the complete documentation index, see llms.txt. This page is also available as Markdown.

Query Exchange Order Detail

Retrieves one exchange order by order_no or exchange_id. Provide at least one query identifier. Both identifiers may be supplied in the same request.

Endpoint

POST /remittance/exchange/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.

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

Request body

Decrypted biz_data fields

Field
Type
Requirement
Description

order_no

string

C

Merchant-defined order number. Required when exchange_id is omitted. Provide at least one of order_no or exchange_id. Both fields may be supplied in the same request.

Length: 16–36 characters.

exchange_id

long

C

Pagsmile-assigned unique identifier of the exchange. Required when order_no is omitted. Provide at least one of order_no or exchange_id. Both fields may be supplied in the same request.

max query 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.

{
  "order_no": "ORDER_202610220001",
  "exchange_id": 200001
}

Request example

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

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

Field
Type
Requirement
Description

exchange_id

long

M

Pagsmile-assigned unique identifier of the exchange order.

merchant_id

long

M

Pagsmile-assigned unique identifier of the merchant associated with the returned record.

order_no

string

M

Merchant-defined order number used to submit, query, and reconcile the foreign-exchange order.

Length: 16–36 characters.

order_status

integer

M

Current processing status of the order. See Order Status for supported values.

sell_currency

string

O

Three-letter ISO 4217 code of the currency being sold.

sell_amount

string

O

Amount of the sell currency in the foreign-exchange transaction.

buy_currency

string

O

Three-letter ISO 4217 code of the currency being purchased.

buy_amount

string

O

Amount of the buy currency in the foreign-exchange transaction.

fixed_side

string

O

Specifies whether the sell amount or buy amount is fixed when calculating the quote. See Fixed Side for supported values.

conversion_rate

string

O

Conversion rate applied between the sell and buy currencies.

transaction_out_id

long

O

Pagsmile-assigned unique identifier of the outgoing exchange transaction that debits the sell-currency account.

transaction_in_id

long

O

Pagsmile-assigned unique identifier of the incoming exchange transaction that credits the buy-currency account.

error_message

string

O

Human-readable explanation provided when processing fails.

created_at

string

O

Date and time when the foreign-exchange order was created. Format: yyyy-MM-dd HH:​mm:ss.

Related APIs

Last updated