5. Order Inquiry

  • Introduction:
    This endpoint allows querying the details and current status of a transfer order using its identifier.
  • Endpoint: /v1/transfer/order-inquiry
  • Method: GET

Request Parameters

Field Type Required Description
transferId string N Unique identifier of the transfer order. At least one of transferId or merchantTranId field must be provided.
merchantTranId string N (Optional) Merchant’s unique order identifier.

Response Fields

Field Type Description
transferId string Unique transfer order identifier.
merchantTranId string Merchant’s unique order identifier.
amount number Amount transferred.
payerAccountId string Identifier of the payer’s account.
beneficiaryAccountId string Identifier of the beneficiary’s account.
status string Current order status: Init, Processing, Success, Fail, Expired, Refund.
reason string Reason for failure when status is Fail.
qrCodeString string Dynamic QR code value when order is pending or processing.
expireAt string Expiration timestamp of the QR code (ISO 8601).
fundArrivalTime string Actual fund arrival time once the transfer is complete (ISO 8601).
fees array Breakdown of fees applied (see example below).
estReceiveAestTotalFeemount Number Estimated fee amount
estTotalFeeCurrency String Estimated fee currency

Fees Structure

{
  "feeType": "ourFee",
  "feeAmount": 107.89,
  "feeCurrency": "USD"
}

Response Example

{
  "status": 200,
  "code": null,
  "msg": "OK",
  "data": {
    "transferId": "trans_1234567890",
    "merchantTranId": "order_001",
    "amount": 100.5,
    "payerAccountId": "acct_payer_abc",
    "beneficiaryAccountId": "acct_bene_xyz",
    "status": "Success",
    "fundArrivalTime": "2025-06-20T12:20:00Z",
    "estTotalFee": "207.89",
    "estTotalFeeCurrency": "USD",
    "fees": [
      {
        "feeType": "swiftFee",
        "feeAmount": 100,
        "feeCurrency": "USD"
      },
      {
        "feeType": "ourFee",
        "feeAmount": 107.89,
        "feeCurrency": "USD"
      }
    ]
  },
  "traceId": "Auto:75f476b99c26423d93c93682dd4ce030"
}
  • For pending or processing orders:
{
  "transferId": "trans_1234567890",
  "merchantTranId": "order_001",
  "amount": 100.5,
  "payerAccountId": "acct_payer_abc",
  "beneficiaryAccountId": "acct_bene_xyz",
  "status": "Pending",
  "qrCodeString": "0002012636...",
  "expireAt": "2025-06-20T10:00:00Z",
  "fees": [],
  "traceId": "8bf891c6-1a1d-4621-99e5-97d7cf704422"
}

Error Response Example

{
  "status": 400,
  "code": "INQUIRY0001",
  "message": "Invalid transferId: abc123",
  "traceId": "e8b6f3c4-1a2d-4f5e-b678-1234567890ab"
}
code message meaning
INQUIRY0001 Invalid transferId: abc123 The specified transferId was not found.
INQUIRY0002 Invalid merchantTranId: xyz The specified merchantTranId does not match record.
INQUIRY0000 Internal server error Unexpected error—please retry or contact support.
  • Notes:
    • Both transferId and merchantTranId can be used; provide at least one.
    • When status is Pending or Processing, the qrCodeString and expireAt fields will be populated.
    • Once status is Success, the fundArrivalTime field indicates when funds were delivered.

results matching ""

    No results matching ""