View transactions

get

https://api.nexiopaysandbox.com/transaction/v3

The endpoint returns all transactions that meet the specified parameters and that are associated with the Nexio account used to authenticate.

You request (or filter) on fields of the query parameters as in the following example:

/transaction/v3?kount.&plugin.&customer.&processor.&gateway.

See the Finding a transaction topic in Guides for a full tutorial.

The default response only includes a small number of parameters. If you want additional objects and parameters, you must specify them in the request. For more information about how to do this, see the Requesting additional response parameters topic in Guides.

Warning

You must specify at least one parameter. Failing to submit one results in an Internal Server Error. Also, it is not possible to send a request with all parameters. Doing so results in a 400 error and the system does not return a response.

Notes

It may take up to a minute after a transaction is run before you can see it in the response for this endpoint.
If you want to search for a transaction by paymentId, you should use the View transaction by payment ID endpoint so that you get all the details for the transaction. Alternately, include the value of the paymentId in the plugin.originalId query parameter in this endpoint along with any additional response parameters.
If you want to search for a transaction by transactionId, you should use the View transaction by transaction ID endpoint so that you get all the details for the transaction. Alternately, include the transaction ID value in the id or transactionId (within any object) query parameter in this endpoint along with any additional response parameters.

Try It

To use the Try It feature for this endpoint, you can use the credentials for your Sandbox API user.

You can also use the following test account. Copy the value and paste it into the appropriate space in the Try It section to the right. username: [email protected] password: JZdzoXpdDeH6VA

When you use the test account, in order to avoid potential security issues, the system returns a set of test transactions. No other transactions that you may have run previously display in the results.

Request parameters

achDetailId
amount
authCode
bankTransfer
bankTransfer.account
bankTransfer.checkNumber
bankTransfer.id
bankTransfer.routing
bankTransfer.transactionId
capturedDate
cardNumber
cardHolder
cardType
createdAt
currencyId
customer
customer.company
customer.customerRef
customer.email
customer.firstName
customer.id
customer.lastName
customer.postalCode
customer.phone
customer.transactionId
customerAddresses
customerAddresses.billingAddressOne
customerAddresses.billingAddressTwo
customerAddresses.billingCity
customerAddresses.billingCountry
customerAddresses.billingPhone
customerAddresses.billingPostalCode
customerAddresses.billingState
customerAddresses.shippingAddressOne
customerAddresses.shippingAddressTwo
customerAddresses.shippingCity
customerAddresses.shippingCountry
customerAddresses.shippingPhone
customerAddresses.shippingPostalCode
customerAddresses.shippingState
customerAddresses.id
customerAddresses.transactionId
endDate
foreignProcessingCurrency
foreignProcessingCurrency.amount
foreignProcessingCurrency.currencyId
foreignProcessingCurrency.id
foreignProcessingCurrency.transactionId
gateway
gateway.additionalRefNumber
gateway.batchRef
gateway.gatewayType
gateway.id
gateway.merchantId
gateway.message
gateway.trackingCode
gateway.refNumber
gateway.transactionId
gateway.nsu
id
kount
kount.counterCount
kount.id
kount.merc
kount.mode
kount.refNumber
kount.ruleCount
kount.rules
kount.score
kount.status
kount.transactionId
kount.velo
kount.vmax
kount.warningCount
kount.wasDeviceFingerprinted
linkedChargebackId
merchantIds
originalTransactionId
plugin
plugin.description
plugin.id
plugin.invoice
plugin.orderNumber
plugin.originalId
plugin.paymentOptionTag
plugin.pluginType
plugin.transactionId
plugin.userId
processMethod
processor
processor.batchRef
processor.id
processor.originalId
processor.processorType
processor.transactionId
processor.transactionRef
reportDate
settledDate
startDate
subscription
subscription.accountId
subscription.id
subscription.initialBalance
subscription.interval
subscription.intervalCount
subscription.remainingBalance
subscription.scheduleType
subscription.subscriptionRef
subscription.transactionId
transactionDate
transactionDetails
transactionDetails.clientIp
transactionDetails.customFields
transactionDetails.description
transactionDetails.id
transactionDetails.paymentType
transactionDetails.retryCount
transactionDetails.shoppingCart
transactionDetails.transactionId
transactionDetails.userName
transactionStatus
transactionType
updatedAt
limit
offset

