Account Transaction Created
The purpose of this webhook is to notify you of a wallet account balance change.
Webhook configuration
To enable in the Viva Wallet banking app:
Log in to Viva Wallet, demo or live , and select the required account.
Visit Settings > API Access > Webhooks.
Click on the Create Webhook link.
The New Webhook dialog box is displayed.Enter your webhook URL in the URL field.
Click on the Verify link.
If verified successfully, a confirmation message is displayed.Choose Account Transaction Created from the Event Type dropdown:
Select the Active checkbox to activate notifications.
Click on the Save button.
Response example
You may find below the sample response with EventTypeId
2054.
{
"Url": "Your webhook URL",
"EventData": {
"Iban": null,
"PersonId": "11ac9cd4-c9ea-48d3-b414-1f10ce664aad",
"WalletId": 2263446434318,
"BankId": null,
"ParentId": "a787e1bb-8101-4043-8618-3b962d8f6cfc",
"Amount": -100.4, //Amount in EUR, GBP, ZLOTY, ETC.
"IsInternal": false,
"StatusId": "F",
"Created": "2022-05-26T03:01:42.457",
"CardNumber": null,
"Description": "Wallet2Wallet Transfer - Merchant Trade Name - [Optional text to show on account statement]",
"ValueDate": null,
"BankAccountId": null,
"CurrencyCode": "978",
"TargetAmount": 10,
"SaleTransactionId": null,
"TargetReserved": 0,
"TargetAvailable": 10,
"TargetOverdraft": 0,
"WalletTransactionId": "6fb74d4a-aa92-4920-a759-49a703834c03",
"InternalDescription": null,
"TypeId": 20,
"SubTypeId": 140
},
"Created": "2022-05-26T00:01:42.4752623Z",
"CorrelationId": "22-146-51FB37DB",
"EventTypeId": 2054,
"Delay": null,
"MessageId": "82606171-a5a3-4330-8a86-548b4344f451",
"RecipientId": "11ac9cd4-c9ea-48d3-b414-1f10ce664aad",
"MessageTypeId": 512
}
Webhook body
You can find below the body parameters of this webhook
Parameter | Description | Example |
---|---|---|
Amount (decimal) | The signed amount of the transaction. Represents the total funds paid by the customer and includes TotalFee (when applicable) | -100.4 |
BankAccountId (uuid) | null | |
BankId (string) | Bank's ID | null |
CardNumber (string) | The card number used (applicable for card related transaction types) | null |
Created (datetime) | Transaction's creation timestamp | "2021-11-04T17:30:24.363" |
CurrencyCode (string) | The currency of the transaction in ISO 4217 numeric format (e.g. “978” for Euro) | "978" |
Description (string) | This description is related to the wallet transaction | "Μεταφορά Wallet2Wallet - George Mitsiou - Test Description" |
Iban (string) | The Iban the wallet owner sent a bank transfer to | null | InternalDescription (string) | This description is related to the wallet transaction | null |
IsInternal (boolean) | True, if the wallet Trn was created through internal viva wallet operations | false |
ParentId (uuid) | The parent TransactionId (if any) of the current transaction | "d1b9242b-5665-44a0-903b-7325b235ca2f" |
PersonId (uuid) | The Id of the person/merchant that initiated the action, or who billing created an obligation for | "bdf4c6b3-c26d-4046-b5df-5c443ec39d09" |
SaleTransactionId (uuid) | The core transaction which is matched to the wallet transaction which generated this event. (e.g. a paid order which resulted in a balance change of a wallet) | null |
StatusId (string) | The status of the transaction | "F" |
SubTypeId (uuid) | The wallet subtypeId | 140 |
TypeId (uuid) | The wallet typeId | 20 |
ValueDate (datetime) | The settlement date of the bank transfer, if the wallet Trn was created from a bank transfer | null |
WalletId (uuid) | The wallet from which the transaction was initiated | 657297971060 |
WalletTransactionId (uuid) | The Id of the wallet transaction that was created as a result of this transaction | "ea312e33-25ef-4858-886f-6298898f4249" |
EventTypeId (int) | The type of the event that triggered the notification | 2054 |
MessageId (uuid) | Unique identifier of the message | "5798c886-6ad7-40ea-bb3f-4b12f16b195b" |
Get Support
If you have any questions about our solutions, or questions about how to integrate with our solutions, please refer to our Get Support page.