@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 { CustomerIdPaymentinstrumentsBody } from '../models'; import { InlineResponse2011 } from '../models'; import { PaymentInstrumentList } from '../models'; import { PaymentinstrumentsPaymentInstrumentIdBody } from '../models'; /** * CustomerPaymentInstrumentApi - axios parameter creator * @export */ export declare const CustomerPaymentInstrumentApiAxiosParamCreator: (configuration?: Configuration) => { /** * | | | | | --- | --- | --- | |**Customer Payment Instrument** A Customer Payment Instrument represents tokenized customer payment information such as expiration date, billing address & card type. A [Customer](#token-management_customer_create-a-customer) can have [one or more Payment Instruments](#token-management_customer-payment-instrument_retrieve-a-customer-payment-instrument), with one allocated as the Customers default for use in payments. A Payment Instrument token does not store the card number. A Payment Instrument is associated with an [Instrument Identifier](#token-management_instrument-identifier_create-an-instrument-identifier) that represents either a payment card number, or in the case of an ACH bank account, the routing and account number. |      |**Deleting a Customers Payment Instrument** Your system can use this API to delete an existing Payment Instrument for a Customer. Any Instrument Identifiers representing the card number will also be deleted if they are not associated with any other Payment Instruments. If a customer has more than one Payment Instrument then the default Payment Instrument cannot be deleted without first selecting a [new default Payment Instrument](#token-management_customer-payment-instrument_update-a-customer-payment-instrument_samplerequests-dropdown_make-customer-payment-instrument-the-default_liveconsole-tab-request-body). * @summary Delete a Customer Payment Instrument * @param {string} customerId The Id of a Customer. * @param {string} paymentInstrumentId The Id of a payment instrument. * @param {string} [profileId] The Id of a profile containing user specific TMS configuration. * @param {*} [options] Override http request option. * @throws {RequiredError} */ deleteCustomerPaymentInstrument: (customerId: string, paymentInstrumentId: string, profileId?: string, options?: AxiosRequestConfig & Configuration) => Promise<RequestArgs>; /** * | | | | | --- | --- | --- | |**Customer Payment Instrument** A Customer Payment Instrument represents tokenized customer payment information such as expiration date, billing address & card type. A [Customer](#token-management_customer_create-a-customer) can have [one or more Payment Instruments](#token-management_customer-payment-instrument_retrieve-a-customer-payment-instrument), with one allocated as the Customers default for use in payments. A Payment Instrument token does not store the card number. A Payment Instrument is associated with an [Instrument Identifier](#token-management_instrument-identifier_create-an-instrument-identifier) that represents either a payment card number, or in the case of an ACH bank account, the routing and account number. |      |**Retrieving a Customer Payment Instrument** Your system can use this API to retrieve an existing Payment Instrument for a Customer. To perform a payment with a particular Payment Instrument simply specify the [Payment Instrument Id in the payments request](#payments_payments_process-a-payment_samplerequests-dropdown_authorization-using-tokens_authorization-with-customer-payment-instrument-and-shipping-address-token-id_liveconsole-tab-request-body). * @summary Retrieve a Customer Payment Instrument * @param {string} customerId The Id of a Customer. * @param {string} paymentInstrumentId The Id of a payment instrument. * @param {string} [profileId] The Id of a profile containing user specific TMS configuration. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getCustomerPaymentInstrument: (customerId: string, paymentInstrumentId: string, profileId?: string, options?: AxiosRequestConfig & Configuration) => Promise<RequestArgs>; /** * | | | | | --- | --- | --- | |**Customer Payment Instrument** A Customer Payment Instrument represents tokenized customer payment information such as expiration date, billing address & card type. A [Customer](#token-management_customer_create-a-customer) can have [one or more Payment Instruments](#token-management_customer-payment-instrument_retrieve-a-customer-payment-instrument), with one allocated as the Customers default for use in payments. A Payment Instrument token does not store the card number. A Payment Instrument is associated with an [Instrument Identifier](#token-management_instrument-identifier_create-an-instrument-identifier) that represents either a payment card number, or in the case of an ACH bank account, the routing and account number. |      |**Retrieving all Customer Payment Instruments** Your system can use this API to retrieve all existing Payment Instruments for a Customer. * @summary List Payment Instruments for a Customer * @param {string} customerId The Id of a Customer. * @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} */ getCustomerPaymentInstrumentsList: (customerId: string, profileId?: string, offset?: number, limit?: number, options?: AxiosRequestConfig & Configuration) => Promise<RequestArgs>; /** * | | | | | --- | --- | --- | |**Customer Payment Instrument** A Customer Payment Instrument represents tokenized customer payment information such as expiration date, billing address & card type. A [Customer](#token-management_customer_create-a-customer) can have [one or more Payment Instruments](#token-management_customer-payment-instrument_retrieve-a-customer-payment-instrument), with one allocated as the Customers default for use in payments. A Payment Instrument token does not store the card number. A Payment Instrument is associated with an [Instrument Identifier](#token-management_instrument-identifier_create-an-instrument-identifier) that represents either a payment card number, or in the case of an ACH bank account, the routing and account number. |      |**Updating a Customers Payment Instrument** Your system can use this API to update an existing Payment Instrument for a Customer, including selecting a [default Payment Instrument](#token-management_customer-payment-instrument_update-a-customer-payment-instrument_samplerequests-dropdown_make-customer-payment-instrument-the-default_liveconsole-tab-request-body) for use in payments. * @summary Update a Customer Payment Instrument * @param {PaymentinstrumentsPaymentInstrumentIdBody} body * @param {string} customerId The Id of a Customer. * @param {string} paymentInstrumentId The Id of a payment instrument. * @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} */ patchCustomersPaymentInstrument: (body: PaymentinstrumentsPaymentInstrumentIdBody, customerId: string, paymentInstrumentId: string, profileId?: string, ifMatch?: string, options?: AxiosRequestConfig & Configuration) => Promise<RequestArgs>; /** * | | | | | --- | --- | --- | |**Customer Payment Instrument** A Customer Payment Instrument represents tokenized customer payment information such as expiration date, billing address & card type. A [Customer](#token-management_customer_create-a-customer) can have [one or more Payment Instruments](#token-management_customer-payment-instrument_retrieve-a-customer-payment-instrument), with one allocated as the Customers default for use in payments. A Payment Instrument token does not store the card number. A Payment Instrument is associated with an [Instrument Identifier](#token-management_instrument-identifier_create-an-instrument-identifier) that represents either a payment card number, or in the case of an ACH bank account, the routing and account number. **Creating a Customer Payment Instrument** It is recommended you [create a Customer Payment Instrument via a Payment Authorization](#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), this can be for a zero amount. 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 Customers Payment Instrument** To perform a payment with a particular Payment Instrument or Shipping Address specify the [Payment Instrument in the payment request](#payments_payments_process-a-payment_samplerequests-dropdown_authorization-using-tokens_authorization-with-customer-payment-instrument-and-shipping-address-token-id_liveconsole-tab-request-body). * @summary Create a Customer Payment Instrument * @param {CustomerIdPaymentinstrumentsBody} body * @param {string} customerId The Id of a Customer. * @param {string} [profileId] The Id of a profile containing user specific TMS configuration. * @param {*} [options] Override http request option. * @throws {RequiredError} */ postCustomerPaymentInstrument: (body: CustomerIdPaymentinstrumentsBody, customerId: string, profileId?: string, options?: AxiosRequestConfig & Configuration) => Promise<RequestArgs>; }; /** * CustomerPaymentInstrumentApi - functional programming interface * @export */ export declare const CustomerPaymentInstrumentApiFp: (configuration?: Configuration) => { /** * | | | | | --- | --- | --- | |**Customer Payment Instrument** A Customer Payment Instrument represents tokenized customer payment information such as expiration date, billing address & card type. A [Customer](#token-management_customer_create-a-customer) can have [one or more Payment Instruments](#token-management_customer-payment-instrument_retrieve-a-customer-payment-instrument), with one allocated as the Customers default for use in payments. A Payment Instrument token does not store the card number. A Payment Instrument is associated with an [Instrument Identifier](#token-management_instrument-identifier_create-an-instrument-identifier) that represents either a payment card number, or in the case of an ACH bank account, the routing and account number. |      |**Deleting a Customers Payment Instrument** Your system can use this API to delete an existing Payment Instrument for a Customer. Any Instrument Identifiers representing the card number will also be deleted if they are not associated with any other Payment Instruments. If a customer has more than one Payment Instrument then the default Payment Instrument cannot be deleted without first selecting a [new default Payment Instrument](#token-management_customer-payment-instrument_update-a-customer-payment-instrument_samplerequests-dropdown_make-customer-payment-instrument-the-default_liveconsole-tab-request-body). * @summary Delete a Customer Payment Instrument * @param {string} customerId The Id of a Customer. * @param {string} paymentInstrumentId The Id of a payment instrument. * @param {string} [profileId] The Id of a profile containing user specific TMS configuration. * @param {*} [options] Override http request option. * @throws {RequiredError} */ deleteCustomerPaymentInstrument(customerId: string, paymentInstrumentId: string, profileId?: string, options?: AxiosRequestConfig & Configuration): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<AxiosResponse<void>>>; /** * | | | | | --- | --- | --- | |**Customer Payment Instrument** A Customer Payment Instrument represents tokenized customer payment information such as expiration date, billing address & card type. A [Customer](#token-management_customer_create-a-customer) can have [one or more Payment Instruments](#token-management_customer-payment-instrument_retrieve-a-customer-payment-instrument), with one allocated as the Customers default for use in payments. A Payment Instrument token does not store the card number. A Payment Instrument is associated with an [Instrument Identifier](#token-management_instrument-identifier_create-an-instrument-identifier) that represents either a payment card number, or in the case of an ACH bank account, the routing and account number. |      |**Retrieving a Customer Payment Instrument** Your system can use this API to retrieve an existing Payment Instrument for a Customer. To perform a payment with a particular Payment Instrument simply specify the [Payment Instrument Id in the payments request](#payments_payments_process-a-payment_samplerequests-dropdown_authorization-using-tokens_authorization-with-customer-payment-instrument-and-shipping-address-token-id_liveconsole-tab-request-body). * @summary Retrieve a Customer Payment Instrument * @param {string} customerId The Id of a Customer. * @param {string} paymentInstrumentId The Id of a payment instrument. * @param {string} [profileId] The Id of a profile containing user specific TMS configuration. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getCustomerPaymentInstrument(customerId: string, paymentInstrumentId: string, profileId?: string, options?: AxiosRequestConfig & Configuration): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<AxiosResponse<InlineResponse2011>>>; /** * | | | | | --- | --- | --- | |**Customer Payment Instrument** A Customer Payment Instrument represents tokenized customer payment information such as expiration date, billing address & card type. A [Customer](#token-management_customer_create-a-customer) can have [one or more Payment Instruments](#token-management_customer-payment-instrument_retrieve-a-customer-payment-instrument), with one allocated as the Customers default for use in payments. A Payment Instrument token does not store the card number. A Payment Instrument is associated with an [Instrument Identifier](#token-management_instrument-identifier_create-an-instrument-identifier) that represents either a payment card number, or in the case of an ACH bank account, the routing and account number. |      |**Retrieving all Customer Payment Instruments** Your system can use this API to retrieve all existing Payment Instruments for a Customer. * @summary List Payment Instruments for a Customer * @param {string} customerId The Id of a Customer. * @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} */ getCustomerPaymentInstrumentsList(customerId: string, profileId?: string, offset?: number, limit?: number, options?: AxiosRequestConfig & Configuration): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<AxiosResponse<PaymentInstrumentList>>>; /** * | | | | | --- | --- | --- | |**Customer Payment Instrument** A Customer Payment Instrument represents tokenized customer payment information such as expiration date, billing address & card type. A [Customer](#token-management_customer_create-a-customer) can have [one or more Payment Instruments](#token-management_customer-payment-instrument_retrieve-a-customer-payment-instrument), with one allocated as the Customers default for use in payments. A Payment Instrument token does not store the card number. A Payment Instrument is associated with an [Instrument Identifier](#token-management_instrument-identifier_create-an-instrument-identifier) that represents either a payment card number, or in the case of an ACH bank account, the routing and account number. |      |**Updating a Customers Payment Instrument** Your system can use this API to update an existing Payment Instrument for a Customer, including selecting a [default Payment Instrument](#token-management_customer-payment-instrument_update-a-customer-payment-instrument_samplerequests-dropdown_make-customer-payment-instrument-the-default_liveconsole-tab-request-body) for use in payments. * @summary Update a Customer Payment Instrument * @param {PaymentinstrumentsPaymentInstrumentIdBody} body * @param {string} customerId The Id of a Customer. * @param {string} paymentInstrumentId The Id of a payment instrument. * @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} */ patchCustomersPaymentInstrument(body: PaymentinstrumentsPaymentInstrumentIdBody, customerId: string, paymentInstrumentId: string, profileId?: string, ifMatch?: string, options?: AxiosRequestConfig & Configuration): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<AxiosResponse<InlineResponse2011>>>; /** * | | | | | --- | --- | --- | |**Customer Payment Instrument** A Customer Payment Instrument represents tokenized customer payment information such as expiration date, billing address & card type. A [Customer](#token-management_customer_create-a-customer) can have [one or more Payment Instruments](#token-management_customer-payment-instrument_retrieve-a-customer-payment-instrument), with one allocated as the Customers default for use in payments. A Payment Instrument token does not store the card number. A Payment Instrument is associated with an [Instrument Identifier](#token-management_instrument-identifier_create-an-instrument-identifier) that represents either a payment card number, or in the case of an ACH bank account, the routing and account number. **Creating a Customer Payment Instrument** It is recommended you [create a Customer Payment Instrument via a Payment Authorization](#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), this can be for a zero amount. 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 Customers Payment Instrument** To perform a payment with a particular Payment Instrument or Shipping Address specify the [Payment Instrument in the payment request](#payments_payments_process-a-payment_samplerequests-dropdown_authorization-using-tokens_authorization-with-customer-payment-instrument-and-shipping-address-token-id_liveconsole-tab-request-body). * @summary Create a Customer Payment Instrument * @param {CustomerIdPaymentinstrumentsBody} body * @param {string} customerId The Id of a Customer. * @param {string} [profileId] The Id of a profile containing user specific TMS configuration. * @param {*} [options] Override http request option. * @throws {RequiredError} */ postCustomerPaymentInstrument(body: CustomerIdPaymentinstrumentsBody, customerId: string, profileId?: string, options?: AxiosRequestConfig & Configuration): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<AxiosResponse<InlineResponse2011>>>; }; /** * CustomerPaymentInstrumentApi - factory interface * @export */ export declare const CustomerPaymentInstrumentApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => { /** * | | | | | --- | --- | --- | |**Customer Payment Instrument** A Customer Payment Instrument represents tokenized customer payment information such as expiration date, billing address & card type. A [Customer](#token-management_customer_create-a-customer) can have [one or more Payment Instruments](#token-management_customer-payment-instrument_retrieve-a-customer-payment-instrument), with one allocated as the Customers default for use in payments. A Payment Instrument token does not store the card number. A Payment Instrument is associated with an [Instrument Identifier](#token-management_instrument-identifier_create-an-instrument-identifier) that represents either a payment card number, or in the case of an ACH bank account, the routing and account number. |      |**Deleting a Customers Payment Instrument** Your system can use this API to delete an existing Payment Instrument for a Customer. Any Instrument Identifiers representing the card number will also be deleted if they are not associated with any other Payment Instruments. If a customer has more than one Payment Instrument then the default Payment Instrument cannot be deleted without first selecting a [new default Payment Instrument](#token-management_customer-payment-instrument_update-a-customer-payment-instrument_samplerequests-dropdown_make-customer-payment-instrument-the-default_liveconsole-tab-request-body). * @summary Delete a Customer Payment Instrument * @param {string} customerId The Id of a Customer. * @param {string} paymentInstrumentId The Id of a payment instrument. * @param {string} [profileId] The Id of a profile containing user specific TMS configuration. * @param {*} [options] Override http request option. * @throws {RequiredError} */ deleteCustomerPaymentInstrument(customerId: string, paymentInstrumentId: string, profileId?: string, options?: AxiosRequestConfig & Configuration): Promise<AxiosResponse<void>>; /** * | | | | | --- | --- | --- | |**Customer Payment Instrument** A Customer Payment Instrument represents tokenized customer payment information such as expiration date, billing address & card type. A [Customer](#token-management_customer_create-a-customer) can have [one or more Payment Instruments](#token-management_customer-payment-instrument_retrieve-a-customer-payment-instrument), with one allocated as the Customers default for use in payments. A Payment Instrument token does not store the card number. A Payment Instrument is associated with an [Instrument Identifier](#token-management_instrument-identifier_create-an-instrument-identifier) that represents either a payment card number, or in the case of an ACH bank account, the routing and account number. |      |**Retrieving a Customer Payment Instrument** Your system can use this API to retrieve an existing Payment Instrument for a Customer. To perform a payment with a particular Payment Instrument simply specify the [Payment Instrument Id in the payments request](#payments_payments_process-a-payment_samplerequests-dropdown_authorization-using-tokens_authorization-with-customer-payment-instrument-and-shipping-address-token-id_liveconsole-tab-request-body). * @summary Retrieve a Customer Payment Instrument * @param {string} customerId The Id of a Customer. * @param {string} paymentInstrumentId The Id of a payment instrument. * @param {string} [profileId] The Id of a profile containing user specific TMS configuration. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getCustomerPaymentInstrument(customerId: string, paymentInstrumentId: string, profileId?: string, options?: AxiosRequestConfig & Configuration): Promise<AxiosResponse<InlineResponse2011>>; /** * | | | | | --- | --- | --- | |**Customer Payment Instrument** A Customer Payment Instrument represents tokenized customer payment information such as expiration date, billing address & card type. A [Customer](#token-management_customer_create-a-customer) can have [one or more Payment Instruments](#token-management_customer-payment-instrument_retrieve-a-customer-payment-instrument), with one allocated as the Customers default for use in payments. A Payment Instrument token does not store the card number. A Payment Instrument is associated with an [Instrument Identifier](#token-management_instrument-identifier_create-an-instrument-identifier) that represents either a payment card number, or in the case of an ACH bank account, the routing and account number. |      |**Retrieving all Customer Payment Instruments** Your system can use this API to retrieve all existing Payment Instruments for a Customer. * @summary List Payment Instruments for a Customer * @param {string} customerId The Id of a Customer. * @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} */ getCustomerPaymentInstrumentsList(customerId: string, profileId?: string, offset?: number, limit?: number, options?: AxiosRequestConfig & Configuration): Promise<AxiosResponse<PaymentInstrumentList>>; /** * | | | | | --- | --- | --- | |**Customer Payment Instrument** A Customer Payment Instrument represents tokenized customer payment information such as expiration date, billing address & card type. A [Customer](#token-management_customer_create-a-customer) can have [one or more Payment Instruments](#token-management_customer-payment-instrument_retrieve-a-customer-payment-instrument), with one allocated as the Customers default for use in payments. A Payment Instrument token does not store the card number. A Payment Instrument is associated with an [Instrument Identifier](#token-management_instrument-identifier_create-an-instrument-identifier) that represents either a payment card number, or in the case of an ACH bank account, the routing and account number. |      |**Updating a Customers Payment Instrument** Your system can use this API to update an existing Payment Instrument for a Customer, including selecting a [default Payment Instrument](#token-management_customer-payment-instrument_update-a-customer-payment-instrument_samplerequests-dropdown_make-customer-payment-instrument-the-default_liveconsole-tab-request-body) for use in payments. * @summary Update a Customer Payment Instrument * @param {PaymentinstrumentsPaymentInstrumentIdBody} body * @param {string} customerId The Id of a Customer. * @param {string} paymentInstrumentId The Id of a payment instrument. * @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} */ patchCustomersPaymentInstrument(body: PaymentinstrumentsPaymentInstrumentIdBody, customerId: string, paymentInstrumentId: string, profileId?: string, ifMatch?: string, options?: AxiosRequestConfig & Configuration): Promise<AxiosResponse<InlineResponse2011>>; /** * | | | | | --- | --- | --- | |**Customer Payment Instrument** A Customer Payment Instrument represents tokenized customer payment information such as expiration date, billing address & card type. A [Customer](#token-management_customer_create-a-customer) can have [one or more Payment Instruments](#token-management_customer-payment-instrument_retrieve-a-customer-payment-instrument), with one allocated as the Customers default for use in payments. A Payment Instrument token does not store the card number. A Payment Instrument is associated with an [Instrument Identifier](#token-management_instrument-identifier_create-an-instrument-identifier) that represents either a payment card number, or in the case of an ACH bank account, the routing and account number. **Creating a Customer Payment Instrument** It is recommended you [create a Customer Payment Instrument via a Payment Authorization](#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), this can be for a zero amount. 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 Customers Payment Instrument** To perform a payment with a particular Payment Instrument or Shipping Address specify the [Payment Instrument in the payment request](#payments_payments_process-a-payment_samplerequests-dropdown_authorization-using-tokens_authorization-with-customer-payment-instrument-and-shipping-address-token-id_liveconsole-tab-request-body). * @summary Create a Customer Payment Instrument * @param {CustomerIdPaymentinstrumentsBody} body * @param {string} customerId The Id of a Customer. * @param {string} [profileId] The Id of a profile containing user specific TMS configuration. * @param {*} [options] Override http request option. * @throws {RequiredError} */ postCustomerPaymentInstrument(body: CustomerIdPaymentinstrumentsBody, customerId: string, profileId?: string, options?: AxiosRequestConfig & Configuration): Promise<AxiosResponse<InlineResponse2011>>; }; /** * CustomerPaymentInstrumentApi - object-oriented interface * @export * @class CustomerPaymentInstrumentApi * @extends {BaseAPI} */ export declare class CustomerPaymentInstrumentApi extends BaseAPI { /** * | | | | | --- | --- | --- | |**Customer Payment Instrument** A Customer Payment Instrument represents tokenized customer payment information such as expiration date, billing address & card type. A [Customer](#token-management_customer_create-a-customer) can have [one or more Payment Instruments](#token-management_customer-payment-instrument_retrieve-a-customer-payment-instrument), with one allocated as the Customers default for use in payments. A Payment Instrument token does not store the card number. A Payment Instrument is associated with an [Instrument Identifier](#token-management_instrument-identifier_create-an-instrument-identifier) that represents either a payment card number, or in the case of an ACH bank account, the routing and account number. |      |**Deleting a Customers Payment Instrument** Your system can use this API to delete an existing Payment Instrument for a Customer. Any Instrument Identifiers representing the card number will also be deleted if they are not associated with any other Payment Instruments. If a customer has more than one Payment Instrument then the default Payment Instrument cannot be deleted without first selecting a [new default Payment Instrument](#token-management_customer-payment-instrument_update-a-customer-payment-instrument_samplerequests-dropdown_make-customer-payment-instrument-the-default_liveconsole-tab-request-body). * @summary Delete a Customer Payment Instrument * @param {string} customerId The Id of a Customer. * @param {string} paymentInstrumentId The Id of a payment instrument. * @param {string} [profileId] The Id of a profile containing user specific TMS configuration. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof CustomerPaymentInstrumentApi */ deleteCustomerPaymentInstrument(customerId: string, paymentInstrumentId: string, profileId?: string, options?: AxiosRequestConfig & Configuration): Promise<AxiosResponse<void>>; /** * | | | | | --- | --- | --- | |**Customer Payment Instrument** A Customer Payment Instrument represents tokenized customer payment information such as expiration date, billing address & card type. A [Customer](#token-management_customer_create-a-customer) can have [one or more Payment Instruments](#token-management_customer-payment-instrument_retrieve-a-customer-payment-instrument), with one allocated as the Customers default for use in payments. A Payment Instrument token does not store the card number. A Payment Instrument is associated with an [Instrument Identifier](#token-management_instrument-identifier_create-an-instrument-identifier) that represents either a payment card number, or in the case of an ACH bank account, the routing and account number. |      |**Retrieving a Customer Payment Instrument** Your system can use this API to retrieve an existing Payment Instrument for a Customer. To perform a payment with a particular Payment Instrument simply specify the [Payment Instrument Id in the payments request](#payments_payments_process-a-payment_samplerequests-dropdown_authorization-using-tokens_authorization-with-customer-payment-instrument-and-shipping-address-token-id_liveconsole-tab-request-body). * @summary Retrieve a Customer Payment Instrument * @param {string} customerId The Id of a Customer. * @param {string} paymentInstrumentId The Id of a payment instrument. * @param {string} [profileId] The Id of a profile containing user specific TMS configuration. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof CustomerPaymentInstrumentApi */ getCustomerPaymentInstrument(customerId: string, paymentInstrumentId: string, profileId?: string, options?: AxiosRequestConfig & Configuration): Promise<AxiosResponse<InlineResponse2011>>; /** * | | | | | --- | --- | --- | |**Customer Payment Instrument** A Customer Payment Instrument represents tokenized customer payment information such as expiration date, billing address & card type. A [Customer](#token-management_customer_create-a-customer) can have [one or more Payment Instruments](#token-management_customer-payment-instrument_retrieve-a-customer-payment-instrument), with one allocated as the Customers default for use in payments. A Payment Instrument token does not store the card number. A Payment Instrument is associated with an [Instrument Identifier](#token-management_instrument-identifier_create-an-instrument-identifier) that represents either a payment card number, or in the case of an ACH bank account, the routing and account number. |      |**Retrieving all Customer Payment Instruments** Your system can use this API to retrieve all existing Payment Instruments for a Customer. * @summary List Payment Instruments for a Customer * @param {string} customerId The Id of a Customer. * @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} * @memberof CustomerPaymentInstrumentApi */ getCustomerPaymentInstrumentsList(customerId: string, profileId?: string, offset?: number, limit?: number, options?: AxiosRequestConfig & Configuration): Promise<AxiosResponse<PaymentInstrumentList>>; /** * | | | | | --- | --- | --- | |**Customer Payment Instrument** A Customer Payment Instrument represents tokenized customer payment information such as expiration date, billing address & card type. A [Customer](#token-management_customer_create-a-customer) can have [one or more Payment Instruments](#token-management_customer-payment-instrument_retrieve-a-customer-payment-instrument), with one allocated as the Customers default for use in payments. A Payment Instrument token does not store the card number. A Payment Instrument is associated with an [Instrument Identifier](#token-management_instrument-identifier_create-an-instrument-identifier) that represents either a payment card number, or in the case of an ACH bank account, the routing and account number. |      |**Updating a Customers Payment Instrument** Your system can use this API to update an existing Payment Instrument for a Customer, including selecting a [default Payment Instrument](#token-management_customer-payment-instrument_update-a-customer-payment-instrument_samplerequests-dropdown_make-customer-payment-instrument-the-default_liveconsole-tab-request-body) for use in payments. * @summary Update a Customer Payment Instrument * @param {PaymentinstrumentsPaymentInstrumentIdBody} body * @param {string} customerId The Id of a Customer. * @param {string} paymentInstrumentId The Id of a payment instrument. * @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} * @memberof CustomerPaymentInstrumentApi */ patchCustomersPaymentInstrument(body: PaymentinstrumentsPaymentInstrumentIdBody, customerId: string, paymentInstrumentId: string, profileId?: string, ifMatch?: string, options?: AxiosRequestConfig & Configuration): Promise<AxiosResponse<InlineResponse2011>>; /** * | | | | | --- | --- | --- | |**Customer Payment Instrument** A Customer Payment Instrument represents tokenized customer payment information such as expiration date, billing address & card type. A [Customer](#token-management_customer_create-a-customer) can have [one or more Payment Instruments](#token-management_customer-payment-instrument_retrieve-a-customer-payment-instrument), with one allocated as the Customers default for use in payments. A Payment Instrument token does not store the card number. A Payment Instrument is associated with an [Instrument Identifier](#token-management_instrument-identifier_create-an-instrument-identifier) that represents either a payment card number, or in the case of an ACH bank account, the routing and account number. **Creating a Customer Payment Instrument** It is recommended you [create a Customer Payment Instrument via a Payment Authorization](#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), this can be for a zero amount. 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 Customers Payment Instrument** To perform a payment with a particular Payment Instrument or Shipping Address specify the [Payment Instrument in the payment request](#payments_payments_process-a-payment_samplerequests-dropdown_authorization-using-tokens_authorization-with-customer-payment-instrument-and-shipping-address-token-id_liveconsole-tab-request-body). * @summary Create a Customer Payment Instrument * @param {CustomerIdPaymentinstrumentsBody} body * @param {string} customerId The Id of a Customer. * @param {string} [profileId] The Id of a profile containing user specific TMS configuration. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof CustomerPaymentInstrumentApi */ postCustomerPaymentInstrument(body: CustomerIdPaymentinstrumentsBody, customerId: string, profileId?: string, options?: AxiosRequestConfig & Configuration): Promise<AxiosResponse<InlineResponse2011>>; }