Obligation Captured
Notification that a marketplace obligation has been captured.
OBLIGATIONS ARE NOW DEPRECATED - PLEASE SEE OUR UPDATED MARKETPLACE SCHEMA
Overview
When a marketplace obligation request has been made, the process will be queued - i.e. this is an automated, non-instant process.
When the obligation is ultimately captured, this webhook (Obligation Captured) will be sent as confirmation of the credit, and the specific amount will be credited to the platform account.
When this obligation request was originally sent to the seller, the Obligation Created webhook will have been sent
Webhook configuration
To enable within 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 Obligation Captured 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 5633.
{
"PersonId": "51638f3b-4d32-4837-a47d-b6917953a183",
"WalletId": 952270799561,
"Amount": 110.0,
"CaptureId": "4daa2301-dec8-4085-8f99-31859cbc71c1",
"ObligationId": "c9dfa962-e2e9-4bff-92eb-072ac7c0baa2",
"CurrencyCode": "978",
"TargetPersonId": "c942b8ce-6da4-4c37-9e72-052d325bc25b",
"TargetWalletId": 596786726505,
"CancellationId": null,
"Created": "2021-10-25T15:36:21.8817+03:00",
"Completed": "2021-10-25T15:36:25.0184+03:00",
"WalletTransactionSubTypeId": 159
}Webhook body
You can find below the body parameters of this webhook
| Parameter | Description | Example |
|---|---|---|
| PersonId (uuid) | The Id of the person/merchant that initiated the action, or who billing created an obligation for | "51638f3b-4d32-4837-a47d-b6917953a183" |
| WalletId (int64) | The wallet from which the transaction was initiated | 952270799561 |
| Amount (decimal) | The signed amount of the transaction. Represents the total funds paid by the customer and includes TotalFee (when applicable) | 110.0 |
| CaptureId (uuid) | Null in created, the Id of the capture for obligation captured event | "4daa2301-dec8-4085-8f99-31859cbc71c1" |
| ObligationId (uuid) | The internal id of the obligation – populated in both cases | "c9dfa962-e2e9-4bff-92eb-072ac7c0baa2" |
| CurrencyCode (string) | The currency of the transaction in ISO 4217 numeric format (e.g. “978” for Euro) | "978" |
| TargetPersonId (uuid) | The target logged-in user of the transaction (e.g. for wallet payments, this is the wallet owner id) | "c942b8ce-6da4-4c37-9e72-052d325bc25b" |
| TargetWalletId (int64) | The target wallet of the transaction | 596786726505 |
| CancellationId (uuid) | This only has a value in obligation canceled event (corresponds to the unique Id of the cancelation), null otherwise | null |
| Created (datetime) | Transaction's creation timestamp | "2021-10-25T15:39:08.9297+03:00" |
| Completed (datetime) | Date time of the obligation completion | "2021-10-25T15:36:25.0184+03:00" |
| WalletTransactionSubTypeId (uuid) | Subtype Ids | WalletObligationReserve = 157 WalletObligationUnreserve = 158 WalletObligation = 159 |
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!