Collaborative authorization is a card product feature that empowers you to approve or decline transactions in real time based on your business logic. It is available for all card product verticals. This guide provides an overview of collaborative authorization and steps for enabling and using the feature. 

Overview

Collaborative authorization works by using collaborative authorization endpoints. Once an endpoint is activated and a transaction is authorized, you will receive an HTTPS POST request with a JSON body containing a payment card authorization request for approval. You can respond to this request to approve or deny an authorization. 

Enable collaborative authorization

In the test environment, you can enable collaborative authorization from the dashboard for each card product. Use the following steps to enable collaborative authorization for your card product: 

1. From the Highnote dashboard, click the name of your card product.
2. Click Product Settings and select the Settings tab. 
3. In the features section of the settings tab, use the toggle to enable collaborative authorization. 
4. In the pop-up window, click Enable. 

Once collaborative authorization is enabled for your card product, you must contact support@highnote.com to turn it off. 

Add an endpoint

Use the following steps to add a collaborative authorization endpoint from the dashboard: 

1. From the Highnote dashboard, click Developers in the left-hand navigation.
2. On the developers page, click the Collab Auth tab and select Add Endpoint.
3. Provide an Endpoint Name and URL.
4. In the pop-up window, click Add Collaborative Authorization Endpoint. 
5. Copy the endpoint key and store it in a safe place. If you need to retrieve this key again, you can do so using the Highnote API. For more information, see Collaborative Authorization.
6. Once you've stored your key, click I've copied my key. 

Activate an endpoint

By default, collaborative authorization endpoints are deactivated upon creation. Use the following steps to activate an endpoint from the dashboard: 

1. From the Highnote dashboard, click Developers in the left-hand navigation.
2. On the developers page, click the Collab Auth tab. 
3. Hover over the endpoint you wish to activate and click the three-dot icon. 
4. From the drop-down, click Activate Endpoint. 
5. In the pop-up window, click Activate. Activating an endpoint automatically deactivates any existing active endpoint. 

Delete an endpoint

Use the following steps to delete a collaborative authorization endpoint: 

1. From the Highnote dashboard, click Developers in the left-hand navigation.
2. On the developers page, click the Collab Auth tab. 
3. Hover over the endpoint you wish to activate and click the three-dot icon. 
4. From the drop-down, click Delete Endpoint.