Webhook

Webhook is a kind of feedback method for payout information.
When payout status changes, a POST request is sent to the url_callback specified when creating the payout.

Response

Response parameters

NameDefinition
typeType. Only payout is available
uuidmethods.UUID of the payout
order_idOrder ID in your system (to identify the payout)
amountThe amount of the payout
merchant_amountThe amount that is debited from the merchant's balance, including all commissions.
commissionCryptomus commission amount
is_finalWhether the payment is completedIf the payout is not final and failed, its still possible to resend it through the support.When payout is finalized it's either paid or failed.
statusPayment status see
txidTransaction hash on the blockchain.The txid field will not exist if1) Payout was paid by p2p to Cryptomuss address2) Payout failed.
currencyInvoice currency
networkThe blockchain network in which the payment was made
payer_currencyCryptocurrency code in which the payout will be actually made. The payout address will receive the payout currency.
payer_amountAmount in payer_currency of the payout.
signSignature to verify that webhook was from Cryptomus

Definition

Type. Only payout is available

Definition

methods.UUID of the payout

Definition

Order ID in your system (to identify the payout)

Definition

The amount of the payout

Definition

The amount that is debited from the merchant's balance, including all commissions.

Definition

Cryptomus commission amount

Definition

Whether the payment is completedIf the payout is not final and failed, its still possible to resend it through the support.When payout is finalized it's either paid or failed.

Definition

Payment status see

Definition

Transaction hash on the blockchain.The txid field will not exist if1) Payout was paid by p2p to Cryptomuss address2) Payout failed.

Definition

Invoice currency

Definition

The blockchain network in which the payment was made

Definition

Cryptocurrency code in which the payout will be actually made. The payout address will receive the payout currency.

Definition

Amount in payer_currency of the payout.

Definition

Signature to verify that webhook was from Cryptomus

Response example


1{
2	"type": "payout",
3	"uuid": "2b852d86-3cf1-43fb-b1bb-36f0b7d12151",
4	"order_id": "129359",
5	"amount": "207.00000000",
6	"merchant_amount": "207.30000000",
7	"commission": "0.30000000",
8	"is_final": true,
9	"status": "paid",
10	"txid": "0xcf8",
11	"currency": "USDT",
12	"network": "bsc",
13	"payer_currency": "USDT",
14	"payer_amount": "207.00000000",
15	"sign": "eff3afba8600af59c98b74155934da2d"
16}
COPY

Webhook verification

see