Overview
1
Open a VA account (sp1103)
Request a virtual account for a specific currency and country.
2
Receive VA opening notification (sp3102 webhook)
Gcashier Pay delivers your account number, bank name, and SWIFT code.
3
Query VA details (sp2101)
Retrieve your active VAs and their current status at any time.
4
Receive trade receipt notification (sp3103 webhook)
Gcashier Pay notifies you when funds arrive on a VA.
5
Create a trade order (sp1104)
Submit the underlying commercial transaction matching the received funds.
6
Associate the collection flow with the trade order (sp1105)
Link the incoming payment flow to your trade order for compliance clearance.
Step 1 — Open a VA Account
Call POST /api/sp1103 to request a new virtual account. Each VA is tied to a specific currency, country, and business type (identified byparentCode).
parentCode Values
Choose the
parentCode that best matches your primary business model. This affects the compliance documents and trade order types required for each collection flow.Request Example
status of ACCEPT means the VA application has been received. The actual account details are delivered asynchronously via the sp3102 webhook.
Step 2 — Receive the VA Opening Notification
Gcashier Pay posts the VA details to yourcallbackUrl once the account is ready. Save accountNo and swiftCode — these are what your buyers will use to send funds.
sp3102 Webhook Payload
Step 3 — Query VA Details
Use POST /api/sp2101 to retrieve all VAs associated with your merchant account, or look up a specific VA bybizFlow or merOrderNo.
Step 4 — Receive Trade Receipt Notifications
When a buyer transfers funds to your VA, Gcashier Pay fires the sp3103 webhook to your callback URL. This delivers the inboundflowNo that you’ll use when associating the payment with a trade order.
sp3103 Webhook Payload
Step 5 — Create a Trade Order
Before you can withdraw or exchange the received funds, you must submit a trade order that documents the underlying commercial transaction. Call POST /api/sp1104 with the goods or services details matching the payment.Request Example
Save the
contractNo — you’ll reference it when associating the collection flow in the next step.
sp3104 Webhook — Trade Order Result
Step 6 — Associate the Collection Flow with a Trade Order
Link the inbound payment (flowNo from sp3103) to your approved trade order (contractNo from sp1104) by calling POST /api/sp1105. This step is required before the collected funds can be released for exchange or withdrawal.
sp3105 Webhook — Association Result
You can also query association status at any time via POST /api/sp2104 using
bizFlow.
