Download Authorize

Changed on

This endpoint allows you to retrieve a list of authorizes with detailed information. The response returned can be saved in a CSV file. Each row represents an authorization with its respective details, and the first row contains the headers describing each field.

post/download

Request

  • Base URL
    https://api.tap.company/v2/authorize
  • URL
    https://api.tap.company/v2/authorize/download
  • Auth
    API key in header Authorization

Request body

merchantsstring[]

List of merchant IDs for which the charges are being queried

payoutsobject

Retrieve charges based on payouts

statusstring

Retrieve the selected list of charges info by charge status. Values can be: INITIATED, IN_PROGRESS, ABANDONED, CANCELLED, FAILED, DECLINED, RESTRICTED, CAPTURED, VOID, TIMEDOUT or UNKNOWN

sourcesstring[]

Array of sources (you can specify the list of Source ID's to retrieve).

payment_methodsstring[]

Array of payment methods (you can specify the list of payment method Source ID's to retrieve).

customersstring[]

Array of customers (you can specify the list of Customer ID's to retrieve).

starting_afterstring

A cursor for use in pagination. The starting_after parameter takes a charge ID that determines your position in the list. For example, if your list request returns 50 charges that end with cus_foo, you can use starting_after=cus_foo in your next call to retrieve the next page of the list.

charge_createdstring

Created date (charge created date), Measured in Unix Epoch Timestamp (milliseconds).

mobilestring

Filter the results based on customer mobile number

emailstring

filter the results based on customer email

limitstring

The maximum number of charges to return in a single call. Default: 25; Maximum: 50.

orderstring

Sort the results Ascending or Descending by date

order_bystring

Defaults to date

currencystring

Filter the charges based on charge currency

Response

200

Changes

    • breaking

      the // request property type changed from string to integer, and format from no format to int32

    • breaking

      the // request property type changed from string to integer, and format from no format to int32

    • info

      api operation id download-disputes removed and replaced with download-authorize

    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      the request property became optional

    • info

      the request property default value changed from 1736507775000 to 1662035009000

    • info

      the request property default value changed from 599424 to 599242

    • info

      the request property default value changed from 1739186175000 to 1664367809000