Retrieve an Instrument Identifier's Payment Instruments

This section shows you how to retrieve the payment instrument tokens associated with an instrument identifier token.

Endpoint

Test:
GET
https://apitest.cybersource.com
/tms/v1/instrumentidentifiers/{instrumentIdentifierTokenId}/paymentinstruments?
Production:
GET
https://api.cybersource.com
/tms/v1/instrumentidentifiers/{instrumentIdentifierTokenId}/paymentinstruments?
Production in India:
GET
https://api.in.cybersource.com
/tms/v1/instrumentidentifiers/{instrumentIdentifierTokenId}/paymentinstruments?
{instrumentIdentifierTokenId}
 is the instrument identifier token ID returned in the
id
 field when you created the instrument identifier token. For more information, see Create an Instrument Identifier.
Use these query string parameters to filter the list of payment instrument tokens:
  • offset
     — Page offset number.
  • limit
     — Maximum number of items you would like returned.

REST Example: Retrieving an Instrument Identifier's Payment Instruments

Request
GET 
https://apitest.cybersource.com
/tms/v1/instrumentidentifiers/7010000000016241111/paymentinstruments?offset=0&limit=5
Response to a Successful Request
{
  "_links": {
    "self": {
      "href": "
https://apitest.cybersource.com
/tms/v1/instrumentidentifiers/7010000000016241111/paymentinstruments?offset=0&limit=5"
    },
    "first": {
      "href": "
https://apitest.cybersource.com
/tms/v1/instrumentidentifiers/7010000000016241111/paymentinstruments?offset=0&limit=5"
    },
    "next": {
      "href": "
https://apitest.cybersource.com
/tms/v1/instrumentidentifiers/7010000000016241111/paymentinstruments?offset=5&limit=5"
    },
    "last": {
      "href": "
https://apitest.cybersource.com
/tms/v1/instrumentidentifiers/7010000000016241111/paymentinstruments?offset=120820&limit=5"
    }
  },
  "object": "collection",
  "offset": 0,
  "limit": 5,
  "count": 5,
  "total": 120825,
  "_embedded": {
    "paymentInstruments": [
      {
        "_links": {
          "self": {
            "href": "
https://apitest.cybersource.com
/tms/v1/paymentinstruments/F396A4DD49CA23ADE053A2598D0AECC4"
          },
          "customer": {
            "href": "
https://apitest.cybersource.com
/tms/v1/customers/F396A4DD49CB23ADE053A2598D0AECC4"
          }
        },
        "id": "F396A4DD49CA23ADE053A2598D0AECC4",
        "object": "paymentInstrument",
        "state": "ACTIVE",
        "card": {
          "expirationMonth": "12",
          "expirationYear": "2031",
          "type": "visa"
        },
        "buyerInformation": {
          "currency": "USD"
        },
        "billTo": {
          "firstName": "JOHN",
          "lastName": "DOE",
          "address1": "1 Market St",
          "locality": "san francisco",
          "administrativeArea": "CA",
          "postalCode": "94105",
          "country": "US",
          "email": "
test@cybs.com
",
          "phoneNumber": "4158880000"
        },
        "processingInformation": {
          "billPaymentProgramEnabled": false
        },
        "metadata": {
          "creator": "testrest"
        },
        "_embedded": {
          "instrumentIdentifier": {
            "_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"
            },
            "processingInformation": {
              "authorizationOptions": {
                "initiator": {
                  "merchantInitiatedTransaction": {
                    "previousTransactionId": "123456789012345"
                  }
                }
              }
            },
            "metadata": {
              "creator": "testrest"
            }
          }
        }
      },
      {
        "_links": {
          "self": {
            "href": "
https://apitest.cybersource.com
/tms/v1/paymentinstruments/F3969009C44DED0DE053AF598E0AD4E0"
          },
          "customer": {
            "href": "
https://apitest.cybersource.com
/tms/v1/customers/F396A109D27377A5E053AF598E0AA34A"
          }
        },
        "id": "F3969009C44DED0DE053AF598E0AD4E0",
        "object": "paymentInstrument",
        "state": "ACTIVE",
        "card": {
          "type": "visa"
        },
        "metadata": {
          "creator": "testrest"
        },
        "_embedded": {
          "instrumentIdentifier": {
            "_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"
            },
            "processingInformation": {
              "authorizationOptions": {
                "initiator": {
                  "merchantInitiatedTransaction": {
                    "previousTransactionId": "123456789012345"
                  }
                }
              }
            },
            "metadata": {
              "creator": "testrest"
            }
          }
        }
      },
      {
        "_links": {
          "self": {
            "href": "
https://apitest.cybersource.com
/tms/v1/paymentinstruments/F396A109F3637776E053AF598E0A87E4"
          },
          "customer": {
            "href": "
https://apitest.cybersource.com
/tms/v1/customers/F396A109D27377A5E053AF598E0AA34A"
          }
        },
        "id": "F396A109F3637776E053AF598E0A87E4",
        "object": "paymentInstrument",
        "state": "ACTIVE",
        "card": {
          "expirationMonth": "12",
          "expirationYear": "2031",
          "type": "visa"
        },
        "billTo": {
          "firstName": "John",
          "lastName": "Doe",
          "company": "Company Name",
          "address1": "1 Market St",
          "locality": "San Francisco",
          "administrativeArea": "CA",
          "postalCode": "94105",
          "country": "US",
          "email": "
test@cybs.com
",
          "phoneNumber": "4158880000"
        },
        "metadata": {
          "creator": "testrest"
        },
        "_embedded": {
          "instrumentIdentifier": {
            "_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"
            },
            "processingInformation": {
              "authorizationOptions": {
                "initiator": {
                  "merchantInitiatedTransaction": {
                    "previousTransactionId": "123456789012345"
                  }
                }
              }
            },
            "metadata": {
              "creator": "testrest"
            }
          }
        }
      },
      {
        "_links": {
          "self": {
            "href": "
https://apitest.cybersource.com
/tms/v1/paymentinstruments/F3965253C47640F5E053AF598E0AA05A"
          }
        },
        "id": "F3965253C47640F5E053AF598E0AA05A",
        "object": "paymentInstrument",
        "state": "ACTIVE",
        "card": {
          "expirationMonth": "02",
          "expirationYear": "2028",
          "type": "visa"
        },
        "billTo": {
          "firstName": "John",
          "lastName": "Snow"
        },
        "metadata": {
          "creator": "testrest"
        },
        "_embedded": {
          "instrumentIdentifier": {
            "_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"
            },
            "processingInformation": {
              "authorizationOptions": {
                "initiator": {
                  "merchantInitiatedTransaction": {
                    "previousTransactionId": "123456789012345"
                  }
                }
              }
            },
            "metadata": {
              "creator": "testrest"
            }
          }
        }
      },
      {
        "_links": {
          "self": {
            "href": "
https://apitest.cybersource.com
/tms/v1/paymentinstruments/F395F6426D9A30AEE053AF598E0A5BD4"
          }
        },
        "id": "F395F6426D9A30AEE053AF598E0A5BD4",
        "object": "paymentInstrument",
        "state": "ACTIVE",
        "card": {
          "expirationMonth": "12",
          "expirationYear": "2031",
          "type": "visa"
        },
        "billTo": {
          "firstName": "John",
          "lastName": "Doe",
          "company": "Company Name",
          "address1": "1 Market St",
          "locality": "San Francisco",
          "administrativeArea": "CA",
          "postalCode": "94105",
          "country": "US",
          "email": "
test@cybs.com
",
          "phoneNumber": "4158880000"
        },
        "metadata": {
          "creator": "testrest"
        },
        "_embedded": {
          "instrumentIdentifier": {
            "_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"
            },
            "processingInformation": {
              "authorizationOptions": {
                "initiator": {
                  "merchantInitiatedTransaction": {
                    "previousTransactionId": "123456789012345"
                  }
                }
              }
            },
            "metadata": {
              "creator": "testrest"
            }
          }
        }
      }
    ]
  }
}
Retrieve an Instrument Identifier's Payment Instruments