Skip to main content
WEBHOOK

Overview

This page documents webhook institutionVerifyResultWebhook. Parameters, response schema, and examples are rendered from the linked OpenAPI definition above. When sub-account KYB verification completes (passed or rejected), GatePay sends a POST request to the callback URL configured by the merchant. The merchant should receive and parse the notification at that URL and return HTTP 200 to acknowledge receipt.

Notes

Trigger scenarios

  • Triggered when KYB verification completes after a sub-account submits verification and the status becomes passed or rejected
  • GatePay sends the notification to the merchant’s configured callback URL
  • If delivery fails, see retry rules in Notifications Overview

Message Structure

Parsed data Content

Callback examples

Verification passed:
Parsed content of data:

Verification rejected

Body

application/json

Sub-account verification result callback notification body

bizType
string
required

Notification type; INSTITUTION = institution notification

bizId
string
required

Notification business ID

bizStatus
string
required

Business status: PASSED = verification passed, FAILED = verification rejected

clientId
string
required

Institution merchant client_id

data
string
required

Message content as a JSON string; see InstitutionVerifyResultCallbackData after parsing.

Response

200 - application/json

Return HTTP 200 to acknowledge receipt.

Merchant acknowledgement returned after receiving the callback.

returnCode
string
required

Return status code, for example SUCCESS.

returnMessage
string | null

Return message.