Bank Accounts - Webhook Payload Documentation
This document outlines the structure and examples of the payloads received by key webhooks in the Kona Finance system, specific to Bank Accounts.
Bank Account Webhooks
Examples
Bank Account validated
{
"created_at": "YYYY-MM-DDTHH:MM:SSZ",
"event": "bank_account_status_changed",
"payload": {
"uuid": "<bank_account_uuid>",
"status": "validated"
}
}
Bank Account invalid
{
"created_at": "YYYY-MM-DDTHH:MM:SSZ",
"event": "bank_account_status_changed",
"payload": {
"uuid": "<bank_account_uuid>",
"status": "invalid",
"validation_result": "tax_id_mismatch"
}
}
Currently, the only possible value for the validation_result
field is tax_id_mismatch
, but additional values may be introduced in the future.
The value tax_id_mismatch
indicates that the provided tax_id for the Bank Account does not match the tax ID associated with the owner (Stakeholder) of the bank account.
It typically means that the account is not registered under the same person or entity as the one identified by the given tax ID, and therefore the ownership could not be validated.
Updated about 1 month ago