External Channel

​

A2: External Channel Guide

​

What is External channel?

The External channel is for integrations between A2 and your own retail platform. The External channel works similarly to webhooks, and are used to request specific data from the retail platform.

Examples:

• Integrate payment page for budget chargement
• Integrate refund page for budget refund

When A2 integrates with retail platforms through external channel, it uses data formats that are specific to each use case.
Please see the infomation below for more details.

​

External Channel Usages

​

Request Budge Charge

If the advertiser requests to charge budget, A2 requests the retail platform to provide the URL of the payment page for that advertiser through a registered external channel. If the response from the retail platform is successful, then show a popup with that URL so that advertiser can follow the retail platform’s payment process.

• Send data format

  {
    'request_type': 'budget_charge_link_info',
    'params': {
      'user_id': ...
    }
  }
  

• Response data format

  {
    'url': "payment page url of ratail platform",
    'width': ...,
    'height': ...
  }
  

​

Request Budget Refund

If the advertiser requests to refund budget, A2 requests the retail platform to provide the URL of the refund page for that advertiser through a registered external channel. If the response from the retail platform is successful, then show a popup with that URL so that advertiser can follow the retail platform’s refund process. This allows retail platforms to issue refunds according to their own refund policies.

• Send data format

  {
    'request_type': 'budget_refund_link_info',
    'params': {
      'user_id': ...
    }
  }
  
  

• Response data format

  {
    'url': "refund page url of retail platform",
    'width': ...,
    'height': ...
  }