Response parameters

offset
limit
rows
rows.id
rows.merchantId
rows.amount
rows.transactionDate
rows.transactionStatus
rows.authCode
rows.transactionType
rows.cardType
rows.cardNumber
rows.cardHolder
rows.processMethod
rows.achDetailId
rows.currencyId
rows.reportDate
rows.settledDate
rows.capturedDate
rows.originalTransactionId
rows.createdAt
rows.updatedAt
rows.customer
rows.customer.id
rows.customer.firstName
rows.customer.lastName
rows.customer.postalCode
rows.customer.phone
rows.customer.email
rows.customer.company
rows.customer.customerRef
rows.customer.transactionId
rows.kount
rows.kount.id
rows.kount.status
rows.kount.rules
rows.kount.refNumber
rows.kount.merc
rows.kount.score
rows.kount.ruleCount
rows.kount.warningCount
rows.kount.counterCount
rows.kount.wasDeviceFingerprinted
rows.kount.mode
rows.kount.velo
rows.kount.vmax
rows.kount.transactionId
rows.bankTransfer
rows.bankTransfer.account
rows.bankTransfer.checkNumber
rows.bankTransfer.id
rows.bankTransfer.routing
rows.bankTransfer.transactionId
rows.foreignProcessingCurrency
rows.foreignProcessingCurrency.amount
rows.foreignProcessingCurrency.currencyId
rows.foreignProcessingCurrency.id
rows.foreignProcessingCurrency.transactionId
rows.threeDS
rows.threeDS.id
rows.threeDS.ECI
rows.threeDS.type
rows.threeDS.transactionId
rows.gateway
rows.gateway.gatewayName
rows.gateway.refNumber
rows.gateway.nsu
rows.processor
rows.processor.id
rows.customerAddresses
rows.customerAddresses.billingAddressOne
rows.customerAddresses.billingAddressTwo
rows.customerAddresses.billingCity
rows.customerAddresses.billingCountry
rows.customerAddresses.billingPhone
rows.customerAddresses.billingPostal
rows.customerAddresses.billingState
rows.customerAddresses.shippingAddressOne
rows.customerAddresses.shippingAddressTwo
rows.customerAddresses.shippingCity
rows.customerAddresses.shippingCountry
rows.customerAddresses.shippingPhone
rows.customerAddresses.shippingPostal
rows.customerAddresses.shippingState
rows.customerAddresses.id
rows.customerAddresses.transactionId
rows.subscription
rows.subscription.id
rows.subscription.accountId
rows.subscription.initialBalance
rows.subscription.interval
rows.subscription.intervalCount
rows.subscription.remainingBalance
rows.subscription.scheduleType
rows.subscription.subscriptionRef
rows.subscription.transactionId
rows.cardMetaData
rows.cardMetaData.id
rows.cardMetaData.bin
rows.cardMetaData.cardBrand
rows.cardMetaData.class
rows.cardMetaData.countryCode
rows.cardMetaData.currencyCode
rows.cardMetaData.issuingBank
rows.cardMetaData.transactionId
rows.plugin
rows.plugin.id
rows.plugin.originalId
rows.plugin.invoice
rows.plugin.orderNumber
rows.plugin.description
rows.plugin.pluginType
rows.plugin.paymentOptionTag
rows.plugin.transactionId
rows.transactionDetails
rows.transactionDetails.id
rows.transactionDetails.clientIp
rows.transactionDetails.customFields
rows.transactionDetails.description
rows.transactionDetails.installments
rows.transactionDetails.installmentUnit
rows.transactionDetails.paymentType
rows.transactionDetails.retryCount
rows.transactionDetails.shoppingCart
rows.transactionDetails.userName
rows.transactionDetails.transactionId
hasMore

