Funding Events

To enable third-party systems to promptly obtain the execution results of deposit/withdrawal operations, Broker OpenAPI provides an asynchronous proactive event push mechanism for deposit/withdrawal transaction events.

Clients can subscribe to receive relevant events, allowing them to monitor transaction processing results and status changes in real time.

Funding Transfer Events

Funding Transfer Event Notification

CANCELED

{
    "id": "event_c4b2c210-ce32-41d4-a9a1-cfad4fdf191c",
    "event_type": "FUNDING",
    "position": "CJO1fxACGAAgADAB",
    "timestamp": "2025-03-29T07:02:33.200962333Z",
    "payload": {
        "account_id": "J6HA4EBQRQFJD2J6NQH0F7M649",
        "client_request_id": "LJIS16BACHQG9LPP44L9IQHGAB",
        "transfer_type": "ACH",
        "ach_relationship_id": "89JGKD4LKIVI5UU6L3KHNU10IA",
        "amount": "1000.00",
        "currency": "USD",
        "direction": "DEPOSIT",
        "status": "CANCELED",
        "reason": "xxx",
        "update_time": "2025-11-21T06:27:43.312Z",
        "biz_type": "TRANSFER"
    }
}

REJECTED

{
    "id": "event_c4b2c210-ce32-41d4-a9a1-cfad4fdf191c",
    "event_type": "FUNDING",
    "position": "CJO1fxACGAAgADAB",
    "timestamp": "2025-03-29T07:02:33.200962333Z",
    "payload": {
        "account_id": "J6HA4EBQRQFJD2J6NQH0F7M649",
        "client_request_id": "LJIS16BACHQG9LPP44L9IQHGAB",
        "transfer_type": "ACH",
        "ach_relationship_id": "89JGKD4LKIVI5UU6L3KHNU10IA",
        "amount": "1000.00",
        "currency": "USD",
        "direction": "DEPOSIT",
        "status": "REJECTED",
        "reason": "xxx",
        "update_time": "2025-11-21T06:27:43.312Z",
        "biz_type": "TRANSFER"
    }
}

COMPLETED

{
    "id": "event_c4b2c210-ce32-41d4-a9a1-cfad4fdf191c",
    "event_type": "FUNDING",
    "position": "CJO1fxACGAAgADAB",
    "timestamp": "2025-03-29T07:02:33.200962333Z",
    "payload": {
        "account_id": "J6HA4EBQRQFJD2J6NQH0F7M649",
        "client_request_id": "LJIS16BACHQG9LPP44L9IQHGAB",
        "transfer_type": "ACH",
        "ach_relationship_id": "89JGKD4LKIVI5UU6L3KHNU10IA",
        "amount": "1000.00",
        "currency": "USD",
        "direction": "DEPOSIT",
        "status": "COMPLETED",
        "update_time": "2025-11-21T06:27:43.312Z",
        "biz_type": "TRANSFER"
    }
}

RETURNED

{
    "id": "event_c4b2c210-ce32-41d4-a9a1-cfad4fdf191c",
    "event_type": "FUNDING",
    "position": "CJO1fxACGAAgADAB",
    "timestamp": "2025-03-29T07:02:33.200962333Z",
    "payload": {
        "account_id": "J6HA4EBQRQFJD2J6NQH0F7M649",
        "client_request_id": "LJIS16BACHQG9LPP44L9IQHGAB",
        "transfer_type": "ACH",
        "ach_relationship_id": "89JGKD4LKIVI5UU6L3KHNU10IA",
        "amount": "1000.00",
        "currency": "USD",
        "direction": "DEPOSIT",
        "status": "RETURNED",
        "reason": "xxx",
        "update_time": "2025-11-21T06:27:43.312Z",
        "biz_type": "TRANSFER"
    }
}

Response Fields

Field	Type	Description
id	string	Unique event identifier
event_type	string	Event type, fixed as FUNDING
position	string	Cursor for event replay; re-pushes subsequent events within the current business type.
timestamp	string	Event timestamp in ISO 8601 format
payload	object	Event payload data

Payload Fields

Field	Type	Description
account_id	string	Account id
client_request_id	string	Client Request ID, unique for each request.
transfer_id	string	Request id generated by the system.
transfer_type	string	Transfer type, See the transfer_type field in the Get Transfer Detail API response.
ach_relationship_id	string	Only present if type is ACH.
bank_relationship_id	string	Only present if type is WIRE.
amount	string	Amount.
currency	string	Currency, See the currency field in the Get Transfer Detail API response.
direction	string	Currency, See the direction field in the Get Transfer Detail API response.
additional_information	string	Additional details for when type is WIRE.
status	string	Request status, See the status field in the Get Transfer Detail API response.
reason	string	Reason. If the terminal state is not “COMPLETED”, return the reason.
update_time	string	UTC time, format: YYYY-MM-dd'T'HH:mm:ss.SSSZ.
fee	string	Fee amount to be collected. Only applies when type is WIRE.
biz_type	string	Business type, fixed as TRANSFER

