InstrumentIdentifierApi (cybersource-rest-client-java 0.0.89 API)

java.lang.Object
- Api.InstrumentIdentifierApi

public class InstrumentIdentifierApi
extends Object

Constructor Summary

Constructors
Constructor Description

InstrumentIdentifierApi()

InstrumentIdentifierApi(ApiClient apiClient)

Constructors
Constructor	Description
`InstrumentIdentifierApi()`
`InstrumentIdentifierApi(ApiClient apiClient)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`void`	`deleteInstrumentIdentifier(String instrumentIdentifierId, String profileId)`	Delete an Instrument Identifier \| \| \| \| \| --- \| --- \| --- \| \|Instrument Identifiers<br>An Instrument Identifier represents either a card number, or in the case of an ACH bank account, the routing <br>and account numbers.<br>The same token Id is returned for a specific card number or bank account & routing number allowing the <br>Instrument Identifier Id to be used for cross-channel payment tracking.<br>An Instrument Identifier can exist independently but also be associated with a [Customer Payment Instrument](#token-management_customer-payment-instrument_create-a-customer-payment-instrument) <br>or [Standalone Payment Instrument](#token-management_payment-instrument_create-a-payment-instrument).\|      \|Deleting an Instrument Identifier<br>Your system can use this API to delete an existing Instrument Identifier.<br>An Instrument Identifier cannot be deleted if it is linked to any Payment Instruments.<br>You can [retrieve all Payment Instruments associated with an Instrument Identifier](#token-management_instrument-identifier_list-payment-instruments-for-an-instrument-identifier).
`okhttp3.Call`	`deleteInstrumentIdentifierAsync(String instrumentIdentifierId, String profileId, ApiCallback<Void> callback)`	Delete an Instrument Identifier (asynchronously) \| \| \| \| \| --- \| --- \| --- \| \|Instrument Identifiers<br>An Instrument Identifier represents either a card number, or in the case of an ACH bank account, the routing <br>and account numbers.<br>The same token Id is returned for a specific card number or bank account & routing number allowing the <br>Instrument Identifier Id to be used for cross-channel payment tracking.<br>An Instrument Identifier can exist independently but also be associated with a [Customer Payment Instrument](#token-management_customer-payment-instrument_create-a-customer-payment-instrument) <br>or [Standalone Payment Instrument](#token-management_payment-instrument_create-a-payment-instrument).\|      \|Deleting an Instrument Identifier<br>Your system can use this API to delete an existing Instrument Identifier.<br>An Instrument Identifier cannot be deleted if it is linked to any Payment Instruments.<br>You can [retrieve all Payment Instruments associated with an Instrument Identifier](#token-management_instrument-identifier_list-payment-instruments-for-an-instrument-identifier).
`okhttp3.Call`	`deleteInstrumentIdentifierCall(String instrumentIdentifierId, String profileId, ProgressResponseBody.ProgressListener progressListener, ProgressRequestBody.ProgressRequestListener progressRequestListener)`	Build call for deleteInstrumentIdentifier
`ApiResponse<Void>`	`deleteInstrumentIdentifierWithHttpInfo(String instrumentIdentifierId, String profileId)`	Delete an Instrument Identifier \| \| \| \| \| --- \| --- \| --- \| \|Instrument Identifiers<br>An Instrument Identifier represents either a card number, or in the case of an ACH bank account, the routing <br>and account numbers.<br>The same token Id is returned for a specific card number or bank account & routing number allowing the <br>Instrument Identifier Id to be used for cross-channel payment tracking.<br>An Instrument Identifier can exist independently but also be associated with a [Customer Payment Instrument](#token-management_customer-payment-instrument_create-a-customer-payment-instrument) <br>or [Standalone Payment Instrument](#token-management_payment-instrument_create-a-payment-instrument).\|      \|Deleting an Instrument Identifier<br>Your system can use this API to delete an existing Instrument Identifier.<br>An Instrument Identifier cannot be deleted if it is linked to any Payment Instruments.<br>You can [retrieve all Payment Instruments associated with an Instrument Identifier](#token-management_instrument-identifier_list-payment-instruments-for-an-instrument-identifier).
`ApiClient`	`getApiClient()`
`PostInstrumentIdentifierRequest`	`getInstrumentIdentifier(String instrumentIdentifierId, String profileId, Boolean retrieveBinDetails)`	Retrieve an Instrument Identifier \| \| \| \| \| --- \| --- \| --- \| \|Instrument Identifiers<br>An Instrument Identifier represents either a card number, or in the case of an ACH bank account, the routing and account number.<br>The same token Id is returned for a specific card number or bank account & routing number allowing the Instrument Identifier Id to be used for cross-channel payment tracking.<br>An Instrument Identifier can exist independently but also be associated with a [Customer Payment Instrument](#token-management_customer-payment-instrument_create-a-customer-payment-instrument) or [Standalone Payment Instrument](#token-management_payment-instrument_create-a-payment-instrument).<br><br>Retrieving an Instrument Identifier<br>Your system can use this API to retrieve an Instrument Identifier.<br>Note: the actual card data will be masked.<br>The Instrument Identifier will also be returned when retrieving a [Customer](#token-management_customer_retrieve-a-customer), [Customer Payment Instrument](#token-management_customer-payment-instrument_retrieve-a-customer-payment-instrument) or [Standalone Payment Instrument](#token-management_payment-instrument_retrieve-a-payment-instrument).\|      \|Payment Network Tokens<br>Network tokens perform better than regular card numbers and they are not necessarily invalidated when a cardholder loses their card, or it expires.<br>A Payment Network Token will be automatically created and used in future payments if you are enabled for the service.<br>A Payment Network Token can also be [provisioned for an existing Instrument Identifier](#token-management_instrument-identifier_enroll-an-instrument-identifier-for-payment-network-token).<br>For more information about Payment Network Tokens see the Developer Guide.<br><br>Payments with Instrument Identifiers<br>To perform a payment with an Instrument Identifier simply specify the [Instrument Identifier Id in the payments request along with the expiration date, card type, & billing address](#payments_payments_process-a-payment_samplerequests-dropdown_authorization-using-tokens_authorization-with-instrument-identifier-token-id_liveconsole-tab-request-body).<br>When an Instrument Identifier is used in a payment the _previousTransactionId_ and _originalAuthorizedAmount_ values are automatically recorded.<br>These values will be added for you to future Merchant Initiated Transaction payments.
`okhttp3.Call`	`getInstrumentIdentifierAsync(String instrumentIdentifierId, String profileId, Boolean retrieveBinDetails, ApiCallback<PostInstrumentIdentifierRequest> callback)`	Retrieve an Instrument Identifier (asynchronously) \| \| \| \| \| --- \| --- \| --- \| \|Instrument Identifiers<br>An Instrument Identifier represents either a card number, or in the case of an ACH bank account, the routing and account number.<br>The same token Id is returned for a specific card number or bank account & routing number allowing the Instrument Identifier Id to be used for cross-channel payment tracking.<br>An Instrument Identifier can exist independently but also be associated with a [Customer Payment Instrument](#token-management_customer-payment-instrument_create-a-customer-payment-instrument) or [Standalone Payment Instrument](#token-management_payment-instrument_create-a-payment-instrument).<br><br>Retrieving an Instrument Identifier<br>Your system can use this API to retrieve an Instrument Identifier.<br>Note: the actual card data will be masked.<br>The Instrument Identifier will also be returned when retrieving a [Customer](#token-management_customer_retrieve-a-customer), [Customer Payment Instrument](#token-management_customer-payment-instrument_retrieve-a-customer-payment-instrument) or [Standalone Payment Instrument](#token-management_payment-instrument_retrieve-a-payment-instrument).\|      \|Payment Network Tokens<br>Network tokens perform better than regular card numbers and they are not necessarily invalidated when a cardholder loses their card, or it expires.<br>A Payment Network Token will be automatically created and used in future payments if you are enabled for the service.<br>A Payment Network Token can also be [provisioned for an existing Instrument Identifier](#token-management_instrument-identifier_enroll-an-instrument-identifier-for-payment-network-token).<br>For more information about Payment Network Tokens see the Developer Guide.<br><br>Payments with Instrument Identifiers<br>To perform a payment with an Instrument Identifier simply specify the [Instrument Identifier Id in the payments request along with the expiration date, card type, & billing address](#payments_payments_process-a-payment_samplerequests-dropdown_authorization-using-tokens_authorization-with-instrument-identifier-token-id_liveconsole-tab-request-body).<br>When an Instrument Identifier is used in a payment the _previousTransactionId_ and _originalAuthorizedAmount_ values are automatically recorded.<br>These values will be added for you to future Merchant Initiated Transaction payments.
`okhttp3.Call`	`getInstrumentIdentifierCall(String instrumentIdentifierId, String profileId, Boolean retrieveBinDetails, ProgressResponseBody.ProgressListener progressListener, ProgressRequestBody.ProgressRequestListener progressRequestListener)`	Build call for getInstrumentIdentifier
`PaymentInstrumentList`	`getInstrumentIdentifierPaymentInstrumentsList(String instrumentIdentifierId, String profileId, Boolean retrieveBinDetails, Long offset, Long limit)`	List Payment Instruments for an Instrument Identifier \| \| \| \| \| --- \| --- \| --- \| \|Instrument Identifiers<br>An Instrument Identifier represents either a card number, or in the case of an ACH bank account, the routing <br>and account numbers.<br>The same token Id is returned for a specific card number or bank account & routing number allowing the <br>Instrument Identifier Id to be used for cross-channel payment tracking.<br>An Instrument Identifier can exist independently but also be associated with a [Customer Payment Instrument](#token-management_customer-payment-instrument_create-a-customer-payment-instrument) <br>or [Standalone Payment Instrument](#token-management_payment-instrument_create-a-payment-instrument).\|      \|Retrieving all Payment Instruments associated with an Instrument Identifier<br>Your system can use this API to retrieve all Payment Instruments linked to an Instrument Identifier.
`okhttp3.Call`	`getInstrumentIdentifierPaymentInstrumentsListAsync(String instrumentIdentifierId, String profileId, Boolean retrieveBinDetails, Long offset, Long limit, ApiCallback<PaymentInstrumentList> callback)`	List Payment Instruments for an Instrument Identifier (asynchronously) \| \| \| \| \| --- \| --- \| --- \| \|Instrument Identifiers<br>An Instrument Identifier represents either a card number, or in the case of an ACH bank account, the routing <br>and account numbers.<br>The same token Id is returned for a specific card number or bank account & routing number allowing the <br>Instrument Identifier Id to be used for cross-channel payment tracking.<br>An Instrument Identifier can exist independently but also be associated with a [Customer Payment Instrument](#token-management_customer-payment-instrument_create-a-customer-payment-instrument) <br>or [Standalone Payment Instrument](#token-management_payment-instrument_create-a-payment-instrument).\|      \|Retrieving all Payment Instruments associated with an Instrument Identifier<br>Your system can use this API to retrieve all Payment Instruments linked to an Instrument Identifier.
`okhttp3.Call`	`getInstrumentIdentifierPaymentInstrumentsListCall(String instrumentIdentifierId, String profileId, Boolean retrieveBinDetails, Long offset, Long limit, ProgressResponseBody.ProgressListener progressListener, ProgressRequestBody.ProgressRequestListener progressRequestListener)`	Build call for getInstrumentIdentifierPaymentInstrumentsList
`ApiResponse<PaymentInstrumentList>`	`getInstrumentIdentifierPaymentInstrumentsListWithHttpInfo(String instrumentIdentifierId, String profileId, Boolean retrieveBinDetails, Long offset, Long limit)`	List Payment Instruments for an Instrument Identifier \| \| \| \| \| --- \| --- \| --- \| \|Instrument Identifiers<br>An Instrument Identifier represents either a card number, or in the case of an ACH bank account, the routing <br>and account numbers.<br>The same token Id is returned for a specific card number or bank account & routing number allowing the <br>Instrument Identifier Id to be used for cross-channel payment tracking.<br>An Instrument Identifier can exist independently but also be associated with a [Customer Payment Instrument](#token-management_customer-payment-instrument_create-a-customer-payment-instrument) <br>or [Standalone Payment Instrument](#token-management_payment-instrument_create-a-payment-instrument).\|      \|Retrieving all Payment Instruments associated with an Instrument Identifier<br>Your system can use this API to retrieve all Payment Instruments linked to an Instrument Identifier.
`ApiResponse<PostInstrumentIdentifierRequest>`	`getInstrumentIdentifierWithHttpInfo(String instrumentIdentifierId, String profileId, Boolean retrieveBinDetails)`	Retrieve an Instrument Identifier \| \| \| \| \| --- \| --- \| --- \| \|Instrument Identifiers<br>An Instrument Identifier represents either a card number, or in the case of an ACH bank account, the routing and account number.<br>The same token Id is returned for a specific card number or bank account & routing number allowing the Instrument Identifier Id to be used for cross-channel payment tracking.<br>An Instrument Identifier can exist independently but also be associated with a [Customer Payment Instrument](#token-management_customer-payment-instrument_create-a-customer-payment-instrument) or [Standalone Payment Instrument](#token-management_payment-instrument_create-a-payment-instrument).<br><br>Retrieving an Instrument Identifier<br>Your system can use this API to retrieve an Instrument Identifier.<br>Note: the actual card data will be masked.<br>The Instrument Identifier will also be returned when retrieving a [Customer](#token-management_customer_retrieve-a-customer), [Customer Payment Instrument](#token-management_customer-payment-instrument_retrieve-a-customer-payment-instrument) or [Standalone Payment Instrument](#token-management_payment-instrument_retrieve-a-payment-instrument).\|      \|Payment Network Tokens<br>Network tokens perform better than regular card numbers and they are not necessarily invalidated when a cardholder loses their card, or it expires.<br>A Payment Network Token will be automatically created and used in future payments if you are enabled for the service.<br>A Payment Network Token can also be [provisioned for an existing Instrument Identifier](#token-management_instrument-identifier_enroll-an-instrument-identifier-for-payment-network-token).<br>For more information about Payment Network Tokens see the Developer Guide.<br><br>Payments with Instrument Identifiers<br>To perform a payment with an Instrument Identifier simply specify the [Instrument Identifier Id in the payments request along with the expiration date, card type, & billing address](#payments_payments_process-a-payment_samplerequests-dropdown_authorization-using-tokens_authorization-with-instrument-identifier-token-id_liveconsole-tab-request-body).<br>When an Instrument Identifier is used in a payment the _previousTransactionId_ and _originalAuthorizedAmount_ values are automatically recorded.<br>These values will be added for you to future Merchant Initiated Transaction payments.
`PatchInstrumentIdentifierRequest`	`patchInstrumentIdentifier(String instrumentIdentifierId, PatchInstrumentIdentifierRequest patchInstrumentIdentifierRequest, String profileId, Boolean retrieveBinDetails, String ifMatch)`	Update an Instrument Identifier \| \| \| \| \| --- \| --- \| --- \| \|Instrument Identifiers<br>An Instrument Identifier represents either a card number, or in the case of an ACH bank account, the routing and account number.<br>The same token Id is returned for a specific card number or bank account & routing number allowing the Instrument Identifier Id to be used for cross-channel payment tracking.<br>An Instrument Identifier can exist independently but also be associated with a [Customer Payment Instrument](#token-management_customer-payment-instrument_create-a-customer-payment-instrument) or [Standalone Payment Instrument](#token-management_payment-instrument_create-a-payment-instrument).\|      \|Updating an Instrument Identifier<br>When an Instrument Identifier is used in a payment the _previousTransactionId_ and _originalAuthorizedAmount_ values are automatically recorded.<br>These values will be added for you to future Merchant Initiated Transaction payments.<br>Your system can use this API to update these values.
`okhttp3.Call`	`patchInstrumentIdentifierAsync(String instrumentIdentifierId, PatchInstrumentIdentifierRequest patchInstrumentIdentifierRequest, String profileId, Boolean retrieveBinDetails, String ifMatch, ApiCallback<PatchInstrumentIdentifierRequest> callback)`	Update an Instrument Identifier (asynchronously) \| \| \| \| \| --- \| --- \| --- \| \|Instrument Identifiers<br>An Instrument Identifier represents either a card number, or in the case of an ACH bank account, the routing and account number.<br>The same token Id is returned for a specific card number or bank account & routing number allowing the Instrument Identifier Id to be used for cross-channel payment tracking.<br>An Instrument Identifier can exist independently but also be associated with a [Customer Payment Instrument](#token-management_customer-payment-instrument_create-a-customer-payment-instrument) or [Standalone Payment Instrument](#token-management_payment-instrument_create-a-payment-instrument).\|      \|Updating an Instrument Identifier<br>When an Instrument Identifier is used in a payment the _previousTransactionId_ and _originalAuthorizedAmount_ values are automatically recorded.<br>These values will be added for you to future Merchant Initiated Transaction payments.<br>Your system can use this API to update these values.
`okhttp3.Call`	`patchInstrumentIdentifierCall(String instrumentIdentifierId, PatchInstrumentIdentifierRequest patchInstrumentIdentifierRequest, String profileId, Boolean retrieveBinDetails, String ifMatch, ProgressResponseBody.ProgressListener progressListener, ProgressRequestBody.ProgressRequestListener progressRequestListener)`	Build call for patchInstrumentIdentifier
`ApiResponse<PatchInstrumentIdentifierRequest>`	`patchInstrumentIdentifierWithHttpInfo(String instrumentIdentifierId, PatchInstrumentIdentifierRequest patchInstrumentIdentifierRequest, String profileId, Boolean retrieveBinDetails, String ifMatch)`	Update an Instrument Identifier \| \| \| \| \| --- \| --- \| --- \| \|Instrument Identifiers<br>An Instrument Identifier represents either a card number, or in the case of an ACH bank account, the routing and account number.<br>The same token Id is returned for a specific card number or bank account & routing number allowing the Instrument Identifier Id to be used for cross-channel payment tracking.<br>An Instrument Identifier can exist independently but also be associated with a [Customer Payment Instrument](#token-management_customer-payment-instrument_create-a-customer-payment-instrument) or [Standalone Payment Instrument](#token-management_payment-instrument_create-a-payment-instrument).\|      \|Updating an Instrument Identifier<br>When an Instrument Identifier is used in a payment the _previousTransactionId_ and _originalAuthorizedAmount_ values are automatically recorded.<br>These values will be added for you to future Merchant Initiated Transaction payments.<br>Your system can use this API to update these values.
`PostInstrumentIdentifierRequest`	`postInstrumentIdentifier(PostInstrumentIdentifierRequest postInstrumentIdentifierRequest, String profileId, Boolean retrieveBinDetails)`	Create an Instrument Identifier \| \| \| \| \| --- \| --- \| --- \| \|Instrument Identifiers<br>An Instrument Identifier represents either a card number, or in the case of an ACH bank account, the routing and account number.<br>The same token Id is returned for a specific card number or bank account & routing number allowing the Instrument Identifier Id to be used for cross-channel payment tracking.<br>An Instrument Identifier can exist independently but also be associated with a [Customer Payment Instrument](#token-management_customer-payment-instrument_create-a-customer-payment-instrument) or [Standalone Payment Instrument](#token-management_payment-instrument_create-a-payment-instrument).<br><br>Creating an Instrument Identifier<br>It is recommended you [create an Instrument Identifier via a Payment Authorization](#payments_payments_process-a-payment_samplerequests-dropdown_authorization-with-token-create_authorization-with-instrument-identifier-token-creation_liveconsole-tab-request-body), this can be for a zero amount.<br>An Instrument Identifier will also be created if you [create a Customer via a Payment Authorization](#payments_payments_process-a-payment_samplerequests-dropdown_authorization-with-token-create_authorization-with-customer-token-creation_liveconsole-tab-request-body)<br>In Europe: You should perform Payer Authentication alongside the Authorization.\|      \|Payment Network Tokens<br>Network tokens perform better than regular card numbers and they are not necessarily invalidated when a cardholder loses their card, or it expires.<br>A Payment Network Token will be automatically created and used in future payments if you are enabled for the service.<br>A Payment Network Token can also be [provisioned for an existing Instrument Identifier](#token-management_instrument-identifier_enroll-an-instrument-identifier-for-payment-network-token).<br>For more information about Payment Network Tokens see the Developer Guide.<br><br>Payments with Instrument Identifiers<br>To perform a payment with an Instrument Identifier simply specify the [Instrument Identifier Id in the payments request along with the expiration date, card type, & billing address](#payments_payments_process-a-payment_samplerequests-dropdown_authorization-using-tokens_authorization-with-instrument-identifier-token-id_liveconsole-tab-request-body).<br>When an Instrument Identifier is used in a payment the _previousTransactionId_ and _originalAuthorizedAmount_ values are automatically recorded.<br>These values will be added for you to future Merchant Initiated Transaction payments.
`okhttp3.Call`	`postInstrumentIdentifierAsync(PostInstrumentIdentifierRequest postInstrumentIdentifierRequest, String profileId, Boolean retrieveBinDetails, ApiCallback<PostInstrumentIdentifierRequest> callback)`	Create an Instrument Identifier (asynchronously) \| \| \| \| \| --- \| --- \| --- \| \|Instrument Identifiers<br>An Instrument Identifier represents either a card number, or in the case of an ACH bank account, the routing and account number.<br>The same token Id is returned for a specific card number or bank account & routing number allowing the Instrument Identifier Id to be used for cross-channel payment tracking.<br>An Instrument Identifier can exist independently but also be associated with a [Customer Payment Instrument](#token-management_customer-payment-instrument_create-a-customer-payment-instrument) or [Standalone Payment Instrument](#token-management_payment-instrument_create-a-payment-instrument).<br><br>Creating an Instrument Identifier<br>It is recommended you [create an Instrument Identifier via a Payment Authorization](#payments_payments_process-a-payment_samplerequests-dropdown_authorization-with-token-create_authorization-with-instrument-identifier-token-creation_liveconsole-tab-request-body), this can be for a zero amount.<br>An Instrument Identifier will also be created if you [create a Customer via a Payment Authorization](#payments_payments_process-a-payment_samplerequests-dropdown_authorization-with-token-create_authorization-with-customer-token-creation_liveconsole-tab-request-body)<br>In Europe: You should perform Payer Authentication alongside the Authorization.\|      \|Payment Network Tokens<br>Network tokens perform better than regular card numbers and they are not necessarily invalidated when a cardholder loses their card, or it expires.<br>A Payment Network Token will be automatically created and used in future payments if you are enabled for the service.<br>A Payment Network Token can also be [provisioned for an existing Instrument Identifier](#token-management_instrument-identifier_enroll-an-instrument-identifier-for-payment-network-token).<br>For more information about Payment Network Tokens see the Developer Guide.<br><br>Payments with Instrument Identifiers<br>To perform a payment with an Instrument Identifier simply specify the [Instrument Identifier Id in the payments request along with the expiration date, card type, & billing address](#payments_payments_process-a-payment_samplerequests-dropdown_authorization-using-tokens_authorization-with-instrument-identifier-token-id_liveconsole-tab-request-body).<br>When an Instrument Identifier is used in a payment the _previousTransactionId_ and _originalAuthorizedAmount_ values are automatically recorded.<br>These values will be added for you to future Merchant Initiated Transaction payments.
`okhttp3.Call`	`postInstrumentIdentifierCall(PostInstrumentIdentifierRequest postInstrumentIdentifierRequest, String profileId, Boolean retrieveBinDetails, ProgressResponseBody.ProgressListener progressListener, ProgressRequestBody.ProgressRequestListener progressRequestListener)`	Build call for postInstrumentIdentifier
`void`	`postInstrumentIdentifierEnrollment(String instrumentIdentifierId, PostInstrumentIdentifierEnrollmentRequest postInstrumentIdentifierEnrollmentRequest, String profileId)`	Enroll an Instrument Identifier for Payment Network Token \| \| \| \| \| --- \| --- \| --- \| \|Instrument Identifiers<br>An Instrument Identifier represents either a card number, or in the case of an ACH bank account, the routing and account number.<br>The same token Id is returned for a specific card number or bank account & routing number allowing the Instrument Identifier Id to be used for cross-channel payment tracking.<br>An Instrument Identifier can exist independently but also be associated with a [Customer Payment Instrument](#token-management_customer-payment-instrument_create-a-customer-payment-instrument) or [Standalone Payment Instrument](#token-management_payment-instrument_create-a-payment-instrument).\|      \|Enroll an Instrument Identifier for a Payment Network Token<br>Your system can use this API to provision a Network token for an existing Instrument Identifier.<br>Network tokens perform better than regular card numbers and they are not necessarily invalidated when a cardholder loses their card, or it expires.<br>A Network token can be [provisioned when creating an Instrument Identifier](#token-management_instrument-identifier_create-an-instrument-identifier_samplerequests-dropdown_create-instrument-identifier-card-enroll-for-network-token_liveconsole-tab-request-body).This will occur automatically when creating a [Customer](#payments_payments_process-a-payment_samplerequests-dropdown_authorization-with-token-create_authorization-with-customer-token-creation_liveconsole-tab-request-body), [Payment Instrument](#payments_payments_process-a-payment_samplerequests-dropdown_authorization-with-token-create_authorization-create-default-payment-instrument-shipping-address-for-existing-customer_liveconsole-tab-request-body) or [Instrument Identifier](#payments_payments_process-a-payment_samplerequests-dropdown_authorization-with-token-create_authorization-with-instrument-identifier-token-creation_liveconsole-tab-request-body) via the Payments API.<br>For more information about Payment Network Tokens see the Developer Guide.
`okhttp3.Call`	`postInstrumentIdentifierEnrollmentAsync(String instrumentIdentifierId, PostInstrumentIdentifierEnrollmentRequest postInstrumentIdentifierEnrollmentRequest, String profileId, ApiCallback<Void> callback)`	Enroll an Instrument Identifier for Payment Network Token (asynchronously) \| \| \| \| \| --- \| --- \| --- \| \|Instrument Identifiers<br>An Instrument Identifier represents either a card number, or in the case of an ACH bank account, the routing and account number.<br>The same token Id is returned for a specific card number or bank account & routing number allowing the Instrument Identifier Id to be used for cross-channel payment tracking.<br>An Instrument Identifier can exist independently but also be associated with a [Customer Payment Instrument](#token-management_customer-payment-instrument_create-a-customer-payment-instrument) or [Standalone Payment Instrument](#token-management_payment-instrument_create-a-payment-instrument).\|      \|Enroll an Instrument Identifier for a Payment Network Token<br>Your system can use this API to provision a Network token for an existing Instrument Identifier.<br>Network tokens perform better than regular card numbers and they are not necessarily invalidated when a cardholder loses their card, or it expires.<br>A Network token can be [provisioned when creating an Instrument Identifier](#token-management_instrument-identifier_create-an-instrument-identifier_samplerequests-dropdown_create-instrument-identifier-card-enroll-for-network-token_liveconsole-tab-request-body).This will occur automatically when creating a [Customer](#payments_payments_process-a-payment_samplerequests-dropdown_authorization-with-token-create_authorization-with-customer-token-creation_liveconsole-tab-request-body), [Payment Instrument](#payments_payments_process-a-payment_samplerequests-dropdown_authorization-with-token-create_authorization-create-default-payment-instrument-shipping-address-for-existing-customer_liveconsole-tab-request-body) or [Instrument Identifier](#payments_payments_process-a-payment_samplerequests-dropdown_authorization-with-token-create_authorization-with-instrument-identifier-token-creation_liveconsole-tab-request-body) via the Payments API.<br>For more information about Payment Network Tokens see the Developer Guide.
`okhttp3.Call`	`postInstrumentIdentifierEnrollmentCall(String instrumentIdentifierId, PostInstrumentIdentifierEnrollmentRequest postInstrumentIdentifierEnrollmentRequest, String profileId, ProgressResponseBody.ProgressListener progressListener, ProgressRequestBody.ProgressRequestListener progressRequestListener)`	Build call for postInstrumentIdentifierEnrollment
`ApiResponse<Void>`	`postInstrumentIdentifierEnrollmentWithHttpInfo(String instrumentIdentifierId, PostInstrumentIdentifierEnrollmentRequest postInstrumentIdentifierEnrollmentRequest, String profileId)`	Enroll an Instrument Identifier for Payment Network Token \| \| \| \| \| --- \| --- \| --- \| \|Instrument Identifiers<br>An Instrument Identifier represents either a card number, or in the case of an ACH bank account, the routing and account number.<br>The same token Id is returned for a specific card number or bank account & routing number allowing the Instrument Identifier Id to be used for cross-channel payment tracking.<br>An Instrument Identifier can exist independently but also be associated with a [Customer Payment Instrument](#token-management_customer-payment-instrument_create-a-customer-payment-instrument) or [Standalone Payment Instrument](#token-management_payment-instrument_create-a-payment-instrument).\|      \|Enroll an Instrument Identifier for a Payment Network Token<br>Your system can use this API to provision a Network token for an existing Instrument Identifier.<br>Network tokens perform better than regular card numbers and they are not necessarily invalidated when a cardholder loses their card, or it expires.<br>A Network token can be [provisioned when creating an Instrument Identifier](#token-management_instrument-identifier_create-an-instrument-identifier_samplerequests-dropdown_create-instrument-identifier-card-enroll-for-network-token_liveconsole-tab-request-body).This will occur automatically when creating a [Customer](#payments_payments_process-a-payment_samplerequests-dropdown_authorization-with-token-create_authorization-with-customer-token-creation_liveconsole-tab-request-body), [Payment Instrument](#payments_payments_process-a-payment_samplerequests-dropdown_authorization-with-token-create_authorization-create-default-payment-instrument-shipping-address-for-existing-customer_liveconsole-tab-request-body) or [Instrument Identifier](#payments_payments_process-a-payment_samplerequests-dropdown_authorization-with-token-create_authorization-with-instrument-identifier-token-creation_liveconsole-tab-request-body) via the Payments API.<br>For more information about Payment Network Tokens see the Developer Guide.
`ApiResponse<PostInstrumentIdentifierRequest>`	`postInstrumentIdentifierWithHttpInfo(PostInstrumentIdentifierRequest postInstrumentIdentifierRequest, String profileId, Boolean retrieveBinDetails)`	Create an Instrument Identifier \| \| \| \| \| --- \| --- \| --- \| \|Instrument Identifiers<br>An Instrument Identifier represents either a card number, or in the case of an ACH bank account, the routing and account number.<br>The same token Id is returned for a specific card number or bank account & routing number allowing the Instrument Identifier Id to be used for cross-channel payment tracking.<br>An Instrument Identifier can exist independently but also be associated with a [Customer Payment Instrument](#token-management_customer-payment-instrument_create-a-customer-payment-instrument) or [Standalone Payment Instrument](#token-management_payment-instrument_create-a-payment-instrument).<br><br>Creating an Instrument Identifier<br>It is recommended you [create an Instrument Identifier via a Payment Authorization](#payments_payments_process-a-payment_samplerequests-dropdown_authorization-with-token-create_authorization-with-instrument-identifier-token-creation_liveconsole-tab-request-body), this can be for a zero amount.<br>An Instrument Identifier will also be created if you [create a Customer via a Payment Authorization](#payments_payments_process-a-payment_samplerequests-dropdown_authorization-with-token-create_authorization-with-customer-token-creation_liveconsole-tab-request-body)<br>In Europe: You should perform Payer Authentication alongside the Authorization.\|      \|Payment Network Tokens<br>Network tokens perform better than regular card numbers and they are not necessarily invalidated when a cardholder loses their card, or it expires.<br>A Payment Network Token will be automatically created and used in future payments if you are enabled for the service.<br>A Payment Network Token can also be [provisioned for an existing Instrument Identifier](#token-management_instrument-identifier_enroll-an-instrument-identifier-for-payment-network-token).<br>For more information about Payment Network Tokens see the Developer Guide.<br><br>Payments with Instrument Identifiers<br>To perform a payment with an Instrument Identifier simply specify the [Instrument Identifier Id in the payments request along with the expiration date, card type, & billing address](#payments_payments_process-a-payment_samplerequests-dropdown_authorization-using-tokens_authorization-with-instrument-identifier-token-id_liveconsole-tab-request-body).<br>When an Instrument Identifier is used in a payment the _previousTransactionId_ and _originalAuthorizedAmount_ values are automatically recorded.<br>These values will be added for you to future Merchant Initiated Transaction payments.
`void`	`setApiClient(ApiClient apiClient)`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
 - InstrumentIdentifierApi
```
public InstrumentIdentifierApi()
```
 - InstrumentIdentifierApi
```
public InstrumentIdentifierApi(ApiClient apiClient)
```
- Method Detail
 - getApiClient
```
public ApiClient getApiClient()
```
 - setApiClient
```
public void setApiClient(ApiClient apiClient)
```
 - deleteInstrumentIdentifierCall
```
public okhttp3.Call deleteInstrumentIdentifierCall(String instrumentIdentifierId,
 String profileId,
 ProgressResponseBody.ProgressListener progressListener,
 ProgressRequestBody.ProgressRequestListener progressRequestListener)
 throws ApiException,
 com.cybersource.authsdk.core.ConfigException
