| Name |
Type& Max |
Description |
Requirement |
| merchantId |
varchar(9) |
The unique identity of the merchant in Geoswift system. Merchant can log in the merchant operation and management system to check |
M |
| requestId |
varchar(50) |
The order number is generated by the merchant and the order number must be the only one on the merchant platform transaction. Request/order which had been paid or cancel in Geoswift’s platform can’t be submitted with same requestId. |
M |
| requestCreditedAmount |
varchar(18) |
UNIT: China fen; Between the parameters requestCreditedAmount and amount, only one of the parameters can be picked as the mandatory parameter and the picked one must be assigned the value and passed viathis interface |
C |
| amount |
varchar(18) |
UNIT: China fen，1 Yuan=100 Fen; Between the parameters requestCreditedAmount and amount, only one of the parameters can be picked as the mandatory parameter and the picked one must be assigned the value and passed via this interface |
C |
| currency |
fixed value |
EUR |
M |
| GBP |
| CAD |
| SGD |
| AUD |
| JPY |
| USD |
| HKD |
| CNY |
| notifyUrl |
varchar(200) |
Server notification： Notification will be sent to the address after remittance is final status.This address can take parameters(Send mechanism see "Interface Rules") example: “www.geoswift.com/callback.action?test =test”. Note: if the parameter value of notifyUrl is not filled, your server will not receive the notice of remittance result. |
O |
| tradePostscript |
varchar(256) |
Remittance postscript |
O |
| sourceCountry |
char(3) |
Currency source country, 3-bit code. See attachment code table. |
M |
| payee |
Json |
Please refer to the table "Request Parameter Fields （ payee ， payee’s information）" |
|
| payer |
Json |
Please refer to the table "Request Parameter Fields （ payer ， payer information）" |
|
| fundPurpose |
fixed value |
The following values apply to all currencies, for recipients who are residents of mainland China:
| M |
| SALARY |
| FAMILY_FUND |
| OTHER (personal Red Packet) |
| -------------------------------- |
| The following values apply to CNY for recipients who are non-residents of mainland China: |
| STUDYING_ABROAD (Tuition and living expenses for studying abroad) |
| TRAINING_ABROAD (Training fees and living expenses abroad) |
| SIGHTSEEING (Tourism) |
| BUSINESS_TRAVEL (Business travel) |
| MEDICAL_ABROAD (Medical expenses abroad) |
| HKMT (Remittance for residents of Hong Kong, Macao, and Taiwan) |
| payeeAccount |
Json |
Please refer to the table "Request Parameter Fields（payeeAccount，payee account information）" |
C |
| partnerId |
varchar(9) |
The unique identifier of the secondary merchant under the main merchant in the Geoswift system.
Note: this parameter can be omitted if the initiating merchant is the main merchant. |
C |
| hmac |
- |
The result of parameter signature,generated by the merchant.For the method of obtaining hmac,please reference to "Geoswift encryption and decryption process specification" |
M |
| Name |
Type& Max |
Description |
Requirement |
| name |
varchar(50) |
Chinese phonetic alphabet of payee's name (both name and nameZh are recommended to use, if only one is needed, please consult technical support in advance) |
C |
| nameZh |
varchar(50) |
Chinese name of payee (both name and nameZh are recommended to use, if only one is needed, please consult technical support in advance) |
C |
| payeeBirthday |
varchar(8) |
Payee's birthday; Format: yyyyMMdd |
O |
| swiftCode |
varchar(11) |
Payee's bank swift code |
O |
| idType |
fixed value |
01 Resident identity card number |
M |
| 03 Passport |
| 05 Others |
| idNum |
varchar(18) |
Id number |
M |
| phoneNum |
varchar(11) |
Payee’s phone number |
O |
| bankCardNum |
varchar(19) |
Bank card number.Please see "Code List"->"BIN List"->"Download" for the current supporting bank list & BIN list.When the accountType is BANK_CARD,the bankCardNum is required |
M |
| bankName |
varchar(100) |
Bank name |
O |
| bankAddress |
varchar(100) |
Bank address |
O |
| bankCity |
varchar(50) |
Bank City |
O |
| payeeIdEffectDateStart |
varchar(8) |
Effective date of payee's certificate Format:yyyyMMdd |
O |
| payeeIdEffectDateEnd |
varchar(8) |
Expiry date of payee's certificate Format:yyyyMMdd |
O |
| payeeAddress |
varchar(200) |
Detailed address of payee |
M |
| payeeAreaCode |
varchar(50) |
The region code of the payee is the level 3 code of the area code. If there is no level 3 code, the level 2 code will be transferred. See the coding table |
O |
| payeeProfessionCode |
varchar(50) |
Payee's profession code, according to the three-level code of profession code, see the attachment code table |
O |
| payeeGender |
fixed value |
MALE |
O |
| FEMALE |
| firstName |
varchar(32) |
Payee firstname, English or Chinese phonetic alphabet |
O |
| lastName |
varchar(32) |
Payee lastName, English or Chinese phonetic alphabet |
O |
| Name |
Type& Max |
Description |
Requirement |
| name |
varchar(50) |
Payer’s name(Chinese Pin Yin/English characters); Company name is not accepted |
M |
| idType |
fixed value |
01: National ID card (applies to all currencies) |
M |
| 02: Chinese passport (applies to remittances in CNY) |
| 03: Passport (applies to remittances in non-CNY currencies) |
| 04: Overseas passport (applies to remittances in CNY) |
| 05: Other document types (applies to all currencies) |
| 06: Taiwan Resident Permit for Mainland China Entry (applies to remittances in CNY) |
| 07: Hong Kong and Macao Resident Permit for Mainland China Entry (applies to remittances in CNY) |
| idNum |
varchar(18) |
Id number |
M |
| bankCardNum |
varchar(19) |
The bank card number or account number of the payer for the source of funds; If paying in cash, please provide the registered user ID of the payer with the institution. |
M |
| payerCountry |
char(3) |
Payer's country code(3-digit) |
M |
| address |
varchar(100) |
Payer's address; Needed to be specific up to the street level |
M |
| birthday |
varchar(50) |
Payer’s birthday |
O |
| swiftCode |
varchar(11) |
Payer’s bank swift code |
O |
| bankName |
varchar(100) |
Bank name |
O |
| bankAddress |
varchar(100) |
Bank address |
O |
| bankCity |
varchar(50) |
Bank city |
O |
| firstName |
varchar(32) |
Payer firstname, English or Chinese phonetic alphabet |
O |
| lastName |
varchar(32) |
Payer lastName, English or Chinese phonetic alphabet |
O |
| payerCity |
varchar(40) |
Payer's city of residence |
M |
| payerNameZh |
varchar(50) |
Payer’s Chinese name
Required when the fund purpose is "HKMT." |
C |
| payerGender |
fixed value |
MALE |
O |
| FEMALE |
| Name |
Description |
| merchantId |
The same as the request parameter |
| requestId |
The same as the request parameter |
| serialNumber |
The unique Id generated by Geoswift system |
| amount |
Unit： Fen 1 Yuan=100 Fen |
| requestCreditedAmount |
The same as the request parame |
| payerCountry |
Currency source country, reference to the code list.xlsx |
| currency |
USD、JPY、EUR、SGD、GBP、CAD、AUD、HKD |
| tradePostscript |
Remittance postscript |
| status |
SUCCESS Request submit successfully |
| ERROR The error of request or process, check the data or contact with Geoswift according to the error Message. |
| businessStatus |
INIT |
| PROCESSING |
| FAILED |
| SUCCESS |
| feeAmount |
Fee amount Unit: Fen, 1 Yuan =100 Fen |
| feeCurrency |
E.g. USD |
| creditedAmount |
Final amount that the payer received Unit: Fen, 1 Yuan =100 Fen |
| creditedCurrency |
CNY Final currency that the payer received |
| rate |
List price |
| completeDateTime |
E.g. 2020-09-23 17:26:38 |
| errorMsg |
Error message |
| partnerId |
The same as the request parameter |
| hmac |
The result of parameter signature,generated by Geoswift.For the signature verification process,please reference to "Geoswift encryption and decryption process specification" |
| Name |
Description |
| merchantId |
The same as the request parameter |
| requestId |
The same as the request parameter |
| serialNumber |
The unique Id generated by Geoswift system |
| amount |
Unit:Fen, 1 Yuan = 100 Fen |
| requestCreditedAmount |
The same as the request parame |
| payerCountry |
Currency source country, reference to the code list.xlsx |
| currency |
USD、JPY、EUR、SGD、GBP、CAD、AUD、HKD The same as the request parameter |
| tradePostscript |
Remittance postscript |
| businessStatus |
FAILED |
| SUCCESS |
| CANCEL |
| feeAmount |
Fee amount Unit: Fen, 1 Yuan =100 Fen |
| feeCurrency |
E.g. USD |
| creditedAmount |
Final amount that the payer received Unit: Fen, 1 Yuan =100 Fen |
| creditedCurrency |
CNY Final currency that the payer received |
| rate |
List price |
| completeDateTime |
E.g. 2020-09-23 17:26:38 |
| errorMsg |
Error message |
| partnerId |
The same as the request parameter |
| hmac |
The result of parameter signature,generated by Geoswift.For the signature verification process,please reference to "Geoswift encryption and decryption process specification" |