Registering an Endpoint

This documentation is deprecated

Please refer to the updated documentation https://docs.payadvantage.com.au/reference/webhook_endpoints_post 

Connect to the Pay Advantage API using your API credentials. Post the endpoint Url and type as shown:

Push Example

POST: https://api.payadvantage.com.au/v3/webhook_endpoints
{
  "Url":"https://yourdomain.com/payadvantage_webhooks",
  "Type":"push"  
}

Pull Example

POST: https://api.payadvantage.com.au/v3/webhook_endpoints
{
  "Url":"MySoftwareBatchProcessing",
  "Type":"pull"  
}

Response

{
  "Code":"ABC123",
  "Secret":"Important Key to keep safe",
  "Url":"https://yourdomain.com/payadvantage_webhooks",
  "DateCreated":"YYYY-MM-YYTHH:mm:ss+10:00",
  "MerchantCode":"PAABC123",
  "IsArmed":false,
  "Errors":null,
  "Type":"push"
}

Code is the unique identifier for the endpoint.

Secret is generated from Pay Advantage and used to hash and sign Webhook requests. You should keep this very safe and assign it to your Endpoint.

Url is the domain and route to your endpoint. We recommend creating a separate endpoint for Pay Advantage Webhooks to clearly distinguish between Webhooks from other sources. We also recommend only using https for secure transmission of your data. If you do choose to use a pull type, then your Url can be any meaningful name (e.g. “batch processing”). This is important to help you manage your endpoints later.

MerchantCode is useful if you have multiple Pay Advantage accounts that send Webhooks to the same Endpoint.

IsArmed indicates if the Endpoint has been armed (see Arming an endpoint) it is ready to accept requests.

Errors is a flat string with the errors received from your endpoint when attempted. If multiple errors occur then these are concatenated in descending order (most recent first).

Type is either push or pull. See Webhooks for more information on these two types. Most users will select push.