@paciolan/cybersource-sdk/dist/apis/reversal-api.d.ts

CyberSource REST API Typescript 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 { IdReversalsBody } from '../models';
import { PtsV2PaymentsReversalsPost201Response } from '../models';
import { PtsV2ReversalsPost201Response } from '../models';
import { V2ReversalsBody } from '../models';
/**
 * ReversalApi - axios parameter creator
 * @export
 */
export declare const ReversalApiAxiosParamCreator: (configuration?: Configuration) => {
    /**
     * Include the payment ID in the POST request to reverse the payment amount.
     * @summary Process an Authorization Reversal
     * @param {IdReversalsBody} body
     * @param {string} id The payment ID returned from a previous payment request.
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    authReversal: (body: IdReversalsBody, id: string, options?: AxiosRequestConfig & Configuration) => Promise<RequestArgs>;
    /**
     * This is to reverse a previous payment that merchant does not receive a reply(Mostly due to Timeout). To use this feature/API, make sure to pass unique value to field - clientReferenceInformation -> transactionId in [/pts/v2/payments](https://developer.cybersource.com/api-reference-assets/index.html#payments_payments) API call and use same transactionId in this API request payload to reverse the payment.
     * @summary Timeout Reversal
     * @param {V2ReversalsBody} body
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    mitReversal: (body: V2ReversalsBody, options?: AxiosRequestConfig & Configuration) => Promise<RequestArgs>;
};
/**
 * ReversalApi - functional programming interface
 * @export
 */
export declare const ReversalApiFp: (configuration?: Configuration) => {
    /**
     * Include the payment ID in the POST request to reverse the payment amount.
     * @summary Process an Authorization Reversal
     * @param {IdReversalsBody} body
     * @param {string} id The payment ID returned from a previous payment request.
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    authReversal(body: IdReversalsBody, id: string, options?: AxiosRequestConfig & Configuration): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<AxiosResponse<PtsV2PaymentsReversalsPost201Response>>>;
    /**
     * This is to reverse a previous payment that merchant does not receive a reply(Mostly due to Timeout). To use this feature/API, make sure to pass unique value to field - clientReferenceInformation -> transactionId in [/pts/v2/payments](https://developer.cybersource.com/api-reference-assets/index.html#payments_payments) API call and use same transactionId in this API request payload to reverse the payment.
     * @summary Timeout Reversal
     * @param {V2ReversalsBody} body
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    mitReversal(body: V2ReversalsBody, options?: AxiosRequestConfig & Configuration): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<AxiosResponse<PtsV2ReversalsPost201Response>>>;
};
/**
 * ReversalApi - factory interface
 * @export
 */
export declare const ReversalApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
    /**
     * Include the payment ID in the POST request to reverse the payment amount.
     * @summary Process an Authorization Reversal
     * @param {IdReversalsBody} body
     * @param {string} id The payment ID returned from a previous payment request.
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    authReversal(body: IdReversalsBody, id: string, options?: AxiosRequestConfig & Configuration): Promise<AxiosResponse<PtsV2PaymentsReversalsPost201Response>>;
    /**
     * This is to reverse a previous payment that merchant does not receive a reply(Mostly due to Timeout). To use this feature/API, make sure to pass unique value to field - clientReferenceInformation -> transactionId in [/pts/v2/payments](https://developer.cybersource.com/api-reference-assets/index.html#payments_payments) API call and use same transactionId in this API request payload to reverse the payment.
     * @summary Timeout Reversal
     * @param {V2ReversalsBody} body
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    mitReversal(body: V2ReversalsBody, options?: AxiosRequestConfig & Configuration): Promise<AxiosResponse<PtsV2ReversalsPost201Response>>;
};
/**
 * ReversalApi - object-oriented interface
 * @export
 * @class ReversalApi
 * @extends {BaseAPI}
 */
export declare class ReversalApi extends BaseAPI {
    /**
     * Include the payment ID in the POST request to reverse the payment amount.
     * @summary Process an Authorization Reversal
     * @param {IdReversalsBody} body
     * @param {string} id The payment ID returned from a previous payment request.
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     * @memberof ReversalApi
     */
    authReversal(body: IdReversalsBody, id: string, options?: AxiosRequestConfig & Configuration): Promise<AxiosResponse<PtsV2PaymentsReversalsPost201Response>>;
    /**
     * This is to reverse a previous payment that merchant does not receive a reply(Mostly due to Timeout). To use this feature/API, make sure to pass unique value to field - clientReferenceInformation -> transactionId in [/pts/v2/payments](https://developer.cybersource.com/api-reference-assets/index.html#payments_payments) API call and use same transactionId in this API request payload to reverse the payment.
     * @summary Timeout Reversal
     * @param {V2ReversalsBody} body
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     * @memberof ReversalApi
     */
    mitReversal(body: V2ReversalsBody, options?: AxiosRequestConfig & Configuration): Promise<AxiosResponse<PtsV2ReversalsPost201Response>>;
}