Skip to main content
The payee identified by payeeId must be pre-registered via sp1401 with payeeType set to OVERSEAS_PAYEE before you can submit a remittance.
POST https://{baseUrl}/api/sp1302
Call sp1302 to retrieve a real-time quote for an international remittance. The response includes a quoteId that locks the rate and fee structure for a limited time window.

​
Request Parameters

​
merOrderNo
string
required
Your unique merchant order number for this remittance quote. Must be unique per request.
​
feeDirection
string
required
Determines who bears the transaction fees.
  • SHA — fees are shared between sender and recipient.
  • OUR — the sender (you) bears all fees. Required for SWIFT payments.
​
arriveCurrency
string
required
ISO 4217 currency code the recipient will receive (e.g. USD).
​
debitCurrency
string
required
ISO 4217 currency code to be debited from your account (e.g. CNY).
​
payType
string
required
Payment network to use (e.g. SWIFT). Contact your account manager for the full list of supported values for your region.
​
accountType
string
required
Payee account type code. 1 = individual, and other values as defined in the Enums appendix.
​
arriveAmount
string
The amount the recipient should receive. Provide either arriveAmount or debitAmount — not both. If both are supplied, arriveAmount takes precedence.
​
debitAmount
string
The amount to debit from your account. Provide either debitAmount or arriveAmount — not both.
​
purpose
string
required
Remittance purpose code. Valid values are 1–31 and 99. See Appendix 6.1 for the full purpose code reference table.
​
payeeId
string
required
The Gcashier Pay payee identifier for the overseas recipient. Must be registered with payeeType=OVERSEAS_PAYEE via sp1401.
​
poboFlag
string
Set to 1 to initiate a same-name POBO (Payment on Behalf Of) transfer. Omit or leave blank for standard payments.

​
Response Body

​
debitCurrency
string
Currency to be debited from your account.
​
arriveCurrency
string
Currency the recipient will receive.
​
rate
string
The locked exchange rate for this quote.
​
debitAmount
string
The amount that will be debited from your balance.
​
arriveAmount
string
The amount the recipient will receive.
​
quoteId
string
Unique identifier for this quote. Pass this to sp1303 to confirm the remittance. The quote is only valid until expireTime.
​
expireTime
number
Unix timestamp in milliseconds. You must call sp1303 before this time or the quote will expire.
​
merOrderNo
string
Echo of your merchant order number.
{
  "merOrderNo": "335621309488900",
  "feeDirection": "SHA",
  "arriveCurrency": "USD",
  "debitCurrency": "CNY",
  "payType": "SWIFT",
  "accountType": "1",
  "arriveAmount": "100",
  "purpose": "26",
  "payeeId": "832b1bbaa5c04e5190342669438be566"
}

{
  "debitCurrency": "CNY",
  "arriveCurrency": "USD",
  "rate": "7.1250",
  "debitAmount": "712.50",
  "arriveAmount": "100",
  "quoteId": "1343536422882177024",
  "expireTime": 1576560599598,
  "merOrderNo": "335621309488900"
}

​
Sandbox Testing

In the sandbox environment, the final remittance result is determined by the single digit of the submitted amount:
DigitSimulated Result
0 – 3Success (SUCC)
4 – 6Rejected (FAIL)
7 – 9No action (remains in processing)