v1

latestOpenAPI 3.0.32026-07-24148824715.6 KB

Transactions

Retrieve a Transaction using your identifier as a reference

When you submit a Transaction to us, you provide us with your identifier for the Transaction. This API allows you to retrieve a Transaction using this identifier you supplied to us.

get/v3/transactions/external/{identifier}

Path parameters

identifierstring required

Your identifier for the transaction.

Example:YourUniqueTransactionIdentifier

Your identifier for the transaction.

Response

Stored Transaction Information

customer_external_identifierstring required

Your unique identifier for customer that the Transaction is associated with. We will populate this after mapping your customer identifier to ours as we process your Transaction.

customer_identifierstring uuid required

Our unique identifier for customer that the Transaction is associated with. We will populate this after mapping your customer identifier to ours as we process your Transaction.

evaluation_outcome'PENDING' | 'PROCESS' | 'ALLOW' | 'HOLD' | 'ERROR' required

The combined outcome of all transaction evaluations.

external_identifierstring required

Your unique identifier for the Transaction. You will use this to reference the Transaction within our systems. This cannot be changed after submitting the Transaction.

identifierstring uuid nullable

Our unique identifier for your Transaction. We generate this when we process your Transaction and you are not able to specify it.

occurred_atstring date-time required

The timestamp of the Transaction. This is the timestamp you want us to use as this transactions position in time for the purposes of risk analysis. This timestamp can contain offset information.

received_atstring date-time nullable

The timestamp the Transaction event was received by us.

review_decision'NOT_APPLICABLE' | 'NOT_REVIEWED' | 'RELEASE' | 'REJECT' required

Represents the states of review decision

versioninteger required

The version of the transaction.