Callback > Payout
The notification for payout result.
Callback API
The callback URL is provided in request body by the request initiator. For more details, see the callback_url
parameter in the Create Payout API.
This API allows cregis
to initiate callback request to the original API caller.
The callback comes in four scenarios, which are determined by the status
in the callback content. These scenarios are mutually exclusive and only trigger once:
status | Description |
---|---|
2 | Signature Rejected |
4 | Approval Rejected |
6 | Transaction Successful |
7 | Transaction Failed |
After initiating the callback, when the returned content is success
, the callback is successful. Otherwise, the callback fails. If the callback fails, you can push it again, you can log into the cregis
client, select the corresponding project in the menu, and re-push it from the callback record.
Note: Different types of callbacks will have different content. It is strongly recommended to use different APIs for different types of callbacks to ensure clear and specific business logic.
Request Method
HTTP POST application/json
Request Parameters
Name | Type | Description |
---|---|---|
pid | integer(int64) | Project ID |
cid | integer(int64) | Cregis ID |
chain_id | string | Chain ID |
token_id | string | Token ID |
currency | string | Currency Identifier |
address | string | Address |
amount | string | Amount |
third_party_id | string | Caller’s Customized ID |
remark | string | Remarks |
status | integer(int32) | Status |
txid | string | Transaction Hash |
block_height | string | Block Height |
block_time | integer(int64) | Block Time |
memo | string | memo or tag on blockchain,Only support Ton and Xrp |
nonce | string | 6-digit random string |
timestamp | integer(int64) | Timestamp |
sign | string | Signature |