Function PayoutsApiFactory

Returns {
    getPayout(requestParameters, options?) => AxiosPromise<Payout>;
    listPayouts(requestParameters, options?) => AxiosPromise<ListPayouts200Response>;
}

• getPayout:function

  • getPayout(requestParameters, options?): AxiosPromise<Payout>

  • Retrieves the details of an existing Payout.

    Summary

    Get a Payout

    Throws

    Parameters

    • requestParameters: PayoutsApiGetPayoutRequest

      Request parameters.

    • Optional options: RawAxiosRequestConfig<any>

      Override http request option.

    Returns AxiosPromise<Payout>

• listPayouts:function

  • listPayouts(requestParameters, options?): AxiosPromise<ListPayouts200Response>

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

    Summary

    List all Payouts

    Throws

    Parameters

    • requestParameters: PayoutsApiListPayoutsRequest

      Request parameters.

    • Optional options: RawAxiosRequestConfig<any>

      Override http request option.

    Returns AxiosPromise<ListPayouts200Response>