Search transactions

This endpoint allows advanced searches, specific filters, and extraction of payment history processed by Paag. It returns a paginated list of records matching the criteria sent in the Query String.

This endpoint is ideal for feeding financial dashboards, performing internal reconciliations, or querying the transaction history of a specific customer. Note that for each new event sent under the same transaction, its updated_at field will be updated.

Filtering is enabled for this endpoint via query parameters. To filter by a specific field, pass it through the request parameters, for example:

https://gateway.prd.pppay.cloud/api/transactions?search[first_name]=John&search[last_name]=Doe

Filter types

You can use filters on the fields like described below:

  • starts with matches records in a SQL LIKE fashion, e.g.: a string Transac will match both Transaction and TransactionEvent;
  • exact comparison matches records through exact comparison, (case sensitive) e.g.: a string Transaction will NOT match transaction;
  • date matches records through SQL date, and these fields should be provided on Y-m-d H:i:s format, e.g.: 2022-02-02 17:59:00

Pagination

Also, this endpoint provides pagination to navigate through record sets. Pagination information can be found in the meta response field. The pages always returns 50 records at a time.

"meta": {
  "last_page": 1,
  "current_page": 1,
  "total": 3
}

Rate limits

While using reporting capabilities, make sure to monitor rate limits through X-RateLimit-Limit and X-RateLimit-Remaining response headers.

Query Params
string

Filter type: starts with.

Search by the transaction identifier on the client side.

string

Filter type: starts with.

string

Filter type: starts with.

Search by the buyer/player's first name.

string

Filter type: starts with.

Search by the buyer/player's last name.

string

Filter type: starts with.

Search by the buyer/player's email.

string

Filter type: starts with.

Search by the buyer/player's mobile phone.

string

Filter type: exact comparison.

string

Filter type: starts with.

Search by city.

string

Filter type: exact comparison.

Search by state.

string

Filter type: exact comparison.

Search by zip code.

string

Filter type: starts with.

string

Filter type: exact comparison.

string

Filter type: exact comparison.

date

Filter type: date.

date

Filter type: date.

date

Filter type: date.

date

Filter type: date.

string

Filter type: exact comparison.

Search by the buyer/player's tax ID (CPF/CNPJ).

string

Filter type: exact comparison.

Search by transaction type (e.g.: pix).

string

Filter type: exact comparison.

Search by transaction status (e.g.: success, pending, failed).

string

Filter type: exact comparison.

Search by transaction flow (cashin or cashout).

string

Filter type: exact comparison.

Search by transaction origin (e.g.: player, settlement, vendor, funding, internal).

integer
Defaults to 50

Number of records returned per page.

integer
Defaults to 1

Page number to return.

Responses

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