```
 Build call for deleteInstrumentIdentifier
 
 Parameters:
 
 instrumentIdentifierId - The Id of an Instrument Identifier. (required)
 
 profileId - The Id of a profile containing user specific TMS configuration. (optional)
 
 progressListener - Progress listener
 
 progressRequestListener - Progress request listener
 
 Returns:
 
 Call to execute
 
 Throws:
 
 ApiException - If fail to serialize the request body object
 
 com.cybersource.authsdk.core.ConfigException - If creation of merchant configuration fails in ApiClient
 - deleteInstrumentIdentifier
```
public void deleteInstrumentIdentifier(String instrumentIdentifierId,
 String profileId)
 throws ApiException,
 com.cybersource.authsdk.core.ConfigException
```
 Delete an Instrument Identifier | | | | | --- | --- | --- | |**Instrument Identifiers** An Instrument Identifier represents either a card number, or in the case of an ACH bank account, the routing and account numbers. The same token Id is returned for a specific card number or bank account & routing number allowing the Instrument Identifier Id to be used for cross-channel payment tracking. An Instrument Identifier can exist independently but also be associated with a [Customer Payment Instrument](#token-management_customer-payment-instrument_create-a-customer-payment-instrument) or [Standalone Payment Instrument](#token-management_payment-instrument_create-a-payment-instrument).|      |**Deleting an Instrument Identifier** Your system can use this API to delete an existing Instrument Identifier. An Instrument Identifier cannot be deleted if it is linked to any Payment Instruments. You can [retrieve all Payment Instruments associated with an Instrument Identifier](#token-management_instrument-identifier_list-payment-instruments-for-an-instrument-identifier).
 
 Parameters:
 
 instrumentIdentifierId - The Id of an Instrument Identifier. (required)
 
 profileId - The Id of a profile containing user specific TMS configuration. (optional)
 
 Throws:
 
 ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body
 
 com.cybersource.authsdk.core.ConfigException - If creation of merchant configuration fails in ApiClient
 - deleteInstrumentIdentifierWithHttpInfo
```
public ApiResponse<Void> deleteInstrumentIdentifierWithHttpInfo(String instrumentIdentifierId,
 String profileId)
 throws ApiException,
 com.cybersource.authsdk.core.ConfigException