Instant Funding Events

Instant Funding Event Notification

CANCELED

{
    "id": "event_c4b2c210-ce32-41d4-a9a1-cfad4fdf191c",
    "event_type": "FUNDING",
    "position": "CJO1fxACGAAgADAB",
    "timestamp": "2025-03-29T07:02:33.200962333Z",
    "payload": {
        "account_id": "93IUJ28O9VO2KBGHDHR4H9",
        "client_request_id": "LJIS16BACHQG9LPP44L9IQHGAB",
        "instant_funding_id": "41IO9QG4M5O65B0EA4LSJ4UJ99",
        "amount": "100",
        "currency": "USD",
        "type": "DEPOSIT",
        "bank_relationship_id": "89JGKD4LKIVI5UU6L3KHNU10IA",
        "status": "CANCELED",
        "reason": "xxxxxx",
        "update_time": "2025-11-21T06:27:43.312Z",
        "biz_type": "INSTANT_FUNDING"
    }
}

REJECTED

{
    "id": "event_c4b2c210-ce32-41d4-a9a1-cfad4fdf191c",
    "event_type": "FUNDING",
    "position": "CJO1fxACGAAgADAB",
    "timestamp": "2025-03-29T07:02:33.200962333Z",
    "payload": {
        "account_id": "93IUJ28O9VO2KBGHDHR4H9",
        "client_request_id": "LJIS16BACHQG9LPP44L9IQHGAB",
        "instant_funding_id": "89JGKD4LKIVI5UU6L3KHNU10IA",
        "amount": "100",
        "currency": "USD",
        "type": "DEPOSIT",
        "bank_relationship_id": "89JGKD4LKIVI5UU6L3KHNU10IA",
        "status": "REJECTED",
        "reason": "xxxxxx",
        "update_time": "2025-11-21T06:27:43.312Z",
        "biz_type": "INSTANT_FUNDING"
    }
}

FAILED

{
    "id": "event_c4b2c210-ce32-41d4-a9a1-cfad4fdf191c",
    "event_type": "FUNDING",
    "position": "CJO1fxACGAAgADAB",
    "timestamp": "2025-03-29T07:02:33.200962333Z",
    "payload": {
        "account_id": "93IUJ28O9VO2KBGHDHR4H9",
        "client_request_id": "LJIS16BACHQG9LPP44L9IQHGAB",
        "instant_funding_id": "89JGKD4LKIVI5UU6L3KHNU10IA",
        "amount": "100",
        "currency": "USD",
        "type": "DEPOSIT",
        "bank_relationship_id": "89JGKD4LKIVI5UU6L3KHNU10IA",
        "status": "FAILED",
        "reason": "xxxxxx",
        "update_time": "2025-11-21T06:27:43.312Z",
        "biz_type": "INSTANT_FUNDING"
    }
}

COMPLETED

{
    "id": "event_c4b2c210-ce32-41d4-a9a1-cfad4fdf191c",
    "event_type": "FUNDING",
    "position": "CJO1fxACGAAgADAB",
    "timestamp": "2025-03-29T07:02:33.200962333Z",
    "payload": {
        "account_id": "93IUJ28O9VO2KBGHDHR4H9",
        "client_request_id": "LJIS16BACHQG9LPP44L9IQHGAB",
        "instant_funding_id": "89JGKD4LKIVI5UU6L3KHNU10IA",
        "amount": "100",
        "currency": "USD",
        "type": "DEPOSIT",
        "bank_relationship_id": "89JGKD4LKIVI5UU6L3KHNU10IA",
        "status": "COMPLETED",
        "update_time": "2025-11-21T06:27:43.312Z",
        "biz_type": "INSTANT_FUNDING"
    }
}

Response Fields

Field	Type	Description
id	string	Unique event identifier
event_type	string	Event type, fixed as FUNDING
position	string	Cursor for event replay; re-pushes subsequent events within the current business type.
timestamp	string	Event timestamp in ISO 8601 format
payload	object	Event payload data

Payload Fields

Field	Type	Description
account_id	string	Account id
client_request_id	string	Client Request ID, unique for each request.
instant_funding_id	string	Request id generated by the system.
amount	string	Amount.
currency	string	Currency, See the currency field in the Get Instant Funding Detail API response.
type	string	Instant Funding Request Type, See the type field in the Get Instant Funding Detail API response.
bank_relationship_id	string	Relationship ID
status	string	Request status, See the status field in the Get Instant Funding Detail API response.
reason	string	Reason. If the terminal state is not “COMPLETED”, return the reason.
update_time	string	UTC time, format: YYYY-MM-dd'T'HH:mm:ss.SSSZ.
biz_type	string	Business type, fixed as INSTANT_FUNDING