View transaction by payment ID

Searches for transactions with the given payment ID. You get the payment ID in the Run card transaction or Process transaction from terminal response as the id. Or, in the page event for the ecommerce or retail iframe.

Because you get the paymentId in the response for a transaction, this endpoint is useful for quickly getting transaction information and updates.

Also, you can use this endpoint instead of View transactions when you only need to get information about a single transaction and in order to get all response parameters related to the transaction without needing to request them specifically.

📘

Notes

⚠️

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

Include the payment ID in the path parameter of the request.

Request parameters

  • paymentId

Response parameters

  • id
  • merchantId
  • amount
  • transactionDate
  • transactionStatus
  • authCode
  • transactionType
  • cardType
  • cardNumber
  • cardHolder
  • processMethod
  • achDetailId
  • currencyId
  • reportDate
  • settledDate
  • capturedDate
  • originalTransactionId
  • createdAt
  • updatedAt
  • customer
  • customer.id
  • customer.firstName
  • customer.lastName
  • customer.postalCode
  • customer.phone
  • customer.email
  • customer.company
  • customer.customerRef
  • customer.transactionId
  • kount
  • kount.id
  • kount.status
  • kount.rules
  • kount.refNumber
  • kount.merc
  • kount.score
  • kount.ruleCount
  • kount.warningCount
  • kount.counterCount
  • kount.wasDeviceFingerprinted
  • kount.mode
  • kount.velo
  • kount.vmax
  • kount.transactionId
  • bankTransfer
  • bankTransfer.account
  • bankTransfer.checkNumber
  • bankTransfer.id
  • bankTransfer.routing
  • bankTransfer.transactionId
  • foreignProcessingCurrency
  • foreignProcessingCurrency.amount
  • foreignProcessingCurrency.currencyId
  • foreignProcessingCurrency.id
  • foreignProcessingCurrency.transactionId
  • threeDS
  • threeDS.id
  • threeDS.ECI
  • threeDS.type
  • threeDS.transactionId
  • gateway
  • gateway.gatewayName
  • gateway.refNumber
  • gateway.nsu
  • processor
  • processor.id
  • customerAddresses
  • customerAddresses.billingAddressOne
  • customerAddresses.billingAddressTwo
  • customerAddresses.billingCity
  • customerAddresses.billingCountry
  • customerAddresses.billingPhone
  • customerAddresses.billingPostal
  • customerAddresses.billingState
  • customerAddresses.shippingAddressOne
  • customerAddresses.shippingAddressTwo
  • customerAddresses.shippingCity
  • customerAddresses.shippingCountry
  • customerAddresses.shippingPhone
  • customerAddresses.shippingPostal
  • customerAddresses.shippingState
  • customerAddresses.id
  • customerAddresses.transactionId
  • subscription
  • subscription.id
  • subscription.accountId
  • subscription.initialBalance
  • subscription.interval
  • subscription.intervalCount
  • subscription.remainingBalance
  • subscription.scheduleType
  • subscription.subscriptionRef
  • subscription.transactionId
  • cardMetaData
  • cardMetaData.id
  • cardMetaData.bin
  • cardMetaData.cardBrand
  • cardMetaData.class
  • cardMetaData.countryCode
  • cardMetaData.currencyCode
  • cardMetaData.issuingBank
  • cardMetaData.transactionId
  • plugin
  • plugin.id
  • plugin.originalId
  • plugin.invoice
  • plugin.orderNumber
  • plugin.description
  • plugin.pluginType
  • plugin.paymentOptionTag
  • plugin.transactionId
  • transactionDetails
  • transactionDetails.id
  • transactionDetails.clientIp
  • transactionDetails.customFields
  • transactionDetails.description
  • transactionDetails.installments
  • transactionDetails.installmentUnit
  • transactionDetails.paymentType
  • transactionDetails.retryCount
  • transactionDetails.shoppingCart
  • transactionDetails.userName
  • transactionDetails.transactionId
  • linkedChargebackId
Recipes
💻
Configuring your backend server to listen for requests from the frontend
Open Recipe
✔️
Creating the confirmation page for payment success
Open Recipe
Language
Credentials
Basic
base64
:
Click Try It! to start a request and see the response here!