Function DisputesApiAxiosParamCreator

  • DisputesApi - axios parameter creator

    Export

    Parameters

    Returns {
        createDisputeEvidence: ((tilled_account, id, DisputeEvidenceCreateParams, options?) => Promise<RequestArgs>);
        getDispute: ((tilled_account, id, options?) => Promise<RequestArgs>);
        listDisputes: ((tilled_account, charge_id?, include_connected_accounts?, created_at_gte?, created_at_lte?, status?, offset?, limit?, options?) => Promise<RequestArgs>);
    }

    • createDisputeEvidence: ((tilled_account, id, DisputeEvidenceCreateParams, options?) => Promise<RequestArgs>)
        • (tilled_account, id, DisputeEvidenceCreateParams, options?): Promise<RequestArgs>
        • Creates Dispute evidence. Dispute evidence can only be submitted prior to the closing_at date.

          Summary

          Create Dispute Evidence

          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
          • DisputeEvidenceCreateParams: DisputeEvidenceCreateParams
          • Optional options: RawAxiosRequestConfig<any> = {}

            Override http request option.

          Returns Promise<RequestArgs>

    • getDispute: ((tilled_account, id, options?) => Promise<RequestArgs>)
        • (tilled_account, id, options?): Promise<RequestArgs>
        • Retrieves the details of an existing Dispute.

          Summary

          Get a Dispute

          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<RequestArgs>

    • listDisputes: ((tilled_account, charge_id?, include_connected_accounts?, created_at_gte?, created_at_lte?, status?, offset?, limit?, options?) => Promise<RequestArgs>)
        • (tilled_account, charge_id?, include_connected_accounts?, created_at_gte?, created_at_lte?, status?, offset?, limit?, options?): Promise<RequestArgs>
        • Returns a list of Disputes. The Disputes are sorted with the most recently created appearing first.

          Summary

          List all Disputes

          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 charge_id: string

            Only returns disputes for the charge specified by this charge ID.

          • Optional include_connected_accounts: boolean

            Whether or not to include the results from any connected accounts.

          • Optional created_at_gte: string

            Minimum `created_at` value to filter by (inclusive).

          • Optional created_at_lte: string

            Maximum `created_at` value to filter by (inclusive).

          • Optional status: ListDisputesStatus[]

            String indicating the status to filter the result by.

          • 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<RequestArgs>

Generated using TypeDoc