Payment: Get Payments by Fingerprint

Related API Reference

🔗

Overview

  • This operation retrieves all payments associated with a specific payment instrument fingerprint - a unique identifier derived from a payment method's details (e.g. card number, wallet ID, bank account, etc.).
  • The fingerprint acts as a consistent reference to the same underlying payment instrument, even across different transactions or sessions.
  • Each retrieved payment transaction will include the payment's current status, the details, and any relevant reference data.
  • Use this feature if you need to extract all the payment transactions with a specific payment instrument fingerprint

How It Works


Payment Status Model

Download high-resolution Payment Status Model


The following table summarizes the statuses a payment may go through:

StatusDescription
ACCEPTEDYou submitted a payment request. We verified and accept it, and it has been queued for sending for authorization or capturing (depending on your settings) on our side.
AUTHORIZATION_REQUESTEDWe forwarded your authorisation request to the designated payment method (e.g. bank or wallet). It is now being processed externally; final status pending.
AUTHORIZEDThe payment method has authorised the requested amount on the payer’s account. Following authorisation, the funds may either be captured through a capture request or released via a cancellation request.
CAPTURE_
REQUEST_ACCEPTEDAfter successful authorization, you submitted a capture request. We verified and accept it, and it has been queued for processing.
CAPTURE_
REQUESTEDWe forwarded your capturing request to the designated payment method (e.g. bank or wallet). It is now being processed externally; final status pending.
CAPTUREDThe payment method has captured the authorized amount on the payer’s account.
DECLINEDThe payment may be declined during authorisation (e.g. insufficient funds or account issues) or during capture (e.g. expired authorisation or policy violations).
EXPIREDThe authorisation period has expired — the time window between authorisation and capture or cancellation elapsed without action.
CANCELLATION_
REQUEST_ACEPTEDAfter successful authorization, you submitted a cancellation request. We verified and accept it, and it has been queued for processing
CANCELLATION_
REQUESTEDWe forwarded your cancellation request to the designated payment method (e.g. bank or wallet). It is now being processed externally; final status pending.
CANCELLEDThe payment method has released the authorized amount on the payer’s account and cancelled the payment.
ERRORThe payment failed due to a technical issue; a retry may be required.

When to Use

  • Identify all payments made with the same card, wallet, or bank account.
  • Detect repeated use of a payment instrument across different users or merchants.
  • Investigate suspicious activity or perform fraud analysis.
  • Audit and group transactions linked to a specific payment method.
  • Support customer service by reviewing all transactions tied to a specific payment instrument.

Payment Structure

The table below describes the general information a payment can contain. These top-level fields provide overall context of a payment transaction.

NameDescription
idUnique identifier for the payment transaction
statusCurrent status of the payment transaction
partnerReferencePaymentIdReference ID provided by the partner system for the payment
submittedAmountAmount requested for payment, including value and currency
authAmountAmount authorised by the payment method, including value and currency
exchangeRateExchange rate applied if currency conversion is involved
exchangeSourceName of the source of the exchange rate
paymentMethodInstanceIdIdentifier of the specific payment method instance used
partnerIdUnique identifier of the partner participating in the transaction processing
adminAccountIdIdentifier of the administrative account associated with the payment
settlementAccountIdIdentifier of the settlement account where funds will be credited or debited
payerObject containing personal or business details of the payer
billingAddressBilling address of the payer
errorCodeCode representing the error if the transaction fails
createdAtTimestamp indicating when the disbursement was created
updatedAtTimestamp indicating the last update to the transaction

Full list of attributes is available in API Reference Section