EVO Payment API Portal

简体中文

ENG

简体中文

ENG

Payment ​

Request

Path Parameters

aid
string
必需

Header Parameters

Content-type
string
固定值application/json
DateTime
string
请求时间，格式：YYYY-MM-DDThh:mm:ss+hh:00
MsgID
string
建议的值为UUID或GUID来标记此请求，例如2d21a5715c034efb7e0aa383b885fc7a，长度不能超过32个字符
SignType
string
SHA256 或者 SHA512 或 SM2withSM3

Request Body schema

allowAvsCheck
boolean
此字段用于指示是否应执行 AVS（地址验证服务）检查 - 使用说明 1. 此字段仅用于 POST 支付请求。如果为 true，EVO Cloud 将对卡交易执行 AVS 检查。 2. 如果未提供，默认值为 false，EVO Cloud 将跳过 AVS 检查。 3. 字段类型：布尔值（true / false）
authentication
object(认证相关信息)
当 paymentMethod.type = card 或 token 时必填。
captureAfterHours
string(授权完成延迟时间)<= 3 字符
根据设置的时间完成交易，将订单状态改为 Captured 。 - 使用说明 1. 如果上送本字段，默认选择手动完成。 2. 0 表示立即完成；1-168 表示 1-168 小时后自动完成。
enhanceMonitoring
boolean
表示当前交易是否需要触发监
extendAuthorizationDateIndicator
string<= 1 字符
枚举: Y
延长卡组织的默认授权日期，适用于支付品牌为Visa
instalment
object(分期付款信息)
如果 captureAfterHours ≠ 0 分期付款信息将被忽略
merchantTransInfo
object
必需
商户交易信息
metadata
string(附加信息)<= 512 字符
当请求中上送了本字段， EVO Cloud 将在同步应答、查询以及异步通知中原样返回本字段。
origMerchantTransInfo
object
原始交易信息 使用说明 1\. 如果 paymentMethod.industry 字段存在，原始交易应为支付交易，此字段适用。
paymentMethod
object
必需
支付方式信息
pspInfo
object
必需
渠道资质信息
recipientInfo
object
在资金转账交易中，资金接收人信息。
surchargeFee
object
在初始交易金额上增加的额外费用 - 使用说明 1. 当此字段出现时，交易金额应为包括附加费的调整后金额。 2. 当 captureAfterHours 不等于 0 时，此字段将被忽略。
tradeInfo
object
当资金转账交易时必填。
transAmount
object
必需
交易金额
transInitiator
object
交易发起平台
userInfo
object
在资金转账交易中，资金发送人的信息
webhook
string(异步通知地址)<= 300 字符
交易在后台成功处理后，推送通知到此地址

Responses