```
 Delete an Instrument Identifier | | | | | --- | --- | --- | |**Instrument Identifiers** An Instrument Identifier represents either a card number, or in the case of an ACH bank account, the routing and account numbers. The same token Id is returned for a specific card number or bank account & routing number allowing the Instrument Identifier Id to be used for cross-channel payment tracking. An Instrument Identifier can exist independently but also be associated with a [Customer Payment Instrument](#token-management_customer-payment-instrument_create-a-customer-payment-instrument) or [Standalone Payment Instrument](#token-management_payment-instrument_create-a-payment-instrument).|      |**Deleting an Instrument Identifier** Your system can use this API to delete an existing Instrument Identifier. An Instrument Identifier cannot be deleted if it is linked to any Payment Instruments. You can [retrieve all Payment Instruments associated with an Instrument Identifier](#token-management_instrument-identifier_list-payment-instruments-for-an-instrument-identifier).
 
 Parameters:
 
 instrumentIdentifierId - The Id of an Instrument Identifier. (required)
 
 profileId - The Id of a profile containing user specific TMS configuration. (optional)
 
 Returns:
 
 ApiResponse<Void>
 
 Throws:
 
 ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body
 
 com.cybersource.authsdk.core.ConfigException - If creation of merchant configuration fails in ApiClient
 - deleteInstrumentIdentifierAsync
```
public okhttp3.Call deleteInstrumentIdentifierAsync(String instrumentIdentifierId,
 String profileId,
 ApiCallback<Void> callback)
 throws ApiException,
 com.cybersource.authsdk.core.ConfigException
