EVO Payment API Portal

ENG

简体中文

ENG

简体中文

Payment ​

Request

Path Parameters

aid
string
Required

Header Parameters

Content-type
string
Fixed value application/json
DateTime
string
Request time, The format is `YYYY-MM-DDThh:mm:ssZhh:00` such as` 2020-03-04T15:39:40Z08:00`.
MsgID
string
The suggested value is UUID or GUID to mark this request, such `2d21a5715c034efb7e0aa383b885fc7a`, Do not exceed 32 characters in length;
SignType
string
Algorithm for calculating signatures.`SHA256` or `SHA512`

Request Body schema

allowAvsCheck
boolean
This is to indicate if an AVS (Address Verification Service) check should be performed - Usage Instruction 1. This field is used in POST Payment requests only. If true, EVO Cloud will perform an AVS check for the card transaction. 2. If not present, default value = false, EVO Cloud will skip AVS check. 3. Field Type: Boolean (true / false)
authentication
object
Cardholder's authentication information Mandatory when paymentMethod.type = card / token
captureAfterHours
string<= 3 characters
Capture delay time Capture according to time, change the order status to captured and send asynchronous notifications to the access party. If it is not sent, the default is to select manual capture. 0: Capture immediately 1-168: Automatic capture after 1-168 hours
enhanceMonitoring
boolean
This is to indicate if this Payment needs to trigger monitoring - Usage instruction: 1. This filed is used in POST Payment request request, if true, EVO cloud will trigger monitoring for this transaction. 2. If not present, means default value=false, EVO Cloud will not trigger monitoring for this transaction. 3. Field Type: Boolean
extendAuthorizationDateIndicator
string<= 1 characters
Enum: Y
Extend Authorization Date Indicator - Usage Instruction 1. This field is suitable for the paymentBrand=Visa;
instalment
object
instalment information, - Usage Instruction If captureAfterHours=0, EVO Cloud support instalment. If captureAfterHours is not 0, this object will ignored.
merchantTransInfo
object
Required
Information of the merchant’s transaction
metadata
string<= 512 characters
Remarks Information
origMerchantTransInfo
object
This is the information for merchant to identify original Transaction - Usage Instruction 1.If paymnetMethod.industry exist, original Transaction should be Payment and this field is applied.
paymentMethod
object
pspInfo
object
The key values of the transactions that assigned by psp.
recipientInfo
object
In funding transfer transaction, this object is used to send recipient information.
surchargeFee
object
An additional fee that is added to initial transaction amount. - Usage Instruction 1. When this field is presented, the transaction amount should be the adjusted amount including the surcharge fee. 2. This field will be ignored when captureAfterHours does not equal to 0.
tradeInfo
object
Mandatory when Funding_Transfer transaction.
transAmount
object
Required
Transaction amount
transInitiator
object
Transaction initiated platform
userInfo
object
In funding transfer transaction, this object is used to send sender information.
webhook
string<= 300 characters
Asynchronous notification address After the transaction is successfully processed in the background, push notification to this address

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 '{
  "merchantTransInfo": {
    "merchantTransID": "{{merchantTransID}}",
    "merchantTransTime": "{{merchantTransTime}}"
  },
  "paymentMethod": {
    "card": {
      "cardInfo": {
        "cardNumber": "2222669999000333",
        "expiryDate": "2712"
      },
      "tokenize": false
    },
    "type": "card"
  },
  "pspInfo": {
    "city": "HongKong",
    "mcc": "5499",
    "merchantID": "123456789999888",
    "merchantName": "Test",
    "nation": "HKG",
    "postCode": "202000",
    "sponsorCode": "123456",
    "storeID": "12345678",
    "storeName": "Test Store",
    "street": "Test street"
  },
  "transAmount": {
    "currency": "HKD",
    "value": "1.00"
  },
  "transInitiator": {
    "platform": "WEB"
  }
}'
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: '{
  "merchantTransInfo": {
    "merchantTransID": "{{merchantTransID}}",
    "merchantTransTime": "{{merchantTransTime}}"
  },
  "paymentMethod": {
    "card": {
      "cardInfo": {
        "cardNumber": "2222669999000333",
        "expiryDate": "2712"
      },
      "tokenize": false
    },
    "type": "card"
  },
  "pspInfo": {
    "city": "HongKong",
    "mcc": "5499",
    "merchantID": "123456789999888",
    "merchantName": "Test",
    "nation": "HKG",
    "postCode": "202000",
    "sponsorCode": "123456",
    "storeID": "12345678",
    "storeName": "Test Store",
    "street": "Test street"
  },
  "transAmount": {
    "currency": "HKD",
    "value": "1.00"
  },
  "transInitiator": {
    "platform": "WEB"
  }
}'
})
  .then(response => response.json())
  .then(data => console.log(data));
Response Samples
application/json
json