1. PaymentMethod
EVO Payment Gateway API
  • Gateway Integration
    • Version Record
    • CardInfoLink Gateway API Integration Guide
      • Online payments scenes
        • DCC
        • Tokenization
        • Payment
        • 3DS Authentication
        • Capture
        • Cancel
        • Refund
        • Merchandise Credit
        • Network token management
        • Cancel or Refund
        • Recapture
        • Recurring
      • Security Requirements and Message Header
        • Message protocol
        • Signature
        • Card Information Encryption
        • PIN Encryption
      • Offline payments scenes
        • Pre-authorization
        • Payment
        • Capture
        • Refund
        • Merchandise Credit
        • Cancel
        • Reversal
        • DCC
        • Recurring
      • Appendix
        • Response code
        • FAQ
        • Mastercard-Merchant Advice Code
        • Product Code
    • Offline API Specification
      • Payment
        • Payment
        • Payment
      • StandaloneCapture
        • StandaloneCapture
        • StandaloneCapture
      • Reversal
        • Reversal
      • MerchandiseCredit
        • MerchandiseCredit
        • MerchandiseCredit
      • Capture
        • Capture
        • Capture
      • TipsAdjustment
        • TipsAdjustment
        • TipsAdjustment
      • Cancel
        • Cancel
        • Cancel
      • MultipleCapture
        • MultipleCapture
        • MultipleCapture
      • FXRateInquiry
        • FXRateInquiry
        • FXRateInquiry
      • Refund
        • Refund
        • Refund
      • DCCToNon-DCC
        • DCCToNon-DCC
        • DCCToNon-DCC
      • ZPK
        • ZPK
      • Notification
        • Asynchronous notification for StandaloneCapture
        • Asynchronous notification for MultipleCapture
        • Asynchronous notification for Payment
        • Asynchronous notification for Capture
        • Asynchronous notification for Refund
        • Asynchronous notification for MerchandiseCredit
        • Asynchronous notification for Cancel
    • Online API Specification
      • PaymentMethod
        • PaymentMethod
          POST
        • PaymentMethod
          PUT
        • PaymentMethod
          GET
        • PaymentMethod
          DELETE
      • Payment
        • Payment
        • Payment
        • Payment
      • Refund
        • Refund
        • Refund
      • Cancel
        • Cancel
        • Cancel
      • Capture
        • Capture
        • Capture
      • PaymentInstrument
        • PaymentInstrument
        • PaymentInstrument
        • PaymentInstrument
        • PaymentInstrument
      • MerchandiseCredit
        • MerchandiseCredit
        • MerchandiseCredit
      • CancelOrRefund
        • CancelOrRefund
        • CancelOrRefund
      • TransactionHistoryInquiry Copy
        • TransactionHistoryInquiry
      • MultipleCapture
        • MultipleCapture
        • MultipleCapture
      • Cryptogram
        • Cryptogram
        • Cryptogram
      • StandaloneCapture
        • StandaloneCapture
        • StandaloneCapture
      • Recapture
        • Recapture
        • Recapture
      • AsynchronousNotification
        • Asynchronous notification for Multiple Capture
        • Asynchronous notification for PaymentMethod
        • Asynchronous notification for PaymentInstrument
        • Asynchronous notification for Payment
        • Asynchronous notification for Merchandise Credit
        • Asynchronous notification for Refund
        • Asynchronous notification for Capture
        • Asynchronous notification for Cancel
        • Asynchronous notification for Recapture
        • Asynchronous notification for Cryptogram
        • Asynchronous notification for Network Token update
        • Asynchronous notification for Standalone Capture
        • Asynchronous notification for Network Token authentication finished
      • HealthCheck
        • HealthCheck
      • FX Rate inquiry
        • FXRateInquiry
        • FXRateInquiry
  1. PaymentMethod

PaymentMethod

POST
/g2/v0/payment/acq/{aid}/evo.e-commerce.paymentMethod

Request

Path Params

Header Params

Body Params application/json