```
 Delete an Instrument Identifier (asynchronously) | | | | | --- | --- | --- | |**Instrument Identifiers** An Instrument Identifier represents either a card number, or in the case of an ACH bank account, the routing and account numbers. The same token Id is returned for a specific card number or bank account & routing number allowing the Instrument Identifier Id to be used for cross-channel payment tracking. An Instrument Identifier can exist independently but also be associated with a [Customer Payment Instrument](#token-management_customer-payment-instrument_create-a-customer-payment-instrument) or [Standalone Payment Instrument](#token-management_payment-instrument_create-a-payment-instrument).|      |**Deleting an Instrument Identifier** Your system can use this API to delete an existing Instrument Identifier. An Instrument Identifier cannot be deleted if it is linked to any Payment Instruments. You can [retrieve all Payment Instruments associated with an Instrument Identifier](#token-management_instrument-identifier_list-payment-instruments-for-an-instrument-identifier).
 
 Parameters:
 
 instrumentIdentifierId - The Id of an Instrument Identifier. (required)
 
 profileId - The Id of a profile containing user specific TMS configuration. (optional)
 
 callback - The callback to be executed when the API call finishes
 
 Returns:
 
 The request call
 
 Throws:
 
 ApiException - If fail to process the API call, e.g. serializing the request body object
 
 com.cybersource.authsdk.core.ConfigException - If creation of merchant configuration fails in ApiClient
 - getInstrumentIdentifierCall
```
public okhttp3.Call getInstrumentIdentifierCall(String instrumentIdentifierId,
 String profileId,
 Boolean retrieveBinDetails,
 ProgressResponseBody.ProgressListener progressListener,
 ProgressRequestBody.ProgressRequestListener progressRequestListener)
 throws ApiException,
 com.cybersource.authsdk.core.ConfigException
```
 Build call for getInstrumentIdentifier
 
 Parameters:
 
 instrumentIdentifierId - The Id of an Instrument Identifier. (required)
 
 profileId - The Id of a profile containing user specific TMS configuration. (optional)
 
 retrieveBinDetails - Retrieve the Bin Details of PAN or network token (optional)
 
 progressListener - Progress listener
 
 progressRequestListener - Progress request listener
 
 Returns:
 
 Call to execute
 
 Throws:
 
 ApiException - If fail to serialize the request body object
 
 com.cybersource.authsdk.core.ConfigException - If creation of merchant configuration fails in ApiClient
 - getInstrumentIdentifier
```
public PostInstrumentIdentifierRequest getInstrumentIdentifier(String instrumentIdentifierId,
 String profileId,
 Boolean retrieveBinDetails)
 throws ApiException,
 com.cybersource.authsdk.core.ConfigException
