createTransaction

SwaggerUI

Parameter description

Request

name type required desc example
param JSONObject YES
─epayAccount string YES Merchant Epay Account test2020@epay.com
─category string YES Bank, Cash BANK
─notifyUrl string NO Callback address http://192.168.2.6:8380/openapi/apiForward/callBack
─merchantOrderNo string YES Merchant order number te3ssd7383d334523t128a
─amount string YES Settlement amount, Deduct the USD amount of the account, Pass amount or receiveamount, At the same time, the receiveamount shall prevail 10
─settlementCurrency string YES Settlement currency,Only support USD USD
─receiveAmount string YES Received amount, Pass amount or receiveamount, At the same time, the receiveamount shall prevail can be empty
─receiveCurrency string YES Receive currency,refer to currencyType CNY
─version string YES Version number V2.0.0
─transactionType string YES Transaction mode(C2C,B2C,B2B,C2B) C2C
─channelCode string NO Channel code 51
─extendFields JSONObject NO Merchant extension field
─senderInfo JSONObject NO Payer information: required when the transactionType is C2C and C2B
─ ─surName string NO Surname wang
─ ─givName string NO Given name wu
─ ─gender string NO Gender (M:male F:female)
─ ─email string NO E-mail 809334399@epay.com
─ ─country string NO Sender country(ISO 2-bit country code CN,AU,US)
─ ─address string NO Address Santa Clara, CA 3050 Bowers Avenue
─ ─city string NO City Santa Clara
─ ─area string NO Area code 86
─ ─phone string NO Mobile 13378975778
─ ─nationality string NO Nationality(ISO 2-bit country code CN,AU,US) RU
─ ─idType string NO ID type (1= ID card 2= passport) 2
─ ─idNumber string NO ID number 452245645634534523
─ ─issueDate string NO Date of issue (yyyy-mm-dd) 1980-01-01
─ ─expireDate string NO Date of expiry (yyyy-mm-dd) 2050-01-01
─ ─birthday string NO Date of birth (yyyy-mm-dd) 1970-01-01
─ ─occupation string NO Occupation 1(Mapping by interface query)
─ ─sourceOfFund string NO Source of funds 1(Mapping by interface query)
─ ─beneficiaryRelationShip string NO Relationship 2(Mapping by interface query)
─ ─purposeOfRemittance string NO Purpose of remittance 6(The nomenclature has mapping instructions)
─ ─accountNo string NO Sender bank account 13721473389
─ ─zipCode string NO Address Postcode 58039
─ ─states string NO Company State shanghai
─ ─country string NO Receiver country CN
─ ─userType string NO User type (1:Individuals 2:Corporate users)
─ ─phoneCountry string NO Country of mobile phone number CN
─ ─postalCode string NO Postcode 230000
─ ─middleName string NO Middle name Swiffte
─ ─provinceState string NO Province GuangDong
─ ─taxId string NO Tax No. 8902385331225
─ ─accountCity string NO City of account TW
─ ─accountCountry string NO Country of account TW
─ ─userName string NO Username Anna
─receiverInfo JSONObject NO Payee information: transactionType C2C,B2C required
─ ─surName string NO Surname li
─ ─givName string NO Given name lei
─ ─middleName string NO Middle name Swiffte
─ ─otherName string NO Other name 리 레이
─ ─address string NO Address shenzhen
─ ─area string NO Area code 86
─ ─phone string NO Mobile 13063456236
─ ─country string NO Receiver country(ISO 2-bit country code CN,AU,US) CN
─ ─nationality string NO Nationality(ISO 2-bit country code CN,AU,US) CN
─ ─idType string NO ID type (1= ID card 2= passport) 1(The nomenclature has mapping instructions)
─ ─idNumber string NO ID number 1234567890
─ ─locationId string NO Bank branch locationId 3922
─ ─bankId string NO Bank id 3922
─ ─bankName string NO Bank branch name Orange Money Morocco
─ ─bankBranchName string NO Bank branch name Morocco Orange Money Morocco
─ ─bankBranchCode string NO Bank branch code BSB/IBAN, etc WEBPAY
─ ─bankBranchId string NO Bank branch id 12345
─ ─accountNo string NO Bank account number 13721000000
─ ─occupation string NO Occupation 1(Mapping by interface query)
─ ─bankMobile string NO Registered mobile number 1343135324111
─ ─issueDate string NO ID Date of Issue(yyyy-mm-dd) 1980-01-01
─ ─expireDate string NO ID Date of expiry(yyyy-mm-dd) 2050-01-01
─ ─licIssuAutho string NO ID issuing authority
─ ─remark string NO Remark
─ ─accountType string NO Account Type receiveCurrency=BRL,ARS,COP Mandatory, please fill in: CHECKING, SAVINGS, DEPOSIT, OTHERS CHECKING
─ ─city string NO City shenzhen
─ ─states string NO State NanShan
─ ─zipCode string NO ZIP Code 340826
─ ─country string NO Country CN
─ ─email string NO Email 809334399@epay.com
─ ─accountNumber string NO Account Number 093149932
─ ─phoneCountry string NO Country of mobile phone number US
─ ─accountCity string NO City of account shenzhen
─ ─accountCountry string NO Country of account CN
─ ─currency string NO Currency USD
─ ─userName string NO User name Jone
─ ─birthday string NO Date of birth 1989-01-09
─ ─routingCode string NO
─ ─ifsCode string NO
─ ─postalCode string NO Post code 340826
─ ─provinceState string NO State, province shenzhen
─ ─transitCode string NO
─ ─sortCode string NO
─ ─swift string NO
─ ─wingMoneyNumber string NO 2341213214223
─ ─cardNumber string NO Card number 2312145621
─ ─nativeFirstName string NO Original surname Li
─ ─nativeLastName string NO Original given name Lei
─ ─remitterType string NO Payment type 1(The nomenclature has mapping instructions)
─ ─ibanNo string NO International bank account number
─ ─accountAddress string NO Account Address
─ ─routingType string NO Route Type
─ senderBusiness JSONObject NO Payment company information: B2C transactionType, B2B required
─ ─registeredName string NO Registered name of company
─ ─tradingName string NO Company name gowins
─ ─address string NO Company address NanShan
─ ─zipCode string NO Address Zip Code 518000
─ ─city string NO The city where the company is located shenzhen
─ ─states string NO The state province where the company is located NanShan
─ ─country string NO Country of company CN
─ ─msisdn string NO Company contact number 0556-7782190
─ ─email string NO Company mailbox test2020@epay.com
─ ─registrationNumber string NO Company registration code 232148029173812
─ ─dateOfIncorporation string NO Company Registration Date 2010-09-18
─ ─purposeOfRemittance string NO Purpose of remittance 1(The nomenclature has mapping instructions)
──documentReferenceNumber string NO Document Reference No. 32151343
─ ─taxId string NO Tax No. 879413321
─ ─accountType string NO Account Type CHECKING
─ ─idNumber string NO id number 43123123
─ ─nationality string NO Nationality CN
─ ─sourceOfFund string NO Source of funds 1(Mapping by interface query)
─receiverBusiness JSONObject NO Information of collection company: C2B is transactionType, required for B2B (Please refer to the payment company information for completion rules)
─ ─registeredName string NO Registered name of company
─ ─tradingName string NO Company name
─ ─address string NO Company address
─ ─zipCode string NO Address Zip Code
─ ─city string NO The city where the company is located
─ ─states string NO The state of the company
─ ─country string NO Country of company
─ ─msisdn string NO Company contact number
─ ─email string NO Company mailbox
─ ─registrationNumber string NO Company registration code
─ ─dateOfIncorporation string NO Company Registration Date
─ ─locationId string NO Bank branch locationId
─ ─bankId string NO bankId
─ ─bankName string NO bankName
─ ─bankBranchName string NO bankBranchName
─ ─bankBranchCode string NO bankBranchCode
─ ─bankBranchId string NO Bank branch id
─ ─accountNo string NO bank accountNo
─ ─taxId string NO Tax number
─ ─accountType string NO Account type receiveCurrency = BRL, ARS, COP required, please fill in: CHECKING, SAVINGS, DEPOSIT, OTHERS
─ ─sortCode string NO sortCode 2321312
─ ─cardNumber string NO cardNumber 09312241
─ ─bizName string NO company identification Epay
─ ─remitterType string NO Payment type 1 (noun interpretation has mapping description)
─ ─ibanNo string NO International bank account number
─ ─userName string NO Name of Account Owner
─ ─accountCountry string NO Country of account
─ ─routingType string NO Route Type
─ ─routingCode string NO Remittance Route Number
─ ─swiftCode string NO Bank International Code
─ ─accountAddress string NO Account Address
─ ─postalCode string NO postcode
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
─merchantOrderNo string YES Merchant order number te3ssd7383d334523t128a
─epayOrderNo string YES Epay order number 211151598521901746507776
─status string YES Epay order status 9
─amount string YES Settlement amount 10.0
─settlementCurrency string YES Settlement currency USD
─receiveAmount string YES Receivement amount 70.6
─receiveCurrency string YES Receivement currency CNY
─rate string YES Exchange rate 0.141647
─fee string YES Fees 1.5
─extendFields string YES Merchant extension field null
─rateMode string YES 0 exchange rate USD to CNY, 1 exchange rate CNY to USD 1

