Create an Instrument Identifier

This section shows you how to create an instrument identifier.

Endpoint

Test:
POST
https://apitest.cybersource.com
/tms/v1/instrumentidentifiers
Production:
POST
https://api.cybersource.com
/tms/v1/instrumentidentifiers
Production in India:
POST
https://api.in.cybersource.com
/tms/v1/instrumentidentifiers

Required Fields for Creating an Instrument Identifier

card.number

Optional Fields for Creating an Instrument Identifier

bankAccount.number
bankAccount.routingNumber
billTo.address1
billTo.address2
billTo.administrativeArea
billTo.country
billTo.locality
billTo.postalCode
card.expirationMonth
card.expirationYear
card.securityCode
processingInformation.authorizationOptions.initiator. merchantInitiatedTransaction.previousTransactionID

REST Example: Creating a Card Instrument Identifier

Request 
        
{
  "card": {
    "number": "4111XXXX11111111"
  }
}
Response to a Successful Request 
        
{
  "_links": {
    "self": {
      "href": "
          
https://apitest.cybersource.com
          
/tms/v1/instrumentidentifiers/7010000000016241111"
    },
    "paymentInstruments": {
      "href": "
          
https://apitest.cybersource.com
          
/tms/v1/instrumentidentifiers/7010000000016241111/paymentinstruments"
    }
  },
  "id": "7010000000016241111",
  "object": "instrumentIdentifier",
  "state": "ACTIVE",
  "card": {
    "number": "411111XXXXXX1111"
  },
  "metadata": {
    "creator": "testrest"
  }
}

REST Example: Creating a Bank Account Instrument Identifier

Request 
    
POST 
      
https://apitest.cybersource.com
      
/tms/v1/instrumentidentifiers
{
  "bankAccount": {
    "number": "4100",
    "routingNumber": "X71923284"
  }
}
Response to a Successful Request 
    
{
  "_links": {
    "self": {
      "href": "
      
https://apitest.cybersource.com
      
/tms/v1/instrumentidentifiers/A7A91A2CA872B272E05340588D0A0699"
    },
    "paymentInstruments": {
      "href": "
      
https://apitest.cybersource.com
      
/tms/v1/instrumentidentifiers/A7A91A2CA872B272E05340588D0A0699/paymentinstruments"
    }
  },
  "id": "A7A91A2CA872B272E05340588D0A0699",
  "object": "instrumentIdentifier",
  "state": "ACTIVE",
  "bankAccount": {
    "number": "XXXX",
    "routingNumber": "X71923284"
  },
  "metadata": {
    "creator": "testrest"
  }
}