Callback Event List

Callback event rule¶

When a customer's account status has changed, system will send the payload to the Webhook URL that partner provided. Callback event arrives between 1 to 5 minutes on average. Theoretically, it might take 24 hours.

If partner miss the callback events for some reasons, our system will record all content and can send these failed events to partner again.

If callback requests failed, we will resend 5 times: after 1 minute, 5 minutes, 1 hour, 5 hours and 18 hours, until system receive 2xx status code.

Account status change event¶

When the status of customer's account has changed, system will send the payload to the Webhook URL that partner provided.

Event Payload¶

{
    "account_uuid": "6d92e7b4-715c-4ce3-a028-19f1c8c9fa6c",
    "user_ext_ref": "fce4fd45-7dd7-4d4c-b06c-e17ff12f3e30",
    "status": "INITIALIZED",
    "event_time": "2020-07-01T09:00:00.000Z"
}

Parameter	Type	Description
`account_uuid`	string	Customer account ID provided by Cabital.
`user_ext_ref`	string	Customer account ID provided by Partner.
`status`	string	The status of account, complete status please reference Account status list.
`event_time`	string	The time of event, format is ISO 8601, e.g. `2020-07-01T09:00:00.000Z`.

Account status list¶

Status	Description
`INITIALIZED`	The customer has already linked, but the customer has not yet submitted KYC at Cabital.
`PENDING`	Cabital is processing customer's KYC materials.
`TEMPORARY_REJECTED`	The customer already requested to resubmit the KYC materials by Cabital.
`FINAL_REJECTED`	The customer has rejected to use Cabital service.
`CREATED`	The customer has passed the KYC, wait for partner to submit the KYC match.
`MATCHING`	Cabital is manually processing customer's KYC match case
`MATCHED`	The customer has matched the KYC successfully.
`MISMATCHED`	The customer failed to match the KYC.
`UNLINKED`	The customer or Cabital has unlinked with the partner's account.

The status transition when reconnecting after unlinking¶

Status	Status Transition Process	Note
`INITIALIZED`	`UNLINKED` → `INITIALIZED`
`PENDING`	`UNLINKED` → `INITIALIZED` → `PENDING`
`TEMPORARY_REJECTED`	`UNLINKED` → `INITIALIZED` → `TEMPORARY_REJECTED`
`FINAL_REJECTED`	`UNLINKED` → `INITIALIZED` → `FINAL_REJECTED`
`CREATED`	`UNLINKED` → `INITIALIZED` → `CREATED`
`MATCHED`	`UNLINKED` → `INITIALIZED` → `CREATED`	Need to process KYC acceptance or KYC match again.
`MISMATCHED`	`UNLINKED` → `INITIALIZED` → `CREATED`	Need to process KYC acceptance or KYC match again.

Transfer transaction status change event¶

When partner or customer initiate a transfer, system will send the payload to the Webhook URL that partner provided.

After partner receive the payload, can use parameter account_id and transfer_id to retrieve the detail of transaction:

account_id: List all transfers by account ID
transfer_id: Retrieve a transfer by transfer ID API

Event Payload¶

{
  "transfer_id": "16d4dfe2-de1b-4ceb-b1d8-8b9b79a3200b",
  "account_id": "1771ffd6-d20b-4858-ad34-d596a9ec51d4",
  "external_id": "c02aa167-ef1a-44bf-8bdb-1da805479013",
  "direction": "DEBIT",
  "transfer_by": "CUSTOMER",
  "status": "SUCCESS",
  "event_time": "2022-04-01T09:00:00.000Z"
}

Parameter	Type	Description
`account_id`	string	Customer account ID provided by Cabital.
`transfer_id`	string	Transfer transaction ID
`external_id`	string	Partner's transaction ID
`direction`	string	Indicates the direction of funds: `CREDIT`: Partner → Cabital `DEBIT`: Cabital → Partner
`transfer_by`	string	Initiator of transfer transaction. `PARTNER`: Partner `CUSTOMER`: Customer
`status`	string	Transfer transaction status. `PROCESSING`: The transaction is processing. `SUCCESS`: The transaction is successful. `FAILED`: The transaction is failed. `CANCEL`: The transaction is canceled.
`event_time`	string	The time of event, format is ISO 8601, e.g. `2020-07-01T09:00:00.000Z`.