Function RefundsApiFp

Returns {
    createRefund(tilled_account, RefundCreateParams, options?) => Promise<((axios?, basePath?) => AxiosPromise<Refund>)>;
    getRefund(tilled_account, id, options?) => Promise<((axios?, basePath?) => AxiosPromise<Refund>)>;
    listRefunds(tilled_account, metadata?, offset?, limit?, options?) => Promise<((axios?, basePath?) => AxiosPromise<ListRefunds200Response>)>;
}

• createRefund:function

  • createRefund(tilled_account, RefundCreateParams, options?): Promise<((axios?, basePath?) => AxiosPromise<Refund>)>

  • Creates a Refund.

    Summary

    Create a Refund

    Throws

    Parameters

    • tilled_account: string

      The id of the Tilled Account (usually starting with the prefix `acct_`) that the request is performed on behalf of.

    • RefundCreateParams: RefundCreateParams

    • Optional options: RawAxiosRequestConfig<any>

      Override http request option.

    Returns Promise<((axios?, basePath?) => AxiosPromise<Refund>)>

• getRefund:function

  • getRefund(tilled_account, id, options?): Promise<((axios?, basePath?) => AxiosPromise<Refund>)>

  • Retrieves the details of an existing Refund.

    Summary

    Get a Refund

    Throws

    Parameters

    • tilled_account: string

      The id of the Tilled Account (usually starting with the prefix `acct_`) that the request is performed on behalf of.

    • id: string

    • Optional options: RawAxiosRequestConfig<any>

      Override http request option.

    Returns Promise<((axios?, basePath?) => AxiosPromise<Refund>)>

• listRefunds:function

  • listRefunds(tilled_account, metadata?, offset?, limit?, options?): Promise<((axios?, basePath?) => AxiosPromise<ListRefunds200Response>)>

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

    Summary

    List all Refunds

    Throws

    Parameters

    • tilled_account: string

      The id of the Tilled Account (usually starting with the prefix `acct_`) that the request is performed on behalf of.

    • Optional metadata: {
          [key: string]: string;
      }

      `metadata` key-value pairs to filter by. Only exact matches on the key-value pair(s) will be returned. Example: `?metadata[internal_customer_id]=7cb1159d-875e-47ae-a309-319fa7ff395b`.

      • [key: string]: string

    • Optional offset: number

      The (zero-based) offset of the first item in the collection to return.

    • Optional limit: number

      The maximum number of entries to return. If the value exceeds the maximum, then the maximum value will be used.

    • Optional options: RawAxiosRequestConfig<any>

      Override http request option.

    Returns Promise<((axios?, basePath?) => AxiosPromise<ListRefunds200Response>)>