Shift4

Shift4 3D Secure API

The 3D Secure API from Shift4 — 2 operation(s) for 3d secure.

GitHub OpenAPI

Operations 2

POST /3dsecure/standalone 3D Secure Standalone #
POST /3dsecure/completion 3D Secure Completion #

Documentation

📖
Documentation
https://docs.shift4.com/guides/core-concepts/capturing-sales
📖
APIReference
https://docs.shift4.com/apis/payments-platform-rest/openapi
📖
Documentation
https://docs.shift4.com/guides/core-concepts/understanding-card-tokens
📖
Documentation
https://docs.shift4.com/guides/device-functionality/commerce-engine
📖
Documentation
https://docs.shift4.com/guides/alternative-payments/ach
📖
Documentation
https://docs.shift4.com/guides/alternative-payments
📖
Documentation
https://docs.shift4.com/guides/advanced-concepts/3d-secure
📖
Documentation
https://docs.shift4.com/guides/core-concepts/payment-links

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/shift4/refs/heads/main/openapi/shift4-3d-secure-api-openapi.yml

Other Resources

🔗
APIsJSON
https://raw.githubusercontent.com/api-evangelist/shift4/refs/heads/main/apis.yml

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/shift4-3d-secure-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no email required.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

shift4-3d-secure-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  version: 1.7.57
  title: Shift4 Payment 3D Secure API
  contact:
    url: https://www.shift4.com/contact-us/
servers:
- url: https://api.shift4test.com/api/rest/v1
  description: Host Direct Test URL
- url: https://api.shift4api.net/api/rest/v1
  description: Host Direct Production URL
