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
typestring

Type of transaction (ex: DEPOSIT, WITHDRAWAL, TRANSFER, EXTERNAL_PAYMENT, REFUND, OTHER)

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:
originUserIdstring or null
UserId for where the transaction originates from
destinationUserIdstring or null
UserId for transaction's destination. In other words, where the value is being transferred to.
transactionStateenum or null
Model for transaction states. E.g. Processing, Refunded, Successful etc.
originAmountDetailsobject or null
Model for transaction amount details
destinationAmountDetailsobject or null
Model for transaction amount details
originPaymentDetailsobject or null
Payment details of the origin. It can be a bank account number, wallet ID, card fingerprint etc.
destinationPaymentDetailsobject or null
originFundsInfoobject or null
Model for origin funds information
relatedTransactionIdslist of strings or null

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

productTypestring or null

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

promotionCodeUsedboolean or null
Whether a promotion code was used or not the transaction
referencestring or null>=1 character
Reference field for the transaction indicating the purpose of the transaction etc.
originDeviceDataobject or null
Model for device data
destinationDeviceDataobject or null
Model for device data
tagslist of objects or null
Additional information that can be added via tags
riskScoreDetailsobject or null

Errors