EVO Payment API Portal

ENG

简体中文

ENG

简体中文

PaymentInstrument ​

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`

Query Parameters

token
string
Example: {EVO Cloud or merchant token value of paymentInstrument}

Request Body schema

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)
paymentMethod
object
This field includes the Payment Method information, including Payment Method selected by User for Payment, and the Payment Method supported by the merchant. - Usage Instruction 1. For PUT PaymentInstrument request, this field must be present when updating token. 2. For GET PaymentInstrument response, if merchant sends merchantTransID in GET PaymentInstrument request, EVO Cloud will return this object. 3. For GET PaymentInstrument response, if merchant sends token in GET PaymentInstrument request and the token generation is successful, EVO Cloud will return this object. 4. For DELETE PaymentInstrument response, if merchant sends token in DELETE PaymentInstrument request, EVO Cloud will return this object when the token exists and is not disable. 5. EVO Cloud may include this object in response.

Responses

Try it
Server
https://hkg-uat-online.everonet.com
Path Parameters
Header Parameters
Query Parameters
Request Body Parameters
Request Samples
cURL
curl -i -X PUT \
'https://hkg-uat-online.everonet.com/g2/v0/payment/acq/{aid}/evo.e-commerce.paymentInstrument?token=%7BEVO+Cloud+or+merchant+token+value+of+paymentInstrument%7D' \
 -H 'Content-type: application/json' \
 -H 'DateTime: string' \
 -H 'MsgID: string' \
 -H 'SignType: string' \
 -d '{
  "metadata": "string",
  "paymentMethod": {
    "card": {
      "cardInfo": {
        "expiryDate": "string",
        "holderName": "string"
      }
    },
    "payerReference": "string",
    "tokenValidDays": "string",
    "type": "string"
  }
}'
JavaScript
const query = new URLSearchParams({
  "token": "{EVO Cloud or merchant token value of paymentInstrument}"
}).toString()

const aid = 'YOUR_aid_PARAMETER';
fetch(
`https://hkg-uat-online.everonet.com/g2/v0/payment/acq/${aid}/evo.e-commerce.paymentInstrument?${query}`,
{
  method: 'put',
  headers: {
  'Content-type': 'application/json',
  'DateTime': 'string',
  'MsgID': 'string',
  'SignType': 'string'
},
  body: '{
  "metadata": "string",
  "paymentMethod": {
    "card": {
      "cardInfo": {
        "expiryDate": "string",
        "holderName": "string"
      }
    },
    "payerReference": "string",
    "tokenValidDays": "string",
    "type": "string"
  }
}'
})
  .then(response => response.json())
  .then(data => console.log(data));
Response Samples
application/json
json