Remit money to a specific bank account or mobile wallet
https://api.geoswift.com/ofr/remitOrder/create
| Name | Type & Max | Description | Requirement |
|---|---|---|---|
| merchantId | varchar(9) | The unique identity of the merchant in Geoswift system | M |
| requestId | varchar(50) | The requestId is an ID generated by the merchant. This ID is unique for each merchant and can be used for ensuring the uniqueness of the request. If the ID has been used previously, the system will respond “order already exists” | M |
| remitPurpose | - | The purpose of remittance: | M |
| WAGE | |||
| FAMILY_MAINTENANCE | |||
| PAYMENT_SERVICES | |||
| GOODS | |||
| EDUCATION_FEE | |||
| OTHER | |||
| PERSONAL_TRANSFER | |||
| RENT (Rental fee) | |||
| ELEC (Utilities fee) | |||
| TAX (Tax fee) | |||
| SOFTWARE (Software service fee) | |||
| AD (Advertisting service fee) | |||
| COMMISSION (Commision fee) | |||
| quotationId | varchar(32) | The serialNumber parameter returned by quotation create or query interface | C |
| originalCountry | - | Original remittance country code | M |
| targetAmount | long(18) | Target remittance amount.UNIT: China fen，1 Yuan=100 Fen It is required if there is no quotationId. | C |
| targetCurrency | - | Target remittance currency.It is required if there is no quotationId. | C |
| notifyUrl | varchar(200) | Server notification: When the remittance is final status(SUCCESS,FAILED,REVERSED, CANCELED) , there would be a notification sent to the address which could be parameterized(the send mechanism reference to the response mechanism).Example:“https://www.geoswift.com/callback. action?test=test ” Note: Your server would not receive the notification of remittance if the parameter value of notifyUrl wasn’t filled in. The notification parameters see table “Asynchronously Returned Parameter Fields” | O |
| postscript | varchar(200) | Remittance postscript | O |
| remark | varchar(200) | Remittance remark | O |
| extraRemark | varchar(200) | Extra remark | O |
| payer | JSON(array) | The information of the payer. Please reference table “Request Parameter Fields(payer)” | C |
| payee | JSON(array) | The information of the payee. Please reference table “Request Parameter Fields(payee)” | C |
| payeeAccount | JSON(array) | The information of the payee account. Please reference table "Request Parameter Fields(payeeAccount)" | M |
| proveFiles | JSON(array) | The information of the prove files. Please refer to table "Request Parameter Fields(proveFiles)" | O |
| 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 |
|---|---|---|---|
| payerType | - | The type of payer | C |
| INDIVIDUAL | |||
| COMPANY | |||
| It is required if there is no quotationId. | |||
| lastName | varchar(100) | The last name of payer （When the payer is an individual, either lastname + firstname or fullname must be provided.） | C |
| middleName | varchar(100) | The middle name of payer | O |
| firstName | varchar(100) | The first name of payer （When the payer is an individual, either lastname + firstname or fullname must be provided.） | C |
| fullName | varchar(100) | The full name of payer in native language （When the payer is an individual, either lastname + firstname or fullname must be provided.） | C |
| companyName | varchar(100) | The company name of payer （Madatory to pass when the payer is a company） | C |
| companyRegistCerNo | varchar(50) | The registration certificate No of company Mandatory to pass when IDTYPE is REGISTCER. |
C |
| taxNo | varchar(50) | The tax number of company Mandatory to pass when IDTYPE is TAX. |
C |
| companyRegistDate | - | The registration date of the company. Format:yyyymmdd | O |
| companyRegistCountry | varchar(3) | The registration country of the company | O |
| birthday | - | The birthday of payer Format:yyyymmdd | O |
| birthCountry | - | The birth country code of payer | O |
| country | - | The country code of payer | M |
| province | varchar(20) | The province of payer | O |
| city | varchar(50) | The city of payer | M |
| address | varchar(255) | The address of payer | M |
| postcode | varchar(50) | The postcode of payer | O |
| gender | - | The gender of payer: | O |
| MALE | |||
| FEMALE | |||
| phoneNumber | varchar(50) | The phone number of payer | O |
| varchar(100) | The email number of payer | O | |
| idType | - | ID type of the payer: | M |
| IDCARD | |||
| PASSPORT | |||
| REGISTCER (Registration Certificate) | |||
| ITAX（Tax Registration Certificate） | |||
| OTHER | |||
| idNo | varchar(50) | ID number under the specified ID type.It is required when the payerType is INDIVIDUAL. | C |
| idEffectDateStart | - | The effective date of ID; Format:yyyymmdd | O |
| idEffectDateEnd | - | The expiry date of ID; Format:yyyymmdd | O |
| profession | varchar(50) | The profession of payer | O |
| bankName | varchar(100) | The bank name | O |
| bankCardNumber | varchar(50) | he bank account number | M |
| payeeRelation | - | Relationship with payee: | O |
| SELF | |||
| FATHER | |||
| MOTHER | |||
| SON | |||
| DAUGHTER | |||
| BROTHER | |||
| SISTER | |||
| GRANDFATHER | |||
| GRANDMOTHER | |||
| FRIEND | |||
| WIFE | |||
| HUSBAND | |||
| OTHER | |||
| fundResource | - | Source of fund: | O |
| CASH | |||
| BANK_CARD_FUNDS | |||
| ACCOUNT_FUNDS | |||
| OTHER |
| Name | Type& Max | Description | Requirement |
|---|---|---|---|
| payeeType | - | The type of payee: | C |
| INDIVIDUAL | |||
| COMPANY | |||
| It is required if there is no quotationId. | |||
| lastName | varchar(100) | The last name of payee （When the beneficiary is an individual, either lastname + firstname or fullname must be provided.） | C |
| middleName | varchar(100) | The middle name of payee | O |
| firstName | varchar(100) | The first name of payee （When the beneficiary is an individual, either lastname + firstname or fullname must be provided.） |
C |
| fullName | varchar(100) | （When the beneficiary is an individual, either lastname + firstname or fullname must be provided.） | C |
| companyName | varchar(100) | The company name of payee （Mandatory to pass when the payer is a company） | C |
| companyRegistCerNo | varchar(50) | The registration certificate No of company Mandatory to pass when IDTYPE is REGISTCER |
C |
| taxNo | varchar(50) | The tax number of company Mandatory to pass when IDTYPE is TAX |
C |
| companyRegistDate | - | The registration date of the company; Format:yyyymmdd | O |
| companyRegistCountry | - | The registration country code of the company | O |
| birthday | - | The birthday of payee; Format:yyyymmdd | O |
| birthCountry | - | The birth country code of payee | O |
| birthCity | varchar(50) | The payee's city of birth. | O |
| country | - | The country code of payee | M |
| province | varchar(20) | The province of payee | O |
| city | varchar(50) | The city of payee | O |
| address | varchar(255) | The address of payee | M |
| postcode | varchar(50) | The postcode of payee | O |
| gender | - | The gender of payee: | O |
| MALE | |||
| FEMALE | |||
| phoneNumber | varchar(50) | The phone number of payee | O |
| varchar(100) | The email account of payee | O | |
| idType | - | ID type of the payee: | M |
| IDCARD | |||
| PASSPORT | |||
| REGISTCER (Registration Certificate) | |||
| TAX (Tax Registration Certificate) | |||
| OTHER | |||
| idNo | varchar(50) | ID number under the specified ID type. It is required when the payeeType is INDIVIDUAL. | C |
| idEffectDateStart | - | The effective date of ID; Format:yyyymmdd | O |
| idEffectDateEnd | - | The expiry date of ID; Format:yyyymmdd | O |
| profession | varchar(50) | The profession of payee | O |
| Name | Type& Max | Description | Requirement |
|---|---|---|---|
| accountType | - | The type of payee account: | M |
| BANK_ACCOUNT | |||
| WALLET_ACCOUNT | |||
| CHECKING_ACCOUNT | |||
| organCode | varchar(50) | The code of the received organization. It is required if there is no quotationId.See attachment. | C |
| organCountry | - | The country code of the received organization. It is required if there is no quotationId.See attachment. | C |
| organProvince | varchar(20) | The province of the received organization. | O |
| organCity | varchar(20) | The city of the received organization. | O |
| organAddress | varchar(255) | The address of the received organization. | O |
| accountHolderName | varchar(100) | The account holder name. | M |
| bankCardNumber | varchar(50) | The bank account number of payee. | O |
| varchar(100) | The email of payee | O | |
| phoneNumber | varchar(50) | The phone number of payee. | O |
| ibanNumber | varchar(50) | International bank account number, mostly for European countries | O |
| ifscCode | varchar(50) | India financial system code for banks in India. | O |
| aba | varchar(50) | American Bankers Association routing number. | O |
| clabe | varchar(50) | Code of Mexico bank | O |
| swiftCode | varchar(50) | Society for Worldwide Interbank Financial Telecommunication code. | O |
| sortCode | varchar(50) | Sort code, mostly for UK bank. | O |
| bsbNumber | varchar(50) | Code of Australian banks in different regions. | O |
| bankCode | varchar(100) | Code of bank | O |
| branchCode | varchar(20) | The code of the branch bank | O |
| branchCode | varchar(100) | The name of the branch bank | O |
| bankName | varchar(100) | The name of the bank | O |
| Name | Type& Max | Description | Requirement |
|---|---|---|---|
| fileSourceUrl | varchar(255) | The SFTP url of the prove file.Merchants upload the file to Geoswift SFTP server; For details, please refer to SFTP Connection Guidance. | C |
| fileType | - | The file type: | C |
| INVOICE | |||
| COMPANY | |||
| PURCHASE_ORDER | |||
| DELIVERY_ORDER | |||
| oddNumber | varchar(50) | The number on the specified file type | O |
| Name | Description |
|---|---|
| merchantId | The unique identity of the merchant in Geoswift system |
| requestId | The requestId |
| serialNumber | Serial number of the remittance in Geoswift system |
| status | The status of the request: |
| SUCCESS | |
| FAILED | |
| payerType | The type of payer: |
| INDIVIDUAL | |
| COMPANY | |
| payeeType | The type of payee: |
| INDIVIDUAL | |
| COMPANY | |
| remark | remark |
| partnerId | 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 unique identity of the merchant in Geoswift system. |
| requestId | The request ID |
| serialNumber | Serial number of the remittance in Geoswift system |
| quotationId | The unique identifier of quotation |
| quotationType | The type of quotation: |
| ORIGINAL | |
| TARGET | |
| orderStatus | The remittance status: |
| SUCCESS | |
| FAILED | |
| REVERSED | |
| CANCELED | |
| originalAmount | Original remittance amount; UNIT is in cents |
| originalCurrency | Original remittance currency |
| targetAmount | Target remittance amount. UNIT is in cents |
| targetCurrency | Target remittance currency |
| rate | FX rate,with eight reserved decimal places |
| errorMessage | The error information; Returned when the orderStatus is FAILED |
| errorCode | The error code; Returned when the orderStatus is FAILED |
| completeDateTime | The remittance completion time,returned when the orderStatus is SUCCESS or FAILED. Beijing time, format: yyyy-mm-dd hh:mm:ss |
| reversalDateTime | The time when the fund is refunded by bank,returned when the orderStatus is REVERSED. Beijing time, format: yyyy-mm-dd hh:mm:ss |
| returnAmount | Return amount, returned only during return notification (unit: cents) |
| returnCurrency | Return currency, returned only during return notification |
| partnerId | 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" |