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

Account suspension webhook notification

  • Updated on Aug 21, 2025
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.

Body parameters
Account Suspended
{
  "event": "account.suspended",
  "created": "2021-01-01T10:00:00Z",
  "data": {
    "id": "5cafeb170a2b18519b1b8761",
    "created": "2021-01-01T10:00:00Z",
    "updated": "2021-01-01T10:00:00Z",
    "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 (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 (date-time)

Timestamp of when the object was created

updated
string (date-time)

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 (public_profile)
business_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

400

Bad Request - Invalid webhook payload