CalculateAmount

SwaggerUI

Parameter description

Request

name type required desc example
param JSONObject YES
─epayAccount string YES Merchant Epay Account test2020@epay.com
─version string YES Version Number V2.0.0
─category string YES Bank, Cash BANK
─amount string YES Settlement amount, Deduct the USD amount of the account, Pass amount or receiveamount, At the same time, the receiveamount shall prevail can be empty
─receiveAmount string YES Received amount, Pass amount or receiveamount, At the same time, the receiveamount shall prevail 100
─settlementCurrency string YES Settlement currency,Only support USD USD
─receiveCurrency string YES Receive currency AUD
─countryCode string YES Country(ISO 2-bit country code CN,AU,US) AU
─locationId string YES Bank branch locationId 10090054
─transactionType string YES Transaction mode(C2C,B2C,B2B,C2B) C2C
─channelCode string NO Channel code 50
─senderCountry string NO Payment country, required when using sentbe AU
─merchantOrderNo string NO Merchant order number, required when using sentbe No5547
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
─category string YES BANK,CASH BANK
─countryCode string YES Country code: ISO 2 bits AU
─locationId string YES Bank branch locationId 10090054
─amount string YES Order Amount 111.11
─settlementCurrency string YES Settlement Currency USD
─receiveAmount string YES Receive Amount 100.00
─receiveCurrency string YES Receivement Currency AUD
─rate string YES rate 1.111111
─fee string YES fee 72.00
─rateMode string YES Exchange rate model 0 USD to target currency, 1 target currency to USD 0

Parameter example

RequestExample ResponseExample 
curl --location --request POST 'http://29597375fx.epaydev.xyz/capi/openapi/payoutApi/calculateAmount' \
--header 'Content-Type: application/json' \
--data-raw '{
  "param": {
    "epayAccount": "test2020@epay.com",
    "category": "BANK",
    "amount": "",
    "receiveAmount": "100",
    "settlementCurrency": "USD",
    "receiveCurrency": "AUD",
    "countryCode": "AU",
    "locationId": "10090054",
    "transactionType": "C2C",
    "version": "V2.0.0"
  },
  "sign": "{{sign}}"
}'

RequestExample

curl --location --request POST 'http://29597375fx.epaydev.xyz/capi/openapi/payoutApi/calculateAmount' \
--header 'Content-Type: application/json' \
--data-raw '{
  "param": {
    "epayAccount": "test2020@epay.com",
    "category": "BANK",
    "amount": "",
    "receiveAmount": "100",
    "settlementCurrency": "USD",
    "receiveCurrency": "AUD",
    "countryCode": "AU",
    "locationId": "10090054",
    "transactionType": "C2C",
    "version": "V2.0.0"
  },
  "sign": "{{sign}}"
}'

ResponseExample

{
  "sign": "19CE078E81A9A5FC17290D47E238ACF59106B4BFBACE2CB878A7AA4E221E68F1",
  "epayAccount": "test2020@epay.com",
  "version": "V2.0.0",
  "code": 1,
  "message": "success",
  "data": {
    "category": "BANK",
    "countryCode": "AU",
    "locationId": "10090054",
    "amount": "111.11",
    "settlementCurrency": "USD",
    "receiveAmount": "100.00",
    "receiveCurrency": "AUD",
    "rate": "1.111111",
    "fee": "72.00",
    "rateMode": "0"
  }
}

results matching ""

    No results matching ""