v1

latestOpenAPI 3.1.0MIT2026-07-211097127.9 KB

Sub-account Creation Result Notification

When sub-account creation succeeds or fails, GatePay sends an asynchronous POST notification to the callback URL configured by the merchant.

The callback payload includes bizType, bizId, bizStatus, clientId, and data, where data is a JSON string of the sub-account creation result object. The merchant must accept and parse the notification at that URL and return HTTP 200 to acknowledge receipt.

postWebhookinstitutionAccountWebhook

Payload

bizTypestring required

Notification type; INSTITUTION = sub-account creation

bizIdstring required

Creation request ID

bizStatusstring required

Business status: INSTITUTION_ACCOUNT_SUCCESS = created, INSTITUTION_ACCOUNT_FAIL = creation failed

clientIdstring required

Merchant client_id that created the sub-account

datastring required

Message body as a JSON string; parsed structure see CreateSubAccountCallbackData.

Response

Return HTTP 200 to indicate the callback notification has been received.

returnCodestring required

Return status code, for example SUCCESS.

returnMessagestring nullable

Return message.