```
 Retrieve an Instrument Identifier | | | | | --- | --- | --- | |**Instrument Identifiers** An Instrument Identifier represents either a card number, or in the case of an ACH bank account, the routing and account number. The same token Id is returned for a specific card number or bank account & routing number allowing the Instrument Identifier Id to be used for cross-channel payment tracking. An Instrument Identifier can exist independently but also be associated with a [Customer Payment Instrument](#token-management_customer-payment-instrument_create-a-customer-payment-instrument) or [Standalone Payment Instrument](#token-management_payment-instrument_create-a-payment-instrument). **Retrieving an Instrument Identifier** Your system can use this API to retrieve an Instrument Identifier. **Note: the actual card data will be masked.** The Instrument Identifier will also be returned when retrieving a [Customer](#token-management_customer_retrieve-a-customer), [Customer Payment Instrument](#token-management_customer-payment-instrument_retrieve-a-customer-payment-instrument) or [Standalone Payment Instrument](#token-management_payment-instrument_retrieve-a-payment-instrument).|      |**Payment Network Tokens** Network tokens perform better than regular card numbers and they are not necessarily invalidated when a cardholder loses their card, or it expires. A Payment Network Token will be automatically created and used in future payments if you are enabled for the service. A Payment Network Token can also be [provisioned for an existing Instrument Identifier](#token-management_instrument-identifier_enroll-an-instrument-identifier-for-payment-network-token). For more information about Payment Network Tokens see the Developer Guide. **Payments with Instrument Identifiers** To perform a payment with an Instrument Identifier simply specify the [Instrument Identifier Id in the payments request along with the expiration date, card type, & billing address](#payments_payments_process-a-payment_samplerequests-dropdown_authorization-using-tokens_authorization-with-instrument-identifier-token-id_liveconsole-tab-request-body). When an Instrument Identifier is used in a payment the **_previousTransactionId_** and **_originalAuthorizedAmount_** values are automatically recorded. These values will be added for you to future Merchant Initiated Transaction payments.
 
 Parameters:
 
 instrumentIdentifierId - The Id of an Instrument Identifier. (required)
 
 profileId - The Id of a profile containing user specific TMS configuration. (optional)
 
 retrieveBinDetails - Retrieve the Bin Details of PAN or network token (optional)
 
 Returns:
 
 PostInstrumentIdentifierRequest
 
 Throws:
 
 ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body
 
 com.cybersource.authsdk.core.ConfigException - If creation of merchant configuration fails in ApiClient
 - getInstrumentIdentifierWithHttpInfo
```
public ApiResponse<PostInstrumentIdentifierRequest> getInstrumentIdentifierWithHttpInfo(String instrumentIdentifierId,
 String profileId,
 Boolean retrieveBinDetails)
 throws ApiException,
 com.cybersource.authsdk.core.ConfigException
```
 Retrieve an Instrument Identifier | | | | | --- | --- | --- | |**Instrument Identifiers** An Instrument Identifier represents either a card number, or in the case of an ACH bank account, the routing and account number. The same token Id is returned for a specific card number or bank account & routing number allowing the Instrument Identifier Id to be used for cross-channel payment tracking. An Instrument Identifier can exist independently but also be associated with a [Customer Payment Instrument](#token-management_customer-payment-instrument_create-a-customer-payment-instrument) or [Standalone Payment Instrument](#token-management_payment-instrument_create-a-payment-instrument). **Retrieving an Instrument Identifier** Your system can use this API to retrieve an Instrument Identifier. **Note: the actual card data will be masked.** The Instrument Identifier will also be returned when retrieving a [Customer](#token-management_customer_retrieve-a-customer), [Customer Payment Instrument](#token-management_customer-payment-instrument_retrieve-a-customer-payment-instrument) or [Standalone Payment Instrument](#token-management_payment-instrument_retrieve-a-payment-instrument).|      |**Payment Network Tokens** Network tokens perform better than regular card numbers and they are not necessarily invalidated when a cardholder loses their card, or it expires. A Payment Network Token will be automatically created and used in future payments if you are enabled for the service. A Payment Network Token can also be [provisioned for an existing Instrument Identifier](#token-management_instrument-identifier_enroll-an-instrument-identifier-for-payment-network-token). For more information about Payment Network Tokens see the Developer Guide. **Payments with Instrument Identifiers** To perform a payment with an Instrument Identifier simply specify the [Instrument Identifier Id in the payments request along with the expiration date, card type, & billing address](#payments_payments_process-a-payment_samplerequests-dropdown_authorization-using-tokens_authorization-with-instrument-identifier-token-id_liveconsole-tab-request-body). When an Instrument Identifier is used in a payment the **_previousTransactionId_** and **_originalAuthorizedAmount_** values are automatically recorded. These values will be added for you to future Merchant Initiated Transaction payments.
 
 Parameters:
 
 instrumentIdentifierId - The Id of an Instrument Identifier. (required)
 
 profileId - The Id of a profile containing user specific TMS configuration. (optional)
 
 retrieveBinDetails - Retrieve the Bin Details of PAN or network token (optional)
 
 Returns:
 
 ApiResponse<PostInstrumentIdentifierRequest>
 
 Throws:
 
 ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body
 
 com.cybersource.authsdk.core.ConfigException - If creation of merchant configuration fails in ApiClient
 - getInstrumentIdentifierAsync
```
public okhttp3.Call getInstrumentIdentifierAsync(String instrumentIdentifierId,
 String profileId,
 Boolean retrieveBinDetails,
 ApiCallback<PostInstrumentIdentifierRequest> callback)
 throws ApiException,
 com.cybersource.authsdk.core.ConfigException
```
 Retrieve an Instrument Identifier (asynchronously) | | | | | --- | --- | --- | |**Instrument Identifiers** An Instrument Identifier represents either a card number, or in the case of an ACH bank account, the routing and account number. The same token Id is returned for a specific card number or bank account & routing number allowing the Instrument Identifier Id to be used for cross-channel payment tracking. An Instrument Identifier can exist independently but also be associated with a [Customer Payment Instrument](#token-management_customer-payment-instrument_create-a-customer-payment-instrument) or [Standalone Payment Instrument](#token-management_payment-instrument_create-a-payment-instrument). **Retrieving an Instrument Identifier** Your system can use this API to retrieve an Instrument Identifier. **Note: the actual card data will be masked.** The Instrument Identifier will also be returned when retrieving a [Customer](#token-management_customer_retrieve-a-customer), [Customer Payment Instrument](#token-management_customer-payment-instrument_retrieve-a-customer-payment-instrument) or [Standalone Payment Instrument](#token-management_payment-instrument_retrieve-a-payment-instrument).|      |**Payment Network Tokens** Network tokens perform better than regular card numbers and they are not necessarily invalidated when a cardholder loses their card, or it expires. A Payment Network Token will be automatically created and used in future payments if you are enabled for the service. A Payment Network Token can also be [provisioned for an existing Instrument Identifier](#token-management_instrument-identifier_enroll-an-instrument-identifier-for-payment-network-token). For more information about Payment Network Tokens see the Developer Guide. **Payments with Instrument Identifiers** To perform a payment with an Instrument Identifier simply specify the [Instrument Identifier Id in the payments request along with the expiration date, card type, & billing address](#payments_payments_process-a-payment_samplerequests-dropdown_authorization-using-tokens_authorization-with-instrument-identifier-token-id_liveconsole-tab-request-body). When an Instrument Identifier is used in a payment the **_previousTransactionId_** and **_originalAuthorizedAmount_** values are automatically recorded. These values will be added for you to future Merchant Initiated Transaction payments.
 
 Parameters:
 
 instrumentIdentifierId - The Id of an Instrument Identifier. (required)
 
 profileId - The Id of a profile containing user specific TMS configuration. (optional)
 
 retrieveBinDetails - Retrieve the Bin Details of PAN or network token (optional)
 
 callback - The callback to be executed when the API call finishes
 
 Returns:
 
 The request call
 
 Throws:
 
 ApiException - If fail to process the API call, e.g. serializing the request body object
 
 com.cybersource.authsdk.core.ConfigException - If creation of merchant configuration fails in ApiClient
 - getInstrumentIdentifierPaymentInstrumentsListCall
```
public okhttp3.Call getInstrumentIdentifierPaymentInstrumentsListCall(String instrumentIdentifierId,
 String profileId,
 Boolean retrieveBinDetails,
 Long offset,
 Long limit,
 ProgressResponseBody.ProgressListener progressListener,
 ProgressRequestBody.ProgressRequestListener progressRequestListener)
 throws ApiException,
 com.cybersource.authsdk.core.ConfigException
```
 Build call for getInstrumentIdentifierPaymentInstrumentsList
 
 Parameters:
 
 instrumentIdentifierId - The Id of an Instrument Identifier. (required)
 
 profileId - The Id of a profile containing user specific TMS configuration. (optional)
 
 retrieveBinDetails - Retrieve the Bin Details of PAN or network token (optional)
 
 offset - Starting record in zero-based dataset that should be returned as the first object in the array. Default is 0. (optional, default to 0)
 
 limit - The maximum number that can be returned in the array starting from the offset record in zero-based dataset. Default is 20, maximum is 100. (optional, default to 20)
 
 progressListener - Progress listener
 
 progressRequestListener - Progress request listener
 
 Returns:
 
 Call to execute
 
 Throws:
 
 ApiException - If fail to serialize the request body object
 
 com.cybersource.authsdk.core.ConfigException - If creation of merchant configuration fails in ApiClient
 - getInstrumentIdentifierPaymentInstrumentsList
```
public PaymentInstrumentList getInstrumentIdentifierPaymentInstrumentsList(String instrumentIdentifierId,
 String profileId,
 Boolean retrieveBinDetails,
 Long offset,
 Long limit)
 throws ApiException,
 com.cybersource.authsdk.core.ConfigException
```
 List Payment Instruments for an Instrument Identifier | | | | | --- | --- | --- | |**Instrument Identifiers** An Instrument Identifier represents either a card number, or in the case of an ACH bank account, the routing and account numbers. The same token Id is returned for a specific card number or bank account & routing number allowing the Instrument Identifier Id to be used for cross-channel payment tracking. An Instrument Identifier can exist independently but also be associated with a [Customer Payment Instrument](#token-management_customer-payment-instrument_create-a-customer-payment-instrument) or [Standalone Payment Instrument](#token-management_payment-instrument_create-a-payment-instrument).|      |**Retrieving all Payment Instruments associated with an Instrument Identifier** Your system can use this API to retrieve all Payment Instruments linked to an Instrument Identifier.
 
 Parameters:
 
 instrumentIdentifierId - The Id of an Instrument Identifier. (required)
 
 profileId - The Id of a profile containing user specific TMS configuration. (optional)
 
 retrieveBinDetails - Retrieve the Bin Details of PAN or network token (optional)
 
 offset - Starting record in zero-based dataset that should be returned as the first object in the array. Default is 0. (optional, default to 0)
 
 limit - The maximum number that can be returned in the array starting from the offset record in zero-based dataset. Default is 20, maximum is 100. (optional, default to 20)
 
 Returns:
 
 PaymentInstrumentList
 
 Throws:
 
 ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body
 
 com.cybersource.authsdk.core.ConfigException - If creation of merchant configuration fails in ApiClient
 - getInstrumentIdentifierPaymentInstrumentsListWithHttpInfo
```
public ApiResponse<PaymentInstrumentList> getInstrumentIdentifierPaymentInstrumentsListWithHttpInfo(String instrumentIdentifierId,
 String profileId,
 Boolean retrieveBinDetails,
 Long offset,
 Long limit)
 throws ApiException,
 com.cybersource.authsdk.core.ConfigException
