General Information

Webhook is a kind of callback method used to receive payment information. When the status of an invoice changes, a POST request is sent to the url_callback specified either during invoice creation.

The Webhook expects your server to respond with a status code in the 2xx range. If it receives any other status code, it will retry sending the request up to 10 times until a successful response is received.

Each request includes a Signature in the header, which must be validated to prevent potential attacks. The algorithm for verifying the signature validity can be found here.

Request Example

{
 type: string, // Payment type PayIn/PayOut
 uuid: string, // Unique identifier in our system
 order_id: string, // Your order ID sent during creation
 user_id: string, // Unique user identifier
 lifetime: number | null, // Validity period of the issued invoice (in seconds)
 expires_at: number, // Unix timestamp for expiration date/time
 amount: string, // Amount of the created order
 currency: string, // Currency code
 payment_link: string | null, // Link to the payment terminal
 fact_amount: string | null, // Amount of actual execution of the order
 accuracy_payment_percent: number// Allowable payment inaccuracy
 address: string | null // Wallet address for payment
 qr_code: string | null, // Wallet address QR code
 from: string | null // The wallet address from which the payment was made
 txid: string | null // Transaction hash
 coins: string[] | null, // List of allowed coins for payment
 except_coins: string[] | null, // List of excluded coins for payment
 commission: string | null, // Amount taken as commission
 is_test: boolean, // Whether the order is a test order
 status: string, // Current order status
 additional_data: string | null, // Extra info sent at order creation
 convert: {
    coin: string  | null, // Cryptocurrency code for credited amount
	  network: string | null, // Blockchain network code
    rate: string | null, // Conversion rate
    course_source: string | null, // Service from which exchange rates are taken
 },
 extra: null, // Additional invoice information 
 created_at: string, // ISO-8601 order creation date/time
}