EVO Payment API Portal

ENG

简体中文

ENG

简体中文

PaymentMethod ​

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

allowNWTokenAuthentication
boolean
Indicates whether to authenticate the Token after successfully obtaining the Network Token. If true, the authentication URL will be responded to after the Network Token is successfully obtained. - Usage definition: 1. This field is only valid when networkTokenOnly = true.
authentication
object
Cardholder authentication information
merchantTransInfo
object
Required
Information of the merchant’s transaction
metadata
string<= 512 characters
Remarks Information
networkTokenOnly
boolean
Indicates whether the current interface request requires a Network Token - Usage definition: 1. If true, EVO Cloud will provision and return a Network Token. 2. If not present, means default value = false
paymentMethod
object
Required
pspInfo
object
Required
The key values of the transactions that assigned by psp.
transInitiator
object
The transaction initiated platform
userInfo
object
Detailed information about the buyer - Usage Instruction 1. Used in POST Payment request and POST PaymentMethod request, to send the buyer's 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.paymentMethod' \
 -H 'Content-type: application/json' \
 -H 'DateTime: string' \
 -H 'MsgID: string' \
 -H 'SignType: string' \
 -d '{
  "allowNWTokenAuthentication": true,
  "authentication": {
    "accountInfo": {
      "accountAgeIndicator": "string",
      "accountChangeDate": "string",
      "accountChangeIndicator": "string",
      "accountCreationDate": "string",
      "addCardAttemptsDay": "string",
      "deliveryAddressUsageDate": "string",
      "deliveryAddressUsageIndicator": "string",
      "homePhone": {
        "countryCode": "string",
        "subscriberSections": "string"
      },
      "mobilePhone": {
        "countryCode": "string",
        "subscriberSections": "string"
      },
      "passwordChangeDate": "string",
      "passwordChangeDateIndicator": "string",
      "pastTransactionsDay": "string",
      "pastTransactionsYear": "string",
      "paymentAccountAge": "string",
      "paymentAccountIndicator": "string",
      "purchasesLast6Months": "string",
      "shippingNameIndicator": true,
      "suspiciousActivity": true,
      "workPhone": {
        "countryCode": "string",
        "subscriberSections": "string"
      }
    },
    "authenticationType": "string",
    "billingAddress": {
      "addressLine1": "string",
      "addressLine2": "string",
      "addressLine3": "string",
      "city": "string",
      "country": "string",
      "postalCode": "string",
      "stateOrProvince": "string"
    },
    "browserInfo": {
      "acceptHeader": "string",
      "colorDepth": "string",
      "javaEnabled": true,
      "javaScriptEnabled": true,
      "language": "string",
      "screenHeight": "string",
      "screenWidth": "string",
      "timeZoneOffset": "string",
      "userAgent": "string"
    },
    "deliveryAddress": {
      "addressLine1": "string",
      "addressLine2": "string",
      "addressLine3": "string",
      "city": "string",
      "country": "string",
      "postalCode": "string",
      "stateOrProvince": "string"
    },
    "merchantRiskIndicator": {
      "deliveryAddressIndicator": "string",
      "deliveryEmail": "string",
      "deliveryTimeframe": "string",
      "giftCardAmount": "string",
      "giftCardCount": "string",
      "giftCardCurrency": "string",
      "preOrderDate": "string",
      "preOrderPurchase": true,
      "reorderItems": true
    },
    "returnUrl": "string",
    "threeDS": {
      "cardholderAccountIdentifier": "string",
      "deviceType": "string",
      "origin": "string",
      "shopperEmail": "string",
      "shopperIP": "string",
      "threeDSRequestorChallengeInd": "string"
    }
  },
  "merchantTransInfo": {
    "merchantOrderReference": "string",
    "merchantTransID": "string",
    "merchantTransTime": "string"
  },
  "metadata": "string",
  "networkTokenOnly": true,
  "paymentMethod": {
    "card": {
      "cardInfo": {
        "cardNumber": "string",
        "cvc": "string",
        "expiryDate": "string",
        "holderName": "string"
      },
      "cardInfoEncryptMethod": "string",
      "cardSource": "string",
      "encryptedCardInfo": "string"
    },
    "isFirstCITTxn": true,
    "payerReference": "string",
    "recurringProcessingModel": "string",
    "tokenValidDays": "string",
    "type": "string"
  },
  "pspInfo": {
    "DXS": "string",
    "city": "string",
    "emailAddress": "string",
    "feeProgramIndicator": "string",
    "marketplaceIDorSalesOrgID": "string",
    "mcc": "string",
    "merchantID": "string",
    "merchantName": "string",
    "merchantVerificationValue": "string",
    "nation": "string",
    "originNation": "string",
    "paymentFacilitator": "string",
    "postCode": "string",
    "sponsorCode": "string",
    "srcDpaID": "string",
    "street": "string",
    "subMerchantID": "string",
    "telephoneNumber": "string",
    "tokenRequesterID": "string",
    "transactionCategoryCode": "string"
  },
  "transInitiator": {
    "deviceID": "string",
    "deviceType": "string",
    "platform": "string"
  },
  "userInfo": {
    "email": "string",
    "locale": "string"
  },
  "webhook": "string"
}'
JavaScript
const aid = 'YOUR_aid_PARAMETER';
fetch(
`https://hkg-uat-online.everonet.com/g2/v0/payment/acq/${aid}/evo.e-commerce.paymentMethod`,
{
  method: 'post',
  headers: {
  'Content-type': 'application/json',
  'DateTime': 'string',
  'MsgID': 'string',
  'SignType': 'string'
},
  body: '{
  "allowNWTokenAuthentication": true,
  "authentication": {
    "accountInfo": {
      "accountAgeIndicator": "string",
      "accountChangeDate": "string",
      "accountChangeIndicator": "string",
      "accountCreationDate": "string",
      "addCardAttemptsDay": "string",
      "deliveryAddressUsageDate": "string",
      "deliveryAddressUsageIndicator": "string",
      "homePhone": {
        "countryCode": "string",
        "subscriberSections": "string"
      },
      "mobilePhone": {
        "countryCode": "string",
        "subscriberSections": "string"
      },
      "passwordChangeDate": "string",
      "passwordChangeDateIndicator": "string",
      "pastTransactionsDay": "string",
      "pastTransactionsYear": "string",
      "paymentAccountAge": "string",
      "paymentAccountIndicator": "string",
      "purchasesLast6Months": "string",
      "shippingNameIndicator": true,
      "suspiciousActivity": true,
      "workPhone": {
        "countryCode": "string",
        "subscriberSections": "string"
      }
    },
    "authenticationType": "string",
    "billingAddress": {
      "addressLine1": "string",
      "addressLine2": "string",
      "addressLine3": "string",
      "city": "string",
      "country": "string",
      "postalCode": "string",
      "stateOrProvince": "string"
    },
    "browserInfo": {
      "acceptHeader": "string",
      "colorDepth": "string",
      "javaEnabled": true,
      "javaScriptEnabled": true,
      "language": "string",
      "screenHeight": "string",
      "screenWidth": "string",
      "timeZoneOffset": "string",
      "userAgent": "string"
    },
    "deliveryAddress": {
      "addressLine1": "string",
      "addressLine2": "string",
      "addressLine3": "string",
      "city": "string",
      "country": "string",
      "postalCode": "string",
      "stateOrProvince": "string"
    },
    "merchantRiskIndicator": {
      "deliveryAddressIndicator": "string",
      "deliveryEmail": "string",
      "deliveryTimeframe": "string",
      "giftCardAmount": "string",
      "giftCardCount": "string",
      "giftCardCurrency": "string",
      "preOrderDate": "string",
      "preOrderPurchase": true,
      "reorderItems": true
    },
    "returnUrl": "string",
    "threeDS": {
      "cardholderAccountIdentifier": "string",
      "deviceType": "string",
      "origin": "string",
      "shopperEmail": "string",
      "shopperIP": "string",
      "threeDSRequestorChallengeInd": "string"
    }
  },
  "merchantTransInfo": {
    "merchantOrderReference": "string",
    "merchantTransID": "string",
    "merchantTransTime": "string"
  },
  "metadata": "string",
  "networkTokenOnly": true,
  "paymentMethod": {
    "card": {
      "cardInfo": {
        "cardNumber": "string",
        "cvc": "string",
        "expiryDate": "string",
        "holderName": "string"
      },
      "cardInfoEncryptMethod": "string",
      "cardSource": "string",
      "encryptedCardInfo": "string"
    },
    "isFirstCITTxn": true,
    "payerReference": "string",
    "recurringProcessingModel": "string",
    "tokenValidDays": "string",
    "type": "string"
  },
  "pspInfo": {
    "DXS": "string",
    "city": "string",
    "emailAddress": "string",
    "feeProgramIndicator": "string",
    "marketplaceIDorSalesOrgID": "string",
    "mcc": "string",
    "merchantID": "string",
    "merchantName": "string",
    "merchantVerificationValue": "string",
    "nation": "string",
    "originNation": "string",
    "paymentFacilitator": "string",
    "postCode": "string",
    "sponsorCode": "string",
    "srcDpaID": "string",
    "street": "string",
    "subMerchantID": "string",
    "telephoneNumber": "string",
    "tokenRequesterID": "string",
    "transactionCategoryCode": "string"
  },
  "transInitiator": {
    "deviceID": "string",
    "deviceType": "string",
    "platform": "string"
  },
  "userInfo": {
    "email": "string",
    "locale": "string"
  },
  "webhook": "string"
}'
})
  .then(response => response.json())
  .then(data => console.log(data));
Response Samples
application/json
json