@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 { InlineResponse2011 } from '../models'; import { PaymentinstrumentsPaymentInstrumentIdBody1 } from '../models'; import { V1PaymentinstrumentsBody } from '../models'; /** * PaymentInstrumentApi - axios parameter creator * @export */ export declare const PaymentInstrumentApiAxiosParamCreator: (configuration?: Configuration) => { /** * | | | | | --- | --- | --- | |**Standalone Payment Instruments** A Payment Instrument represents tokenized payment information such as expiration date, billing address & card type. 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. **Standalone Payment Instruments do not belong to a [Customer](#token-management_customer_create-a-customer).**|      |**Deleting a Payment Instrument** Your system can use this API to delete an existing Payment Instrument. Any Instrument Identifiers representing the card number will also be deleted if they are not associated with any other Payment Instruments. * @summary Delete a Payment Instrument * @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} */ deletePaymentInstrument: (paymentInstrumentId: string, profileId?: string, options?: AxiosRequestConfig & Configuration) => Promise<RequestArgs>; /** * | | | | | --- | --- | --- | |**Standalone Payment Instruments** A Payment Instrument represents tokenized payment information such as expiration date, billing address & card type. 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. **Standalone Payment Instruments do not belong to a [Customer](#token-management_customer_create-a-customer).**|      |**Retrieving a Payment Instrument** Your system can use this API to retrieve an existing Payment Instrument. 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 Payment Instrument * @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} */ getPaymentInstrument: (paymentInstrumentId: string, profileId?: string, options?: AxiosRequestConfig & Configuration) => Promise<RequestArgs>; /** * | | | | | --- | --- | --- | |**Standalone Payment Instruments** A Payment Instrument represents tokenized payment information such as expiration date, billing address & card type. 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. **Standalone Payment Instruments do not belong to a [Customer](#token-management_customer_create-a-customer).**|      |**Updating a Payment Instrument** Your system can use this API to update an existing Payment Instrument. * @summary Update a Payment Instrument * @param {PaymentinstrumentsPaymentInstrumentIdBody1} body * @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} */ patchPaymentInstrument: (body: PaymentinstrumentsPaymentInstrumentIdBody1, paymentInstrumentId: string, profileId?: string, ifMatch?: string, options?: AxiosRequestConfig & Configuration) => Promise<RequestArgs>; /** * | | | | | --- | --- | --- | |**Standalone Payment Instruments** A Payment Instrument represents tokenized payment information such as expiration date, billing address & card type. 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. **Standalone Payment Instruments do not belong to a [Customer](#token-management_customer_create-a-customer).** **Creating a Payment Instrument** It is recommended you [create a Payment Instrument 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. 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 Payment Instruments** To perform a payment with a particular Payment Instrument 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 Payment Instrument * @param {V1PaymentinstrumentsBody} body * @param {string} [profileId] The Id of a profile containing user specific TMS configuration. * @param {*} [options] Override http request option. * @throws {RequiredError} */ postPaymentInstrument: (body: V1PaymentinstrumentsBody, profileId?: string, options?: AxiosRequestConfig & Configuration) => Promise<RequestArgs>; }; /** * PaymentInstrumentApi - functional programming interface * @export */ export declare const PaymentInstrumentApiFp: (configuration?: Configuration) => { /** * | | | | | --- | --- | --- | |**Standalone Payment Instruments** A Payment Instrument represents tokenized payment information such as expiration date, billing address & card type. 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. **Standalone Payment Instruments do not belong to a [Customer](#token-management_customer_create-a-customer).**|      |**Deleting a Payment Instrument** Your system can use this API to delete an existing Payment Instrument. Any Instrument Identifiers representing the card number will also be deleted if they are not associated with any other Payment Instruments. * @summary Delete a Payment Instrument * @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} */ deletePaymentInstrument(paymentInstrumentId: string, profileId?: string, options?: AxiosRequestConfig & Configuration): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<AxiosResponse<void>>>; /** * | | | | | --- | --- | --- | |**Standalone Payment Instruments** A Payment Instrument represents tokenized payment information such as expiration date, billing address & card type. 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. **Standalone Payment Instruments do not belong to a [Customer](#token-management_customer_create-a-customer).**|      |**Retrieving a Payment Instrument** Your system can use this API to retrieve an existing Payment Instrument. 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 Payment Instrument * @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} */ getPaymentInstrument(paymentInstrumentId: string, profileId?: string, options?: AxiosRequestConfig & Configuration): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<AxiosResponse<InlineResponse2011>>>; /** * | | | | | --- | --- | --- | |**Standalone Payment Instruments** A Payment Instrument represents tokenized payment information such as expiration date, billing address & card type. 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. **Standalone Payment Instruments do not belong to a [Customer](#token-management_customer_create-a-customer).**|      |**Updating a Payment Instrument** Your system can use this API to update an existing Payment Instrument. * @summary Update a Payment Instrument * @param {PaymentinstrumentsPaymentInstrumentIdBody1} body * @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} */ patchPaymentInstrument(body: PaymentinstrumentsPaymentInstrumentIdBody1, paymentInstrumentId: string, profileId?: string, ifMatch?: string, options?: AxiosRequestConfig & Configuration): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<AxiosResponse<InlineResponse2011>>>; /** * | | | | | --- | --- | --- | |**Standalone Payment Instruments** A Payment Instrument represents tokenized payment information such as expiration date, billing address & card type. 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. **Standalone Payment Instruments do not belong to a [Customer](#token-management_customer_create-a-customer).** **Creating a Payment Instrument** It is recommended you [create a Payment Instrument 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. 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 Payment Instruments** To perform a payment with a particular Payment Instrument 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 Payment Instrument * @param {V1PaymentinstrumentsBody} body * @param {string} [profileId] The Id of a profile containing user specific TMS configuration. * @param {*} [options] Override http request option. * @throws {RequiredError} */ postPaymentInstrument(body: V1PaymentinstrumentsBody, profileId?: string, options?: AxiosRequestConfig & Configuration): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<AxiosResponse<InlineResponse2011>>>; }; /** * PaymentInstrumentApi - factory interface * @export */ export declare const PaymentInstrumentApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => { /** * | | | | | --- | --- | --- | |**Standalone Payment Instruments** A Payment Instrument represents tokenized payment information such as expiration date, billing address & card type. 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. **Standalone Payment Instruments do not belong to a [Customer](#token-management_customer_create-a-customer).**|      |**Deleting a Payment Instrument** Your system can use this API to delete an existing Payment Instrument. Any Instrument Identifiers representing the card number will also be deleted if they are not associated with any other Payment Instruments. * @summary Delete a Payment Instrument * @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} */ deletePaymentInstrument(paymentInstrumentId: string, profileId?: string, options?: AxiosRequestConfig & Configuration): Promise<AxiosResponse<void>>; /** * | | | | | --- | --- | --- | |**Standalone Payment Instruments** A Payment Instrument represents tokenized payment information such as expiration date, billing address & card type. 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. **Standalone Payment Instruments do not belong to a [Customer](#token-management_customer_create-a-customer).**|      |**Retrieving a Payment Instrument** Your system can use this API to retrieve an existing Payment Instrument. 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 Payment Instrument * @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} */ getPaymentInstrument(paymentInstrumentId: string, profileId?: string, options?: AxiosRequestConfig & Configuration): Promise<AxiosResponse<InlineResponse2011>>; /** * | | | | | --- | --- | --- | |**Standalone Payment Instruments** A Payment Instrument represents tokenized payment information such as expiration date, billing address & card type. 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. **Standalone Payment Instruments do not belong to a [Customer](#token-management_customer_create-a-customer).**|      |**Updating a Payment Instrument** Your system can use this API to update an existing Payment Instrument. * @summary Update a Payment Instrument * @param {PaymentinstrumentsPaymentInstrumentIdBody1} body * @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} */ patchPaymentInstrument(body: PaymentinstrumentsPaymentInstrumentIdBody1, paymentInstrumentId: string, profileId?: string, ifMatch?: string, options?: AxiosRequestConfig & Configuration): Promise<AxiosResponse<InlineResponse2011>>; /** * | | | | | --- | --- | --- | |**Standalone Payment Instruments** A Payment Instrument represents tokenized payment information such as expiration date, billing address & card type. 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. **Standalone Payment Instruments do not belong to a [Customer](#token-management_customer_create-a-customer).** **Creating a Payment Instrument** It is recommended you [create a Payment Instrument 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. 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 Payment Instruments** To perform a payment with a particular Payment Instrument 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 Payment Instrument * @param {V1PaymentinstrumentsBody} body * @param {string} [profileId] The Id of a profile containing user specific TMS configuration. * @param {*} [options] Override http request option. * @throws {RequiredError} */ postPaymentInstrument(body: V1PaymentinstrumentsBody, profileId?: string, options?: AxiosRequestConfig & Configuration): Promise<AxiosResponse<InlineResponse2011>>; }; /** * PaymentInstrumentApi - object-oriented interface * @export * @class PaymentInstrumentApi * @extends {BaseAPI} */ export declare class PaymentInstrumentApi extends BaseAPI { /** * | | | | | --- | --- | --- | |**Standalone Payment Instruments** A Payment Instrument represents tokenized payment information such as expiration date, billing address & card type. 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. **Standalone Payment Instruments do not belong to a [Customer](#token-management_customer_create-a-customer).**|      |**Deleting a Payment Instrument** Your system can use this API to delete an existing Payment Instrument. Any Instrument Identifiers representing the card number will also be deleted if they are not associated with any other Payment Instruments. * @summary Delete a Payment Instrument * @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 PaymentInstrumentApi */ deletePaymentInstrument(paymentInstrumentId: string, profileId?: string, options?: AxiosRequestConfig & Configuration): Promise<AxiosResponse<void>>; /** * | | | | | --- | --- | --- | |**Standalone Payment Instruments** A Payment Instrument represents tokenized payment information such as expiration date, billing address & card type. 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. **Standalone Payment Instruments do not belong to a [Customer](#token-management_customer_create-a-customer).**|      |**Retrieving a Payment Instrument** Your system can use this API to retrieve an existing Payment Instrument. 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 Payment Instrument * @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 PaymentInstrumentApi */ getPaymentInstrument(paymentInstrumentId: string, profileId?: string, options?: AxiosRequestConfig & Configuration): Promise<AxiosResponse<InlineResponse2011>>; /** * | | | | | --- | --- | --- | |**Standalone Payment Instruments** A Payment Instrument represents tokenized payment information such as expiration date, billing address & card type. 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. **Standalone Payment Instruments do not belong to a [Customer](#token-management_customer_create-a-customer).**|      |**Updating a Payment Instrument** Your system can use this API to update an existing Payment Instrument. * @summary Update a Payment Instrument * @param {PaymentinstrumentsPaymentInstrumentIdBody1} body * @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 PaymentInstrumentApi */ patchPaymentInstrument(body: PaymentinstrumentsPaymentInstrumentIdBody1, paymentInstrumentId: string, profileId?: string, ifMatch?: string, options?: AxiosRequestConfig & Configuration): Promise<AxiosResponse<InlineResponse2011>>; /** * | | | | | --- | --- | --- | |**Standalone Payment Instruments** A Payment Instrument represents tokenized payment information such as expiration date, billing address & card type. 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. **Standalone Payment Instruments do not belong to a [Customer](#token-management_customer_create-a-customer).** **Creating a Payment Instrument** It is recommended you [create a Payment Instrument 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. 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 Payment Instruments** To perform a payment with a particular Payment Instrument 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 Payment Instrument * @param {V1PaymentinstrumentsBody} body * @param {string} [profileId] The Id of a profile containing user specific TMS configuration. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof PaymentInstrumentApi */ postPaymentInstrument(body: V1PaymentinstrumentsBody, profileId?: string, options?: AxiosRequestConfig & Configuration): Promise<AxiosResponse<InlineResponse2011>>; }