API ReferenceTransactions

Retrieve a Transaction

GET Transactions

/transactions endpoint allows you to operate on the Transaction entity.

Calling GET /transactions/{transactionId} will return the entire transaction payload and rule execution results for the transaction with the corresponding transactionId

Path parameters

transactionIdstringRequired

Unique Transaction Identifier

Headers

x-api-keystringRequired

Response

OK

typeenum
transactionIdstring>=1 character

Unique transaction identifier

timestampdouble>=315529200000<=4133890801000

Timestamp of when transaction took place

executedRuleslist of objects
hitRuleslist of objects
statusenum

Model for rule action if a rule is hit. This is returned in the API response and can be configured on Console by operational accounts like a Compliance Analyst

Allowed values:
originUserIdstringOptional

UserId for where the transaction originates from

destinationUserIdstringOptional

UserId for transaction’s destination. In other words, where the value is being transferred to.

transactionStateenumOptional

Model for transaction states. E.g. Processing, Refunded, Successful etc.

originAmountDetailsobjectOptional

Model for transaction amount details

destinationAmountDetailsobjectOptional

Model for transaction amount details

originPaymentDetailsobjectOptional

Payment details of the origin. It can be a bank account number, wallet ID, card fingerprint etc.

destinationPaymentDetailsobjectOptional
originFundsInfoobjectOptional

Model for origin funds information

relatedTransactionIdslist of stringsOptional

IDs of transactions related to this transaction. Ex: refund, split bills

productTypestringOptional

Type of produce being used by the consumer (ex wallets, payments etc)

promotionCodeUsedbooleanOptional

Whether a promotion code was used or not the transaction

referencestringOptional>=1 character

Reference field for the transaction indicating the purpose of the transaction etc.

originDeviceDataobjectOptional

Model for device data

destinationDeviceDataobjectOptional

Model for device data

tagslist of objectsOptional

Additional information that can be added via tags

riskScoreDetailsobjectOptional

Errors