A Transaction represents the movement of funds between accounts, merchants, or beneficiaries. Transactions can occur for various purposes, including payouts, payins, transfers, and exchanges. Each transaction has specific attributes that define its details and status.
Transactions enable operations such as:
- Sending funds to another account.
- Receiving funds from various sources.
- Exchanging currencies between accounts with different currencies.
- Transferring funds between accounts within the same currency.
| Attribute | Description | Format |
|---|---|---|
| transactionId | Unique identifier of the transaction. | UUID e.g., 5def2f43-2c81-4230-85b2-c8a62f7460c9 |
| shortId | Simplified identifier for the transaction. | String e.g., 241014IEXJRRDR |
| createdAt | Timestamp when the transaction was created. | ISO 8601 Timestamp e.g., 2025-01-01T00:00:00.000000Z |
| amount | Amount of money involved in the transaction. | Object including currency (e.g., EUR) and value (e.g., 100.00) |
| status | Current status of the transaction. | INITIATED, WAITING_FOR_CANCELATION, FAILED, COMPLETED, PROCESSING, REVIEWED |
| type | Type of transaction. | PAYOUT, PAYIN, TRANSFER, FEE, SELL, EXTERNAL_PAYOUT, EXTERNAL_PAYIN |
| tenantId | Identifier of the tenant associated with the transaction. | UUID e.g., 5def2f43-2c81-4230-85b2-c8a62f7460c9 |
| merchantId | Identifier of the merchant associated with the transaction. | UUID e.g., 5def2f43-2c81-4230-85b2-c8a62f7460c9 |
| sourceAccountId | Identifier of the source account for the transaction. | UUID e.g., 5def2f43-2c81-4230-85b2-c8a62f7460c9 |
| destinationAccountId | Identifier of the destination account for the transaction. | UUID e.g., 5def2f43-2c81-4230-85b2-c8a62f7460c9 |
| beneficiary | Details of the transaction's beneficiary, if applicable. | Object containing attributes like bankName, iban, walletAddress, etc. |
| sender | Details of the sender, if applicable. | Object containing attributes like bankName, iban, walletAddress, etc. |
| note | Additional note or description for the transaction. | String |
| exchangeRate | Exchange rate applied during the transaction, if applicable. | Decimal e.g., 1.15 |
| feeAmount | Fee charged for the transaction. | Object including currency and value |
| transactionHash | Hash of the transaction for blockchain verification. | |
| endToEndReference | Reference for end-to-end tracking of the transaction. | |
| notifyUrl | Notification URL to receive updates about the transaction. | |
| related | Indicates if the transaction is related to another. | Boolean e.g., true, false |
| buyAmount | Amount to buy in the transaction, if applicable. | Object including currency and value |
| sellAmount | Amount to sell in the transaction, if applicable. | Object including currency and value |
| feeFromAmount | Whether the fee is deducted from the transaction amount. | Boolean e.g., true, false |
| externalTransactionId | External reference ID for the transaction. | |
| reference | Internal reference for the transaction. |