API Overview

Token Management Service Developer Guide
- Recent Revisions to This Document
- VISA Platform Connect: Specifications and Conditions for Resellers/Partners
- TERMS OF USE APPLICABLE TO CARD NETWORK TOKENS

Introduction to the Token Management Service
- Types of Tokens
  - Instrument Identifier Tokens
  - Customer Tokens
  - Shipping Address Tokens
  - Payment Instrument Tokens
  - Network Tokens

Token Management Service Workflows
- PAN Tokenization Process Using TMS
- Network Token Tokenization Process
- Push Provisioning Process
- Network Token Provisioning for Partners
- Network Token CIT for Partners
- Network Token MIT for Partners

Requesting the Token Management Service API
- HTTP Response Headers
- Case Sensitivity
- Metadata
- Patching Considerations
  - Pagination
- Test Card Numbers

Token Management Service Onboarding
- Merchant ID Hierarchy
- Merchant ID Registration
- Portfolio MIDs for Partners
- Token Vault Management
  - Configure the Token Vault Settings Using the Gateway Portal
  - Configure the Token Vault Access Using the Gateway Portal
  - Configure Network Tokenization Using the Gateway Portal
- Token Management Message-Level Encryption Keys
  - Creating a Token Management MLE Key

Network Tokenization
- Network Token Enablement
- Network Token Onboarding—Partner Model
- Network Token Life-Cycle Management
- Network Token Life-Cycle Management Reports
- Manage Webhook Subscriptions
  - Create a Digital Signature Key
  - Create Webhook Subscription
  - Retrieve the Details of a Webhook Subscription
  - Update Webhook Subscription
  - Delete Webhook Subscription
  - Network Token Life-Cycle Management Notification Examples
- Token Requestor IDs
- Digital Commerce Authentication Program

Manage Network Tokens
- Authorize a Payment While Ignoring Network Token
- Provision a Network Token for a Card Number
- Provision a Network Token for an Existing Instrument Identifier
- Provision a Network Token for a Customer
- Provision a Network Token for a Token
- Retrieve a Standalone Network Token
- Delete a Standalone Network Token
- Retrieve Network Token Payment Credentials
- Retrieve Network Token AFT Payment Credentials
- Provision a Network Token with Push Provisioning
- Generate Payment Credentials
- Generate Payment Credentials for Digital Commerce Authentication Program
- Generate Payment Passkey Credentials
- Simulate Life-Cycle Management Events
  - Available Fields for Simulating Life-Cycle Management Events
  - REST Example: Simulating Life-Cycle Management Events
- Network Token Provision Failures

Create Tokens
- Create an Instrument Identifier and Provision a Network Token
- Create an Instrument Identifier and Provision a Network Token Using a Transient Token
- Create a Customer Payment Instrument
- Create a Token with a Request ID

Instrument Identifier Tokens
- Manage Instrument Identifier Tokens
  - Create an Instrument Identifier
  - Create an Instrument Identifier for Enrollable Network Tokens
  - Create an Instrument Identifier and Network Token Using EMV Tags
  - Retrieve an Instrument Identifier
  - Update an Instrument Identifier
  - Retrieve an Instrument Identifier's Payment Instruments
  - Retrieve an Instrument Identifier with an Unmasked Card Number
  - Delete an Instrument Identifier
- Payments with Instrument Identifier Tokens
  - Authorize a Payment with an Instrument Identifier
  - Making a Credit with an Instrument Identifier

Payment Instrument Tokens
- Manage Payment Instrument Tokens
  - Create a Payment Instrument
  - Retrieve a Payment Instrument
  - Find Payment Instruments by Card Number
  - Retrieve a Payment Instrument with an Unmasked Card Number
  - Update a Payment Instrument
  - Delete a Payment Instrument
- Payments with Payment Instrument Tokens
  - Authorizing a Payment with a Payment Instrument
  - Making a Credit with a Payment Instrument

