Search for Transactions

get https://{environment}.{server}.com/v3/transaction/search

Get a collection of transactions matching the supplied criteria. At least one parameter is required.

Specify the search in the URL query string. Possible query keys are below Example: GET [base_url]transaction/search?date=2022-03-22&amount=1.02 will get all transactions run on the 22nd of march 2022 for $1.02.

time	status	user agent
Retrieving recent requests…

Loading…

Query Params

date

string

The Transaction date to search for. Formatted as yyyy-mm-dd

datetime_start

string

The start date of a range to search through. Formatted as yyyy-mm-dd. Cannot be used in conjunction with date query parameter. Must be used with datetime_end query parameter.

datetime_end

string

The end date of a range to search through. Formatted as yyyy-mm-dd. Cannot be used in conjunction with date query parameter. Must be used with datetime_start query parameter.

amount

string

The Transaction amount. Decimal with no currency symbol.

first_name

string

The Customer's first name. If there are spaces, they should be url encoded.

last_name

string

The Customer's last name. If there are spaces, they should be url encoded.

custom_fields

object

Any Custom Fields that are sent in with a transaction can be searched. Use the Custom Field's key as the query parameter name and the Custom Field's value as the query parameter value.

status

string

The Transaction's status. Either approved, declined or scheduled.

type

string

The Transaction's type. Either sale, auth, refund, void (comma seperate for multiple).

Responses

Language

Credentials

Bearer

JWT

URL


xxxxxxxxxx
1
curl --request GET \
2
     --url https://api.sandbox-paidyet.com/v3/transaction/search \
3
     --header 'accept: application/json'

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200PaidYET API Response containing the payload and any messages. The payload's items array contains ZERO to MANY Transactions.

400Authentication Token error

401Authentication required