The settings object

The customer settings object

When creating a Merchant Customer, you may provide a settings parameter in your request.

You can also update these settings at a later time.

Settings are used to configure if and where Paystand will send webhooks. Please see events for more information about what data you can expect to see in a webhook.

Events are not enabled by default.

Please be sure to enable events and provide at least one valid webhook event URL if you want to listen to webhooks.

Failure to enable events and provide at least one valid webhook event URL may result in missing important resource updates.

Paystand highly recommends using HTTPS for all event webhook URLs. Paystand does not enforce this requirement, but customers should be aware that failure to do so has serious security implications.

Settings request

{
  "settings": {
    "events": {
      "enabled": true,
      "urls": {
        "always": ["https://www.acmecorporation.com/myWebhookReceiver"]
      }
    }
  }
}

Settings response

{
    "account": {
    "settings": {
            "events": {
        "enabled": true,
        "urls": {
            "always": ["https://www.acmecorporation.com/myWebhookReceiver"]
        }
      }
    }
  }
}

Documentation

Element

Specification

events.enabled

Type: Boolean

Set to true in order to enable events.

events.urls.always

Type: Array

An array of URLs for events to be sent to.