• Home
  • Our APIs
  • Guides
  • Our Products
    • Nothing Found
  • Home
  • Our APIs
  • Guides
  • Our Products
    • Nothing Found
    v1.0
    Introduction
    Authentication
    Payment
      post
      Initiate transaction from online channel
      get
      Get specific payment detail
      post
      update Pre-auth payment or any pending payment
      post
      cancel the pre-auth
      post
      complete pre-auth payment (full or partial amount)
      post
      refund a payment
      post
      reverse a payment
      post
      3ds authentication flow
      post
      notify 3ds challenge completion & authorise the payment

3ds authentication flow

Securityapi_key
Request
Request Body schema: application/json
threeDSCompInd
required
string = 1 characters
Enum: "Y" "N" "U"
threeDSRequestorAuthenticationInd
required
string = 2 characters
Enum: "01" "02" "03" "04" "05" "06"
object
threeDSRequestorChallengeInd
string = 2 characters
Enum: "01" "02" "03" "04" "05" "06" "07" "08" "09"
threeDSRequestorDecMaxTime
string = 5 characters
threeDSRequestorDecReqInd
string = 1 characters
Enum: "Y" "N"
threeDSRequestorID
required
string <= 35 characters
threeDSRequestorName
required
string <= 40 characters
object
threeDSRequestorURL
required
string <= 2048 characters
threeDSServerTransID
required
string = 36 characters
acctType
string
Enum: "01" "02" "03"
acquirerMerchantID
string <= 35 characters
addrMatch
string = 1 characters
Enum: "Y" "N"
object
browserAcceptHeader
string
browserIP
string
browserJavaEnabled
boolean
browserJavascriptEnabled
boolean
browserLanguage
string
browserColorDepth
string
Enum: "1 bits" "4 bits" "8 bits" "15 bits" "16 bits" "24 bits" "32 bits" "48 bits"
browserScreenHeight
string [ 1 .. 6 ] characters
browserScreenWidth
string [ 1 .. 6 ] characters
browserTZ
string [ 1 .. 5 ] characters
browserUserAgent
string <= 2048 characters
cardExpiryDate
string = 4 characters
object
acctID
string <= 64 characters
billAddrCity
string <= 50 characters
billAddrCountry
string <= 50 characters
billAddrLine1
string <= 50 characters
billAddrLine2
string <= 50 characters
billAddrLine3
string <= 50 characters
billAddrPostCode
string <= 16 characters
billAddrState
string <= 3 characters
email
string <= 254 characters
object
object
cardholderName
string [ 2 .. 45 ] characters
shipAddrCity
string <= 50 characters
shipAddrCountry
string = 3 characters
shipAddrLine1
string <= 50 characters
shipAddrLine2
string <= 50 characters
shipAddrLine3
string <= 50 characters
shipAddrPostCode
string <= 16 characters
shipAddrState
string <= 3 characters
object
deviceChannel
required
string
Value: "02"
payTokenInd
string
payTokenSource
string
purchaseInstalData
string <= 3 characters
mcc
string = 4 characters
merchantCountryCode
string = 3 characters
merchantName
string <= 40 characters
object
messageCategory
required
string
Enum: "01" "02"
Array of objects
messageType
required
string = 4 characters
messageVersion
required
string [ 5 .. 8 ] characters
purchaseAmount
string <= 48 characters
purchaseCurrency
string = 3 characters
purchaseExponent
string = 1 characters
purchaseDate
string
recurringExpiry
string = 8 characters
recurringFrequency
string <= 4 characters
transType
string
Enum: "01" "03" "10" "11" "28"
whiteListStatus
string
Enum: "Y" "N" "E" "P" "R" "U"
whiteListStatusSource
string
Enum: "01" "02" "03"
challengeWindowSize
required
string
Enum: "01" "02" " 03" "04" "05"
Responses
200

Successful response.

400

Invalid Request

401

Invalid API key.

403

Forbidden from performing this action.

500
post/online/v1/payment/3ds2/authenticate
Request samples
  • Payload
application/json
{
  • "deviceChannel": "02",
  • "messageCategory": null,
  • "messageType": "AReq",
  • "messageVersion": "2.2.0",
  • "threeDSCompInd": "Y",
  • "threeDSRequestorAuthenticationInd": "01",
  • "threeDSRequestorID": "",
  • "threeDSRequestorName": "",
  • "threeDSRequestorURL": "merchantcheckout.com",
  • "threeDSServerTransID": "cfdab65d-2374-9a40-9e13-fbb4c8325ac7",
  • "challengeWindowSize": "03"
}
Response samples
  • 200
  • 400
  • 401
  • 403
  • 500
