Skip to main content

Get a list of sale transactions.

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

Query Parameters
filter object

This field can contain different param used in the transaction search.

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

page object

Get a sale transactions list of the DB with of the given page number and size.

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]
X-AppKey string REQUIRED

The application key used in the transaction.

Responses
200

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

Schema OPTIONAL
data object[] OPTIONAL

A list of none, one or all the Sales 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 sale transaction information.

refNumber string OPTIONAL

The transaction reference number. It can be used as a filter param to search the transaction.

status string OPTIONAL

The transaction status. If it is not specified in the filter, shows the last transaction status.

billingInfo object OPTIONAL

The amount and taxes information.

total string OPTIONAL

The transaction amount total.

currencyCode string OPTIONAL

The amounts and taxes currency code.

transactionDate string OPTIONAL

The transaction creation date.

transactionTimeZone string OPTIONAL

The transaction time zone.

recordCreationDate string OPTIONAL

The transaction persisted date in the DB.

paymentMethod object OPTIONAL
entryMode object OPTIONAL
cardDataSource string OPTIONAL

The transaction card data information source.

contactless boolean OPTIONAL
fallback boolean OPTIONAL
quickPayment boolean OPTIONAL
cardInfo object OPTIONAL

The card information used in the transaction.

maskedPan string OPTIONAL
brand string OPTIONAL
cardType string OPTIONAL
paymentContext object OPTIONAL

The device information and configuration used in the transaction.

endUserInterface string OPTIONAL
cardPresent boolean OPTIONAL
cardHolderAuthenticationMethod string OPTIONAL
cardHolderAuthenticationEntity string OPTIONAL
establishment object OPTIONAL

The establishment information.

legalName string OPTIONAL
address object OPTIONAL
addressLine1 string OPTIONAL
addressLine2 string OPTIONAL
city string OPTIONAL
state string OPTIONAL
countryCode string OPTIONAL
postalCode string OPTIONAL
rrn string OPTIONAL

The retrieval reference number. This id is given in the processor response.

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.

batch object OPTIONAL
status string OPTIONAL

The status of the batch that contains the searched transaction.

merchant object OPTIONAL
merchantId string OPTIONAL
merchantType string OPTIONAL
terminalId string OPTIONAL
externalData string OPTIONAL
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