@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 { CustomersCustomerIdBody } from '../models'; import { InlineResponse200 } from '../models'; import { TmsV2CustomersResponse } from '../models'; import { V2CustomersBody } from '../models'; /** * CustomerApi - axios parameter creator * @export */ export declare const CustomerApiAxiosParamCreator: (configuration?: Configuration) => { /** * | | | | | --- | --- | --- | |**Customers** A Customer represents your tokenized customer information. You should associate the Customer Id with the customer account on your systems. A Customer can have one or more [Payment Instruments](#token-management_customer-payment-instrument_create-a-customer-payment-instrumentl) or [Shipping Addresses](#token-management_customer-shipping-address_create-a-customer-shipping-address) with one allocated as the Customers default.|      |**Deleting a Customer** Your system can use this API to delete a complete Customer. When a Customer is deleted all associated Payment Instruments & Shipping Addresses are deleted. Any Instrument Identifiers representing the card number will also be deleted if they are not associated with any other Payment Instruments. Note: Individual [Payment Instruments](#token-management_customer-payment-instrument_delete-a-customer-payment-instrument) or [Shipping Addresses](#token-management_customer-shipping-address_delete-a-customer-shipping-address) can be deleted via their own dedicated API resources. * @summary Delete a Customer * @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} */ deleteCustomer: (customerId: string, profileId?: string, options?: AxiosRequestConfig & Configuration) => Promise<RequestArgs>; /** * | | | | | --- | --- | --- | |**Customers** A Customer represents your tokenized customer information. You should associate the Customer Id with the customer account on your systems. A Customer can have one or more [Payment Instruments](#token-management_customer-payment-instrument_create-a-customer-payment-instrumentl) or [Shipping Addresses](#token-management_customer-shipping-address_create-a-customer-shipping-address) with one allocated as the Customers default. **Retrieving a Customer** When your customer signs into their account, your system can use this API to retrieve the Customers default Payment Instrument and Shipping Address. **Note: the actual card data will be masked.** If your customer wants to see other available Payment Instruments, your system can [retrieve all Payment Instruments](#token-management_customer-payment-instrument_list-payment-instruments-for-a-customer) associated with the Customer. The same applies to [Shipping Addresses](#token-management_customer-shipping-address_list-shipping-addresses-for-a-customer).|      |**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** To perform a payment with the Customers default details specify the [Customer Id in the payments request](#payments_payments_process-a-payment_samplerequests-dropdown_authorization-using-tokens_authorization-with-customer-token-id_liveconsole-tab-request-body). To perform a payment with a particular Payment Instrument or Shipping Address specify the [Payment Instrument or Shipping Address Ids 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 * @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} */ getCustomer: (customerId: string, profileId?: string, options?: AxiosRequestConfig & Configuration) => Promise<RequestArgs>; /** * | | | | | --- | --- | --- | |**Customers** A Customer represents your tokenized customer information. You should associate the Customer Id with the customer account on your systems. A Customer can have one or more [Payment Instruments](#token-management_customer-payment-instrument_create-a-customer-payment-instrumentl) or [Shipping Addresses](#token-management_customer-shipping-address_create-a-customer-shipping-address) with one allocated as the Customers default.|      |**Updating a Customer** Your system can use this API to update a Customers details including selecting a [default Payment Instrument](#token-management_customer_update-a-customer_samplerequests-dropdown_update-customers-default-payment-instrument_liveconsole-tab-request-body) or [default Shipping Address](#token-management_customer_update-a-customer_samplerequests-dropdown_update-customers-default-shipping-address_liveconsole-tab-request-body) for use in payments. Note: Updating a Customers [Payment Instrument](#token-management_customer-payment-instrument_update-a-customer-payment-instrument) or [Shipping Address](#token-management_customer-shipping-address_update-a-customer-shipping-address) details is performed using their own dedicated API resources. * @summary Update a Customer * @param {CustomersCustomerIdBody} body * @param {string} customerId The Id of a Customer. * @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} */ patchCustomer: (body: CustomersCustomerIdBody, customerId: string, profileId?: string, ifMatch?: string, options?: AxiosRequestConfig & Configuration) => Promise<RequestArgs>; /** * | | | | | --- | --- | --- | |**Customers** A Customer represents your tokenized customer information. You should associate the Customer Id with the customer account on your systems. A Customer can have one or more [Payment Instruments](#token-management_customer-payment-instrument_create-a-customer-payment-instrumentl) or [Shipping Addresses](#token-management_customer-shipping-address_create-a-customer-shipping-address) with one allocated as the Customers default. **Creating a Customer** It is recommended 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), this can be for a zero amount. The Customer will be created with a Payment Instrument and Shipping Address. You can also [add additional Payment Instruments to a Customer 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). 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** To perform a payment with the Customers default details specify the [Customer Id in the payments request](#payments_payments_process-a-payment_samplerequests-dropdown_authorization-using-tokens_authorization-with-customer-token-id_liveconsole-tab-request-body). To perform a payment with a particular Payment Instrument or Shipping Address specify the [Payment Instrument or Shipping Address Ids 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 Create a Customer * @param {V2CustomersBody} body * @param {string} [profileId] The Id of a profile containing user specific TMS configuration. * @param {*} [options] Override http request option. * @throws {RequiredError} */ postCustomer: (body: V2CustomersBody, profileId?: string, options?: AxiosRequestConfig & Configuration) => Promise<RequestArgs>; }; /** * CustomerApi - functional programming interface * @export */ export declare const CustomerApiFp: (configuration?: Configuration) => { /** * | | | | | --- | --- | --- | |**Customers** A Customer represents your tokenized customer information. You should associate the Customer Id with the customer account on your systems. A Customer can have one or more [Payment Instruments](#token-management_customer-payment-instrument_create-a-customer-payment-instrumentl) or [Shipping Addresses](#token-management_customer-shipping-address_create-a-customer-shipping-address) with one allocated as the Customers default.|      |**Deleting a Customer** Your system can use this API to delete a complete Customer. When a Customer is deleted all associated Payment Instruments & Shipping Addresses are deleted. Any Instrument Identifiers representing the card number will also be deleted if they are not associated with any other Payment Instruments. Note: Individual [Payment Instruments](#token-management_customer-payment-instrument_delete-a-customer-payment-instrument) or [Shipping Addresses](#token-management_customer-shipping-address_delete-a-customer-shipping-address) can be deleted via their own dedicated API resources. * @summary Delete a Customer * @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} */ deleteCustomer(customerId: string, profileId?: string, options?: AxiosRequestConfig & Configuration): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<AxiosResponse<void>>>; /** * | | | | | --- | --- | --- | |**Customers** A Customer represents your tokenized customer information. You should associate the Customer Id with the customer account on your systems. A Customer can have one or more [Payment Instruments](#token-management_customer-payment-instrument_create-a-customer-payment-instrumentl) or [Shipping Addresses](#token-management_customer-shipping-address_create-a-customer-shipping-address) with one allocated as the Customers default. **Retrieving a Customer** When your customer signs into their account, your system can use this API to retrieve the Customers default Payment Instrument and Shipping Address. **Note: the actual card data will be masked.** If your customer wants to see other available Payment Instruments, your system can [retrieve all Payment Instruments](#token-management_customer-payment-instrument_list-payment-instruments-for-a-customer) associated with the Customer. The same applies to [Shipping Addresses](#token-management_customer-shipping-address_list-shipping-addresses-for-a-customer).|      |**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** To perform a payment with the Customers default details specify the [Customer Id in the payments request](#payments_payments_process-a-payment_samplerequests-dropdown_authorization-using-tokens_authorization-with-customer-token-id_liveconsole-tab-request-body). To perform a payment with a particular Payment Instrument or Shipping Address specify the [Payment Instrument or Shipping Address Ids 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 * @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} */ getCustomer(customerId: string, profileId?: string, options?: AxiosRequestConfig & Configuration): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<AxiosResponse<InlineResponse200>>>; /** * | | | | | --- | --- | --- | |**Customers** A Customer represents your tokenized customer information. You should associate the Customer Id with the customer account on your systems. A Customer can have one or more [Payment Instruments](#token-management_customer-payment-instrument_create-a-customer-payment-instrumentl) or [Shipping Addresses](#token-management_customer-shipping-address_create-a-customer-shipping-address) with one allocated as the Customers default.|      |**Updating a Customer** Your system can use this API to update a Customers details including selecting a [default Payment Instrument](#token-management_customer_update-a-customer_samplerequests-dropdown_update-customers-default-payment-instrument_liveconsole-tab-request-body) or [default Shipping Address](#token-management_customer_update-a-customer_samplerequests-dropdown_update-customers-default-shipping-address_liveconsole-tab-request-body) for use in payments. Note: Updating a Customers [Payment Instrument](#token-management_customer-payment-instrument_update-a-customer-payment-instrument) or [Shipping Address](#token-management_customer-shipping-address_update-a-customer-shipping-address) details is performed using their own dedicated API resources. * @summary Update a Customer * @param {CustomersCustomerIdBody} body * @param {string} customerId The Id of a Customer. * @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} */ patchCustomer(body: CustomersCustomerIdBody, customerId: string, profileId?: string, ifMatch?: string, options?: AxiosRequestConfig & Configuration): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<AxiosResponse<InlineResponse200>>>; /** * | | | | | --- | --- | --- | |**Customers** A Customer represents your tokenized customer information. You should associate the Customer Id with the customer account on your systems. A Customer can have one or more [Payment Instruments](#token-management_customer-payment-instrument_create-a-customer-payment-instrumentl) or [Shipping Addresses](#token-management_customer-shipping-address_create-a-customer-shipping-address) with one allocated as the Customers default. **Creating a Customer** It is recommended 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), this can be for a zero amount. The Customer will be created with a Payment Instrument and Shipping Address. You can also [add additional Payment Instruments to a Customer 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). 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** To perform a payment with the Customers default details specify the [Customer Id in the payments request](#payments_payments_process-a-payment_samplerequests-dropdown_authorization-using-tokens_authorization-with-customer-token-id_liveconsole-tab-request-body). To perform a payment with a particular Payment Instrument or Shipping Address specify the [Payment Instrument or Shipping Address Ids 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 Create a Customer * @param {V2CustomersBody} body * @param {string} [profileId] The Id of a profile containing user specific TMS configuration. * @param {*} [options] Override http request option. * @throws {RequiredError} */ postCustomer(body: V2CustomersBody, profileId?: string, options?: AxiosRequestConfig & Configuration): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<AxiosResponse<TmsV2CustomersResponse>>>; }; /** * CustomerApi - factory interface * @export */ export declare const CustomerApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => { /** * | | | | | --- | --- | --- | |**Customers** A Customer represents your tokenized customer information. You should associate the Customer Id with the customer account on your systems. A Customer can have one or more [Payment Instruments](#token-management_customer-payment-instrument_create-a-customer-payment-instrumentl) or [Shipping Addresses](#token-management_customer-shipping-address_create-a-customer-shipping-address) with one allocated as the Customers default.|      |**Deleting a Customer** Your system can use this API to delete a complete Customer. When a Customer is deleted all associated Payment Instruments & Shipping Addresses are deleted. Any Instrument Identifiers representing the card number will also be deleted if they are not associated with any other Payment Instruments. Note: Individual [Payment Instruments](#token-management_customer-payment-instrument_delete-a-customer-payment-instrument) or [Shipping Addresses](#token-management_customer-shipping-address_delete-a-customer-shipping-address) can be deleted via their own dedicated API resources. * @summary Delete a Customer * @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} */ deleteCustomer(customerId: string, profileId?: string, options?: AxiosRequestConfig & Configuration): Promise<AxiosResponse<void>>; /** * | | | | | --- | --- | --- | |**Customers** A Customer represents your tokenized customer information. You should associate the Customer Id with the customer account on your systems. A Customer can have one or more [Payment Instruments](#token-management_customer-payment-instrument_create-a-customer-payment-instrumentl) or [Shipping Addresses](#token-management_customer-shipping-address_create-a-customer-shipping-address) with one allocated as the Customers default. **Retrieving a Customer** When your customer signs into their account, your system can use this API to retrieve the Customers default Payment Instrument and Shipping Address. **Note: the actual card data will be masked.** If your customer wants to see other available Payment Instruments, your system can [retrieve all Payment Instruments](#token-management_customer-payment-instrument_list-payment-instruments-for-a-customer) associated with the Customer. The same applies to [Shipping Addresses](#token-management_customer-shipping-address_list-shipping-addresses-for-a-customer).|      |**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** To perform a payment with the Customers default details specify the [Customer Id in the payments request](#payments_payments_process-a-payment_samplerequests-dropdown_authorization-using-tokens_authorization-with-customer-token-id_liveconsole-tab-request-body). To perform a payment with a particular Payment Instrument or Shipping Address specify the [Payment Instrument or Shipping Address Ids 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 * @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} */ getCustomer(customerId: string, profileId?: string, options?: AxiosRequestConfig & Configuration): Promise<AxiosResponse<InlineResponse200>>; /** * | | | | | --- | --- | --- | |**Customers** A Customer represents your tokenized customer information. You should associate the Customer Id with the customer account on your systems. A Customer can have one or more [Payment Instruments](#token-management_customer-payment-instrument_create-a-customer-payment-instrumentl) or [Shipping Addresses](#token-management_customer-shipping-address_create-a-customer-shipping-address) with one allocated as the Customers default.|      |**Updating a Customer** Your system can use this API to update a Customers details including selecting a [default Payment Instrument](#token-management_customer_update-a-customer_samplerequests-dropdown_update-customers-default-payment-instrument_liveconsole-tab-request-body) or [default Shipping Address](#token-management_customer_update-a-customer_samplerequests-dropdown_update-customers-default-shipping-address_liveconsole-tab-request-body) for use in payments. Note: Updating a Customers [Payment Instrument](#token-management_customer-payment-instrument_update-a-customer-payment-instrument) or [Shipping Address](#token-management_customer-shipping-address_update-a-customer-shipping-address) details is performed using their own dedicated API resources. * @summary Update a Customer * @param {CustomersCustomerIdBody} body * @param {string} customerId The Id of a Customer. * @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} */ patchCustomer(body: CustomersCustomerIdBody, customerId: string, profileId?: string, ifMatch?: string, options?: AxiosRequestConfig & Configuration): Promise<AxiosResponse<InlineResponse200>>; /** * | | | | | --- | --- | --- | |**Customers** A Customer represents your tokenized customer information. You should associate the Customer Id with the customer account on your systems. A Customer can have one or more [Payment Instruments](#token-management_customer-payment-instrument_create-a-customer-payment-instrumentl) or [Shipping Addresses](#token-management_customer-shipping-address_create-a-customer-shipping-address) with one allocated as the Customers default. **Creating a Customer** It is recommended 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), this can be for a zero amount. The Customer will be created with a Payment Instrument and Shipping Address. You can also [add additional Payment Instruments to a Customer 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). 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** To perform a payment with the Customers default details specify the [Customer Id in the payments request](#payments_payments_process-a-payment_samplerequests-dropdown_authorization-using-tokens_authorization-with-customer-token-id_liveconsole-tab-request-body). To perform a payment with a particular Payment Instrument or Shipping Address specify the [Payment Instrument or Shipping Address Ids 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 Create a Customer * @param {V2CustomersBody} body * @param {string} [profileId] The Id of a profile containing user specific TMS configuration. * @param {*} [options] Override http request option. * @throws {RequiredError} */ postCustomer(body: V2CustomersBody, profileId?: string, options?: AxiosRequestConfig & Configuration): Promise<AxiosResponse<TmsV2CustomersResponse>>; }; /** * CustomerApi - object-oriented interface * @export * @class CustomerApi * @extends {BaseAPI} */ export declare class CustomerApi extends BaseAPI { /** * | | | | | --- | --- | --- | |**Customers** A Customer represents your tokenized customer information. You should associate the Customer Id with the customer account on your systems. A Customer can have one or more [Payment Instruments](#token-management_customer-payment-instrument_create-a-customer-payment-instrumentl) or [Shipping Addresses](#token-management_customer-shipping-address_create-a-customer-shipping-address) with one allocated as the Customers default.|      |**Deleting a Customer** Your system can use this API to delete a complete Customer. When a Customer is deleted all associated Payment Instruments & Shipping Addresses are deleted. Any Instrument Identifiers representing the card number will also be deleted if they are not associated with any other Payment Instruments. Note: Individual [Payment Instruments](#token-management_customer-payment-instrument_delete-a-customer-payment-instrument) or [Shipping Addresses](#token-management_customer-shipping-address_delete-a-customer-shipping-address) can be deleted via their own dedicated API resources. * @summary Delete a Customer * @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 CustomerApi */ deleteCustomer(customerId: string, profileId?: string, options?: AxiosRequestConfig & Configuration): Promise<AxiosResponse<void>>; /** * | | | | | --- | --- | --- | |**Customers** A Customer represents your tokenized customer information. You should associate the Customer Id with the customer account on your systems. A Customer can have one or more [Payment Instruments](#token-management_customer-payment-instrument_create-a-customer-payment-instrumentl) or [Shipping Addresses](#token-management_customer-shipping-address_create-a-customer-shipping-address) with one allocated as the Customers default. **Retrieving a Customer** When your customer signs into their account, your system can use this API to retrieve the Customers default Payment Instrument and Shipping Address. **Note: the actual card data will be masked.** If your customer wants to see other available Payment Instruments, your system can [retrieve all Payment Instruments](#token-management_customer-payment-instrument_list-payment-instruments-for-a-customer) associated with the Customer. The same applies to [Shipping Addresses](#token-management_customer-shipping-address_list-shipping-addresses-for-a-customer).|      |**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** To perform a payment with the Customers default details specify the [Customer Id in the payments request](#payments_payments_process-a-payment_samplerequests-dropdown_authorization-using-tokens_authorization-with-customer-token-id_liveconsole-tab-request-body). To perform a payment with a particular Payment Instrument or Shipping Address specify the [Payment Instrument or Shipping Address Ids 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 * @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 CustomerApi */ getCustomer(customerId: string, profileId?: string, options?: AxiosRequestConfig & Configuration): Promise<AxiosResponse<InlineResponse200>>; /** * | | | | | --- | --- | --- | |**Customers** A Customer represents your tokenized customer information. You should associate the Customer Id with the customer account on your systems. A Customer can have one or more [Payment Instruments](#token-management_customer-payment-instrument_create-a-customer-payment-instrumentl) or [Shipping Addresses](#token-management_customer-shipping-address_create-a-customer-shipping-address) with one allocated as the Customers default.|      |**Updating a Customer** Your system can use this API to update a Customers details including selecting a [default Payment Instrument](#token-management_customer_update-a-customer_samplerequests-dropdown_update-customers-default-payment-instrument_liveconsole-tab-request-body) or [default Shipping Address](#token-management_customer_update-a-customer_samplerequests-dropdown_update-customers-default-shipping-address_liveconsole-tab-request-body) for use in payments. Note: Updating a Customers [Payment Instrument](#token-management_customer-payment-instrument_update-a-customer-payment-instrument) or [Shipping Address](#token-management_customer-shipping-address_update-a-customer-shipping-address) details is performed using their own dedicated API resources. * @summary Update a Customer * @param {CustomersCustomerIdBody} body * @param {string} customerId The Id of a Customer. * @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 CustomerApi */ patchCustomer(body: CustomersCustomerIdBody, customerId: string, profileId?: string, ifMatch?: string, options?: AxiosRequestConfig & Configuration): Promise<AxiosResponse<InlineResponse200>>; /** * | | | | | --- | --- | --- | |**Customers** A Customer represents your tokenized customer information. You should associate the Customer Id with the customer account on your systems. A Customer can have one or more [Payment Instruments](#token-management_customer-payment-instrument_create-a-customer-payment-instrumentl) or [Shipping Addresses](#token-management_customer-shipping-address_create-a-customer-shipping-address) with one allocated as the Customers default. **Creating a Customer** It is recommended 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), this can be for a zero amount. The Customer will be created with a Payment Instrument and Shipping Address. You can also [add additional Payment Instruments to a Customer 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). 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** To perform a payment with the Customers default details specify the [Customer Id in the payments request](#payments_payments_process-a-payment_samplerequests-dropdown_authorization-using-tokens_authorization-with-customer-token-id_liveconsole-tab-request-body). To perform a payment with a particular Payment Instrument or Shipping Address specify the [Payment Instrument or Shipping Address Ids 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 Create a Customer * @param {V2CustomersBody} body * @param {string} [profileId] The Id of a profile containing user specific TMS configuration. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof CustomerApi */ postCustomer(body: V2CustomersBody, profileId?: string, options?: AxiosRequestConfig & Configuration): Promise<AxiosResponse<TmsV2CustomersResponse>>; }