Fast Payout(No Pages)
Parameter description
Request
| name | type | required | desc | example |
|---|---|---|---|---|
| param | JSONObject | YES | ||
| ─epayAccount | string | YES | Merchant Epay Account | test2020@epay.com |
| ─payerAccount | string | NO | Sender account | 100 |
| ─merchantName | string | YES | Merchant name | EPay |
| ─merchantOrderNo | string | YES | Merchant order number | lx083031 |
| ─paymentAmount | string | YES | Payment amount | 100,can be empty value |
| ─paymentCurrency | string | YES | Payment currenc,refer to currencyType | BRL |
| ─paymentCountry | string | YES | Merchant payment country | BR |
| ─receiveAmount | string | YES | Merchant Received amount | can be empty value |
| ─receiveCurrency | string | YES | Merchant Receive currency, refer tocurrencyType | USD |
| ─channelCode | string | YES | Channel number | 46 |
| ─version | string | YES | Version number | V2.0.0 |
| ─notifyUrl | string | YES | Callback address | http://localhost/paymentApi/channel/send.do |
| ─remark | string | NO | Remark | |
| ─category | string | NO | BANK or CASH | BANK |
| ─extendFields | JSONObject | NO | Merchant extension field | |
| ─senderInfo | JSONObject | NO | sender info | |
| ─ ─surName | String | NO | surname | |
| ─ ─givName | String | NO | givName | |
| ─ ─purposeOfRemittance | String | NO | purpose of remittance | |
| ─ ─country | String | NO | country | |
| ─ ─userType | String | NO | User type | |
| ─ ─idType | String | NO | Certificate type | |
| ─ ─idNumber | String | NO | ID number | |
| String | NO | |||
| ─ ─locationId | String | NO | Bank branch locationId | |
| ─ ─accountType | String | NO | bank account type | |
| ─ ─bankName | String | NO | bank name | |
| ─ ─accountNo | String | NO | bank number | |
| ─ ─bankBranchCode | String | NO | bank branch number | |
| ─ ─phone | String | NO | phone | |
| ─ ─area | String | NO | area | |
| ─ ─bankBranchName | String | NO | bank branch name | |
| ─ ─orderDesc | String | NO | Order Remark | |
| ─ ─productName | String | NO | Product Name | |
| ─ ─productPrice | String | NO | Product Price | |
| ─ ─productCount | String | NO | Product Count | |
| ─ ─productShowUrl | String | NO | Product Link | |
| sign | string | YES | Signature |
Response
| name | type | required | desc | example |
|---|---|---|---|---|
| sign | string | YES | Signature | |
| epayAccount | string | YES | Merchant Epay Account | test2020@epay.com |
| version | string | YES | Version number | V2.0.0 |
| code | integer | YES | Response code 1 : Success | 1 |
| message | string | YES | Message info | success |
| data | JSONObject | YES | ||
| ─epayAccount | string | YES | Merchant Epay Account | test2020@epay.com |
| ─merchantName | string | YES | Merchant name | EPay |
| ─merchantOrderNo | string | YES | Merchant order number | lx0812097 |
| ─paymentAmount | string | YES | Payment amount | 1000 |
| ─paymentCurrency | string | YES | Payment currency, refer to currencyType | BRL |
| ─receiveAmount | string | YES | Received amount | 195.44 |
| ─receiveCurrency | string | YES | Receive currency,refer to currencyType | USD |
| ─channelCode | string | YES | Channel number | 46 |
| ─version | string | YES | Version number | V2.0.0 |
| ─notifyUrl | string | YES | Callback address | www.yourmerchant.com |
| ─successUrl | string | YES | Successfully returned address | www.yourmerchant.com |
| ─failUrl | string | YES | Failure returned address | www.yourmerchant.com |
| ─remark | string | YES | Remark | |
| ─epayOrderNo | string | YES | Epay order number | 211141425716147189493760 |
| ─status | string | YES | Epay order status | 1 |
| ─fields | string | YES | Merchant extension field | {"url": "https://sandbox-gateway.safetypay.com/Express4/Checkout/index?TokenID=5e1789e7-9bf0-4901-9b5c-3d26a4ba9caf-45ssws"} |
Parameter example
curl --location --request POST 'http://29597375fx.epaydev.xyz/capi/openapi/payinApi/sendTransaction' \
--header 'Content-Type: application/json' \
--data-raw '{
"param": {
"epayAccount": "test2020@epay.com",
"version": "V2.0.0",
"merchantName": "epay",
"merchantOrderNo": "lx083031",
"receiveAmount": "",
"receiveCurrency": "USD",
"paymentAmount": "100",
"paymentCurrency": "BRL",
"paymentCountry": "BR",
"payerAccount ":"",
"channelCode": "46",
"notifyUrl": "http://localhost/paymentApi/channel/send.do",
"remark": ""
},
"sign": "{{sign}}"
}'
RequestExample
curl --location --request POST 'http://29597375fx.epaydev.xyz/capi/openapi/payinApi/sendTransaction' \
--header 'Content-Type: application/json' \
--data-raw '{
"param": {
"epayAccount": "test2020@epay.com",
"version": "V2.0.0",
"merchantName": "epay",
"merchantOrderNo": "lx083031",
"receiveAmount": "",
"receiveCurrency": "USD",
"paymentAmount": "100",
"paymentCurrency": "BRL",
"paymentCountry": "BR",
"payerAccount ":"",
"channelCode": "46",
"notifyUrl": "http://localhost/paymentApi/channel/send.do",
"remark": ""
},
"sign": "{{sign}}"
}'
ResponseExample
{
"sign": "735BA86F116D4A4865302513D6F9DD8D3A2ABF0FA94A52664A794378952C2507",
"epayAccount": "test2020@epay.com",
"version": "V2.0.0",
"code": 1,
"message": "success",
"data": {
"epayAccount": "test2020@epay.com",
"merchantName": "epay",
"merchantOrderNo": "lx0812097",
"paymentAmount": "1000",
"paymentCurrency": "BRL",
"receiveAmount": "195.44",
"receiveCurrency": "USD",
"channelCode": "46",
"version": "V2.0.0",
"notifyUrl": "www.baidu.com",
"successUrl": "www.baidu.com",
"failUrl": "www.baidu.com",
"remark": "",
"fields": {
"url": "https://sandbox-gateway.safetypay.com/Express4/Checkout/index?TokenID=5e1789e7-9bf0-4901-9b5c-3d26a4ba9caf"
},
"epayOrderNo": "211141425716147189493760",
"status": "1"
}
}