☰

Navigation:

Account Connected

Notification of a successful account connection.

Overview

Account Connected is a Marketplace- and ISV-related webhook, which is triggered when an account (such as a seller or merchant account) is successfully connected to the platform/ISV account.

Webhook configuration

The below steps refer to Marketplace integrations. If you are instead setting up an ISV integration, please see our ISV Create webhook API call

To enable in the viva banking app:

  1. Log in to Viva, demo or live , and select the required account.

  2. Visit Settings > API Access > Webhooks.

  3. Click on the Create Webhook link.
    The New Webhook dialog box is displayed.

  4. Enter your webhook URL in the URL field.

  5. Click on the Verify link.
    If verified successfully, a confirmation message is displayed.

  6. Choose Account Connected from the Event Type dropdown.

  7. Select the Active checkbox to activate notifications.

  8. Click on the Save button.

Response example

You may find below the sample response with EventTypeId 8193.

{
  "Url": "Your webhook URL",
  "EventData": {
    "PersonId":"1aabc6f0-b419-4be5-b898-12345f4c912f",
    "WalletId":3059898763296,
    "PlatformPersonId":"faa1a888-5651-4bdf-6565-4f41c730a321",
    "ConnectedAccountId":"592d2e2f-11ec-408b-8552-ea06af1d1eee"
  },
  "Created": "2021-05-26T00:01:20.4752112Z",
  "CorrelationId": "22-146-51FB37AA",
  "EventTypeId": 8193,
  "Delay": null,
  "MessageId": "82606171-a5a3-4330-8a86-548b1111f451",
  "RecipientId": "11ac9cd4-c9ea-48d3-b414-1f10ce999aad",
  "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 created person/merchant "1aabc6f0-b419-4be5-b898-12345f4c912f"
WalletId (int64) The ID of the wallet.

For ISV integrations, this is the primary wallet of the Merchant.

For Marketplace integrations, this is a new wallet which is created on the Seller account.		 3059898763296
PlatformPersonId (uuid) The Id of the platform/ISV account "1aabc6f0-b419-4be5-b898-12345f4c912f"
ConnectedAccountId (uuid) The Id of the connected account (such as a seller or merchant account) "592d2e2f-11ec-408b-8552-ea06af1d1eee"
Created (datetime) Transaction's creation timestamp "2021-09-02T07:39:28.8496795Z"
CorrelationId (uuid) Internal Id to track the request flow for debug reasons "21-245-DB33F8C9"
EventTypeId (int) The type of the event that triggered the notification 8193
Delay (string) Delay timespan for messages that are sent at a future date and not instantly null
MessageId (uuid) Unique identifier of the message "e8b09fc2-d4a4-43fc-8251-acd87ad04d96"
RecipientId (uuid) The recipient of the webhook "bdf4c6b3-c26d-4046-b5df-5c443ec39d09"
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!