Create the quotation
https://api.geoswift.com/ofr/quotation/order
| 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 |
| originalCurrency | - | Original remittance currency, See "originalCurrency" within "Currency list & Target Country Guide" in the attachment | M |
| originalAmount | long(18) | Original remittance amount.It is required when the quotationType is ORIGINAL. UNIT is in cents | C |
| targetCurrency | varchar(3) | Target remittance currency, See "originalCurrency" within "Currency list & Target Country Guide" in the attachment | M |
| targetAmount | long(18) | Target remittance amount.It is required when the quotationType is TARGET. UNIT is in cents | C |
| payerType | - | The payer type: | O |
| INDIVIDUAL | |||
| COMPANY | |||
| payeeType | - | The payee type: | O |
| INDIVIDUAL | |||
| COMPANY | |||
| quotationType | - | The quotation type: | M |
| ORIGINAL | |||
| TARGET | |||
| tenor | - | The tenor date: | M |
| TODAY（Real time） | |||
| TOM(T+1) | |||
| SPOT(T+2) | |||
| TOM and SPOT can be passed when the target currencies are USD, AUD, GBP, CAD, HKD, CNH, SGD, JPY, or EUR | |||
| includeFee | - | Service Fee: | M |
| 1 (Include remittance service fees) | |||
| 0 (Exclude remittance service fees) | |||
| Can only be set to 1 when quoting in the target currency, which must be USD, AUD, GBP, CAD, HKD, CNH, SGD, JPY, or EUR. | |||
| payeeOrgCode | varchar(50) | The code of payee organization; See "OrganCode" within "Currency list & Target Country Guide" in the attachment | O |
| payeeOrgCountry | - | The country code of payee organization, See "Country Code" within "Currency list & Target Country Guide" in the attachment | M |
| payeeBankNo | varchar(50) | The bank account number of payee | 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 |
| partnerCommissionFeeType | Fixed Value | Commission Fee Type FIXED – Fixed Amount |
C |
| PERCENT – Percentage | |||
This field is required when partnerCommissionFeeValue is not empty. | |||
This field can be passed when partnerId is specified. | |||
| This field is required when the target currency is USD, AUD, GBP, CAD, SGD, JPY, EUR, HKD, or CNH, a service fee is to be included, and the partner is entitled to receive commission. If omitted under these conditions, the system will treat the transaction as commission-free. | |||
| partnerCommissionFeeValue | varchar(10) | Commission Fee Value. If charging a fixed amount per transaction, e.g., passing 200 indicates a commission of 2 dollars per transaction. |
C |
If charging by percentage, e.g., passing 15 indicates a 0.15% commission based on the credited amount.
For example: if the remittance amount is 10,000 USD, and the service fee rate agreed with the provider is 0.2%, and the commission rate is 0.15%,
then the total fee is calculated as: 10,000 × 0.2% + 10,000 × 0.15% = 35 USD, where 15 USD will be settled to the partner’s account. | |||
This field is required when partnerCommissionFeeType is not empty. | |||
This field can be passed when partnerId is specified. | |||
| This field is required when the target currency is USD, AUD, GBP, CAD, SGD, JPY, EUR, HKD, or CNH, a service fee is to be included, and the partner is entitled to receive commission. If omitted under these conditions, the system will treat the transaction as commission-free. | |||
| 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 | Description |
|---|---|
| merchantId | The unique identity of the merchant in Geoswift system |
| requestId | The requestId |
| serialNumber | The unique identifier of quotation |
| originalCurrency | Original remittance currency |
| originalAmount | Original remittance amount.UNIT: China fen，1 Yuan=100 Fen |
| targetCurrency | Target remittance currency |
| targetAmount | Target remittance amount. UNIT is in cents |
| payerType | The payer type: |
| INDIVIDUAL | |
| COMPANY | |
| payeeType | The payee type: |
| INDIVIDUAL | |
| COMPANY | |
| quotationType | The quotation type: |
| ORIGINAL | |
| TARGET | |
| payeeOrgCode | The code of payee organization |
| payeeOrgCountry | The country of payee organization |
| payeeBankNo | The bank account number of payee |
| completionTime | The completion time of the quotation request; GMT time,format: yyyy-mm-dd hh:mm:ss |
| quotationStatus | The quotation status: |
| SUCCESS | |
| FAILED | |
| tenor | Tenor Date |
| feeAmount | Service fee amount; |
| Returned when includeFee is set to 1. | |
| feeCurrency | Service fee currency; |
| Returned when includeFee is set to 1. | |
| status | The response status: |
| SUCCESS | |
| ERROR | |
| listPrice | FX rate,with eight reserved decimal places |
| expiredDateTime | The expiry time of the quotation; Beijing time,format: yyyy-mm-dd hh:mm:ss |
| createDateTime | The creation time of the quotation; Beijing time,format: yyyy-mm-dd hh:mm:ss |
| partnerId | Same as the request parameter |
| partnerCommissionFeeType | Same as request parameter |
| partnerCommissionFeeValue | Same as request parameter |
| partnerCommissionAmount | Commission Amount. Unit: cent (integer only, no decimals) |
| hmac | The result of parameter signature,generated by Geoswift.For the signature verification process,please reference to "Geoswift encryption and decryption process specification" |