EVO Payment API Portal

ENG

简体中文

ENG

简体中文

Notification for Payment ​

Request

Request Body schema

authentication
object
The information used for User authentication with Card - Usage Instruction 1. EVO Cloud supports securePlus and threeDS authentication types
eventCode
string<= 32 characters
Required
Enum: Payment
Used to indicate the type of a Notification - Usage Instruction 1. Filed Type: String(32)
extendAuthorizationDateIndicator
string<= 1 characters
Enum: YN
Extend Authorization Date Indicator - Usage Instruction 1. This field is suitable for the paymentBrand=Visa
fxRateInquiry
object
This object includes related information for an original FXRateInquiry which has been successfully processed in EVO Cloud - Usage Instruction 1. This field is used in response for the API of FXRateInquiry and Payment 2. This field is used in Notification for the API of Payment
metadata
string<= 512 characters
This field is used for merchant to state reference information - Usage Instruction 1. If merchant sends this field in the request message, EVO Cloud will echo it back in the response 2. Field Type: String(512)
payment
object
Required
This object includes related information for an original Payment transaction which has been successfully processed in EVO Cloud - Usage Instruction 1. This field is used in response for the API of Payment, Cancel, Capture, Refund and DataSubmission 2. This field is used in Notification for the API of Payment, Cancel, Capture and Refund and DataSubmission
paymentMethod
object
Required
This field includes the Payment Method information, including Payment Method selected by User for Payment, and the Payment Method supported by the merchant
pspData
object
This is the supplemental data from PSP which may be used for some special service scenarios - Usage Instruction 1. EVO Cloud may provide this information if PSP provides
storeInfo
object
Supplemental store information need to be provided by merchant. - Usage definition 1. To indicate MCC for this merchant when the store is assigned multiple MCCs in EVO Cloud. 2. To indicate the store information for this merchant when settlement notification.
transInitiator
object
Information of terminal to initiate the transaction. - Usage instruction 1. Used in the request of PaymentMethod, Payment.
Try it
Server
https://online-uat.everonet.com
Request Body Parameters
Request Samples
cURL
curl -i -X POST \
'https://online-uat.everonet.com/payment webhook in the request' \
 -d '{
  "authentication": {
    "FIDO": {
      "eci": "string"
    },
    "threeDS": {
      "isFrictionless": "string",
      "mpiData": {
        "cardholderInfo": "string",
        "cavv": "string",
        "dsTransID": "string",
        "eci": "string",
        "status": "string",
        "threeDSVersion": "string",
        "transStatusReason": "string"
      }
    },
    "type": "string"
  },
  "eventCode": "string",
  "extendAuthorizationDateIndicator": "string",
  "fxRateInquiry": {
    "evoTransInfo": {
      "evoTransID": "string",
      "evoTransTime": "string"
    },
    "localAmount": {
      "currency": "string",
      "value": "string"
    },
    "localToTransFXRate": {
      "baseCurrency": "string",
      "date": "string",
      "quoteCurrency": "string",
      "source": "string",
      "value": "string"
    },
    "merchantTransInfo": {
      "merchantOrderReference": "string",
      "merchantTransID": "string",
      "merchantTransTime": "string"
    },
    "status": "string",
    "transAmount": {
      "currency": "string",
      "value": "string"
    }
  },
  "metadata": "string",
  "payment": {
    "ASICancelStatus": "string",
    "billingAmount": {
      "currency": "string",
      "value": "string"
    },
    "billingFXRate": {
      "baseCurrency": "string",
      "quoteCurrency": "string",
      "value": "string"
    },
    "convertTransAmount": {
      "currency": "string",
      "value": "string"
    },
    "convertTransFXRate": {
      "baseCurrency": "string",
      "date": "string",
      "quoteCurrency": "string",
      "source": "string",
      "value": "string"
    },
    "discount": {
      "discountAmount": {
        "currency": "string",
        "value": "string"
      },
      "discountInfo": [
        {
          "currency": "string",
          "discountType": "string",
          "subDiscountAmount": {},
          "value": "string"
        }
      ],
      "payAmount": {
        "currency": "string",
        "value": "string"
      }
    },
    "evoTransInfo": {
      "evoTransID": "string",
      "evoTransTime": "string",
      "retrievalReferenceNum": "string",
      "traceNum": "string"
    },
    "failureCode": "string",
    "failureReason": "string",
    "localAmount": {
      "currency": "string",
      "value": "string"
    },
    "merchantTransInfo": {
      "merchantOrderReference": "string",
      "merchantTransID": "string",
      "merchantTransTime": "string"
    },
    "pspTransInfo": {
      "authorizationCode": "string",
      "avsCheckResult": "string",
      "avsCheckResultRaw": "string",
      "cvcCheckResult": "string",
      "cvcCheckResultRaw": "string",
      "merchantAdviceCode": "string",
      "pspTransID": "string",
      "pspTransTime": "string",
      "retrievalReferenceNum": "string"
    },
    "status": "string",
    "transAmount": {
      "currency": "string",
      "value": "string"
    }
  },
  "paymentMethod": {
    "accountUpdateIndicator": "string",
    "bankTransfer": {
      "accountNumber": "string",
      "paymentBrand": "string"
    },
    "buyNowPayLater": {
      "paymentBrand": "string"
    },
    "card": {
      "first6No": "string",
      "fundingType": "string",
      "hashCardNumber": "string",
      "holderName": "string",
      "isCommercial": true,
      "issuerCountry": "string",
      "issuingBank": "string",
      "issuingCountry": "string",
      "last4No": "string",
      "paymentBrand": "string",
      "posEntryMode": "string",
      "posEntryModeCode": "string",
      "productID": "string",
      "updatedCardInfo": "string"
    },
    "carrierBilling": {
      "paymentBrand": "string"
    },
    "cash": {
      "paymentBrand": "string"
    },
    "e-wallet": {
      "first6No": "string",
      "last4No": "string",
      "paymentBrand": "string"
    },
    "isNetworkToken": true,
    "networkToken": {
      "expiryDate": "string",
      "first6No": "string",
      "last4No": "string",
      "paymentAccountReference": "string",
      "status": "string",
      "supportDeviceBinding": true,
      "tokenID": "string",
      "tokenReferenceID": "string",
      "tokenRequesterID": "string"
    },
    "onlineBanking": {
      "issuingCompany": "string",
      "paymentBrand": "string"
    },
    "paymentAccountReference": "string",
    "paymentMethodVariant": "string",
    "points": {
      "paymentBrand": "string"
    },
    "prepaidCard": {
      "paymentBrand": "string"
    },
    "recurringReference": "string",
    "token": {
      "createTime": "string",
      "expiryDate": "string",
      "fingerprint": "string",
      "first6No": "string",
      "last4No": "string",
      "status": "string",
      "updateTime": "string",
      "userReference": "string",
      "value": "string",
      "vaultID": "string"
    }
  },
  "pspData": {
    "extra": "string",
    "fingerprint": "string",
    "name": "string",
    "networkTxReference": "string",
    "payerReference": "string",
    "sponsorCode": "string",
    "token": "string"
  },
  "storeInfo": {
    "mcc": "string",
    "sid": "string",
    "storeID": "string"
  },
  "transInitiator": {
    "terminalID": "string"
  }
}'
JavaScript
fetch(
`https://online-uat.everonet.com/payment webhook in the request`,
{
  method: 'post',
  body: '{
  "authentication": {
    "FIDO": {
      "eci": "string"
    },
    "threeDS": {
      "isFrictionless": "string",
      "mpiData": {
        "cardholderInfo": "string",
        "cavv": "string",
        "dsTransID": "string",
        "eci": "string",
        "status": "string",
        "threeDSVersion": "string",
        "transStatusReason": "string"
      }
    },
    "type": "string"
  },
  "eventCode": "string",
  "extendAuthorizationDateIndicator": "string",
  "fxRateInquiry": {
    "evoTransInfo": {
      "evoTransID": "string",
      "evoTransTime": "string"
    },
    "localAmount": {
      "currency": "string",
      "value": "string"
    },
    "localToTransFXRate": {
      "baseCurrency": "string",
      "date": "string",
      "quoteCurrency": "string",
      "source": "string",
      "value": "string"
    },
    "merchantTransInfo": {
      "merchantOrderReference": "string",
      "merchantTransID": "string",
      "merchantTransTime": "string"
    },
    "status": "string",
    "transAmount": {
      "currency": "string",
      "value": "string"
    }
  },
  "metadata": "string",
  "payment": {
    "ASICancelStatus": "string",
    "billingAmount": {
      "currency": "string",
      "value": "string"
    },
    "billingFXRate": {
      "baseCurrency": "string",
      "quoteCurrency": "string",
      "value": "string"
    },
    "convertTransAmount": {
      "currency": "string",
      "value": "string"
    },
    "convertTransFXRate": {
      "baseCurrency": "string",
      "date": "string",
      "quoteCurrency": "string",
      "source": "string",
      "value": "string"
    },
    "discount": {
      "discountAmount": {
        "currency": "string",
        "value": "string"
      },
      "discountInfo": [
        {
          "currency": "string",
          "discountType": "string",
          "subDiscountAmount": {},
          "value": "string"
        }
      ],
      "payAmount": {
        "currency": "string",
        "value": "string"
      }
    },
    "evoTransInfo": {
      "evoTransID": "string",
      "evoTransTime": "string",
      "retrievalReferenceNum": "string",
      "traceNum": "string"
    },
    "failureCode": "string",
    "failureReason": "string",
    "localAmount": {
      "currency": "string",
      "value": "string"
    },
    "merchantTransInfo": {
      "merchantOrderReference": "string",
      "merchantTransID": "string",
      "merchantTransTime": "string"
    },
    "pspTransInfo": {
      "authorizationCode": "string",
      "avsCheckResult": "string",
      "avsCheckResultRaw": "string",
      "cvcCheckResult": "string",
      "cvcCheckResultRaw": "string",
      "merchantAdviceCode": "string",
      "pspTransID": "string",
      "pspTransTime": "string",
      "retrievalReferenceNum": "string"
    },
    "status": "string",
    "transAmount": {
      "currency": "string",
      "value": "string"
    }
  },
  "paymentMethod": {
    "accountUpdateIndicator": "string",
    "bankTransfer": {
      "accountNumber": "string",
      "paymentBrand": "string"
    },
    "buyNowPayLater": {
      "paymentBrand": "string"
    },
    "card": {
      "first6No": "string",
      "fundingType": "string",
      "hashCardNumber": "string",
      "holderName": "string",
      "isCommercial": true,
      "issuerCountry": "string",
      "issuingBank": "string",
      "issuingCountry": "string",
      "last4No": "string",
      "paymentBrand": "string",
      "posEntryMode": "string",
      "posEntryModeCode": "string",
      "productID": "string",
      "updatedCardInfo": "string"
    },
    "carrierBilling": {
      "paymentBrand": "string"
    },
    "cash": {
      "paymentBrand": "string"
    },
    "e-wallet": {
      "first6No": "string",
      "last4No": "string",
      "paymentBrand": "string"
    },
    "isNetworkToken": true,
    "networkToken": {
      "expiryDate": "string",
      "first6No": "string",
      "last4No": "string",
      "paymentAccountReference": "string",
      "status": "string",
      "supportDeviceBinding": true,
      "tokenID": "string",
      "tokenReferenceID": "string",
      "tokenRequesterID": "string"
    },
    "onlineBanking": {
      "issuingCompany": "string",
      "paymentBrand": "string"
    },
    "paymentAccountReference": "string",
    "paymentMethodVariant": "string",
    "points": {
      "paymentBrand": "string"
    },
    "prepaidCard": {
      "paymentBrand": "string"
    },
    "recurringReference": "string",
    "token": {
      "createTime": "string",
      "expiryDate": "string",
      "fingerprint": "string",
      "first6No": "string",
      "last4No": "string",
      "status": "string",
      "updateTime": "string",
      "userReference": "string",
      "value": "string",
      "vaultID": "string"
    }
  },
  "pspData": {
    "extra": "string",
    "fingerprint": "string",
    "name": "string",
    "networkTxReference": "string",
    "payerReference": "string",
    "sponsorCode": "string",
    "token": "string"
  },
  "storeInfo": {
    "mcc": "string",
    "sid": "string",
    "storeID": "string"
  },
  "transInitiator": {
    "terminalID": "string"
  }
}'
})
  .then(response => response.json())
  .then(data => console.log(data));
Response Samples
application/octet-stream
json