```
 List Payment Instruments for an Instrument Identifier | | | | | --- | --- | --- | |**Instrument Identifiers** An Instrument Identifier represents either a card number, or in the case of an ACH bank account, the routing and account numbers. The same token Id is returned for a specific card number or bank account & routing number allowing the Instrument Identifier Id to be used for cross-channel payment tracking. An Instrument Identifier can exist independently but also be associated with a [Customer Payment Instrument](#token-management_customer-payment-instrument_create-a-customer-payment-instrument) or [Standalone Payment Instrument](#token-management_payment-instrument_create-a-payment-instrument).|      |**Retrieving all Payment Instruments associated with an Instrument Identifier** Your system can use this API to retrieve all Payment Instruments linked to an Instrument Identifier.
 
 Parameters:
 
 instrumentIdentifierId - The Id of an Instrument Identifier. (required)
 
 profileId - The Id of a profile containing user specific TMS configuration. (optional)
 
 retrieveBinDetails - Retrieve the Bin Details of PAN or network token (optional)
 
 offset - Starting record in zero-based dataset that should be returned as the first object in the array. Default is 0. (optional, default to 0)
 
 limit - The maximum number that can be returned in the array starting from the offset record in zero-based dataset. Default is 20, maximum is 100. (optional, default to 20)
 
 Returns:
 
 ApiResponse<PaymentInstrumentList>
 
 Throws:
 
 ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body
 
 com.cybersource.authsdk.core.ConfigException - If creation of merchant configuration fails in ApiClient
 - getInstrumentIdentifierPaymentInstrumentsListAsync
```
public okhttp3.Call getInstrumentIdentifierPaymentInstrumentsListAsync(String instrumentIdentifierId,
 String profileId,
 Boolean retrieveBinDetails,
 Long offset,
 Long limit,
 ApiCallback<PaymentInstrumentList> callback)
 throws ApiException,
 com.cybersource.authsdk.core.ConfigException
```
 List Payment Instruments for an Instrument Identifier (asynchronously) | | | | | --- | --- | --- | |**Instrument Identifiers** An Instrument Identifier represents either a card number, or in the case of an ACH bank account, the routing and account numbers. The same token Id is returned for a specific card number or bank account & routing number allowing the Instrument Identifier Id to be used for cross-channel payment tracking. An Instrument Identifier can exist independently but also be associated with a [Customer Payment Instrument](#token-management_customer-payment-instrument_create-a-customer-payment-instrument) or [Standalone Payment Instrument](#token-management_payment-instrument_create-a-payment-instrument).|      |**Retrieving all Payment Instruments associated with an Instrument Identifier** Your system can use this API to retrieve all Payment Instruments linked to an Instrument Identifier.
 
 Parameters:
 
 instrumentIdentifierId - The Id of an Instrument Identifier. (required)
 
 profileId - The Id of a profile containing user specific TMS configuration. (optional)
 
 retrieveBinDetails - Retrieve the Bin Details of PAN or network token (optional)
 
 offset - Starting record in zero-based dataset that should be returned as the first object in the array. Default is 0. (optional, default to 0)
 
 limit - The maximum number that can be returned in the array starting from the offset record in zero-based dataset. Default is 20, maximum is 100. (optional, default to 20)
 
 callback - The callback to be executed when the API call finishes
 
 Returns:
 
 The request call
 
 Throws:
 
 ApiException - If fail to process the API call, e.g. serializing the request body object
 
 com.cybersource.authsdk.core.ConfigException - If creation of merchant configuration fails in ApiClient
 - patchInstrumentIdentifierCall
```
public okhttp3.Call patchInstrumentIdentifierCall(String instrumentIdentifierId,
 PatchInstrumentIdentifierRequest patchInstrumentIdentifierRequest,
 String profileId,
 Boolean retrieveBinDetails,
 String ifMatch,
 ProgressResponseBody.ProgressListener progressListener,
 ProgressRequestBody.ProgressRequestListener progressRequestListener)
 throws ApiException,
 com.cybersource.authsdk.core.ConfigException
```
 Build call for patchInstrumentIdentifier
 
 Parameters:
 
 instrumentIdentifierId - The Id of an Instrument Identifier. (required)
 
 patchInstrumentIdentifierRequest - Specify the previous transaction Id to update. (required)
 
 profileId - The Id of a profile containing user specific TMS configuration. (optional)
 
 retrieveBinDetails - Retrieve the Bin Details of PAN or network token (optional)
 
 ifMatch - Contains an ETag value from a GET request to make the request conditional. (optional)
 
 progressListener - Progress listener
 
 progressRequestListener - Progress request listener
 
 Returns:
 
 Call to execute
 
 Throws:
 
 ApiException - If fail to serialize the request body object
 
 com.cybersource.authsdk.core.ConfigException - If creation of merchant configuration fails in ApiClient
 - patchInstrumentIdentifier
```
public PatchInstrumentIdentifierRequest patchInstrumentIdentifier(String instrumentIdentifierId,
 PatchInstrumentIdentifierRequest patchInstrumentIdentifierRequest,
 String profileId,
 Boolean retrieveBinDetails,
 String ifMatch)
 throws ApiException,
 com.cybersource.authsdk.core.ConfigException
```
 Update an Instrument Identifier | | | | | --- | --- | --- | |**Instrument Identifiers** An Instrument Identifier represents either a card number, or in the case of an ACH bank account, the routing and account number. The same token Id is returned for a specific card number or bank account & routing number allowing the Instrument Identifier Id to be used for cross-channel payment tracking. An Instrument Identifier can exist independently but also be associated with a [Customer Payment Instrument](#token-management_customer-payment-instrument_create-a-customer-payment-instrument) or [Standalone Payment Instrument](#token-management_payment-instrument_create-a-payment-instrument).|      |**Updating an Instrument Identifier** When an Instrument Identifier is used in a payment the **_previousTransactionId_** and **_originalAuthorizedAmount_** values are automatically recorded. These values will be added for you to future Merchant Initiated Transaction payments. Your system can use this API to update these values.
 
 Parameters:
 
 instrumentIdentifierId - The Id of an Instrument Identifier. (required)
 
 patchInstrumentIdentifierRequest - Specify the previous transaction Id to update. (required)
 
 profileId - The Id of a profile containing user specific TMS configuration. (optional)
 
 retrieveBinDetails - Retrieve the Bin Details of PAN or network token (optional)
 
 ifMatch - Contains an ETag value from a GET request to make the request conditional. (optional)
 
 Returns:
 
 PatchInstrumentIdentifierRequest
 
 Throws:
 
 ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body
 
 com.cybersource.authsdk.core.ConfigException - If creation of merchant configuration fails in ApiClient
 - patchInstrumentIdentifierWithHttpInfo
```
public ApiResponse<PatchInstrumentIdentifierRequest> patchInstrumentIdentifierWithHttpInfo(String instrumentIdentifierId,
 PatchInstrumentIdentifierRequest patchInstrumentIdentifierRequest,
 String profileId,
 Boolean retrieveBinDetails,
 String ifMatch)
 throws ApiException,
 com.cybersource.authsdk.core.ConfigException
```
 Update an Instrument Identifier | | | | | --- | --- | --- | |**Instrument Identifiers** An Instrument Identifier represents either a card number, or in the case of an ACH bank account, the routing and account number. The same token Id is returned for a specific card number or bank account & routing number allowing the Instrument Identifier Id to be used for cross-channel payment tracking. An Instrument Identifier can exist independently but also be associated with a [Customer Payment Instrument](#token-management_customer-payment-instrument_create-a-customer-payment-instrument) or [Standalone Payment Instrument](#token-management_payment-instrument_create-a-payment-instrument).|      |**Updating an Instrument Identifier** When an Instrument Identifier is used in a payment the **_previousTransactionId_** and **_originalAuthorizedAmount_** values are automatically recorded. These values will be added for you to future Merchant Initiated Transaction payments. Your system can use this API to update these values.
 
 Parameters:
 
 instrumentIdentifierId - The Id of an Instrument Identifier. (required)
 
 patchInstrumentIdentifierRequest - Specify the previous transaction Id to update. (required)
 
 profileId - The Id of a profile containing user specific TMS configuration. (optional)
 
 retrieveBinDetails - Retrieve the Bin Details of PAN or network token (optional)
 
 ifMatch - Contains an ETag value from a GET request to make the request conditional. (optional)
 
 Returns:
 
 ApiResponse<PatchInstrumentIdentifierRequest>
 
 Throws:
 
 ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body
 
 com.cybersource.authsdk.core.ConfigException - If creation of merchant configuration fails in ApiClient
 - patchInstrumentIdentifierAsync
```
public okhttp3.Call patchInstrumentIdentifierAsync(String instrumentIdentifierId,
 PatchInstrumentIdentifierRequest patchInstrumentIdentifierRequest,
 String profileId,
 Boolean retrieveBinDetails,
 String ifMatch,
 ApiCallback<PatchInstrumentIdentifierRequest> callback)
 throws ApiException,
 com.cybersource.authsdk.core.ConfigException
```
 Update an Instrument Identifier (asynchronously) | | | | | --- | --- | --- | |**Instrument Identifiers** An Instrument Identifier represents either a card number, or in the case of an ACH bank account, the routing and account number. The same token Id is returned for a specific card number or bank account & routing number allowing the Instrument Identifier Id to be used for cross-channel payment tracking. An Instrument Identifier can exist independently but also be associated with a [Customer Payment Instrument](#token-management_customer-payment-instrument_create-a-customer-payment-instrument) or [Standalone Payment Instrument](#token-management_payment-instrument_create-a-payment-instrument).|      |**Updating an Instrument Identifier** When an Instrument Identifier is used in a payment the **_previousTransactionId_** and **_originalAuthorizedAmount_** values are automatically recorded. These values will be added for you to future Merchant Initiated Transaction payments. Your system can use this API to update these values.
 
 Parameters:
 
 instrumentIdentifierId - The Id of an Instrument Identifier. (required)
 
 patchInstrumentIdentifierRequest - Specify the previous transaction Id to update. (required)
 
 profileId - The Id of a profile containing user specific TMS configuration. (optional)
 
 retrieveBinDetails - Retrieve the Bin Details of PAN or network token (optional)
 
 ifMatch - Contains an ETag value from a GET request to make the request conditional. (optional)
 
 callback - The callback to be executed when the API call finishes
 
 Returns:
 
 The request call
 
 Throws:
 
 ApiException - If fail to process the API call, e.g. serializing the request body object
 
 com.cybersource.authsdk.core.ConfigException - If creation of merchant configuration fails in ApiClient
 - postInstrumentIdentifierCall
```
public okhttp3.Call postInstrumentIdentifierCall(PostInstrumentIdentifierRequest postInstrumentIdentifierRequest,
 String profileId,
 Boolean retrieveBinDetails,
 ProgressResponseBody.ProgressListener progressListener,
 ProgressRequestBody.ProgressRequestListener progressRequestListener)
 throws ApiException,
 com.cybersource.authsdk.core.ConfigException
