Retrieve Transactions List

get

https://api-dev.gettrx.com/payments/v1/transactions

This API provides a different way to view your transactions. Unlike the payment requests API which consolidates the related sales, declines, and refunds in a single 'Payment Request' record, the Transactions List API will list both charges, refunds, and declines as individual transaction records. This API is useful for reconciliation of payments and deposits

Query Params

start_date

int64

required

The start date for the search, specified as a Unix timestamp. This applies to the payment request's creation date.

end_date

int64

required

The end date for the search, specified as a Unix timestamp. This applies to the payment request's creation date.

limit

int32

required

Defaults to 10

The number of records to retrieve. If not provided it defaults to 10.

page

int32

required

Defaults to 1

The page to retrieve based on the limit parameter provided. If not provided it defaults to 1.

type

string

Defaults to sale,refund

The type for the search. Possible values are: sale and refund. You can send multiple options and separate them with commas (,)

status

string

The status for the search. Possible values are: succeeded, failed, pending. You can send multiple options and separate them with commas (,)

payment_method

string

The payment methods search. Possible value are: card and us_bank_account. You can send multiple options and separate them with commas (,)

customer

string

The customer ID for the search.

string

Field to allow to search by paymentMethod.last4, customer.name, customer.email, and description.

order_by

string

The fields and the directions to sort by. (e.g. created:desc,amount:asc)

expand

string

Fields to expand in the response. (e.g. charge.customer, refund.charge.customer)

Headers

onBehalfOf

string

Specifies the account for which the Transaction list retrieval is intended. This is used for scenarios where one partner processes payments on behalf of a merchant

string

enum

Defaults to application/json

Generated from available response content types

Allowed:

Responses

200200

400400

401401