Customer Tokens
- Manage Customer Tokens
  - Create a Customer
  - Retrieve a Customer
  - Update a Customer
  - Delete a Customer
  - Retrieve a Customer's Default Payment with an Unmasked Card Number
  - Retrieve a Customer's Default Payment and Shipping Details
- Payments with Customer Tokens
  - Authorizing a Payment with a Customer Token
  - Making a Credit with a Customer Token
- Shipping Address Tokens
  - Manage Shipping Address Tokens
  - Create a Customer Shipping Address
  - Add a Default Shipping Address
  - Add a Non-Default Shipping Address
  - Change a Default Shipping Address
  - Retrieve a Customer Shipping Address
  - Retrieve All Customer Shipping Addresses
  - Update a Customer Shipping Address
  - Delete a Customer Shipping Address
  - Payments with Shipping Address Tokens
  - Authorizing a Payment with a Non-Default Shipping Address
- Customer Payment Instruments
  - Manage Customer Payment Instruments
    - Create a Customer Payment Instrument
    - Add a Default Payment Instrument Using Instrument Identifier
    - Add a Default Payment Instrument with Validated Payment
    - Add a Non-Default Payment Instrument Using Instrument Identifier
    - Add a Non-Default Payment Instrument with Validated Payment
    - Change a Customer's Default Payment Instrument
    - Retrieve a Customer Payment Instrument
    - Retrieve a Customer Payment Instrument with an Unmasked Card Number
    - List Payment Instruments for a Customer
    - Update a Customer Payment Instrument
    - Delete a Customer Payment Instrument
  - Payments with Customer Payment Instruments
    - Authorizing a Payment with a Non-Default Payment Instrument
    - Making a Credit with a Non-Default Payment Instrument

Card Art
- Retrieve Card Art

Reference Information
- Encrypt and Decrypt Data
- HTTP Status Codes

On This Page

Generate Payment Credentials

This section describes how to generate payment credentials.

You can use the payment credentials API to retrieve the payment credentials for an existing customer, payment instrument, instrument identifier or tokenized card. For information about these token types, see these topics:

Customer Tokens

Payment Instrument Tokens

Instrument Identifier Tokens

Endpoint

Test:

POST https://nabgateway-api-test.nab.com.au/tms/v2/tokens/{tokenId}/
payment-credentials

Production:

POST https://nabgateway-api.nab.com.au/tms/v2/tokens/{tokenId}/
payment-credentials

The {tokenId}
is the identifier of the tokenized card.

Required Fields for Generating Payment Credentials

paymentCredentialType: Set to one of these values:
CRYPTOGRAM
NETWORK_TOKEN
SECURITY_CODE
transactionType

REST Example: Generating Payment Credentials

Request

{
  "paymentCredentialType": "CRYPTOGRAM",
  "transactionType": "ECOM"
}

Response to a Successful Request

{
  "_links": {
    "self": {
      "href": "/tms/v2/tokens/7010000000016241111/payment-credentials"
    }
  },
  "tokenizedCard": {
    "state": "ACTIVE",
    "enrollmentId": "c2d1b36fad46aed1ca8318dca5ed1e02",
    "tokenReferenceId": "168661ada5115ca3589b1ba3dabdb102",
    "number": "4895370016750801",
    "expirationMonth": "12",
    "expirationYear": "2023",
    "type": "visa",
    "cryptogram": "AwAAAADggP/Ce5+ZciCXQUUAAAA=",
    "eci": "05",
    "requestorId": "40010052236",
    "card": {
      "suffix": "0394",
      "expirationMonth": "12",
      "expirationYear": "2023"
    }
  },
  "card": {
    "number": "411111XXXXXX1111"
  },
  "issuer": {
    "paymentAccountReference": "V0010013022298169667504231315"
  },
  "processingInformation": {
    "authorizationOptions": {
      "initiator": {
        "merchantInitiatedTransaction": {
          "previousTransactionId": "123456789619999"
        }
      }
    },
    "commerceIndicator": "vbv"
  }
}

Back to top