Approval topics are for 'general' use scenarios where user permission needs to be granted before an action is taken. Functionally, it behaves similarly, where a request is made to the user and Authvia will negotiate a response from the user. Upon approval from the user, we will initiate a request to the protectedURL provided to execute the intended action, and the controlled response will determine how the user is notified.

The following values are required to be supplied in the context.

Required Fields

To create a topic of this type your conversation must have at least theses two options in the conversation context.

Attribute Name	Example	Description
description	Water Bill Maid Services	Required. The short description presented to the user in explanation for the payment. Keep it to a short title, so it can sound more natural to the user.
protectedURL	https://some.place/com	The endpoint that will have a 'GET' operation executed against it, after approval was granted by the end user. More on this attribute below.

Protected URL

The protectedURL has a specific contract that must be respected.

It must respond within 60 seconds.
It will be invoked via GET request.
It must be https (http is not supported).
The response status code must be in the 2xx range.
The response must be JSON, with 'success' a boolean value.

Optionally, you can configure the URL and response using the following.

The URL can contain {conversation-id}, {merchant-id} and/or {customer-ref} to have the actual values pertaining to the conversation coerced into the URL before it is invoked.
The response body can optionally contain a message attribute with a string value.