Example
{
    "networkTokenOnly": true,
    "allowNWTokenAuthentication": true,
    "authentication": {
        "authenticationType": "threeDSPage",
        "returnUrl": "string",
        "threeDS": {
            "deviceType": "Web",
            "shopperIP": "string",
            "shopperEmail": "string",
            "cardholderAccountIdentifier": "string",
            "origin": "string",
            "threeDSRequestorChallengeInd": "01"
        },
        "browserInfo": {
            "acceptHeader": "string",
            "colorDepth": "st",
            "javaEnabled": true,
            "javaScriptEnabled": true,
            "language": "string",
            "screenHeight": "string",
            "screenWidth": "string",
            "timeZoneOffset": "strin",
            "userAgent": "string"
        },
        "accountInfo": {
            "accountAgeIndicator": "notApplicable",
            "accountChangeDate": "string",
            "accountChangeIndicator": "thisTransaction",
            "accountCreationDate": "string",
            "passwordChangeDate": "string",
            "passwordChangeDateIndicator": "notApplicable",
            "purchasesLast6Months": "stri",
            "addCardAttemptsDay": "str",
            "pastTransactionsDay": "str",
            "pastTransactionsYear": "str",
            "paymentAccountAge": "string",
            "paymentAccountIndicator": "notApplicable",
            "deliveryAddressUsageDate": "string",
            "deliveryAddressUsageIndicator": "thisTransaction",
            "shippingNameIndicator": true,
            "suspiciousActivity": true,
            "homePhone": {
                "countryCode": "str",
                "subscriberSections": "string"
            },
            "mobilePhone": {
                "countryCode": "str",
                "subscriberSections": "string"
            },
            "workPhone": {
                "countryCode": "str",
                "subscriberSections": "string"
            }
        },
        "deliveryAddress": {
            "addressLine1": "string",
            "addressLine2": "string",
            "addressLine3": "string",
            "city": "string",
            "stateOrProvince": "str",
            "country": "str",
            "postalCode": "string"
        },
        "merchantRiskIndicator": {
            "deliveryEmail": "string",
            "deliveryTimeframe": "electronicDelivery",
            "giftCardAmount": "string",
            "giftCardCount": "st",
            "giftCardCurrency": "str",
            "preOrderDate": "string",
            "preOrderPurchase": true,
            "reorderItems": true,
            "deliveryAddressIndicator": "shipToBillingAddress"
        },
        "billingAddress": {
            "addressLine1": "string",
            "addressLine2": "string",
            "addressLine3": "string",
            "city": "string",
            "stateOrProvince": "str",
            "country": "str",
            "postalCode": "string"
        }
    },
    "merchantTransInfo": {
        "merchantTransID": "string",
        "merchantOrderReference": "string",
        "merchantTransTime": "2019-08-24T14:15:22.123Z"
    },
    "pspInfo": {
        "mcc": "stri",
        "sponsorCode": "Diners",
        "DXS": "Diners",
        "merchantID": "string",
        "merchantName": "string",
        "emailAddress": "string",
        "telephoneNumber": "string",
        "street": "string",
        "city": "string",
        "postCode": "string",
        "nation": "str",
        "originNation": "str",
        "merchantVerificationValue": "string",
        "transactionCategoryCode": "s",
        "paymentFacilitator": "string",
        "marketplaceIDorSalesOrgID": "string",
        "subMerchantID": "string",
        "feeProgramIndicator": "str",
        "tokenRequesterID": "string",
        "srcDpaID": "string",
        "foreignRetailerIndicator": "F"
    },
    "paymentMethod": {
        "type": "card",
        "tokenValidDays": "str",
        "payerReference": "string",
        "recurringProcessingModel": "COF",
        "isFirstCITTxn": true,
        "card": {
            "cardSource": "Cardholder",
            "encryptedCardInfo": "string",
            "cardInfoEncryptMethod": "RSA",
            "cardInfo": {
                "cardNumber": "string",
                "expiryDate": "stri",
                "cvc": "stri",
                "holderName": "string"
            }
        }
    },
    "userInfo": {
        "email": "string",
        "locale": "strin",
        "name": {
            "firstName": "string",
            "middleName": "string",
            "lastName": "string"
        }
    },
    "transInitiator": {
        "platform": "WEB",
        "deviceType": "Terminal Type",
        "deviceID": "string"
    },
    "webhook": "string",
    "metadata": "string",
    "recipientInfo": {
        "name": {
            "firstName": "string",
            "middleName": "string",
            "lastName": "string"
        }
    },
    "allowAniCheck": {}
}

Responses

🟢200Success
application/json
Headers

Bodyapplication/json

Example
{
    "result": {
        "code": "string",
        "message": "string",
        "pspResponseCode": "string",
        "pspMessage": "string",
        "action": "IdentifyShopper"
    },
    "paymentMethod": {
        "status": "Verifying",
        "failureCode": "string",
        "failureReason": "string",
        "paymentAccountReference": "string",
        "pspFailureCode": "string",
        "pspFailureReason": "string",
        "merchantTransInfo": {
            "merchantTransID": "string",
            "merchantOrderReference": "string",
            "merchantTransTime": "2019-08-24T14:15:22.123Z"
        },
        "card": {
            "first6No": "string",
            "last4No": "stri",
            "paymentBrand": "string",
            "fundingType": "string",
            "holderName": "string",
            "issuingBank": "string",
            "issuingCountry": "str",
            "issuerCountry": "str",
            "isCommercial": true,
            "updatedCardInfo": "string",
            "cardInfoEncryptMethod": "RSA",
            "creditFlagOrig": "01"
        },
        "token": {
            "value": "string",
            "fingerprint": "string",
            "createTime": "2019-08-24T14:15:22.123Z",
            "updateTime": "2019-08-24T14:15:22.123Z",
            "status": "disable"
        },
        "networkToken": {
            "value": "string",
            "first6No": "string",
            "last4No": "stri",
            "tokenID": "string",
            "paymentBrand": "Visa ",
            "expiryDate": "stri",
            "status": "enabled",
            "paymentAccountReference": "string",
            "tokenReferenceID": "string"
        },
        "pspTransInfo": {
            "aniCheckRecipientResultRaw": "Y/01",
            "aniCheckRecipientResult": "string",
            "aniCheckSenderResultRaw": "A/01",
            "aniCheckSenderResult": "string"
        }
    },
    "authentication": {
        "authenticationType": "threeDS",
        "threeDS": {
            "redirectUrl": "string",
            "redirectData": {
                "method": "string",
                "threeDSMethodData": "string",
                "creq": "string"
            }
        }
    },
    "pendingEvents": [
        {
            "eventType": "FIDOAuthentication",
            "eventMethod": "FIDOPage",
            "action": {
                "type": "redirectUser",
                "redirectData": {
                    "url": "string",
                    "method": "string"
                }
            }
        }
    ],
    "metadata": "string"
}
Previous
Asynchronous notification for Cancel
Next
PaymentMethod
Built with