Parameter example

RequestExample ResponseExample 
curl --location --request POST 'http://29597375fx.epaydev.xyz/capi/openapi/payoutApi/createTransaction' \
--header 'Content-Type: application/json' \
--data-raw '{
  "sign": "5CC22598927472D70D1F59122EF2635E871E49C44BB469055534711E5C96485A",
  "param": {
    "epayAccount": "jing32@qq.com",
    "transactionType": "C2C",
    "category": "BANK",
    "notifyUrl": "http://192.168.2.6:8380/openapi/apiForward/callBack",
    "merchantOrderNo": "te3ssd7383d334523t128a",
    "amount": "10",
    "receiveAmount": "",
    "settlementCurrency": "USD",
    "receiveCurrency": "CNY",
    "version": "V2.0.0",
    "channelCode": "51",
    "senderInfo": { 
      "surName": "wang",
      "givName": "wu",
      "idType": "2",
      "idNumber": "452245645634534523",
      "purposeOfRemittance": "6",
      "birthday": "1992-12-28",
      "city": "Santa Clara",
      "zipCode": "58039",
      "address": "Santa Clara, CA 3050 Bowers Avenue",
      "country": "US",
      "accountNo":"13721473389"
    },
    "receiverInfo": {
      "surName": "li",
      "givName": "lei",
      "nationality": "CN",
      "country": "CN",
      "area": "",
      "accountNo": "13721473389",
      "idNumber":"1234567890"
    }
  }
}'

