Class RefundsApi

RefundsApi - object-oriented interface

Export

Hierarchy

  • BaseAPI
    • RefundsApi

Constructors

constructor

Properties

axios basePath configuration

Methods

createRefund getRefund listRefunds

Constructors

constructor

  • Parameters

    • Optional configuration: Configuration
    • basePath: string = BASE_PATH
    • axios: AxiosInstance = globalAxios

    Returns RefundsApi

Properties

Protected axios

axios: AxiosInstance = globalAxios

Protected basePath

basePath: string = BASE_PATH

Protected configuration

configuration: undefined | Configuration

Methods

createRefund

  • Creates a Refund.

    Summary

    Create a Refund

    Throws

    Memberof

    RefundsApi

    Parameters

    • requestParameters: RefundsApiCreateRefundRequest

      Request parameters.

    • Optional options: RawAxiosRequestConfig<any>

      Override http request option.

    Returns Promise<AxiosResponse<Refund, any>>

getRefund

  • Retrieves the details of an existing Refund.

    Summary

    Get a Refund

    Throws

    Memberof

    RefundsApi

    Parameters

    • requestParameters: RefundsApiGetRefundRequest

      Request parameters.

    • Optional options: RawAxiosRequestConfig<any>

      Override http request option.

    Returns Promise<AxiosResponse<Refund, any>>

listRefunds

  • Returns a list of Refunds. The Refunds are sorted with the most recently created appearing first.

    Summary

    List all Refunds

    Throws

    Memberof

    RefundsApi

    Parameters

    • requestParameters: RefundsApiListRefundsRequest

      Request parameters.

    • Optional options: RawAxiosRequestConfig<any>

      Override http request option.

    Returns Promise<AxiosResponse<ListRefunds200Response, any>>

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc