Home
API Reference

Download Charges

post
https://api.tap.company/v2/charges/download

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

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
period
object

Retrieve charges for a selected period

merchants
array of strings
Defaults to 599242

List of merchant IDs for which the charges are being queried

merchants
payouts
object

Retrieve charges based on payouts

string

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

sources
array of strings

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

sources
payment_methods
array of strings

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

payment_methods
customers
array of strings

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

customers
charges
array of strings

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

charges
string

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.

string

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

string

Filter the results based on customer mobile number

string

filter the results based on customer email

string

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

string

Sort the results Ascending or Descending by date

string

Defaults to date

metadata
object

Filter the results based on meta data values

string

Filter the charges based on charge currency

reference
object
additional_fields
array of strings

additional fields can be returned in the report, for the marketplace you can get the destination_id and the destination_amount

additional_fields
Headers
string
enum
Defaults to application/json

Generated from available response content types

Allowed:
Responses

Updated 6 months ago

Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
text/plain
application/json

Updated 6 months ago