```
 Build call for postInstrumentIdentifier
 
 Parameters:
 
 postInstrumentIdentifierRequest - Specify either a Card, Bank Account or Enrollable Card (required)
 
 profileId - The Id of a profile containing user specific TMS configuration. (optional)
 
 retrieveBinDetails - Retrieve the Bin Details of PAN or network token (optional)
 
 progressListener - Progress listener
 
 progressRequestListener - Progress request listener
 
 Returns:
 
 Call to execute
 
 Throws:
 
 ApiException - If fail to serialize the request body object
 
 com.cybersource.authsdk.core.ConfigException - If creation of merchant configuration fails in ApiClient
 - postInstrumentIdentifier
```
public PostInstrumentIdentifierRequest postInstrumentIdentifier(PostInstrumentIdentifierRequest postInstrumentIdentifierRequest,
 String profileId,
 Boolean retrieveBinDetails)
 throws ApiException,
 com.cybersource.authsdk.core.ConfigException
```
 Create an Instrument Identifier | | | | | --- | --- | --- | |**Instrument Identifiers** An Instrument Identifier represents either a card number, or in the case of an ACH bank account, the routing and account number. The same token Id is returned for a specific card number or bank account & routing number allowing the Instrument Identifier Id to be used for cross-channel payment tracking. An Instrument Identifier can exist independently but also be associated with a [Customer Payment Instrument](#token-management_customer-payment-instrument_create-a-customer-payment-instrument) or [Standalone Payment Instrument](#token-management_payment-instrument_create-a-payment-instrument). **Creating an Instrument Identifier** It is recommended you [create an Instrument Identifier via a Payment Authorization](#payments_payments_process-a-payment_samplerequests-dropdown_authorization-with-token-create_authorization-with-instrument-identifier-token-creation_liveconsole-tab-request-body), this can be for a zero amount. An Instrument Identifier will also be created if you [create a Customer via a Payment Authorization](#payments_payments_process-a-payment_samplerequests-dropdown_authorization-with-token-create_authorization-with-customer-token-creation_liveconsole-tab-request-body) In Europe: You should perform Payer Authentication alongside the Authorization.|      |**Payment Network Tokens** Network tokens perform better than regular card numbers and they are not necessarily invalidated when a cardholder loses their card, or it expires. A Payment Network Token will be automatically created and used in future payments if you are enabled for the service. A Payment Network Token can also be [provisioned for an existing Instrument Identifier](#token-management_instrument-identifier_enroll-an-instrument-identifier-for-payment-network-token). For more information about Payment Network Tokens see the Developer Guide. **Payments with Instrument Identifiers** To perform a payment with an Instrument Identifier simply specify the [Instrument Identifier Id in the payments request along with the expiration date, card type, & billing address](#payments_payments_process-a-payment_samplerequests-dropdown_authorization-using-tokens_authorization-with-instrument-identifier-token-id_liveconsole-tab-request-body). When an Instrument Identifier is used in a payment the **_previousTransactionId_** and **_originalAuthorizedAmount_** values are automatically recorded. These values will be added for you to future Merchant Initiated Transaction payments.
 
 Parameters:
 
 postInstrumentIdentifierRequest - Specify either a Card, Bank Account or Enrollable Card (required)
 
 profileId - The Id of a profile containing user specific TMS configuration. (optional)
 
 retrieveBinDetails - Retrieve the Bin Details of PAN or network token (optional)
 
 Returns:
 
 PostInstrumentIdentifierRequest
 
 Throws:
 
 ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body
 
 com.cybersource.authsdk.core.ConfigException - If creation of merchant configuration fails in ApiClient
 - postInstrumentIdentifierWithHttpInfo
```
public ApiResponse<PostInstrumentIdentifierRequest> postInstrumentIdentifierWithHttpInfo(PostInstrumentIdentifierRequest postInstrumentIdentifierRequest,
 String profileId,
 Boolean retrieveBinDetails)
 throws ApiException,
 com.cybersource.authsdk.core.ConfigException
```
 Create an Instrument Identifier | | | | | --- | --- | --- | |**Instrument Identifiers** An Instrument Identifier represents either a card number, or in the case of an ACH bank account, the routing and account number. The same token Id is returned for a specific card number or bank account & routing number allowing the Instrument Identifier Id to be used for cross-channel payment tracking. An Instrument Identifier can exist independently but also be associated with a [Customer Payment Instrument](#token-management_customer-payment-instrument_create-a-customer-payment-instrument) or [Standalone Payment Instrument](#token-management_payment-instrument_create-a-payment-instrument). **Creating an Instrument Identifier** It is recommended you [create an Instrument Identifier via a Payment Authorization](#payments_payments_process-a-payment_samplerequests-dropdown_authorization-with-token-create_authorization-with-instrument-identifier-token-creation_liveconsole-tab-request-body), this can be for a zero amount. An Instrument Identifier will also be created if you [create a Customer via a Payment Authorization](#payments_payments_process-a-payment_samplerequests-dropdown_authorization-with-token-create_authorization-with-customer-token-creation_liveconsole-tab-request-body) In Europe: You should perform Payer Authentication alongside the Authorization.|      |**Payment Network Tokens** Network tokens perform better than regular card numbers and they are not necessarily invalidated when a cardholder loses their card, or it expires. A Payment Network Token will be automatically created and used in future payments if you are enabled for the service. A Payment Network Token can also be [provisioned for an existing Instrument Identifier](#token-management_instrument-identifier_enroll-an-instrument-identifier-for-payment-network-token). For more information about Payment Network Tokens see the Developer Guide. **Payments with Instrument Identifiers** To perform a payment with an Instrument Identifier simply specify the [Instrument Identifier Id in the payments request along with the expiration date, card type, & billing address](#payments_payments_process-a-payment_samplerequests-dropdown_authorization-using-tokens_authorization-with-instrument-identifier-token-id_liveconsole-tab-request-body). When an Instrument Identifier is used in a payment the **_previousTransactionId_** and **_originalAuthorizedAmount_** values are automatically recorded. These values will be added for you to future Merchant Initiated Transaction payments.
 
 Parameters:
 
 postInstrumentIdentifierRequest - Specify either a Card, Bank Account or Enrollable Card (required)
 
 profileId - The Id of a profile containing user specific TMS configuration. (optional)
 
 retrieveBinDetails - Retrieve the Bin Details of PAN or network token (optional)
 
 Returns:
 
 ApiResponse<PostInstrumentIdentifierRequest>
 
 Throws:
 
 ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body
 
 com.cybersource.authsdk.core.ConfigException - If creation of merchant configuration fails in ApiClient
 - postInstrumentIdentifierAsync
```
public okhttp3.Call postInstrumentIdentifierAsync(PostInstrumentIdentifierRequest postInstrumentIdentifierRequest,
 String profileId,
 Boolean retrieveBinDetails,
 ApiCallback<PostInstrumentIdentifierRequest> callback)
 throws ApiException,
 com.cybersource.authsdk.core.ConfigException
```
 Create an Instrument Identifier (asynchronously) | | | | | --- | --- | --- | |**Instrument Identifiers** An Instrument Identifier represents either a card number, or in the case of an ACH bank account, the routing and account number. The same token Id is returned for a specific card number or bank account & routing number allowing the Instrument Identifier Id to be used for cross-channel payment tracking. An Instrument Identifier can exist independently but also be associated with a [Customer Payment Instrument](#token-management_customer-payment-instrument_create-a-customer-payment-instrument) or [Standalone Payment Instrument](#token-management_payment-instrument_create-a-payment-instrument). **Creating an Instrument Identifier** It is recommended you [create an Instrument Identifier via a Payment Authorization](#payments_payments_process-a-payment_samplerequests-dropdown_authorization-with-token-create_authorization-with-instrument-identifier-token-creation_liveconsole-tab-request-body), this can be for a zero amount. An Instrument Identifier will also be created if you [create a Customer via a Payment Authorization](#payments_payments_process-a-payment_samplerequests-dropdown_authorization-with-token-create_authorization-with-customer-token-creation_liveconsole-tab-request-body) In Europe: You should perform Payer Authentication alongside the Authorization.|      |**Payment Network Tokens** Network tokens perform better than regular card numbers and they are not necessarily invalidated when a cardholder loses their card, or it expires. A Payment Network Token will be automatically created and used in future payments if you are enabled for the service. A Payment Network Token can also be [provisioned for an existing Instrument Identifier](#token-management_instrument-identifier_enroll-an-instrument-identifier-for-payment-network-token). For more information about Payment Network Tokens see the Developer Guide. **Payments with Instrument Identifiers** To perform a payment with an Instrument Identifier simply specify the [Instrument Identifier Id in the payments request along with the expiration date, card type, & billing address](#payments_payments_process-a-payment_samplerequests-dropdown_authorization-using-tokens_authorization-with-instrument-identifier-token-id_liveconsole-tab-request-body). When an Instrument Identifier is used in a payment the **_previousTransactionId_** and **_originalAuthorizedAmount_** values are automatically recorded. These values will be added for you to future Merchant Initiated Transaction payments.
 
 Parameters:
 
 postInstrumentIdentifierRequest - Specify either a Card, Bank Account or Enrollable Card (required)
 
 profileId - The Id of a profile containing user specific TMS configuration. (optional)
 
 retrieveBinDetails - Retrieve the Bin Details of PAN or network token (optional)
 
 callback - The callback to be executed when the API call finishes
 
 Returns:
 
 The request call
 
 Throws:
 
 ApiException - If fail to process the API call, e.g. serializing the request body object
 
 com.cybersource.authsdk.core.ConfigException - If creation of merchant configuration fails in ApiClient
 - postInstrumentIdentifierEnrollmentCall
```
public okhttp3.Call postInstrumentIdentifierEnrollmentCall(String instrumentIdentifierId,
 PostInstrumentIdentifierEnrollmentRequest postInstrumentIdentifierEnrollmentRequest,
 String profileId,
 ProgressResponseBody.ProgressListener progressListener,
 ProgressRequestBody.ProgressRequestListener progressRequestListener)
 throws ApiException,
 com.cybersource.authsdk.core.ConfigException