Try it
Server
https://hkg-uat-online.everonet.com
Path Parameters
Header Parameters
Request Body Parameters
Request Samples
cURL
curl -i -X POST \
'https://hkg-uat-online.everonet.com/g2/v0/payment/acq/{aid}/evo.e-commerce.payment' \
 -H 'Content-type: application/json' \
 -H 'DateTime: string' \
 -H 'MsgID: string' \
 -H 'SignType: string' \
 -d '{
  "allowAvsCheck": true,
  "authentication": {
    "accountInfo": {
      "accountAgeIndicator": "string",
      "accountChangeDate": "20170717",
      "accountChangeIndicator": "string",
      "accountCreationDate": "20170717",
      "addCardAttemptsDay": "string",
      "deliveryAddressUsageDate": "20170717",
      "deliveryAddressUsageIndicator": "string",
      "homePhone": {
        "countryCode": "string",
        "subscriberSections": "string"
      },
      "mobilePhone": {
        "countryCode": "string",
        "subscriberSections": "string"
      },
      "passwordChangeDate": "20170717",
      "passwordChangeDateIndicator": "string",
      "pastTransactionsDay": "string",
      "pastTransactionsYear": "string",
      "paymentAccountAge": "20170717",
      "paymentAccountIndicator": "string",
      "purchasesLast6Months": "string",
      "shippingNameIndicator": true,
      "suspiciousActivity": true,
      "workPhone": {
        "countryCode": "string",
        "subscriberSections": "string"
      }
    },
    "authenticationMethod": "string",
    "authenticationOnly": true,
    "authenticationType": "string",
    "billingAddress": {
      "addressLine1": "string",
      "addressLine2": "string",
      "addressLine3": "string",
      "city": "string",
      "country": "CHN",
      "postalCode": "string",
      "stateOrProvince": "string"
    },
    "browserInfo": {
      "acceptHeader": "string",
      "colorDepth": "string",
      "javaEnabled": true,
      "javaScriptEnabled": true,
      "language": "en-GB",
      "screenHeight": "string",
      "screenWidth": "string",
      "timeZoneOffset": "-120",
      "userAgent": "string"
    },
    "deliveryAddress": {
      "addressLine1": "string",
      "addressLine2": "string",
      "addressLine3": "string",
      "city": "string",
      "country": "CHN",
      "postalCode": "string",
      "stateOrProvince": "string"
    },
    "merchantRiskIndicator": {
      "deliveryAddressIndicator": "string",
      "deliveryEmail": "string",
      "deliveryTimeframe": "string",
      "giftCardAmount": "123",
      "giftCardCount": "string",
      "giftCardCurrency": "HKD",
      "preOrderDate": "20170717",
      "preOrderPurchase": true,
      "reorderItems": true
    },
    "returnUrl": "string",
    "scaExemption": "string",
    "threeDS": {
      "cardholderAccountIdentifier": "string",
      "deviceType": "string",
      "mpiData": {
        "cavv": "string",
        "dsTransID": "string",
        "eci": "string",
        "threeDSVersion": "2.2.0"
      },
      "origin": "string",
      "shopperEmail": "string",
      "shopperIP": "string",
      "threeDSRequestorChallengeInd": "string"
    }
  },
  "captureAfterHours": "string",
  "enhanceMonitoring": true,
  "extendAuthorizationDateIndicator": "string",
  "instalment": {
    "name": "string",
    "planID": "string",
    "terms": "12"
  },
  "merchantTransInfo": {
    "merchantOrderReference": "string",
    "merchantTransID": "string",
    "merchantTransTime": "2017-07-17T13:42:40+01:00"
  },
  "metadata": "string",
  "origMerchantTransInfo": {
    "merchantTransID": "string"
  },
  "paymentMethod": {
    "accountUpdateIndicator": "string",
    "card": {
      "cardInfo": {
        "cardNumber": "string",
        "cvc": "string",
        "expiryDate": "string",
        "holderName": "string"
      },
      "cardInfoEncryptMethod": "string",
      "encryptedCardInfo": "string",
      "payerReference": "string",
      "tokenValidDays": "string",
      "tokenize": true
    },
    "industryUsage": "string",
    "isFirstCITTxn": true,
    "isSubsequentTxn": true,
    "recurringProcessingModel": "string",
    "recurringReference": "string",
    "token": {
      "eci": "string",
      "expiryDate": "string",
      "holderName": "string",
      "paymentBrand": "string",
      "tokenCryptogram": "string",
      "type": "string",
      "value": "string",
      "walletIdentifiers": "string"
    },
    "type": "string"
  },
  "pspInfo": {
    "DXS": "string",
    "city": "string",
    "emailAddress": "string",
    "feeProgramIndicator": "string",
    "marketplaceIDorSalesOrgID": "string",
    "mcc": "string",
    "merchantID": "string",
    "merchantName": "string",
    "merchantTaxID": "string",
    "merchantVerificationValue": "string",
    "nation": "string",
    "originNation": "string",
    "paymentFacilitator": "string",
    "paymentFacilitatorAddress": {
      "city": "string",
      "country": "string",
      "postalCode": "string",
      "stateOrProvince": "string",
      "street": "string"
    },
    "postCode": "string",
    "sponsorCode": "string",
    "stateOrProvince": "string",
    "street": "string",
    "subMerchantID": "string",
    "telephoneNumber": "string",
    "transactionCategoryCode": "string"
  },
  "recipientInfo": {
    "accountNumber": "string",
    "accountType": "string",
    "address": {
      "city": "string",
      "country": "string",
      "stateOrProvince": "string",
      "street": "string"
    },
    "name": {
      "firstName": "string",
      "lastName": "string",
      "middleName": "string"
    }
  },
  "surchargeFee": {
    "currency": "string",
    "value": "string"
  },
  "tradeInfo": {
    "checkInTime": "2006-01-02T15:04:05+07:00",
    "checkOutTime": "string",
    "departureTime": "string",
    "flightNumber": "string",
    "goodsDescription": "string",
    "goodsName": "string",
    "hotelName": "string",
    "purposeOfPayment": "string",
    "totalQuantity": 0,
    "tradeType": "string"
  },
  "transAmount": {
    "currency": "CNY",
    "value": "string"
  },
  "transInitiator": {
    "appVersion": "string",
    "deviceID": "string",
    "deviceType": "string",
    "inStorePaymentScenario": "string",
    "paymentScenario": "string",
    "platform": "string",
    "spec": "string",
    "tokenCookie": "string",
    "userCreateIp": "string"
  },
  "userInfo": {
    "address": {
      "city": "string",
      "country": "string",
      "stateOrProvince": "string",
      "street": "string"
    },
    "dateOfBirth": "string",
    "name": {
      "firstName": "string",
      "lastName": "string",
      "middleName": "string"
    }
  },
  "webhook": "string"
}'
JavaScript
const aid = 'YOUR_aid_PARAMETER';
fetch(
`https://hkg-uat-online.everonet.com/g2/v0/payment/acq/${aid}/evo.e-commerce.payment`,
{
  method: 'post',
  headers: {
  'Content-type': 'application/json',
  'DateTime': 'string',
  'MsgID': 'string',
  'SignType': 'string'
},
  body: '{
  "allowAvsCheck": true,
  "authentication": {
    "accountInfo": {
      "accountAgeIndicator": "string",
      "accountChangeDate": "20170717",
      "accountChangeIndicator": "string",
      "accountCreationDate": "20170717",
      "addCardAttemptsDay": "string",
      "deliveryAddressUsageDate": "20170717",
      "deliveryAddressUsageIndicator": "string",
      "homePhone": {
        "countryCode": "string",
        "subscriberSections": "string"
      },
      "mobilePhone": {
        "countryCode": "string",
        "subscriberSections": "string"
      },
      "passwordChangeDate": "20170717",
      "passwordChangeDateIndicator": "string",
      "pastTransactionsDay": "string",
      "pastTransactionsYear": "string",
      "paymentAccountAge": "20170717",
      "paymentAccountIndicator": "string",
      "purchasesLast6Months": "string",
      "shippingNameIndicator": true,
      "suspiciousActivity": true,
      "workPhone": {
        "countryCode": "string",
        "subscriberSections": "string"
      }
    },
    "authenticationMethod": "string",
    "authenticationOnly": true,
    "authenticationType": "string",
    "billingAddress": {
      "addressLine1": "string",
      "addressLine2": "string",
      "addressLine3": "string",
      "city": "string",
      "country": "CHN",
      "postalCode": "string",
      "stateOrProvince": "string"
    },
    "browserInfo": {
      "acceptHeader": "string",
      "colorDepth": "string",
      "javaEnabled": true,
      "javaScriptEnabled": true,
      "language": "en-GB",
      "screenHeight": "string",
      "screenWidth": "string",
      "timeZoneOffset": "-120",
      "userAgent": "string"
    },
    "deliveryAddress": {
      "addressLine1": "string",
      "addressLine2": "string",
      "addressLine3": "string",
      "city": "string",
      "country": "CHN",
      "postalCode": "string",
      "stateOrProvince": "string"
    },
    "merchantRiskIndicator": {
      "deliveryAddressIndicator": "string",
      "deliveryEmail": "string",
      "deliveryTimeframe": "string",
      "giftCardAmount": "123",
      "giftCardCount": "string",
      "giftCardCurrency": "HKD",
      "preOrderDate": "20170717",
      "preOrderPurchase": true,
      "reorderItems": true
    },
    "returnUrl": "string",
    "scaExemption": "string",
    "threeDS": {
      "cardholderAccountIdentifier": "string",
      "deviceType": "string",
      "mpiData": {
        "cavv": "string",
        "dsTransID": "string",
        "eci": "string",
        "threeDSVersion": "2.2.0"
      },
      "origin": "string",
      "shopperEmail": "string",
      "shopperIP": "string",
      "threeDSRequestorChallengeInd": "string"
    }
  },
  "captureAfterHours": "string",
  "enhanceMonitoring": true,
  "extendAuthorizationDateIndicator": "string",
  "instalment": {
    "name": "string",
    "planID": "string",
    "terms": "12"
  },
  "merchantTransInfo": {
    "merchantOrderReference": "string",
    "merchantTransID": "string",
    "merchantTransTime": "2017-07-17T13:42:40+01:00"
  },
  "metadata": "string",
  "origMerchantTransInfo": {
    "merchantTransID": "string"
  },
  "paymentMethod": {
    "accountUpdateIndicator": "string",
    "card": {
      "cardInfo": {
        "cardNumber": "string",
        "cvc": "string",
        "expiryDate": "string",
        "holderName": "string"
      },
      "cardInfoEncryptMethod": "string",
      "encryptedCardInfo": "string",
      "payerReference": "string",
      "tokenValidDays": "string",
      "tokenize": true
    },
    "industryUsage": "string",
    "isFirstCITTxn": true,
    "isSubsequentTxn": true,
    "recurringProcessingModel": "string",
    "recurringReference": "string",
    "token": {
      "eci": "string",
      "expiryDate": "string",
      "holderName": "string",
      "paymentBrand": "string",
      "tokenCryptogram": "string",
      "type": "string",
      "value": "string",
      "walletIdentifiers": "string"
    },
    "type": "string"
  },
  "pspInfo": {
    "DXS": "string",
    "city": "string",
    "emailAddress": "string",
    "feeProgramIndicator": "string",
    "marketplaceIDorSalesOrgID": "string",
    "mcc": "string",
    "merchantID": "string",
    "merchantName": "string",
    "merchantTaxID": "string",
    "merchantVerificationValue": "string",
    "nation": "string",
    "originNation": "string",
    "paymentFacilitator": "string",
    "paymentFacilitatorAddress": {
      "city": "string",
      "country": "string",
      "postalCode": "string",
      "stateOrProvince": "string",
      "street": "string"
    },
    "postCode": "string",
    "sponsorCode": "string",
    "stateOrProvince": "string",
    "street": "string",
    "subMerchantID": "string",
    "telephoneNumber": "string",
    "transactionCategoryCode": "string"
  },
  "recipientInfo": {
    "accountNumber": "string",
    "accountType": "string",
    "address": {
      "city": "string",
      "country": "string",
      "stateOrProvince": "string",
      "street": "string"
    },
    "name": {
      "firstName": "string",
      "lastName": "string",
      "middleName": "string"
    }
  },
  "surchargeFee": {
    "currency": "string",
    "value": "string"
  },
  "tradeInfo": {
    "checkInTime": "2006-01-02T15:04:05+07:00",
    "checkOutTime": "string",
    "departureTime": "string",
    "flightNumber": "string",
    "goodsDescription": "string",
    "goodsName": "string",
    "hotelName": "string",
    "purposeOfPayment": "string",
    "totalQuantity": 0,
    "tradeType": "string"
  },
  "transAmount": {
    "currency": "CNY",
    "value": "string"
  },
  "transInitiator": {
    "appVersion": "string",
    "deviceID": "string",
    "deviceType": "string",
    "inStorePaymentScenario": "string",
    "paymentScenario": "string",
    "platform": "string",
    "spec": "string",
    "tokenCookie": "string",
    "userCreateIp": "string"
  },
  "userInfo": {
    "address": {
      "city": "string",
      "country": "string",
      "stateOrProvince": "string",
      "street": "string"
    },
    "dateOfBirth": "string",
    "name": {
      "firstName": "string",
      "lastName": "string",
      "middleName": "string"
    }
  },
  "webhook": "string"
}'
})
  .then(response => response.json())
  .then(data => console.log(data));
Response Samples
application/json
json