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

Account suspension webhook notification

Prev Next
Post
/your_account_suspension_status_callback_url

These events may occur if we have reason to believe that the Account has engaged in fraudulent activity.

Security
HTTP
Type basic
Body parameters
{
  "event": "account.suspended",
  "created": "2021-01-01T10:00:00Z",
  "data": {
    "id": "5cafeb170a2b18519b1b8761",
    "created": "2021-01-01T10:00:00Z",
    "updated": "2021-01-01T10:00:00Z",
    "type": "MANAGED",
    "email": "test@xendit.co",
    "public_profile": {
      "business_name": "My Store"
    },
    "status": "SUSPENDED",
    "reason": "FRAUD_PROMO_ABUSE"
  }
}
Expand All
object
event
string

These events may occur if we have reason to believe that the Account has engaged in fraudulent activity.

Valid values[ "account.suspected", "account.suspended", "account.cleared" ]
Exampleaccount.suspended
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_AccountSuspensionCallbackSchema)
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

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.

status
string
Valid values[ "SUSPECTED", "SUSPENDED", "CLEARED" ]
reason
string

Reason given for the status change

Responses
200

OK