API Overview

Card Present Connect | Mass Transit Developer Guide
- Recent Revisions to This Document
- VISA Platform Connect: Specifications and Conditions for Resellers/Partners

Mass Transit Transaction Workflows
- American Express Pay As You Go Workflow
- Mastercard Pay As You Go Workflow
- Visa Mobility and Transport Transaction Workflow
- Additional Workflows
  - Near Real-Time Workflow
  - Fare Calculation and Submission Workflow
  - Debt Recovery Workflows

Mass Transit Payment Services Using EMV and Card Data
- Transaction Types
- Required Fields for Authorizations with EMV Data
- American Express Authorization with EMV Data
  - Example: American Express Account Status Check Authorization with EMV Data
  - Example: American Express Delayed Online Authorization with EMV Data
- Mastercard Authorization with EMV Data
  - Example: Mastercard Authorization with EMV Data
- Visa Account Verification Request (AVR) with EMV Data
  - Example: Visa AVR Authorization with EMV Data
- Required Fields for Sales with EMV Data
- Visa Deferred Sale with EMV Data
  - Example: Visa Deferred Sale with EMV Data
- Required Fields for Authorization for Debt Recovery
- Tap-Initiated Authorization for Debt Recovery with EMV Data
  - Example: Tap-Initiated Authorization for Debt Recovery with EMV Data
- Merchant-Initiated Authorizations for Debt Recovery with Stored Card Data
  - Example: Merchant-Initiated Authorization for Debt Recovery with Stored Card Data
- Required Fields for Sales for Debt Recovery
- Tap-Initiated Sales for Debt Recovery with EMV Data
  - Example: Mastercard Tap-Initiated Sale for Debt Recovery with EMV Data Using the REST API
  - Example: Tap-Initiated Sale for Debt Recovery with EMV Data Using the REST API
- Merchant-Initiated Sales for Debt Recovery with Stored Card Data
  - Example: Merchant-Initiated Sale for Debt Recovery with Stored Card Data
- Required Fields for Stand-Alone Credits with Card Data
- Stand-Alone Credits with Card Data
  - Example: Stand-Alone Credit with Card Data

Mass Transit Payment Services Using TMS Tokens
- Mass Transit Mastercard Authorization with a Token
  - Required Fields for a Mastercard Authorization with a Token Using the REST API
  - Example: Performing a Mastercard Authorization with a Token Using the REST API
- Mass Transit Visa Account Verification Request (AVR) with a Token
  - Required Fields for a Visa AVR Authorization with a Transient Token Using the REST API
  - Example: Performing a Visa AVR Authorization with a Transient Token Using the REST API
- Mass Transit Visa Deferred Sale with a Token
  - Required Fields for a Visa Deferred Sale with a Token Using the REST API
  - Example: Performing a Visa Deferred Sale with a Token Using the REST API
- Mass Transit Authorizations for a Tap-Initiated Debt Recovery with a Token
  - Required Fields for a Tap-Initiated Authorization for Debt Recovery with a Token Using the REST API
  - Example: Performing a Tap-Initiated Authorization for Debt Recovery with a Token Using the REST API
- Mass Transit Merchant-Initiated Authorizations for Debt Recovery with a Token
  - Required Fields for a Merchant-Initiated Authorization for Debt Recovery with a Token Using the REST API
  - Example: Performing a Merchant-Initiated Authorization for Debt Recovery with a Token Using the REST API
- Mass Transit Tap-Initiated Sale for Debt Recovery with a Token
  - Required Fields for a Tap-Initiated Sale for Debt Recovery with a Token Using the REST API
  - Example: Performing a Tap-Initiated Sale for Debt Recovery with a Token Using the REST API
- Mass Transit Merchant-Initiated Sale for Debt Recovery with a Token
  - Required Fields for a Merchant-Initiated Sale for Debt Recovery with a Token Using the REST API
  - Example: Performing a Merchant-Initiated Sale for Debt Recovery with a Token Using the REST API
- Mass Transit Stand-Alone Credit with a Token
  - Required Fields for a Stand-Alone Credit with a Token Using the REST API
  - Example: Performing a Stand-Alone Credit with a Token Using the REST API

Mass Transit Follow-On Payment Services
- Required Fields for Mass Transit Captures
- Capture an Authorization
  - Example: Capture an Authorization
- Required Fields for Mass Transit Reversals
- Authorization Reversals
  - Example: Reversing a Mass Transit Authorization
- Timeout Reversal
  - Example: Timeout Reversal
- Required Field for Timeout Voids
- Timeout Void
  - Example: Timeout Void

Mass Transit Token Management Services
- Creating a Token
  - Required Fields for Creating a Token Using the REST API
  - Example: Create a Token Using the REST API
- Retrieving Transient Token Details
  - Example: Retrieve Transient Token Details Using the REST API
- Retrieving an Instrument Identifier Details
  - Example: Retrieving Instrument Identifier Details Using the REST API
- Retrieving Card Hash Details
  - Example: Retrieving Card Hash Details Using the REST API
- Retrieving Payment Instrument Details
  - Example: Retrieving Payment Instrument Details Using the REST API
- Deleting an Instrument Identifier
  - Example: Deleting an Instrument Identifier Using the REST API
- Deleting a Card Hash
  - Example: Deleting a Card Hash Using the REST API

Transit Test Cases

Retrieving Payment Instrument Details

Send a

GET

request to retrieve payment instrument details, which include the card details, card hash, and instrument identifier.

Endpoint

Test:

GET https://apitest.cybersource.com/tms/v1/paymentinstruments/{id}

Production:

GET https://api.cybersource.com/tms/v1/paymentinstruments/{id}

The

id

is the transient token identifier assigned by the contactless terminal.

Example: Retrieving Payment Instrument Details Using the REST API

Request

{
}

Response 200

{
    "_links": {
        "self": {
            "href": https://apitest.cybersource.com/tms/v1/paymentinstruments/CD98B27F62A8AECBE053AF598E0AF965
        }
    },
    "id": "CD98B27F62A8AECBE053AF598E0AF965",
    "object": "paymentInstrument",
    "state": "ACTIVE",
    "type": "cardHash",
    "card": {
        "expirationMonth": "12",
        "expirationYear": "2030",
        "type": "visa",
        "hash": "7400A4154369E584BA36CA19B50AAA3F9AE97FEAE64B3E87B2B93CF8FBC97777"
    },
    "_embedded": {
        "instrumentIdentifier": {
            "_links": {
                "self": {
                    "href": https://apitest.cybersource.com/tms/v1/instrumentidentifiers/CD616772D8355EA6E053AF598E0AE794
                },
                "paymentInstruments": {
                    "href": https://apitest.cybersource.com/tms/v1/instrumentidentifiers/CD616772D8355EA6E053AF598E0AE794/paymentinstruments
                }
            },
            "id": "CD616772D8355EA6E053AF598E0AE794",
            "object": "instrumentIdentifier",
            "state": "ACTIVE",
            "card": {
                "number": "476173XXXXXXXXXX"
            },
            "processingInformation": {
                "authorizationOptions": {
                    "initiator": {
                        "merchantInitiatedTransaction": {
                            "previousTransactionId": "016153570198200"
                        }
                    }
                }
            }
        }
    }
}

Retrieving Payment Instrument Details

Back to top