application/json
{
  • "transactionReceipt": "string",
  • "payment": {
    • "paymentId": "472e651e-5a1e-424d-8098-23858bf03ad7",
    • "amount": 0,
    • "currency": "string",
    • "description": "string",
    • "autoComplete": true,
    • "standingInstruction": {
      • "type": "RECURRING",
      • "recurringType": "STANDING_ORDER",
      • "initialTransactionId": "string",
      • "mode": "INITIAL",
      • "industryPractice": "RESUBMISSION"
      },
    • "register": true,
    • "customer": {
      • "customerId": "string",
      • "firstName": "string",
      • "lastName": "string",
      • "dob": "string",
      • "gender": "M",
      • "emailId": "string",
      • "billingAddress": {
        • "addressLine1": "string",
        • "addressLine2": "string",
        • "city": "string",
        • "state": "string",
        • "postcode": "string",
        • "country": "string"
        },
      • "shippingFirstName": "string",
      • "shippingLastName": "string",
      • "shippingCompanyName": "string",
      • "shippingAddress": {
        • "addressLine1": "string",
        • "addressLine2": "string",
        • "city": "string",
        • "state": "string",
        • "postcode": "string",
        • "country": "string"
        },
      • "status": "ACTIVE",
      • "externalReferenceId": "string",
      • "createdDate": "2019-08-24T14:15:22Z",
      • "lastModifiedDate": "2019-08-24T14:15:22Z"
      },
    • "paymentMethod": {
      • "paymentMethodId": "string",
      • "type": "CARD",
      • "card": {
        • "cardId": "string",
        • "cardHolder": "string",
        • "paymentToken": "string",
        • "tokenId": "string",
        • "scheme": "string",
        • "threeDSecureUsage": true,
        • "bin": "string",
        • "last4Digit": "string",
        • "expiryMonth": "string",
        • "expiryYear": "string"
        },
      • "wallet": {
        • "walletId": "string",
        • "type": "string",
        • "paymentToken": "string",
        • "tokenId": "string",
        • "owner": "string",
        • "referenceId": "string"
        },
      • "preferred": true,
      • "status": "ACTIVE",
      • "threeDSResult": {
        • "eci": "string",
        • "authenticationValue": "string",
        • "messageVersion": "string",
        • "dsTransId": "string",
        • "transStatus": "string",
        • "xid": "string"
        },
      • "nextAction": {
        • "redirectType": "3DS_REDIRECT",
        • "threeDSRedirect": {
          • "threeDSMethodURL": "string",
          • "threeDSMethodData": "string",
          • "threeDSServerTransID": "string"
          }
        }
      },
    • "subscription": {
      • "subscriptionId": "string",
      • "status": "ACTIVE",
      • "amount": 0,
      • "currency": "string",
      • "startDate": "string",
      • "endDate": "string",
      • "frequency": "DAILY",
      • "paymentMethod": {
        • "paymentMethodId": "string",
        • "type": "CARD",
        • "card": {
          • "cardId": "string",
          • "cardHolder": "string",
          • "paymentToken": "string",
          • "tokenId": "string",
          • "scheme": "string",
          • "threeDSecureUsage": true,
          • "bin": "string",
          • "last4Digit": "string",
          • "expiryMonth": "string",
          • "expiryYear": "string"
          },
        • "wallet": {
          • "walletId": "string",
          • "type": "string",
          • "paymentToken": "string",
          • "tokenId": "string",
          • "owner": "string",
          • "referenceId": "string"
          },
        • "preferred": true,
        • "status": "ACTIVE",
        • "threeDSResult": {
          • "eci": "string",
          • "authenticationValue": "string",
          • "messageVersion": "string",
          • "dsTransId": "string",
          • "transStatus": "string",
          • "xid": "string"
          },
        • "nextAction": {
          • "redirectType": "3DS_REDIRECT",
          • "threeDSRedirect": {
            • "threeDSMethodURL": "string",
            • "threeDSMethodData": "string",
            • "threeDSServerTransID": "string"
            }
          }
        },
      • "mandate": {
        • "mandateId": "string",
        • "customerId": "string",
        • "acceptedDate": "string",
        • "status": "PENDING",
        • "createdDate": "string"
        },
      • "createdDate": "string",
      • "lastUpdatedDate": "string"
      },
    • "threeDSResult": {
      • "eci": "string",
      • "authenticationValue": "string",
      • "messageVersion": "string",
      • "dsTransId": "string",
      • "transStatus": "string",
      • "xid": "string"
      },
    • "nextAction": {
      • "redirectType": "3DS_REDIRECT",
      • "threeDSRedirect": {
        • "threeDSMethodURL": "string",
        • "threeDSMethodData": "string",
        • "threeDSServerTransID": "string"
        }
      },
    • "metadata": {
      • "merchantAdviceCode": 2,
      • "rrn": 12345678,
      • "stan": 123456,
      • "auth-code": 123456
      }
    },
  • "authenticationResponse": {
    • "threeDSServerTransID": "stringstringstringstringstringstring",
    • "acsChallengeMandated": "Y",
    • "acsDecConInd": "Y",
    • "acsOperatorID": "string",
    • "acsReferenceNumber": "string",
    • "acsTransID": "stringstringstringstringstringstring",
    • "acsURL": "string",
    • "authenticationType": "01",
    • "authenticationValue": "stringstringstringstringstri",
    • "broadInfo": {
      • "data": "string"
      },
    • "cardholderInfo": "string",
    • "dsReferenceNumber": "string",
    • "dsTransID": "string",
    • "eci": "st",
    • "messageExtension": [
      • {
        • "name": "string",
        • "id": "string",
        • "criticalityIndicator": true,
        • "data": {
          • "valueOne": "string",
          • "valueTwo": "string"
          }
        }
      ],
    • "messageType": "stri",
    • "messageVersion": "string",
    • "status": "AWAIT_COMPLETE",
    • "transStatus": "Y",
    • "transStatusReason": "01",
    • "whiteListStatus": "Y",
    • "whiteListStatusSource": "01",
    • "workPhone": {
      • "cc": "str",
      • "subscriber": "string"
      },
    • "errorCode": "string",
    • "errorComponent": "string",
    • "errorDescription": "string",
    • "errorDetail": "string",
    • "errorMessageType": "string"
    },
  • "result": {
    • "resultType": "COMPLETED",
    • "resultDescription": "string",
    • "errorCode": "string",
    • "errorDescription": "string",
    • "externalErrorCode": "string",
    • "externalErrorDescription": "string"
    }
}
Legal
  • Privacy Policy
Support
  • Contact us
© Copyright Till Payments 2023. All right reserved.