Webhooks for payments

Viva Wallet supports webhooks, a simple and powerful solution that allows you to receive notifications each time a specific event takes place.

• Overview
• Webhook URL verification
• Events
• Retry policy
• Viva Wallet IP addresses for whitelisting
• Further information

Overview

To receive webhook notifications, you need to create a public URL resource that can receive (via POST) objects of type Message<TransactionEventData>.

Message has the following properties:

• EventData ( TransactionEventData ): the actual notification
• EventTypeId ( int ): the type of the event that triggered the notification
• Created ( datetime ): the date and time the notification was initially created

TransactionEventData has the following properties:

• Amount ( decimal ): the signed amount of the transaction. Represents the total funds paid by the customer and includes TotalFee
• CardNumber ( string ): the card number used (applicable for card related transaction types)
• CardTypeId ( byte ): Possible values 0(Visa), 1(Mastercard), 2(Diners), 3(Amex), 4(Invalid), 5(Uknown), 6(Maestro), 7(Discover), 8(JCB)
• CompanyName ( string ): the company name of the Merchant
• CurrencyCode ( string ): the currency of the transaction in ISO 4217 numeric format (e.g. “978” for Euro)
• CurrentInstallment ( byte ): the current installment ordinal (use in relation with TotalInstallments parameter)
• CustomerTrns ( string ): the CustomerTrns property as set during the creation of the Order
• Email ( string ): customer email
• FullName ( string ): customer Fullname
• InsDate ( datetime ): the date and time the transaction took place
• MerchantId ( uuid ): the MerchantId of the Merchant
• MerchantTrns ( string ): the MerchantTrns property as set during the creation of the Order
• OrderCode ( long ): the OrderCode of the transaction
• ParentId ( uuid ): the parent TransactionId (if any) of the current transaction
• ResellerCompanyName ( string ): the name of the Reseller (if any) that received the payment
• ResellerId ( uuid ): the ResellerId of the Reseller (if any) that received the payment
• ResellerSourceAddress ( string ): the address of the source of the Reseller (if any) that received the payment
• ResellerSourceCode ( string ): the SourceCode of the source of the Reseller (if any) that received the payment
• SourceCode ( string ): the SourceCode of the Merchant used for the transaction
• StatusId ( string ): the status of the transaction
• TargetPersonId ( uuid ): the target logged-in user of the transaction (e.g. for wallet payments, this is the wallet owner id)
• TotalCommission ( decimal ): the signed total commission of the transaction
• TotalFee ( decimal ): the signed fees that apply to the transaction (e.g. if paid through reseller network)
• TotalInstallments ( byte ): the total installments of the transaction
• TransactionId ( uuid ): the TransactionId of the transaction
• TransactionTypeId ( int ): the type of transaction

Events

The following events are available for which a notification can be sent:

• Obligation Created
• Obligation Captured
• Account Transaction Created
• Transaction Payment Created
• Transaction Price Calculated
• Transaction Reversal Created
• Transaction Failed
• Command Bank Transfer Created
• Command Bank Transfer Executed

Webhook URL verification

The API call below uses basic auth.

To receive your unique webhook authorization code, all you need to do is call the following API action with standard API authentication headers. Set the response to application/json. The demo environment has a base URL of https://demo.vivapayments.com/ and for the live environment it’s https://www.vivapayments.com/.

{
  "Key":"B3248222FDCD1885AEAFE51CCC1B5607F00903F6"
}