Navigation:

Transfer Created

Notification of a marketplace transfer.

Overview
Webhook configuration
Response example
Webhook body
Get Support

Overview

Transfer Created is a Marketplace-related webhook, which is triggered when a transfer is created in any of the below circumstances, regardless of whether the transfer has yet been executed:

Send funds to a connected account
Create a transfer reversal
Create payment order (when transfers are triggered with the transfer parameter)
Cancel transaction (when transfers are triggered with the reverseTransfers or refundPlatformFee parameters)

Webhook configuration

To enable in the viva banking app:

Log in to Viva, 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 Transfer 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 8448.

{
  "Url": "Your webhook URL",
  "EventData": {
    "PersonId":"fdd6d888-5651-4bdf-9100-4f41c712d156",
    "Amount":24.50,
    "ParentId":null,
    "TransferId":"5f53244a-7e2a-4bc2-bceb-c111da3edb95",
    "CurrencyCode":"978",
    "TargetWalletId":982778784821,
    "TargetPersonId":"bde07eaa-9176-4bf4-9703-2621212742d7",
    "TransactionId":"527cc791-7632-4d64-bdb9-50719e343b37",
    "Executed":null,
    "DebitWalletTransactionId":null,
    "CreditWalletTransactionId":null,
    "TransferTypeId":1
  },
  "Created": "2022-05-26T00:01:42.4752623Z",
  "CorrelationId": "22-146-51FB37DB",
  "EventTypeId": 8448,
  "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
Url (string)	Your webhook URL	"Your webhook URL"
PersonId (uuid)	The Id of the person/merchant that initiated the action	"fdd6d888-5651-4bdf-9100-4f41c712d156"
Amount (decimal)	The amount of the transfer	24.50
ParentId (uuid)	The parent TransactionId (if any) of the current transfer	null
TransferId (uuid)	The Id of the transfer	"5f53244a-7e2a-4bc2-bceb-c111da3edb95"
CurrencyCode (string)	The currency of the transaction in ISO 4217 numeric format (e.g. '978' for Euro)	"978"
TargetWalletId (int64)	The Id of the target wallet	982778784821
TargetPersonId (uuid)	The Id of the target person/merchant	"bde07eaa-9176-4bf4-9703-2621212742d7"
TransactionId (uuid)	The Id of any related transaction/sale. If the transfer is not connected to a transaction, this value will be empty	"527cc791-7632-4d64-bdb9-50719e343b37"
Executed (string)	The date that the transfer was executed. If the transaction is not settled, this value will be empty	null
DebitWalletTransactionId (uuid)	A unique identifier for the debit taken from the source wallet	null
CreditWalletTransactionId (uuid)	A unique identifier for the credit sent to the target wallet	null
TransferTypeId (byte)	The type of the transfer	Possible values are the below: `0`= Invalid `1`= PlatformAmountSettlement `2`=: PlatformFeeSettlement `3`= PlatformAmountRefund `4`=: PlatformFeeRefund
Created (datetime)	Transaction's creation timestamp	"2022-05-26T00:01:42.4752623Z"
CorrelationId (uuid)	Internal Id to track the request flow for debug reasons	"22-146-51FB37DB"
EventTypeId (int)	The type of the event that triggered the notification	8448
Delay (string)	Delay timespan for messages that are sent at a future date and not instantly	null
MessageId (uuid)	Unique identifier of the message	"82606171-a5a3-4330-8a86-548b4344f451"
RecipientId (uuid)	The recipient of the webhook (in this case the merchant)	"11ac9cd4-c9ea-48d3-b414-1f10ce664aad"
MessageTypeId (int)	The type of the message, this will always be webhook for the merchants 0x200 or 0x201 in hex.	512

Get Support

If you would like to integrate with Viva, or if you have any queries about our products and solutions, please see our Contact & Support page to see how we can help!