```
 Build call for postInstrumentIdentifierEnrollment
 
 Parameters:
 
 instrumentIdentifierId - The Id of an Instrument Identifier. (required)
 
 postInstrumentIdentifierEnrollmentRequest - Specify Enrollable Card details (required)
 
 profileId - The Id of a profile containing user specific TMS configuration. (optional)
 
 progressListener - Progress listener
 
 progressRequestListener - Progress request listener
 
 Returns:
 
 Call to execute
 
 Throws:
 
 ApiException - If fail to serialize the request body object
 
 com.cybersource.authsdk.core.ConfigException - If creation of merchant configuration fails in ApiClient
 - postInstrumentIdentifierEnrollment
```
public void postInstrumentIdentifierEnrollment(String instrumentIdentifierId,
 PostInstrumentIdentifierEnrollmentRequest postInstrumentIdentifierEnrollmentRequest,
 String profileId)
 throws ApiException,
 com.cybersource.authsdk.core.ConfigException
```
 Enroll an Instrument Identifier for Payment Network Token | | | | | --- | --- | --- | |**Instrument Identifiers** An Instrument Identifier represents either a card number, or in the case of an ACH bank account, the routing and account number. The same token Id is returned for a specific card number or bank account & routing number allowing the Instrument Identifier Id to be used for cross-channel payment tracking. An Instrument Identifier can exist independently but also be associated with a [Customer Payment Instrument](#token-management_customer-payment-instrument_create-a-customer-payment-instrument) or [Standalone Payment Instrument](#token-management_payment-instrument_create-a-payment-instrument).|      |**Enroll an Instrument Identifier for a Payment Network Token** Your system can use this API to provision a Network token for an existing Instrument Identifier. Network tokens perform better than regular card numbers and they are not necessarily invalidated when a cardholder loses their card, or it expires. A Network token can be [provisioned when creating an Instrument Identifier](#token-management_instrument-identifier_create-an-instrument-identifier_samplerequests-dropdown_create-instrument-identifier-card-enroll-for-network-token_liveconsole-tab-request-body).This will occur automatically when creating a [Customer](#payments_payments_process-a-payment_samplerequests-dropdown_authorization-with-token-create_authorization-with-customer-token-creation_liveconsole-tab-request-body), [Payment Instrument](#payments_payments_process-a-payment_samplerequests-dropdown_authorization-with-token-create_authorization-create-default-payment-instrument-shipping-address-for-existing-customer_liveconsole-tab-request-body) or [Instrument Identifier](#payments_payments_process-a-payment_samplerequests-dropdown_authorization-with-token-create_authorization-with-instrument-identifier-token-creation_liveconsole-tab-request-body) via the Payments API. For more information about Payment Network Tokens see the Developer Guide.
 
 Parameters:
 
 instrumentIdentifierId - The Id of an Instrument Identifier. (required)
 
 postInstrumentIdentifierEnrollmentRequest - Specify Enrollable Card details (required)
 
 profileId - The Id of a profile containing user specific TMS configuration. (optional)
 
 Throws:
 
 ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body
 
 com.cybersource.authsdk.core.ConfigException - If creation of merchant configuration fails in ApiClient
 - postInstrumentIdentifierEnrollmentWithHttpInfo
```
public ApiResponse<Void> postInstrumentIdentifierEnrollmentWithHttpInfo(String instrumentIdentifierId,
 PostInstrumentIdentifierEnrollmentRequest postInstrumentIdentifierEnrollmentRequest,
 String profileId)
 throws ApiException,
 com.cybersource.authsdk.core.ConfigException
```
 Enroll an Instrument Identifier for Payment Network Token | | | | | --- | --- | --- | |**Instrument Identifiers** An Instrument Identifier represents either a card number, or in the case of an ACH bank account, the routing and account number. The same token Id is returned for a specific card number or bank account & routing number allowing the Instrument Identifier Id to be used for cross-channel payment tracking. An Instrument Identifier can exist independently but also be associated with a [Customer Payment Instrument](#token-management_customer-payment-instrument_create-a-customer-payment-instrument) or [Standalone Payment Instrument](#token-management_payment-instrument_create-a-payment-instrument).|      |**Enroll an Instrument Identifier for a Payment Network Token** Your system can use this API to provision a Network token for an existing Instrument Identifier. Network tokens perform better than regular card numbers and they are not necessarily invalidated when a cardholder loses their card, or it expires. A Network token can be [provisioned when creating an Instrument Identifier](#token-management_instrument-identifier_create-an-instrument-identifier_samplerequests-dropdown_create-instrument-identifier-card-enroll-for-network-token_liveconsole-tab-request-body).This will occur automatically when creating a [Customer](#payments_payments_process-a-payment_samplerequests-dropdown_authorization-with-token-create_authorization-with-customer-token-creation_liveconsole-tab-request-body), [Payment Instrument](#payments_payments_process-a-payment_samplerequests-dropdown_authorization-with-token-create_authorization-create-default-payment-instrument-shipping-address-for-existing-customer_liveconsole-tab-request-body) or [Instrument Identifier](#payments_payments_process-a-payment_samplerequests-dropdown_authorization-with-token-create_authorization-with-instrument-identifier-token-creation_liveconsole-tab-request-body) via the Payments API. For more information about Payment Network Tokens see the Developer Guide.
 
 Parameters:
 
 instrumentIdentifierId - The Id of an Instrument Identifier. (required)
 
 postInstrumentIdentifierEnrollmentRequest - Specify Enrollable Card details (required)
 
 profileId - The Id of a profile containing user specific TMS configuration. (optional)
 
 Returns:
 
 ApiResponse<Void>
 
 Throws:
 
 ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body
 
 com.cybersource.authsdk.core.ConfigException - If creation of merchant configuration fails in ApiClient
 - postInstrumentIdentifierEnrollmentAsync
```
public okhttp3.Call postInstrumentIdentifierEnrollmentAsync(String instrumentIdentifierId,
 PostInstrumentIdentifierEnrollmentRequest postInstrumentIdentifierEnrollmentRequest,
 String profileId,
 ApiCallback<Void> callback)
 throws ApiException,
 com.cybersource.authsdk.core.ConfigException
```
 Enroll an Instrument Identifier for Payment Network Token (asynchronously) | | | | | --- | --- | --- | |**Instrument Identifiers** An Instrument Identifier represents either a card number, or in the case of an ACH bank account, the routing and account number. The same token Id is returned for a specific card number or bank account & routing number allowing the Instrument Identifier Id to be used for cross-channel payment tracking. An Instrument Identifier can exist independently but also be associated with a [Customer Payment Instrument](#token-management_customer-payment-instrument_create-a-customer-payment-instrument) or [Standalone Payment Instrument](#token-management_payment-instrument_create-a-payment-instrument).|      |**Enroll an Instrument Identifier for a Payment Network Token** Your system can use this API to provision a Network token for an existing Instrument Identifier. Network tokens perform better than regular card numbers and they are not necessarily invalidated when a cardholder loses their card, or it expires. A Network token can be [provisioned when creating an Instrument Identifier](#token-management_instrument-identifier_create-an-instrument-identifier_samplerequests-dropdown_create-instrument-identifier-card-enroll-for-network-token_liveconsole-tab-request-body).This will occur automatically when creating a [Customer](#payments_payments_process-a-payment_samplerequests-dropdown_authorization-with-token-create_authorization-with-customer-token-creation_liveconsole-tab-request-body), [Payment Instrument](#payments_payments_process-a-payment_samplerequests-dropdown_authorization-with-token-create_authorization-create-default-payment-instrument-shipping-address-for-existing-customer_liveconsole-tab-request-body) or [Instrument Identifier](#payments_payments_process-a-payment_samplerequests-dropdown_authorization-with-token-create_authorization-with-instrument-identifier-token-creation_liveconsole-tab-request-body) via the Payments API. For more information about Payment Network Tokens see the Developer Guide.
 
 Parameters:
 
 instrumentIdentifierId - The Id of an Instrument Identifier. (required)
 
 postInstrumentIdentifierEnrollmentRequest - Specify Enrollable Card details (required)
 
 profileId - The Id of a profile containing user specific TMS configuration. (optional)
 
 callback - The callback to be executed when the API call finishes
 
 Returns:
 
 The request call
 
 Throws:
 
 ApiException - If fail to process the API call, e.g. serializing the request body object
 
 com.cybersource.authsdk.core.ConfigException - If creation of merchant configuration fails in ApiClient

Class InstrumentIdentifierApi

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

InstrumentIdentifierApi

InstrumentIdentifierApi

Method Detail

getApiClient

setApiClient

deleteInstrumentIdentifierCall

deleteInstrumentIdentifier

deleteInstrumentIdentifierWithHttpInfo

deleteInstrumentIdentifierAsync

getInstrumentIdentifierCall

getInstrumentIdentifier

getInstrumentIdentifierWithHttpInfo

getInstrumentIdentifierAsync

getInstrumentIdentifierPaymentInstrumentsListCall

getInstrumentIdentifierPaymentInstrumentsList

getInstrumentIdentifierPaymentInstrumentsListWithHttpInfo

getInstrumentIdentifierPaymentInstrumentsListAsync

patchInstrumentIdentifierCall

patchInstrumentIdentifier

patchInstrumentIdentifierWithHttpInfo

patchInstrumentIdentifierAsync

postInstrumentIdentifierCall

postInstrumentIdentifier

postInstrumentIdentifierWithHttpInfo

postInstrumentIdentifierAsync

postInstrumentIdentifierEnrollmentCall

postInstrumentIdentifierEnrollment

postInstrumentIdentifierEnrollmentWithHttpInfo

postInstrumentIdentifierEnrollmentAsync