RequestExample

curl --location --request POST 'http://29597375fx.epaydev.xyz/capi/openapi/payoutApi/createTransaction' \
--header 'Content-Type: application/json' \
--data-raw '{
  "sign": "5CC22598927472D70D1F59122EF2635E871E49C44BB469055534711E5C96485A",
  "param": {
    "epayAccount": "jing32@qq.com",
    "transactionType": "C2C",
    "category": "BANK",
    "notifyUrl": "http://192.168.2.6:8380/openapi/apiForward/callBack",
    "merchantOrderNo": "te3ssd7383d334523t128a",
    "amount": "10",
    "receiveAmount": "",
    "settlementCurrency": "USD",
    "receiveCurrency": "CNY",
    "version": "V2.0.0",
    "channelCode": "51",
    "senderInfo": { 
      "surName": "wang",
      "givName": "wu",
      "idType": "2",
      "idNumber": "452245645634534523",
      "purposeOfRemittance": "6",
      "birthday": "1992-12-28",
      "city": "Santa Clara",
      "zipCode": "58039",
      "address": "Santa Clara, CA 3050 Bowers Avenue",
      "country": "US",
      "accountNo":"13721473389"
    },
    "receiverInfo": {
      "surName": "li",
      "givName": "lei",
      "nationality": "CN",
      "country": "CN",
      "area": "",
      "accountNo": "13721473389",
      "idNumber":"1234567890"
    }
  }
}'

ResponseExample

{
  "sign": "9AF49E2564C829418BBC7FE43F4BAC55E9F848B6C886AF5EF637B598D96CFFEF",
  "epayAccount": "jing32@qq.com",
  "version": "V2.0.0",
  "code": 1,
  "message": "success",
  "data": {
    "category": "BANK",
    "merchantOrderNo": "te3ssd7383d334523t128a",
    "epayOrderNo": "211151598521901746507776",
    "status": "9",
    "amount": "10.0",
    "settlementCurrency": "USD",
    "receiveAmount": "70.6",
    "receiveCurrency": "CNY",
    "rate": "0.141647",
    "fee": "1.5",
    "extendFields": null,
    "rateMode": "1"
  }
}

results matching ""

    No results matching ""