Query Params

limit

integer

Defaults to 10

Specifies the maximum number of transactions to return in a single API response. For example, if you set limit=20, the API returns up to 20 transactions starting from the position specified by the offset parameter.

offset

integer

Defaults to 0

Specifies the starting point within the list of transactions. Use it in conjunction with the limit parameter to control which subset of transactions the API returns. For example, if you set offset=10 and limit=20, the API skips the first 10 transactions and returns the next 20 transactions (in other words, transactions 11 to 30).

startDate

string

The start date. Format: YYYY-MM-DD. The default value is 30 days prior to the current date.

endDate

string

The end date. Format: YYYY-MM-DD. The default is the current date.

string

The Nexio ID of the transaction. This is also known as the Transaction ID.

You can also use this value in the View transaction by transaction ID endpoint or for this endpoint within any object as the transactionId.

merchantIds

string

A comma-separated list of one or more merchant IDs. Each value is used as the input for an exact search of the merchant ID for a transaction.

amount

number

0 to 99999999999999.98

The transaction amount. This value is used as the input for a fuzzy search. The maximum value has 16 digits total, including up to two of those digits after the decimal point.

authCode

string

length ≤ 50

Represents a successfully authorized payment request. This value is used as the input for a fuzzy search.

transactionStatus

integer

One or more transaction statuses. For information about valid values, see the relevant transactionStatus table in Guides.

transactionType

integer

The transaction type. For information about valid values, see the transactionType table in Guides.

cardType

integer

enum

The code for the Nexio card type. For information about valid values, see the cardType table in Guides.

Allowed:

cardNumber

string

length ≤ 20

The masked card number. This value is used as the input for a fuzzy search.

cardHolder

string

length ≤ 200

The cardholder's name as it appears on the card. This value is used as the input for a fuzzy search.

processMethod

integer

The process method code. For information about valid values, see the processMethod table in Guides.

achDetailId

string

length ≤ 50

The Deposit Detail ID that corresponds to this transaction. This value is used as the input for a fuzzy search.

currencyId

string

length ≤ 3

Defaults to 840

The three-digit ISO numeric currency code. The default value is the code for the US dollar (840). For information about valid values, see the currency table in Guides.

originalTransactionId

integer

The original transaction ID of a refunded transaction.

customer.

string

Send this as an empty query parameter in order to have all customer data for the transaction returned in the response. For example, https://{api_url}/transaction/v3?customer.&plugin.originalId=PAYMENT_ID, returns all transactions matching the specified PAYMENT_ID and gives all information from the customer object in the response. Alternately, you can instead send a specific customer parameter to match against and you will get the customer object in the matching transactions.

customer.id

integer

The transaction's unique ID for the customer. Note that the same customer will have different IDs for each transaction. Therefore, you cannot expect to use this value to track a specific customer. Instead, provide a customer.customerRef value in transaction requests for a specific customer and then use that value in querying for a customer's transactions.

customer.firstName

string

length ≤ 50

The customer's first name. This value is used as the input for a fuzzy search.

customer.lastName

string

length ≤ 50

The customer's last name. This value is used as the input for a fuzzy search.

customer.postalCode

string

length ≤ 20

The customer's postal code. This value is used as the input for a fuzzy search.

customer.phone

string

length ≤ 20

The customer's phone number. This value is used as the input for a fuzzy search.

customer.email

string

length ≤ 150

The customer's email address. This value is used as the input for a fuzzy search.

customer.company

string

length ≤ 200

The customer's company. This value is used as the input for a fuzzy search.

customer.customerRef

string

length ≤ 50

Customer identifier. If included in the request, the system only searches for exact matches to the value.

kount.

string

Send this as an empty query parameter in order to have all kount data for the transaction returned in the response. For example, https://{api_url}/transaction/v3?kount.&plugin.originalId=PAYMENT_ID, returns all transactions matching the specified PAYMENT_ID and gives all information from the kount object in the response. Alternately, you can instead send a specific kount parameter to match against and you will get the kount object in the matching transactions.

kount.id

