@paciolan/cybersource-sdk

/** * CyberSource Merged Spec * All CyberSource API specs merged together. These are available at https://developer.cybersource.com/api/reference/api-reference.html * * OpenAPI spec version: 0.0.1 * * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ import { AxiosResponse, AxiosInstance, AxiosRequestConfig } from 'axios'; import { Configuration } from '../configuration'; import { RequestArgs, BaseAPI } from '../base'; import { InlineResponse2001 } from '../models'; import { InstrumentIdentifierIdEnrollmentBody } from '../models'; import { InstrumentidentifiersInstrumentIdentifierIdBody } from '../models'; import { PaymentInstrumentList } from '../models'; import { V1InstrumentidentifiersBody } from '../models'; /** * InstrumentIdentifierApi - axios parameter creator * @export */ export declare const InstrumentIdentifierApiAxiosParamCreator: (configuration?: Configuration) => { /** * | | | | | --- | --- | --- | |**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). * @summary Delete an Instrument Identifier * @param {string} instrumentIdentifierId The Id of an Instrument Identifier. * @param {string} [profileId] The Id of a profile containing user specific TMS configuration. * @param {*} [options] Override http request option. * @throws {RequiredError} */ deleteInstrumentIdentifier: (instrumentIdentifierId: string, profileId?: string, options?: AxiosRequestConfig & Configuration) => Promise<RequestArgs>; /** * | | | | | --- | --- | --- | |**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. * @summary Retrieve an Instrument Identifier * @param {string} instrumentIdentifierId The Id of an Instrument Identifier. * @param {string} [profileId] The Id of a profile containing user specific TMS configuration. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getInstrumentIdentifier: (instrumentIdentifierId: string, profileId?: string, options?: AxiosRequestConfig & Configuration) => Promise<RequestArgs>; /** * | | | | | --- | --- | --- | |**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. * @summary List Payment Instruments for an Instrument Identifier * @param {string} instrumentIdentifierId The Id of an Instrument Identifier. * @param {string} [profileId] The Id of a profile containing user specific TMS configuration. * @param {number} [offset] Starting record in zero-based dataset that should be returned as the first object in the array. Default is 0. * @param {number} [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. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getInstrumentIdentifierPaymentInstrumentsList: (instrumentIdentifierId: string, profileId?: string, offset?: number, limit?: number, options?: AxiosRequestConfig & Configuration) => Promise<RequestArgs>; /** * | | | | | --- | --- | --- | |**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. * @summary Update an Instrument Identifier * @param {InstrumentidentifiersInstrumentIdentifierIdBody} body Specify the previous transaction Id to update. * @param {string} instrumentIdentifierId The Id of an Instrument Identifier. * @param {string} [profileId] The Id of a profile containing user specific TMS configuration. * @param {string} [ifMatch] Contains an ETag value from a GET request to make the request conditional. * @param {*} [options] Override http request option. * @throws {RequiredError} */ patchInstrumentIdentifier: (body: InstrumentidentifiersInstrumentIdentifierIdBody, instrumentIdentifierId: string, profileId?: string, ifMatch?: string, options?: AxiosRequestConfig & Configuration) => Promise<RequestArgs>; /** * | | | | | --- | --- | --- | |**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. * @summary Create an Instrument Identifier * @param {V1InstrumentidentifiersBody} body Specify either a Card, Bank Account or Enrollable Card * @param {string} [profileId] The Id of a profile containing user specific TMS configuration. * @param {*} [options] Override http request option. * @throws {RequiredError} */ postInstrumentIdentifier: (body: V1InstrumentidentifiersBody, profileId?: string, options?: AxiosRequestConfig & Configuration) => Promise<RequestArgs>; /** * | | | | | --- | --- | --- | |**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. * @summary Enroll an Instrument Identifier for Payment Network Token * @param {InstrumentIdentifierIdEnrollmentBody} body Specify Enrollable Card details * @param {string} instrumentIdentifierId The Id of an Instrument Identifier. * @param {string} [profileId] The Id of a profile containing user specific TMS configuration. * @param {*} [options] Override http request option. * @throws {RequiredError} */ postInstrumentIdentifierEnrollment: (body: InstrumentIdentifierIdEnrollmentBody, instrumentIdentifierId: string, profileId?: string, options?: AxiosRequestConfig & Configuration) => Promise<RequestArgs>; }; /** * InstrumentIdentifierApi - functional programming interface * @export */ export declare const InstrumentIdentifierApiFp: (configuration?: Configuration) => { /** * | | | | | --- | --- | --- | |**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). * @summary Delete an Instrument Identifier * @param {string} instrumentIdentifierId The Id of an Instrument Identifier. * @param {string} [profileId] The Id of a profile containing user specific TMS configuration. * @param {*} [options] Override http request option. * @throws {RequiredError} */ deleteInstrumentIdentifier(instrumentIdentifierId: string, profileId?: string, options?: AxiosRequestConfig & Configuration): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<AxiosResponse<void>>>; /** * | | | | | --- | --- | --- | |**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. * @summary Retrieve an Instrument Identifier * @param {string} instrumentIdentifierId The Id of an Instrument Identifier. * @param {string} [profileId] The Id of a profile containing user specific TMS configuration. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getInstrumentIdentifier(instrumentIdentifierId: string, profileId?: string, options?: AxiosRequestConfig & Configuration): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<AxiosResponse<InlineResponse2001>>>; /** * | | | | | --- | --- | --- | |**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. * @summary List Payment Instruments for an Instrument Identifier * @param {string} instrumentIdentifierId The Id of an Instrument Identifier. * @param {string} [profileId] The Id of a profile containing user specific TMS configuration. * @param {number} [offset] Starting record in zero-based dataset that should be returned as the first object in the array. Default is 0. * @param {number} [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. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getInstrumentIdentifierPaymentInstrumentsList(instrumentIdentifierId: string, profileId?: string, offset?: number, limit?: number, options?: AxiosRequestConfig & Configuration): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<AxiosResponse<PaymentInstrumentList>>>; /** * | | | | | --- | --- | --- | |**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. * @summary Update an Instrument Identifier * @param {InstrumentidentifiersInstrumentIdentifierIdBody} body Specify the previous transaction Id to update. * @param {string} instrumentIdentifierId The Id of an Instrument Identifier. * @param {string} [profileId] The Id of a profile containing user specific TMS configuration. * @param {string} [ifMatch] Contains an ETag value from a GET request to make the request conditional. * @param {*} [options] Override http request option. * @throws {RequiredError} */ patchInstrumentIdentifier(body: InstrumentidentifiersInstrumentIdentifierIdBody, instrumentIdentifierId: string, profileId?: string, ifMatch?: string, options?: AxiosRequestConfig & Configuration): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<AxiosResponse<InlineResponse2001>>>; /** * | | | | | --- | --- | --- | |**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. * @summary Create an Instrument Identifier * @param {V1InstrumentidentifiersBody} body Specify either a Card, Bank Account or Enrollable Card * @param {string} [profileId] The Id of a profile containing user specific TMS configuration. * @param {*} [options] Override http request option. * @throws {RequiredError} */ postInstrumentIdentifier(body: V1InstrumentidentifiersBody, profileId?: string, options?: AxiosRequestConfig & Configuration): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<AxiosResponse<InlineResponse2001>>>; /** * | | | | | --- | --- | --- | |**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. * @summary Enroll an Instrument Identifier for Payment Network Token * @param {InstrumentIdentifierIdEnrollmentBody} body Specify Enrollable Card details * @param {string} instrumentIdentifierId The Id of an Instrument Identifier. * @param {string} [profileId] The Id of a profile containing user specific TMS configuration. * @param {*} [options] Override http request option. * @throws {RequiredError} */ postInstrumentIdentifierEnrollment(body: InstrumentIdentifierIdEnrollmentBody, instrumentIdentifierId: string, profileId?: string, options?: AxiosRequestConfig & Configuration): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<AxiosResponse<void>>>; }; /** * InstrumentIdentifierApi - factory interface * @export */ export declare const InstrumentIdentifierApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => { /** * | | | | | --- | --- | --- | |**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). * @summary Delete an Instrument Identifier * @param {string} instrumentIdentifierId The Id of an Instrument Identifier. * @param {string} [profileId] The Id of a profile containing user specific TMS configuration. * @param {*} [options] Override http request option. * @throws {RequiredError} */ deleteInstrumentIdentifier(instrumentIdentifierId: string, profileId?: string, options?: AxiosRequestConfig & Configuration): Promise<AxiosResponse<void>>; /** * | | | | | --- | --- | --- | |**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. * @summary Retrieve an Instrument Identifier * @param {string} instrumentIdentifierId The Id of an Instrument Identifier. * @param {string} [profileId] The Id of a profile containing user specific TMS configuration. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getInstrumentIdentifier(instrumentIdentifierId: string, profileId?: string, options?: AxiosRequestConfig & Configuration): Promise<AxiosResponse<InlineResponse2001>>; /** * | | | | | --- | --- | --- | |**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. * @summary List Payment Instruments for an Instrument Identifier * @param {string} instrumentIdentifierId The Id of an Instrument Identifier. * @param {string} [profileId] The Id of a profile containing user specific TMS configuration. * @param {number} [offset] Starting record in zero-based dataset that should be returned as the first object in the array. Default is 0. * @param {number} [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. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getInstrumentIdentifierPaymentInstrumentsList(instrumentIdentifierId: string, profileId?: string, offset?: number, limit?: number, options?: AxiosRequestConfig & Configuration): Promise<AxiosResponse<PaymentInstrumentList>>; /** * | | | | | --- | --- | --- | |**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. * @summary Update an Instrument Identifier * @param {InstrumentidentifiersInstrumentIdentifierIdBody} body Specify the previous transaction Id to update. * @param {string} instrumentIdentifierId The Id of an Instrument Identifier. * @param {string} [profileId] The Id of a profile containing user specific TMS configuration. * @param {string} [ifMatch] Contains an ETag value from a GET request to make the request conditional. * @param {*} [options] Override http request option. * @throws {RequiredError} */ patchInstrumentIdentifier(body: InstrumentidentifiersInstrumentIdentifierIdBody, instrumentIdentifierId: string, profileId?: string, ifMatch?: string, options?: AxiosRequestConfig & Configuration): Promise<AxiosResponse<InlineResponse2001>>; /** * | | | | | --- | --- | --- | |**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. * @summary Create an Instrument Identifier * @param {V1InstrumentidentifiersBody} body Specify either a Card, Bank Account or Enrollable Card * @param {string} [profileId] The Id of a profile containing user specific TMS configuration. * @param {*} [options] Override http request option. * @throws {RequiredError} */ postInstrumentIdentifier(body: V1InstrumentidentifiersBody, profileId?: string, options?: AxiosRequestConfig & Configuration): Promise<AxiosResponse<InlineResponse2001>>; /** * | | | | | --- | --- | --- | |**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. * @summary Enroll an Instrument Identifier for Payment Network Token * @param {InstrumentIdentifierIdEnrollmentBody} body Specify Enrollable Card details * @param {string} instrumentIdentifierId The Id of an Instrument Identifier. * @param {string} [profileId] The Id of a profile containing user specific TMS configuration. * @param {*} [options] Override http request option. * @throws {RequiredError} */ postInstrumentIdentifierEnrollment(body: InstrumentIdentifierIdEnrollmentBody, instrumentIdentifierId: string, profileId?: string, options?: AxiosRequestConfig & Configuration): Promise<AxiosResponse<void>>; }; /** * InstrumentIdentifierApi - object-oriented interface * @export * @class InstrumentIdentifierApi * @extends {BaseAPI} */ export declare class InstrumentIdentifierApi extends BaseAPI { /** * | | | | | --- | --- | --- | |**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). * @summary Delete an Instrument Identifier * @param {string} instrumentIdentifierId The Id of an Instrument Identifier. * @param {string} [profileId] The Id of a profile containing user specific TMS configuration. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof InstrumentIdentifierApi */ deleteInstrumentIdentifier(instrumentIdentifierId: string, profileId?: string, options?: AxiosRequestConfig & Configuration): Promise<AxiosResponse<void>>; /** * | | | | | --- | --- | --- | |**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. * @summary Retrieve an Instrument Identifier * @param {string} instrumentIdentifierId The Id of an Instrument Identifier. * @param {string} [profileId] The Id of a profile containing user specific TMS configuration. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof InstrumentIdentifierApi */ getInstrumentIdentifier(instrumentIdentifierId: string, profileId?: string, options?: AxiosRequestConfig & Configuration): Promise<AxiosResponse<InlineResponse2001>>; /** * | | | | | --- | --- | --- | |**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. * @summary List Payment Instruments for an Instrument Identifier * @param {string} instrumentIdentifierId The Id of an Instrument Identifier. * @param {string} [profileId] The Id of a profile containing user specific TMS configuration. * @param {number} [offset] Starting record in zero-based dataset that should be returned as the first object in the ar