Skip to main content

Get a list of payments transactions.

It is recommended to use [filter] or [page] to improve the query.

Query Parameters
filter object REQUIRED

Get a list of payment transactions that are between a date range.

Return a specific transaction, or a list of transactions, that match the given params.

page object REQUIRED

Get a list of payment transactions from the DB with of the given page number and size. Must be combined with the date filter.

Return a list of transactions.

Header Parameters
Authorization string

An authorization token needed to validate the identity of the user without vpn. It is Needed in all the environments, except for local and dev. This token can be obtained with a request to: [https://auth.{ENVIRONMENT}.geopagos.com/oauth/token]

Example: Bearer [token}
Responses
200

A successful query response. The data contains a list of all the payments that match the query.

Schema OPTIONAL
data object[] OPTIONAL

A list of none, one or all the Payments that match the query.

type string OPTIONAL
id string OPTIONAL

The paymentId used to identify the transaction in the DB.

link object OPTIONAL

Other endpoint path that can be used to search the transaction with the paymentId.

self string OPTIONAL
attributes object OPTIONAL

The payment transaction information.

refNumber string OPTIONAL
txType string OPTIONAL
status string OPTIONAL
appKey string OPTIONAL
recordCreationDate string OPTIONAL

The transaction persisted date in the DB.

transactionDateWithTimeZone string OPTIONAL
billingInfoExtended string OPTIONAL
paymentMethod object OPTIONAL
entryMode string OPTIONAL
cardInfo object OPTIONAL

The card information used in the transaction.

maskedPan string OPTIONAL
brand string OPTIONAL
cardType string OPTIONAL
paymentContext object OPTIONAL
endUserInterface string OPTIONAL
merchant object OPTIONAL
merchantId string OPTIONAL
terminalId string OPTIONAL
rrn string OPTIONAL
history object[] OPTIONAL
status string OPTIONAL
recordCreationDate string OPTIONAL
processorResult object OPTIONAL

The processor response information. Only present if the transaction was sent to the processor.

status string OPTIONAL
code string OPTIONAL

The processor response code.

message string OPTIONAL

The response message assigned to the given processor response code.

authCode string OPTIONAL

The processor authentication code.

settlementKey string OPTIONAL

[Optional] This value is used to arrange a transaction in a specific batch if the connector has a settlement process.

acquirer string OPTIONAL

[Optional] This value is given by the processor in the response. This value is persisted if it is required.

additionalResponseData object OPTIONAL

[Optional] Contains additional information given by the processor. This information is persisted only if needed.

batchId string OPTIONAL

. Only present if the application key has a settlement close batch process.

meta object OPTIONAL

The query response information

timeRange string OPTIONAL
count integer OPTIONAL

The number of transaction obtained in the response.

totalPages integer OPTIONAL
took string OPTIONAL