v1
latestOpenAPI 3.1.02026-08-06731,0781.4 MB3D Secure Standalone
This function is used to process a request via the 3D Secure process without authorizing the payment. This will return the result of the 3D Secure process as well as the 3D Secure data that can then be used to process a payment via the Authorization or Sale/Purchase endpoint.
Integration Methods:
- Host Direct
See the Integration Methods and URLs Section sections of the Development Quick Start guide for details regarding each processing option.
Headers
Refers to the version of the program or application that is sending requests to Shift4. The following special characters are not allowed: $ % : ^ - ~ < > , ? “ ” ‘ ’ { } [ ] \ + =
Refers to the name of the program or application that is sending requests to Shift4. This should be the name of the program that you purchased or created. The following special characters are not allowed: $ % : ^ - ~ ` < > , ? “ ” ‘ ’ { } [ ] \ + =
Refers to the vendor or partner that designed and certified the interface. The information you use in this field should match what Shift4 has on file or what was agreed upon in your Integration Plan. The following special characters are not allowed: $ % : ^ - ~ ` < > , ? “ ” ‘ ’ { } [ ] \ + =
A security credential used to authenticate API requests and all i4Go® authorizeClient/preauthorizeClient requests. An Access Token is the alias for the merchant account and interface being used. The Access Token is required in all requests except an Access Token Exchange request, which generates an Access Token using an authToken and clientGuid.
Request body
Example request
{
"dateTime": "2022-05-04T09:18:23.283-07:00",
"amount": {
"total": 160
},
"currencyCode": "EUR",
"customer": {
"firstName": "John",
"lastName": "Smith",
"addressLine1": "65 Easy St",
"city": "Las Vegas",
"postalCode": "65144",
"emailAddress": "firstname.lastname@email.com",
"ipAddress": "63.57.84.101"
},
"card": {
"number": "4012000098765439",
"expirationDate": 1225,
"present": "N"
},
"transaction": {
"invoice": "730518",
"notes": "Transaction notes are added here"
},
"threeDSecure": {
"initiate": "03",
"browser": {
"acceptHeader": "text/html,application/xhtml+xml,application/xml;q=0.9,image/webp,image/apng,*/*;q=0.8",
"javaEnabled": true,
"javascriptEnabled": true,
"language": "en-GB",
"colorDepth": "48",
"screenWidth": 1920,
"screenHeight": 1080,
"tz": -480
},
"headerContent": "userAgent header",
"challengeWindowSize": "05",
"transType": "01",
"channel": "02"
},
"completionUrl": "https://merchant.com/completion",
"apiOptions": [
"ALLOWPARTIALAUTH"
]
}Response
Request was processed
Example response
{
"result": [
{
"dateTime": "2024-05-21T09:18:23.283-07:00",
"amount": {
"total": 160,
"tax": 15,
"taxIndicator": "Y",
"cashback": 20,
"iiasAmounts": [
{
"type": "4S",
"amount": 75
},
{
"type": "4W",
"amount": 25
}
],
"surcharge": 5,
"tip": 20,
"checkTotal": 200
},
"currencyCode": "USD",
"card": {
"entryMode": "M",
"expirationDate": 1230,
"levelResult": "2C",
"number": "XXXXXXXXXXXX1119",
"present": "Y",
"type": "VS",
"balance": {
"amount": 24.33
},
"securityCode": {
"result": "M",
"valid": "Y"
},
"token": {
"value": "8048471746471119"
},
"debitType": "girocard"
},
"customer": {
"firstName": "John",
"lastName": "Smith",
"phoneNumber": "3110001234",
"emailAddress": "john.smith@email.com",
"addressLine1": "65 Easy St",
"city": "Las Vegas",
"region": "NV",
"postalCode": "65144",
"country": "US",
"ipAddress": "63.57.84.101",
"shipping": {
"addressLine1": "65 Easy St",
"addressLine2": "c/o John Doe",
"city": "Las Vegas",
"country": "US",
"postalCode": "65144",
"region": "NV"
}
},
"merchant": {
"mid": 15877,
"name": "Merchant XYZ"
},
"transaction": {
"authSource": "E",
"hostResponse": {
"reasonCode": "04",
"reasonDescription": "Pick Up Card",
"reattemptPermission": "Reattempt not permitted"
},
"invoice": "0510093358",
"responseCode": "A",
"retrievalReference": "402F9H0230S0",
"avs": {
"postalCodeVerified": "Y",
"result": "X",
"streetVerified": "Y",
"valid": "Y"
}
},
"threeDSecure": {
"trxId": "a7bbd49a-ffe6-49b2-8a92-541f0a3b053d",
"cardholderInfo": "We+were+unable+to+confirm+your+payment.Please+contact+us+on+0800+121+4251+quoting+the+reference+AL01",
"cryptogram": "AAAAAAAA/COBt84dnIEcwAA3gAAGhgEDoLABAAhAgAABAAAALnNCLw==",
"programProtocol": "2",
"directoryServerTranId": "07e54000-2721-4df9-aa51-04fa0e079aa8",
"ecommIndicator": "5",
"securityLevelIndicator": "241"
},
"receipt": [
{
"key": "ApplicationIdentifier",
"printName": "AID",
"printValue": "A0000000031010"
},
{
"key": "TerminalVerificationResults",
"printName": "TVR",
"printValue": "8000"
},
{
"key": "IssuerApplicationData",
"printName": "IAD",
"printValue": "06010A03A40002"
},
{
"key": "TransactionStatusIndicator",
"printName": "TSI",
"printValue": "E800"
},
{
"key": "AuthorizationResponseCode",
"printName": "ARC",
"printValue": "00"
},
{
"key": "TransactionCurrencyCode",
"printValue": "USD$"
},
{
"key": "ApplicationLabel",
"printValue": "CREDITO DE VISA"
}
],
"server": {
"name": "TM01CE"
},
"universalToken": {
"value": "97032276-5944-00000001-16985FD179D"
},
"cardBrandToken": {
"requestorId": "12345678901",
"assuranceLevel": "01",
"panLast4": "6810",
"acctRangeStatus": "N"
}
}
]
}