Home
API Reference

List all Charges

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

This endpoint returns a list of all previously created charges, with the most recent charges appearing first.

Body Params
period
object

Retrieve charges for a selected period

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 chg_foo, you can use starting_after=chg_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
Defaults to 25

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

string
enum

Sort the results Ascending or Descending by date

Allowed:
string
Defaults to date

Applying the sorting based on

string

Filter the results based on meta data values

string

Filter the charges based on charge currency

payouts
object

Retrieve charges based on payouts

reference
object
Responses

Updated 10 months ago

Language
Credentials
Header
Response 
Click Try It! to start a request and see the response here! Or choose an example:
application/json
Updated 10 months ago