Cregis Developer Docs
WEBHOOK

Payout External Verification Notification

A server-initiated callback. Implement a receiving endpoint in your service.

Receive notifications for WaaS project payout applications. You must implement a receiving endpoint in your service. Configure the callback URL in the WaaS project in the Cregis App (PC). This callback request is initiated by Cregis and sent to the specified business side, and is generated only once.

When your service endpoint receives the callback event, return one of the following responses:

ResponseMeaning
okApprove the transaction request
denyReject the transaction request

If the endpoint does not respond, or returns any other content, the callback is considered failed. Different business callback types have different payloads. We strongly recommend using separate endpoints for different callback types to keep business logic clear. Failed callbacks can be pushed again. Log in to the Cregis App, select the corresponding project in the WaaS project menu, and push again from the abnormal callback records menu.

Request

Callback Payload

application/json
  • pidinteger<int64>

    The WaaS project ID you created.

  • cidinteger<int64>

    Unique business ID generated by Cregis.

  • third_party_idstring

    Caller business ID generated by your business system.

  • chain_idstring

    Blockchain ID.

  • token_idstring

    Token ID.

  • from_addressstring

    Sender address.

  • to_addressstring

    Recipient address.

  • amountstring

    Payout amount.

  • noncestring

    6-character random string.

  • timestampinteger<int64>

    Current request timestamp in milliseconds.

  • signstring

    Digital signature for this callback request to prevent unauthorized requests. See the signature rules.

  • remarkstring

    Transfer description. Maximum 256 characters.

  • memostring

    On-chain memo/tag information. Only supported and required by networks such as TON and XRP.

Responses

200Your server must return HTTP 200 and a response body strictly equal to plain text `ok` or `deny` (`text/plain`). `ok` means approve the transaction, and `deny` means reject the transaction. Returning any other content is treated as callback failure.
text/plain
string
enum: "ok", "deny"