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

Owned account status webhook notification

Prev Next
Post
/your_xenplatform_owned_webhook_url

A webhook event sent when your OWNED sub-account has been successfully created

Security
HTTP
Type basic
Body parameters
{
  "accountCreated": {
    "value": {
      "event": "account.created",
      "created": "2021-01-01T10:00:00Z",
      "data": {
        "id": "5cafeb170a2b18519b1b8761",
        "created": "2021-01-01T10:00:00Z",
        "updated": "2021-01-01T10:00:00Z",
        "type": "OWNED",
        "email": "test@xendit.co",
        "public_profile": {
          "business_name": "My Store"
        },
        "country": "ID",
        "status": "LIVE"
      }
    }
  }
}
Expand All
object
event
string

Your OWNED sub-account has been successfully created

Valid values[ "account.created" ]
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_CreateAccountResponseSchema)
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 object was created

updated
string

Timestamp of when the object was updated

type
string

The type of account created

Valid values[ "MANAGED", "OWNED", "CUSTOM" ]
email
string (email)

A valid email address associated with the object

Max length255
Exampletest@example.co
public_profile
object (xenPlatform_public_profile)
name
string

Public name of the account.

description
string

Additional description visible publicly.

country
string

The country (based on ISO 3166-1 Alpha-2) of incorporation for a business, or the country of residence for an individual.

Valid values[ "ID", "PH", "VN", "MY", "TH" ]
status
string

Status of the Account you are creating.

Valid values[ "INVITED", "REGISTERED", "AWAITING_DOCS", "LIVE", "SUSPENDED" ]
configurations
object (xenPlatform_configurations)

Contains the configurations for CUSTOM sub-accounts. Parameters available: payment_settings_follow_platform, has_withdrawal, has_dashboard

payment_settings_follow_platform
boolean

Indicates if payment settings follow the platform.

has_withdrawal
boolean

Indicates if the account has withdrawal enabled.

has_dashboard
boolean

Indicates if the account has access to the dashboard.

Responses
200

OK