tags:
- name: 3D Secure
paths:
  /3dsecure/standalone:
    servers:
    - url: https://api.shift4test.com/api/rest/v1
      description: Host Direct Test URL
    - url: https://api.shift4api.net/api/rest/v1
      description: Host Direct Production URL
    post:
      tags:
      - 3D Secure
      summary: 3D Secure Standalone
      operationId: 3dsecurestandalone
      security:
      - AccessToken: []
      description: '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](/apis/payments-platform-rest/openapi/transactions/transactionsauthorization) or [Sale/Purchase](/apis/payments-platform-rest/openapi/transactions/transactionssale) endpoint.


        **Integration Methods:**

        - Host Direct


        See the [Integration Methods](/guides/quickstart#integration-methods) and [URLs Section](/guides/quickstart#urls) sections of the Development Quick Start guide for details regarding each processing option.

        '
      parameters:
      - $ref: '#/components/parameters/InterfaceVersion'
      - $ref: '#/components/parameters/InterfaceName'
      - $ref: '#/components/parameters/CompanyName'
      - $ref: '#/components/parameters/AccessToken'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              oneOf:
              - $ref: '#/components/schemas/3dsecure_standalone_cardnumber'
              - $ref: '#/components/schemas/3dsecure_standalone_token_gtv'
      responses:
        '200':
          description: Request was processed
          content:
            application/json:
              schema:
                oneOf:
                - title: Request Complete
                  properties:
                    result:
                      type: array
                      items:
                        type: object
                        required:
                        - dateTime
                        - amount
                        - currencyCode
                        properties:
                          dateTime:
                            $ref: '#/components/schemas/DateTime'
                          amount:
                            $ref: '#/components/schemas/Amount'
                          currencyCode:
                            $ref: '#/components/schemas/CurrencyCode'
                          card:
                            $ref: '#/components/schemas/CardResponse'
                          customer:
                            type: object
                            properties:
                              firstName:
                                $ref: '#/components/schemas/CustomerFirstName'
                              lastName:
                                $ref: '#/components/schemas/CustomerLastName'
                              phoneNumber:
                                $ref: '#/components/schemas/CustomerPhoneNumber'
                              emailAddress:
                                $ref: '#/components/schemas/CustomerEmailAddress'
                              addressLine1:
                                $ref: '#/components/schemas/CustomerAddressLine1'
                              city:
                                $ref: '#/components/schemas/CustomerCity'
                              region:
                                $ref: '#/components/schemas/CustomerRegion'
                              postalCode:
                                $ref: '#/components/schemas/CustomerPostalCode'
                              country:
                                $ref: '#/components/schemas/CustomerCountry'
                              ipAddress:
                                $ref: '#/components/schemas/CustomerIpAddress'
                              shipping:
                                $ref: '#/components/schemas/CustomerShipping3DSecure'
                          merchant:
                            $ref: '#/components/schemas/MerchantResponse'
                          transaction:
                            type: object
                            properties:
                              authSource:
                                $ref: '#/components/schemas/TransactionAuthSource'
                              hostResponse:
                                $ref: '#/components/schemas/HostResponse'
                              invoice:
                                $ref: '#/components/schemas/TransactionInvoice'
                              responseCode:
                                $ref: '#/components/schemas/TransactionResponseCode3DSStandalone'
                              retrievalReference:
                                $ref: '#/components/schemas/TransactionRetrievalReference'
                              avs:
                                $ref: '#/components/schemas/AVS'
                          threeDSecure:
                            type: object
                            properties:
                              trxId:
                                $ref: '#/components/schemas/ThreeDSecureTrxId'
                              cardholderInfo:
                                $ref: '#/components/schemas/ThreeDSecureCardholderInfo'
                              cryptogram:
                                $ref: '#/components/schemas/ThreeDSecureCryptogram'
                              programProtocol:
                                $ref: '#/components/schemas/ThreeDSecureProgramProtocol'
                              directoryServerTranId:
                                $ref: '#/components/schemas/ThreeDSecureDirectoryServerTranId'
                              ecommIndicator:
                                $ref: '#/components/schemas/ThreeDSecureEcommIndicator'
                              securityLevelIndicator:
                                $ref: '#/components/schemas/ThreeDSecureSecurityLevelIndicator'
                          receipt:
                            $ref: '#/components/schemas/ReceiptArray'
                          server:
                            $ref: '#/components/schemas/Server'
                          universalToken:
                            $ref: '#/components/schemas/UniversalToken'
                          cardBrandToken:
                            $ref: '#/components/schemas/CardBrandToken'
                      example:
                        dateTime: '2022-05-04T09:20:04.487-07:00'
                        amount:
                          tax: 15
                          total: 160
                        currencyCode: EUR
                        card:
                          entryMode: M
                          number: XXXXXXXXXXXX1119
                          present: N
                          securityCode:
                            result: M
                            valid: Y
                          token:
                            value: '8048471746471119'
                          type: VS
                        customer:
                          firstName: John
                          lastName: Smith
                          addressLine1: 65 Easy St
                          city: Las Vegas
                          postalCode: '65144'
                          emailAddress: firstname.lastname@email.com
                          ipAddress: 63.57.84.101
                        merchant:
                          mid: 15877
                          name: Merchant XYZ
                        threeDSecure:
                          trxId: a7bbd49a-ffe6-49b2-8a92-541f0a3b053d
                          cryptogram: AAAAAAAA/COBt84dnIEcwAA3gAAGhgEDoLABAAhAgAABAAAALnNCLw==
                          programProtocol: '2'
                          directoryServerTranId: 07e54000-2721-4df9-aa51-04fa0e079aa8
                          ecommIndicator: '5'
                        server:
                          name: TM01CE
                        transaction:
                          authSource: A
                          avs:
                            postalCodeVerified: N
                            result: A
                            streetVerified: Y
                            valid: Y
                          invoice: '730518'
                          responseCode: A
                          retrievalReference: 402F9H0230S0
                        receipt:
                        - key: CardEntryMode
                          printName: ENTRY METHOD
                          printValue: KEYED
                        - key: MaskedPAN
                          printValue: XXXXXXXXXXXX1119
                        - key: SignatureRequired
                          printValue: Y
                        - key: TransactionResponse
                          printName: Response
                          printValue: APPROVED
                - title: Device Fingerprint
                  properties:
                    result:
                      type: array
                      items:
                        type: object
                        required:
                        - dateTime
                        - amount
                        - currencyCode
                        - threeDSecure
                        - redirectUrl
                        properties:
                          dateTime:
                            $ref: '#/components/schemas/DateTime'
                          amount:
                            $ref: '#/components/schemas/Amount'
                          currencyCode:
                            $ref: '#/components/schemas/CurrencyCode'
                          card:
                            $ref: '#/components/schemas/CardResponse3DSChallenge'
                          customer:
                            type: object
                            properties:
                              firstName:
                                $ref: '#/components/schemas/CustomerFirstName'
                              lastName:
                                $ref: '#/components/schemas/CustomerLastName'
                              phoneNumber:
                                $ref: '#/components/schemas/CustomerPhoneNumber'
                              emailAddress:
                                $ref: '#/components/schemas/CustomerEmailAddress'
                              addressLine1:
                                $ref: '#/components/schemas/CustomerAddressLine1'
                              city:
                                $ref: '#/components/schemas/CustomerCity'
                              region:
                                $ref: '#/components/schemas/CustomerRegion'
                              postalCode:
                                $ref: '#/components/schemas/CustomerPostalCode'
                              country:
                                $ref: '#/components/schemas/CustomerCountry'
                              ipAddress:
                                $ref: '#/components/schemas/CustomerIpAddress'
                              shipping:
                                $ref: '#/components/schemas/CustomerShipping3DSecure'
                          merchant:
                            $ref: '#/components/schemas/MerchantResponse'
                          transaction:
                            type: object
                            properties:
                              authSource:
                                $ref: '#/components/schemas/TransactionAuthSource'
                              invoice:
                                $ref: '#/components/schemas/TransactionInvoice'
                              responseCode:
                                $ref: '#/components/schemas/TransactionResponseCode3DSFingerprint'
                              retrievalReference:
                                $ref: '#/components/schemas/TransactionRetrievalReference'
                          threeDSecure:
                            type: object
                            required:
                            - trxId
                            properties:
                              trxId:
                                $ref: '#/components/schemas/ThreeDSecureTrxId'
                          redirectUrl:
                            $ref: '#/components/schemas/RedirectURL3DSResponse'
                          server:
                            $ref: '#/components/schemas/Server'
                      example:
                        dateTime: '2022-05-04T09:20:04.487-07:00'
                        amount:
                          tax: 15
                          total: 160
                        currencyCode: EUR
                        card:
                          entryMode: M
                          number: XXXXXXXXXXXX1119
                          present: N
                          type: VS
                          token:
                            value: '8048471746471119'
                        customer:
                          firstName: John
                          lastName: Smith
                          addressLine1: 65 Easy St
                          city: Las Vegas
                          postalCode: '65144'
                          emailAddress: firstname.lastname@email.com
                          ipAddress: 63.57.84.101
                        merchant:
                          mid: 15877
                          name: Merchant XYZ
                        transaction:
                          authSource: A
                          invoice: '730518'
                          responseCode: H
                          retrievalReference: 402F9H0230S0
                        redirectUrl: https://issuer.com/fingerprint
                        threeDSecure:
                          trxId: a7bbd49a-ffe6-49b2-8a92-541f0a3b053d
                        server:
                          name: TM01CE
                - title: 3D Secure Challenge
                  properties:
                    result:
                      type: array
                      items:
                        type: object
                        required:
                        - dateTime
                        - amount
                        - currencyCode
                        - threeDSecure
                        - redirectUrl
                        properties:
                          dateTime:
                            $ref: '#/components/schemas/DateTime'
                          amount:
                            $ref: '#/components/schemas/Amount'
                          currencyCode:
                            $ref: '#/components/schemas/CurrencyCode'
                          card:
                            $ref: '#/components/schemas/CardResponse3DSChallenge'
                          customer:
                            type: object
                            properties:
                              firstName:
                                $ref: '#/components/schemas/CustomerFirstName'
                              lastName:
                                $ref: '#/components/schemas/CustomerLastName'
                              phoneNumber:
                                $ref: '#/components/schemas/CustomerPhoneNumber'
                              emailAddress:
                                $ref: '#/components/schemas/CustomerEmailAddress'
                              addressLine1:
                                $ref: '#/components/schemas/CustomerAddressLine1'
                              city:
                                $ref: '#/components/schemas/CustomerCity'
                              region:
                                $ref: '#/components/schemas/CustomerRegion'
                              postalCode:
                                $ref: '#/components/schemas/CustomerPostalCode'
                              country:
                                $ref: '#/components/schemas/CustomerCountry'
                              ipAddress:
                                $ref: '#/components/schemas/CustomerIpAddress'
                              shipping:
                                $ref: '#/components/schemas/CustomerShipping3DSecure'
                          merchant:
                            $ref: '#/components/schemas/MerchantResponse'
                          transaction:
                            type: object
                            properties:
                              authSource:
                                $ref: '#/components/schemas/TransactionAuthSource'
                              invoice:
                                $ref: '#/components/schemas/TransactionInvoice'
                              responseCode:
                                $ref: '#/components/schemas/TransactionResponseCode3DSChallenge'
                              retrievalReference:
                                $ref: '#/components/schemas/TransactionRetrievalReference'
                          threeDSecure:
                            type: object
                            required:
                            - trxId
                            properties:
                              trxId:
                                $ref: '#/components/schemas/ThreeDSecureTrxId'
                          redirectUrl:
                            $ref: '#/components/schemas/RedirectURL3DSResponse'
                          server:
                            $ref: '#/components/schemas/Server'
                      example:
                        dateTime: '2022-05-04T09:20:04.487-07:00'
                        amount:
                          tax: 15
                          total: 160
                        currencyCode: EUR
                        card:
                          entryMode: M
                          number: XXXXXXXXXXXX1119
                          present: N
                          type: VS
                          token:
                            value: '8048471746471119'
                        customer:
                          firstName: John
                          lastName: Smith
                          addressLine1: 65 Easy St
                          city: Las Vegas
                          postalCode: '65144'
                          emailAddress: firstname.lastname@email.com
                          ipAddress: 63.57.84.101
                        merchant:
                          mid: 15877
                          name: Merchant XYZ
                        transaction:
                          authSource: A
                          invoice: '730518'
                          responseCode: G
                          retrievalReference: 402F9H0230S0
                        redirectUrl: https://issuer.com/challenge
                        server:
                          name: TM01CE
        '400':
          $ref: '#/components/responses/ErrorResponse3DSecure'
        '504':
          $ref: '#/components/responses/TimeoutResponse'
  /3dsecure/completion:
    servers:
    - url: https://api.shift4test.com/api/rest/v1
      description: Host Direct Test URL
    - url: https://api.shift4api.net/api/rest/v1
      description: Host Direct Production URL
    post:
      tags:
      - 3D Secure
      summary: 3D Secure Completion
      operationId: 3dsecurecompletion
      security:
      - AccessToken: []
      description: 'This endpoint is utilized to send the status of the device fingerprint. This must be sent whenever the response to the [3D Secure Standalone](/apis/payments-platform-rest/openapi/3d-secure/3dsecurestandalone) results in a device fingerprint required.


        **Integration Methods:**

        - Host Direct


        See the [Integration Methods](/guides/quickstart#integration-methods) and [URLs Section](/guides/quickstart#urls) sections of the Development Quick Start guide for details regarding each processing option.

        '
      parameters:
      - $ref: '#/components/parameters/InterfaceVersion'
      - $ref: '#/components/parameters/InterfaceName'
      - $ref: '#/components/parameters/CompanyName'
      - $ref: '#/components/parameters/AccessToken'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              required:
              - dateTime
              - transaction
              - threeDSecure
              properties:
                dateTime:
                  $ref: '#/components/schemas/DateTime'
                merchant:
                  $ref: '#/components/schemas/MerchantResponse'
                transaction:
                  type: object
                  required:
                  - invoice
                  properties:
                    invoice:
                      $ref: '#/components/schemas/TransactionInvoice'
                threeDSecure:
                  type: object
                  required:
                  - trxId
                  - compInd
                  properties:
                    trxId:
                      $ref: '#/components/schemas/ThreeDSecureTrxId'
                    compInd:
                      $ref: '#/components/schemas/ThreeDSecureCompInd'
            example:
              dateTime: '2022-05-04T09:20:04.487-07:00'
              merchant:
                mid: 15877
                name: Merchant XYZ
              transaction:
                invoice: '730518'
              threeDSecure:
                trxId: a7bbd49a-ffe6-49b2-8a92-541f0a3b053d
                compInd: Y
      responses:
        '200':
          description: Transaction was processed
          content:
            application/json:
              schema:
                oneOf:
                - title: Transaction Complete
                  properties:
                    result:
                      type: array
                      items:
                        type: object
                        required:
                        - dateTime
                        - amount
                        - currencyCode
                        - card
                        - customer
                        - transaction
                        properties:
                          dateTime:
                            $ref: '#/components/schemas/DateTime'
                          amount:
                            $ref: '#/components/schemas/Amount'
                          currencyCode:
                            $ref: '#/components/schemas/CurrencyCode'
                          card:
                            $ref: '#/components/schemas/CardResponse'
                          customer:
                            type: object
                            properties:
                              firstName:
                                $ref: '#/components/schemas/CustomerFirstName'
                              lastName:
                                $ref: '#/components/schemas/CustomerLastName'
                              phoneNumber:
                                $ref: '#/components/schemas/CustomerPhoneNumber'
                              emailAddress:
                                $ref: '#/components/schemas/CustomerEmailAddress'
                              addressLine1:
                                $ref: '#/components/schemas/CustomerAddressLine1'
                              city:
                                $ref: '#/components/schemas/CustomerCity'
                              region:
                                $ref: '#/components/schemas/CustomerRegion'
                              postalCode:
                                $ref: '#/components/schemas/CustomerPostalCode'
                              country:
                                $ref: '#/components/schemas/CustomerCountry'
                              ipAddress:
                                $ref: '#/components/schemas/CustomerIpAddress'
                          merchant:
                            $ref: '#/components/schemas/MerchantResponse'
                          transaction:
                            type: object
                            properties:
                              authorizationCode:
                                $ref: '#/components/schemas/TransactionAuthorizationCode'
                              authSource:
                                $ref: '#/components/schemas/TransactionAuthSource'
                              hostResponse:
                                $ref: '#/components/schemas/HostResponse'
                              invoice:
                                $ref: '#/components/schemas/TransactionInvoice'
                              responseCode:
                                $ref: '#/components/schemas/TransactionResponseCode3DSStandalone'
                              retrievalReference:
                                $ref: '#/components/schemas/TransactionRetrievalReference'
                              saleFlag:
                                $ref: '#/components/schemas/TransactionSaleFlag'
                              avs:
                                $ref: '#/components/schemas/AVS'
                              cardOnFile:
                                $ref: '#/components/schemas/CardOnFile'
                          threeDSecure:
                            type: object
                            properties:
                              trxId:
                                $ref: '#/components/schemas/ThreeDSecureTrxId'
                              cardholderInfo:
                                $ref: '#/components/schemas/ThreeDSecureCardholderInfo'
                          receipt:
                            $ref: '#/components/schemas/ReceiptArray'
                          server:
                            $ref: '#/components/schemas/Server'
                          universalToken:
                            $ref: '#/components/schemas/UniversalToken'
                          cardBrandToken:
                            $ref: '#/components/schemas/CardBrandToken'
                      example:
                        dateTime: '2022-05-04T09:20:04.487-07:00'
                        amount:
                          tax: 15
                          total: 160
                        currencyCode: EUR
                        card:
                          entryMode: M
                          number: XXXXXXXXXXXX1119
                          present: N
                          securityCode:
                            result: M
                            valid: Y
                          token:
                            value: '8048471746471119'
                          type: VS
                        customer:
                          firstName: John
                          lastName: Smith
                          addressLine1: 65 Easy St
                          city: Las Vegas
                          postalCode: '65144'
                          emailAddress: firstname.lastname@email.com
                          ipAddress: 63.57.84.101
                        merchant:
                          mid: 15877
                          name: Merchant XYZ
                        server:
                          name: TM01CE
                        transaction:
                          authorizationCode: OK868Z
                          authSource: A
                          avs:
                            postalCodeVerified: N
                            result: A
                            streetVerified: Y
                            valid: Y
                          invoice: '730518'
                          responseCode: A
                          retrievalReference: 402F9H0230S0
                          saleFlag: S
                        receipt:
                        - key: CardEntryMode
                          printName: ENTRY METHOD
                          printValue: KEYED
                        - key: MaskedPAN
                          printValue: XXXXXXXXXXXX1119
                        - key: SignatureRequired
                          printValue: Y
                        - key: TransactionResponse
                          printName: Response
                          printValue: APPROVED
                - title: 3D Secure Challenge
                  properties:
                    result:
                      type: array
                      items:
                        type: object
                        required:
                        - dateTime
                        - amount
                        - currencyCode
                        - card
                        - customer
                        - transaction
                        - threeDSecure
                        - redirectUrl
                        properties:
                          dateTime:
                            $ref: '#/components/schemas/DateTime'
                          amount:
                            $ref: '#/components/schemas/Amount'
                          currencyCode:
                            $ref: '#/components/schemas/CurrencyCode'
                          card:
                            $ref: '#/components/schemas/CardResponse3DSChallenge'
                          customer:
                            type: object
                            properties:
                              firstName:
                                $ref: '#/components/schemas/CustomerFirstName'
                              lastName:
                                $ref: '#/components/schemas/CustomerLastName'
                              phoneNumber:
                                $ref: '#/components/schemas/CustomerPhoneNumber'
                              emailAddress:
                                $ref: '#/components/schemas/CustomerEmailAddress'
                              addressLine1:
                                $ref: '#/components/schemas/CustomerAddressLine1'
                              city:
                                $ref: '#/components/schemas/CustomerCity'
                              region:
                                $ref: '#/components/schemas/CustomerRegion'
                              postalCode:
                                $ref: '#/components/schemas/CustomerPostalCode'
                              country:
                                $ref: '#/components/schemas/CustomerCountry'
                              ipAddress:
                                $ref: '#/components/schemas/CustomerIpAddress'
                          merchant:
                            $ref: '#/components/schemas/MerchantResponse'
                          transaction:
                            type: object
                            properties:
                              authSource:
                                $ref: '#/components/schemas/TransactionAuthSource'
                              invoice:
                                $ref: '#/components/schemas/TransactionInvoice'
                              responseCode:
                                $ref: '#/components/schemas/TransactionResponseCode3DSChallenge'
                              retrievalReference:
                                $ref: '#/components/schemas/TransactionRetrievalReference'
                              saleFlag:
                                $ref: '#/components/schemas/TransactionSaleFlag'
                              cardOnFile:
                                $ref: '#/components/schemas/CardOnFile'
                          threeDSecure:
                            type: object
                            required:
                            - trxId
                            properties:
                              trxId:
                                $ref: '#/components/schemas/ThreeDSecureTrxId'
                          redirectUrl:
                            $ref: '#/components/schemas/RedirectURL3DSResponse'
                          server:
                            $ref: '#/components/schemas/Server'
                      example:
                        dateTime: '2022-05-04T09:20:04.487-07:00'
                        am

# --- truncated at 32 KB (121 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/shift4/refs/heads/main/openapi/shift4-3d-secure-api-openapi.yml