integer

Nexio's unique identifier.

kount.status

string

length ≤ 20

The fraud status. This value is used as the input for a fuzzy search.

kount.rules

string

length ≤ 10000

Kount-specific information, including rules triggered. See our Fraud tutorial for more information. This value is used as the input for a fuzzy search.

kount.refNumber

string

length ≤ 100

The transaction reference number. This value is used as the input for a fuzzy search.

kount.merc

string

length ≤ 100

The Kount merchant ID (Different from Nexio's Merchant ID). This value is used as the input for a fuzzy search.

kount.score

string

length ≤ 20

The Kount fraud score. This value is used as the input for a fuzzy search.

kount.ruleCount

integer

The number of rules triggered.

kount.warningCount

integer

The number of warnings triggered.

kount.counterCount

integer

Custom Kount counter. For more information, see the Kount documentation.

kount.wasDeviceFingerprinted

boolean

Will be true if the device was fingerprinted.

kount.mode

string

length ≤ 20

The Kount inquiry mode. This value is used as the input for a fuzzy search.

kount.velo

integer

The 14 day velocity. For more information, see Kount's documentation.

kount.vmax

integer

The 6 hour rolling velocity. For more information, see Kount's documentation.

bankTransfer.

string

Send this as an empty query parameter in order to have all bankTransfer data for the transaction returned in the response. For example, https://{api_url}/transaction/v3?bankTransfer.&plugin.originalId=PAYMENT_ID, returns all transactions matching the specified PAYMENT_ID and gives all information from the bankTransfer object in the response. Alternately, you can instead send a specific bankTransfer parameter to match against and you will get the bankTransfer object in the matching transactions. NOTE: This object only applies to transactions involving an eCheck.

bankTransfer.id

integer

The Nexio-generated unique identifier for the bank record associated with an eCheck payment.

bankTransfer.account

string

length ≤ 20

The masked account number for the bank record associated with an eCheck payment used for the transaction. Only the last four numbers of the account display.

bankTransfer.routing

string

length ≤ 20

The masked routing number for the bank record associated with an eCheck payment used for the transaction.

bankTransfer.checkNumber

string

length ≤ 20

deprecated

The check number associated with an eCheck payment used for the transaction.

plugin.

string

Send this as an empty query parameter in order to have all plugin data for the transaction returned in the response. For example, https://{api_url}/transaction/v3?plugin.&startDate=2021-06-25, returns all transactions matching the specified start date and gives all information from the plugin object in the response. Alternately, you can instead send a specific plugin parameter to match against and you will get the plugin object in the matching transactions.

plugin.id

integer

Nexio's plugin ID.

plugin.originalId

string

length ≤ 255

The Payment ID (paymentId) for the transaction. This value is used as the input for an exact search.

plugin.invoice

string

length ≤ 50

The invoice number. This value is used as the input for a fuzzy search.

plugin.orderNumber

string

length ≤ 50

The order number. This value is used as the input for a fuzzy search.

plugin.description

string

length ≤ 200

The order description. This value is used as the input for a fuzzy search.

plugin.userId

string

deprecated

The user ID.

plugin.pluginType

integer

Nexio's plugin type.

plugin.paymentOptionTag

string

length ≤ 50

A custom value used to route transactions to a specific gateway or merchant account. Contact Integrations Support to designate a paymentOptionTag for a given merchant account. This value is used as the input for a fuzzy search.

foreignProcessingCurrency.

string

Send this as an empty query parameter in order to have all foreignProcessingCurrency data for the transaction returned in the response. For example, https://{api_url}/transaction/v3?foreignProcessingCurrency.&plugin.originalId=PAYMENT_ID, returns all transactions matching the specified PAYMENT_ID and gives all information from the foreignProcessingCurrency object in the response. Alternately, you can instead send a specific foreignProcessingCurrency parameter to match against and you will get the foreignProcessingCurrency object in the matching transactions.

foreignProcessingCurrency.id

integer

Nexio's unique identifier.

foreignProcessingCurrency.amount

number

0 to 99999999999999.98

The amount. The maximum value has 16 digits total, including up to two of those digits after the decimal point.

foreignProcessingCurrency.currencyId

string

length ≤ 3

The three-digit ISO numeric currency code. For information about valid values, see the currency table in Guides.

gateway.

string

Send this as an empty query parameter in order to have all gateway data for the transaction returned in the response. For example, https://{api_url}/transaction/v3?gateway.&plugin.originalId=PAYMENT_ID, returns all transactions matching the specified PAYMENT_ID and gives all information from the gateway object in the response. Alternately, you can instead send a specific gateway parameter to match against and you will get the gateway object in the matching transactions.

gateway.id

integer

Unique gateway identifier.

transaction_gateway.nsu

string

A code returned by specific gateways when a transaction used the BRL currency. This value is used as the input for a fuzzy search.

gateway.merchantId

string

length ≤ 20

The merchant ID associated with the transaction. This value is used as the input for a fuzzy search.

gateway.batchRef

string

length ≤ 50

Reference to a batch number from the gateway about a transaction. This value is used as the input for a fuzzy search.

gateway.refNumber

string

length ≤ 100

Reference number from the gateway for the transaction. This value is used as the input for a fuzzy search.

gateway.additionalRefNumber

string

length ≤ 100

Extra field for referencing a transaction that the gateway uses. This value is used as the input for a fuzzy search.

gateway.trackingCode

string

length ≤ 100

deprecated

Tracking code used by the gateway. This value is used as the input for a fuzzy search.

gateway.gatewayType

integer

The gateway type, expressed as an integer.

gateway.message

string

length ≤ 250

Message from the gateway about the transaction. This value is used as the input for a fuzzy search.

processor.

string

Send this as an empty query parameter in order to have all processor data for the transaction returned in the response. For example, https://{api_url}/transaction/v3?processor.&plugin.originalId=PAYMENT_ID, returns all transactions matching the specified PAYMENT_ID and gives all information from the processor object in the response. Alternately, you can instead send a specific processor parameter to match against and you will get the processor object in the matching transactions. Details will vary by processor. Do NOT code to any information included in this object.

processor.id

integer

A Nexio ID for the processor information associated with this transaction.

processor.transactionRef

string

length ≤ 50

Reference number for the transaction associated with this processor. This value is used as the input for a fuzzy search.

processor.batchRef

string

length ≤ 50

Reference to a batch number from the processor about a transaction. This value is used as the input for a fuzzy search.

processor.originalId

integer

The original ID, if available.

processor.processorType

integer

The processor type, expressed as an integer.

customerAddresses.

string

Send this as an empty query parameter in order to have all customerAddresses data for the transaction returned in the response. For example, https://{api_url}/transaction/v3?customerAddresses.&plugin.originalId=PAYMENT_ID, returns all transactions matching the specified PAYMENT_ID and gives all information from the customerAddresses object in the response. Alternately, you can instead send a specific customerAddresses parameter to match against and you will get the customerAddresses object in the matching transactions.

customerAddresses.id

integer

Nexio's unique identifier for the customer address record.

customerAddresses.billingAddressOne

string

length ≤ 200

The street address for the customer. This value is used as the input for a fuzzy search.

customerAddresses.billingAddressTwo

string

length ≤ 200

Additional street address information, if required. This value is used as the input for a fuzzy search.

customerAddresses.billingCity

string

length ≤ 50

The city for the address record. This value is used as the input for a fuzzy search.

customerAddresses.billingState

string

length ≤ 50

The state or province on file. (If in the US, this must be the two-character state abbreviation). This value is used as the input for a fuzzy search.

customerAddresses.billingPostalCode

string

length ≤ 20

The postal code on file. This value is used as the input for a fuzzy search.

customerAddresses.billingCountry

string

length ≤ 50

The country for the billing address. This value is used as the input for a fuzzy search.

customerAddresses.billingPhone

string

length ≤ 20

The billing phone number. This value is used as the input for a fuzzy search.

customerAddresses.shippingAddressOne

string

length ≤ 200

The shipping address, if different from the billing address. This value is used as the input for a fuzzy search.

customerAddresses.shippingAddressTwo

string

length ≤ 200

Additional shipping address information, if required. This value is used as the input for a fuzzy search.

customerAddresses.shippingCity

string

length ≤ 50

The shipping city. This value is used as the input for a fuzzy search.

customerAddresses.shippingState

string

length ≤ 50

The shipping state or province. (If in the US, this must be the two-character state abbreviation). This value is used as the input for a fuzzy search.

customerAddresses.shippingPostalCode

string

length ≤ 20

The shipping postal code. This value is used as the input for a fuzzy search.

customerAddresses.shippingCountry

string

length ≤ 50

The country for the shipping address. This value is used as the input for a fuzzy search.

customerAddresses.shippingPhone

string

length ≤ 20

The shipping phone number. This value is used as the input for a fuzzy search.

transactionDetails.

string

Send this as an empty query parameter in order to have all transactionDetails data for the transaction returned in the response. For example, https://{api_url}/transaction/v3?transactionDetails.&plugin.originalId=PAYMENT_ID, returns all transactions matching the specified PAYMENT_ID and gives all information from the transactionDetails object in the response. Alternately, you can instead send a specific transactionDetails parameter to match against and you will get the transactionDetails object in the matching transactions.

transactionDetails.id

integer

Unique identifier for the transaction details.

transactionDetails.description

string

length ≤ 255

Description of the transaction. This value is used as the input for a fuzzy search.

transactionDetails.clientIp

string

length ≤ 50

The IP address of where the transaction occurred. This value is used as the input for a fuzzy search.

transactionDetails.userName

string

length ≤ 50

User name of the API user for the transaction. This value is used as the input for a fuzzy search.

transactionDetails.shoppingCart

string

length ≤ 2000

Stringified version of the shoppingCart object for the transaction. This value is used as the input for a fuzzy search.

transactionDetails.customFields

string

length ≤ 2000

Stringified version of the customFields object for the transaction. This value is used as the input for a fuzzy search.

transactionDetails.retryCount

integer

The number of retries for the transaction.

transactionDetails.paymentType

string

length ≤ 30

Indicates the type of transaction being processed (one-time or recurring) using stored payment credentials. For information about the possible options, see Payment type in Guides. This value is used as the input for a fuzzy search.

subscription.

string

Send this as an empty query parameter in order to have all subscription data for the transaction returned in the response. For example, https://{api_url}/transaction/v3?subscription.&plugin.originalId=PAYMENT_ID, returns all transactions matching the specified PAYMENT_ID and gives all information from the subscription object in the response. Alternately, you can instead send a specific subscription parameter to match against and you will get the subscription object in the matching transactions.

subscription.id

integer

Nexio's unique identifier for the subscription.

subscription.remainingBalance

number

≤ 99999999999999.98

The current balance of the pay plan. The maximum value has 16 digits total, including up to two of those digits after the decimal point.

subscription.initialBalance

number

≤ 99999999999999.98

The starting balance of the pay plan. The maximum value has 16 digits total, including up to two of those digits after the decimal point.

subscription.interval

string

enum

length ≤ 20

The schedule's time period. This value is used as the input for a fuzzy search.

Allowed:

subscription.intervalCount

integer

The number of intervals that will pass between transactions. For examples of how the interval and interval count create the subscription schedule, see the subscription schedule examples table.

subscription.subscriptionRef

string

length ≤ 50

Reference number from the merchant for the subscription. This value is used as the input for a fuzzy search.

subscription.accountId

string

length ≤ 50

Identifier for the Nexio account running the subscription. This value is used as the input for a fuzzy search.

subscription.scheduleType

string

enum

length ≤ 20

Type of schedule, given as an integer for whether the subscription is a payment plan (the value for this is 20) or a subscription (the value for this is 10). This value is used as the input for a fuzzy search.

Allowed:

Responses

400

Bad Request

200Success

401Unauthorized. For help with this error and other error codes, see Common errors in the Guides area.