Skip to main content
To onboard a new agent merchant, you submit their KYC data to Gcashier Pay via this endpoint. Gcashier Pay validates the payload in real time and responds with an ACCEPT status once the submission is received. The final approval or rejection is then delivered asynchronously to the callbackUrl you provide, through the sp3101 webhook.
This API uses a two-phase response model. The synchronous response only confirms receipt (ACCEPT). The definitive review outcome — including your assigned merchantNo and token — arrives via the sp3101 notification webhook. Make sure your callbackUrl is publicly reachable before submitting.

Endpoint


Request Parameters

Top-Level Fields

string(32)
Your unique order reference for this application. You can use this to correlate the sp3101 callback with your internal records. O
string(255)
required
Contact email address for the merchant. Used for review notifications when noticeMarker is 1. M
string(10)
required
International dialling code for the merchant’s phone number, e.g. 852 for Hong Kong. M
string(32)
required
Merchant contact phone number, without the area code. M
string(16)
required
Referral agent number assigned to you by Gcashier Pay. Required for all agent-submitted applications. M
string(2)
required
ISO 3166-1 alpha-2 country code for the merchant’s registered jurisdiction, e.g. HK, US, CN. M
string(255)
required
Merchant’s legal English company name, exactly as it appears on the business registration certificate. M
string(255)
Merchant’s Chinese company name. Required when countryCode is CN. O
string(128)
required
City where the merchant’s principal office is located. M
string(255)
required
Full physical address of the merchant’s registered office. M
string(1)
required
Type of office premises. M
string(18)
required
Business registration or company license number. M
List<String>
required
SFTP file paths to the merchant’s business registration documents uploaded via the Gcashier Pay file upload service, e.g. ["uploadFile/reg_cert.png"]. M
string(255)
Merchant’s corporate website URL. O
string(255)
Trading website or mobile app URL used by end-customers. Required when businessNature.natureType is 2 (E-commerce). O
List<String>
required
ISO alpha-2 codes of the countries where the merchant’s main customers are located, e.g. ["US", "GB"]. M
string(1)
required
Indicates whether the business is primarily operated by a company or individuals. M
string(1)
required
Previous year’s annual turnover range in USD. M
string(1)
required
Expected monthly transaction volume in USD. M
List<String>
required
Codes indicating the source of the merchant’s operating funds. Refer to the Enums appendix for valid values, e.g. ["03"]. M
List<String>
required
Codes describing the purpose of payments. Refer to the Enums appendix for valid values, e.g. ["26"]. M
string(2)
required
Whether the merchant conducts business with sanctioned jurisdictions (Iran, DPRK, Cuba). M
List<String>
required
Codes representing the type of identity documents held by the merchant’s customers. Refer to the Enums appendix for valid values. M
List<personInfo>
required
Identity documents for the merchant’s authorised representative(s). See the personInfo schema below. M
List<personInfo>
required
Identity documents for all beneficial owners holding more than 25% of shares. See the personInfo schema below. M
List<personInfo>
Identity documents for company directors. C — Required for merchants registered outside mainland China.
Identity documents for the legal representative. C — Required when countryCode is CN.
List<String>
required
SFTP paths to the board resolution or power-of-attorney documents authorising the application, e.g. ["uploadFile/board_resolution.pdf"]. M
string(2)
required
Whether the merchant has a parent company. 0 = No, 1 = Yes. M
string(2)
required
Whether the merchant has subsidiaries or branch offices. 0 = No, 1 = Yes. M
string(1)
required
Controls whether Gcashier Pay sends review status notifications to the merchant by email and SMS. 0 = Do not notify, 1 = Notify. M
string(255)
required
Your publicly accessible HTTPS endpoint that will receive the sp3101 webhook once the review is complete. M
string(10)
Process version identifier. Supply this when resubmitting an application after receiving a process ID of V2 or later. O

businessNature Object

object
required
Describes the merchant’s primary line of business. M

personInfo Object

The following schema applies to the customerId, shareholder, director, and legalPerson arrays.
string(2)
required
Document type. 0 = National ID Card, 1 = Passport. M
string(2)
required
ISO alpha-2 code of the country that issued the document, e.g. HK. M
string(64)
required
Full name exactly as it appears on the identity document. M
string(32)
required
Document number (passport number or ID card number). M
List<String>
required
SFTP paths to scanned images of the identity document. For ID cards, supply [front_image, back_image]. M
string(10)
Date of birth in yyyy-MM-dd format. O
string(10)
Document expiry date in yyyy-MM-dd format. Use 9999-12-31 for documents with no expiry. O
string(2)
required
ISO alpha-2 code of the person’s current country of residence. M
string(255)
required
Full current residential address of the person. M

Request Example


Response Body

string(32)
required
Gcashier Pay’s internal business order number for this application. Store this value — you will need it to track the review and to submit any modifications via sp1102. M
string(32)
Echo of the merOrderNo you submitted in the request, if provided. O
string(6)
required
Synchronous processing status. Always ACCEPT for a successful submission, indicating the payload passed validation and has been queued for review. M
string(6)
required
Result code. S00001 means the application was received and is awaiting manual review. M
string(255)
required
Human-readable description of the result, e.g. "ACCEPT". M

Response Example


Notes

The ACCEPT status in the synchronous response only confirms that Gcashier Pay has received and validated your submission. The actual approval decision is delivered asynchronously via the sp3101 webhook posted to your callbackUrl. Do not treat ACCEPT as final approval.
Before going live, verify that your callbackUrl returns an HTTP 200 response to POST requests. Gcashier Pay will retry failed webhook deliveries, but delays in receipt can slow down your merchant’s onboarding.
All file paths in certificate, authorization, and certificates fields inside personInfo must be valid SFTP paths obtained from the Gcashier Pay file upload service. Submitting local file names or external URLs will cause the application to be rejected.