CreateEpayTransaction
Parameter description
Request
name | type | required | desc | example |
---|---|---|---|---|
param | JSONObject | YES | ||
─epayAccount | string | YES | Merchant Epay Account | test2020@epay.com |
─merchantName | string | YES | Merchant Name | merchantName |
─merchantOrderNo | string | YES | Merchant order number | 2021041409022211 |
─amount | string | YES | Amount | 10 |
─currency | string | YES | Currency USD, EUR, HKD, GBP, JPY | USD |
─notifyUrl | string | YES | Callback address | https://openapi.alipay.com/gateway.do |
─receiveEpayAccount | string | NO | Receiving Epay account | 11@qq.com |
─version | string | YES | Version number | V2.0.0 |
─remark | string | NO | Remarks | |
─extendFields | JSONObject | NO | Merchant extension field | {"test": "test"} |
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 | ||
─merchantName | string | YES | Merchant name | merchantName |
─receiveEpayAccount | string | YES | Receiving Epay account | 11@qq.com |
─merchantOrderNo | string | YES | Merchant order number | 2021041409022211xx |
─epayOrderNo | string | YES | Epay order number | 211151598563331919745024 |
─status | string | YES | Epay order status | 7 |
─amount | string | YES | Amount | 10.6 |
─fee | string | YES | Fees | 0.6 |
─currency | string | YES | Currency | USD |
─notifyUrl | string | YES | Callback address | https://openapi.alipay.com/gateway.do |
─remark | string | NO | Remarks | null |
─extendFields | string | NO | Merchant extension field | {\"test\":\"test\"} |
Parameter example
curl --location --request POST 'http://29597375fx.epaydev.xyz/capi/openapi/payoutApi/createEpayTransaction' \
--header 'Content-Type: application/json' \
--data-raw '{
"param": {
"epayAccount": "test2020@epay.com",
"version": "V2.0.0",
"merchantName": "merchantName",
"notifyUrl": "http://localhost/paymentApi/channel/send.do",
"merchantOrderNo": "2021041409022211",
"receiveEpayAccount": "11@qq.com",
"amount": "10",
"currency": "USD",
"extendFields": {
"test": "test"
}
},
"sign": "{{sign}}"
}'
RequestExample
curl --location --request POST 'http://29597375fx.epaydev.xyz/capi/openapi/payoutApi/createEpayTransaction' \
--header 'Content-Type: application/json' \
--data-raw '{
"param": {
"epayAccount": "test2020@epay.com",
"version": "V2.0.0",
"merchantName": "merchantName",
"notifyUrl": "http://localhost/paymentApi/channel/send.do",
"merchantOrderNo": "2021041409022211",
"receiveEpayAccount": "11@qq.com",
"amount": "10",
"currency": "USD",
"extendFields": {
"test": "test"
}
},
"sign": "{{sign}}"
}'
ResponseExample
{
"sign": "C4D3FC47BAEA591889390D49B145BB2927BAE8691C95A1938657B24B602A791E",
"epayAccount": "test2020@epay.com",
"version": "V2.0.0",
"code": 1,
"message": "success",
"data": {
"merchantName": "merchantName",
"receiveEpayAccount": "11@qq.com",
"merchantOrderNo": "2021041409022211xx",
"epayOrderNo": "211151598563331919745024",
"status": "7",
"extendFields": "{\"test\":\"test\"}",
"amount": "10.6",
"fee": "0.6",
"currency": "USD",
"notifyUrl": "http://localhost/paymentApi/channel/send.do",
"remark": null
}
}