Welcome to Xendit’s latest documentation. For legacy content, access the previous version here.

Handling Webhooks

Prev Next

You can also use the available webhooks and decide your systems’ response to each event.

  • Ensure that you have set your webhook URL for xenPlatform - Account Holder.

  • See guide to set your webhook URL from the Xendit Dashboard or API

The table below lists and describes the types of webhooks available.

Webhook event

Trigger

Description

KYC verification passed account_holder.kyc.status:passed

When Xendit decides that Account Holder information is sufficient for Account to go live

Use this event to notify your merchants that their Account has passed KYC verification from Xendit

KYC verification failed account_holder.kyc.status:failed

When Xendit decides that Account Holder does not have sufficient information for Account to go live

Use this event to notify your merchants that their onboarding is declined by Xendit Platform can also use the failure_reason to notify their Partners the reason why their submission is failed

Document resubmission required account_holder.kyc.status:resubmission_required

When Xendit requires additional documents so that you can resubmit the correct onboarding information

Use this event to notify your merchants that their onboarding information is invalid and needs document resubmission We will also notify Platform via webhook and and specify the invalid fields so that Partners can update the invalid fields with the right information

Capabilities have been activated account_holder.capabilities.status:live

When capabilities has been activated for the sub-account

Use this event to notify your merchants that the requested capabilities or payment channel have been activated for the sub-account

Capabilities activation request has been declined account_holder.capabilities.status:declined

When capabilities has been declined for the sub-account and you can no longer resubmit

Use this event to notify your merchants that their activation request is declined by Xendit. The failure_reason explains the reason why their submission is declined.

Capabilities activation needs documents resubmission account_holder.capabilities.status:resubmission_required

When Xendit request additional documents so that you can resubmit the correct information to activate certain capabilities

Use this event to notify your merchants that their information is invalid and needs resubmission. The invalid fields that need to be updated are specified in the webhook.

Simulating Webhook Scenarios in Test Mode

You can use the following Account Holder IDs as magic numbers to simulate API responses for different webhook scenarios.

Scenario

Account Holder ID

Endpoint

Accounts KYC verification passed

00000000-0000-0000-0000-000000000000

PATCH v2/accounts/:id

Accounts KYC verification failed

00000000-0000-0000-0000-111111111111

PATCH v2/accounts/:id

Accounts KYC needs documents resubmission

00000000-0000-0000-0000-222222222222

PATCH v2/accounts/:id

Capabilities has been activated

00000000-0000-0000-0000-333333333333

PATCH account_holders/:id

Capabilities activation request has been declined

00000000-0000-0000-0000-444444444444

PATCH account_holders/:id

Capabilities activation needs documents resubmission

00000000-0000-0000-0000-555555555555

PATCH account_holders/:id