@paciolan/cybersource-sdk
Version:
CyberSource REST API Typescript SDK
80 lines (79 loc) • 3.5 kB
TypeScript
/**
* 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 { IdCapturesBody } from '../models';
import { PtsV2PaymentsCapturesPost201Response } from '../models';
/**
* CaptureApi - axios parameter creator
* @export
*/
export declare const CaptureApiAxiosParamCreator: (configuration?: Configuration) => {
/**
* Include the payment ID in the POST request to capture the payment amount.
* @summary Capture a Payment
* @param {IdCapturesBody} body
* @param {string} id The payment ID returned from a previous payment request. This ID links the capture to the payment.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
capturePayment: (body: IdCapturesBody, id: string, options?: AxiosRequestConfig & Configuration) => Promise<RequestArgs>;
};
/**
* CaptureApi - functional programming interface
* @export
*/
export declare const CaptureApiFp: (configuration?: Configuration) => {
/**
* Include the payment ID in the POST request to capture the payment amount.
* @summary Capture a Payment
* @param {IdCapturesBody} body
* @param {string} id The payment ID returned from a previous payment request. This ID links the capture to the payment.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
capturePayment(body: IdCapturesBody, id: string, options?: AxiosRequestConfig & Configuration): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<AxiosResponse<PtsV2PaymentsCapturesPost201Response>>>;
};
/**
* CaptureApi - factory interface
* @export
*/
export declare const CaptureApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
/**
* Include the payment ID in the POST request to capture the payment amount.
* @summary Capture a Payment
* @param {IdCapturesBody} body
* @param {string} id The payment ID returned from a previous payment request. This ID links the capture to the payment.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
capturePayment(body: IdCapturesBody, id: string, options?: AxiosRequestConfig & Configuration): Promise<AxiosResponse<PtsV2PaymentsCapturesPost201Response>>;
};
/**
* CaptureApi - object-oriented interface
* @export
* @class CaptureApi
* @extends {BaseAPI}
*/
export declare class CaptureApi extends BaseAPI {
/**
* Include the payment ID in the POST request to capture the payment amount.
* @summary Capture a Payment
* @param {IdCapturesBody} body
* @param {string} id The payment ID returned from a previous payment request. This ID links the capture to the payment.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof CaptureApi
*/
capturePayment(body: IdCapturesBody, id: string, options?: AxiosRequestConfig & Configuration): Promise<AxiosResponse<PtsV2PaymentsCapturesPost201Response>>;
}