For archived content, access the previous documentation here or the previous API reference here.

Managed account status webhook notification

Prev Next
Post
/your_xenplatform_managed_webhook_url

Webhook events sent for your MANAGED sub-accounts when they have registered or are activated.

Security
HTTP
Type basic
Body parameters
{
  "accountRegistered": {
    "value": {
      "event_type": "account.registered",
      "created": "2021-01-01T10:00:00Z",
      "data": {
        "user_id": "5cafeb170a2b18519b1b8761",
        "created": "2021-01-01T10:00:00Z",
        "account_info": {
          "payments_enabled": false
        }
      }
    }
  },
  "accountActivated": {
    "value": {
      "event_type": "account.activated",
      "created": "2021-01-01T10:00:00Z",
      "master_acc_business_id": "5cafeb170a2b18529b6120a4",
      "data": {
        "user_id": "5cafeb170a2b18519b1b8761",
        "created": "2021-01-01T10:00:00Z",
        "account_info": {
          "payments_enabled": true
        }
      }
    }
  }
}
Expand All
object
event
string

account.registered: Your MANAGED sub-account has successfully registered account.activated: Your MANAGED sub-account has been verified and enabled for live payments

Valid values[ "account.registered", "account.activated" ]
Exampleaccount.created
business_id
string

ID of your Account, use this in the for-user-id header to create transactions on behalf of your Account

created
string

Timestamp of when the webhook was sent

updated
string

Timestamp of when the webhook was updated

data
object (xenPlatform_AccountCallbackDataSchema)
user_id
string

The sub-account business ID

account_info
object
payments_enabled
boolean

Indicates whether live payments are enabled for the account

Responses
200

OK