Settings
Webhook URL settings
The target URL to which HTTP POST requests will be sent needs to be provided to your integration manager, and confirmation should be received that it has been added to the partner settings on Paybis end.
Available webhooks
Successfully executed event
Webhook on the successfully executed event, after the crypto transaction is submitted to the blockchain.
Request
| Parameter | Type | Description |
|---|---|---|
event_id | REQUIRED uuid | Event id. |
transaction_id | REQUIRED uuid | Transaction id. Paybis will return value from payment.transaction.id from the corresponding Event. |
digital_amount_sent | REQUIRED object | |
digital_amount_sent.currency | REQUIRED string | Cryptocurrency is sent to the crypto address. |
digital_amount_sent.amount | REQUIRED string | Crypto amount sent to the crypto address. |
blockchain_txn_hash | OPTIONAL string | The blockchain transaction hash. |
{
"event_id": "0000079f-6981-4cd7-bf7b-88c5699eebb5",
"transaction_id": "26e312b9-2206-1005-227e-f95808946cd3",
"digital_amount_sent": {
"currency": "BTC",
"amount": "0.699999"
},
"blockchain_txn_hash": "492e43fa04ec86d7d4bc7deb38e4956312e78eb68d97824e73660a52283344ab"
}
Unsuccessfully executed event
Webhook on the unsuccessfully executed event, after the crypto transaction is submitted to the blockchain.
Request
| Parameter | Type | Description |
|---|---|---|
event_id | REQUIRED uuid | Event id. |
event_type | REQUIRED object | Type of the event. For transaction payout error it should be TransactionCryptoPayoutError. |
transaction_id | REQUIRED uuid | Transaction id. Paybis will return value from payment.transaction.id from the corresponding Event. |
event_type | REQUIRED object | TransactionCryptoPayoutError |
invoice | REQUIRED object | Invoice details associated with the transaction. |
amount_sent.amount | REQUIRED object | Cryptocurrency amount is sent to the crypto address. |
amount_sent.currency | REQUIRED object | Cryptocurrency currency is sent to the crypto address. |
status | REQUIRED object | Status of the transaction - Rejected for the error case. |
reason | REQUIRED object | Reason of the rejection. |
{
"event_id": "4e882fc8-07d1-4759-bbc5-4c0d8029109d",
"event_type": "TransactionCryptoPayoutError",
"transaction_id": "785bae8a-759d-4eb3-b1c1-307f221018f1",
"invoice": "PBQA240628300573TX2",
"status": "Rejected",
"amount_sent": {
"amount": "1000",
"currency": "BTC-TESTNET"
},
"reason": "some reason test 28.06",
"timestamp": 1719293227
}
Response
A successful HTTP response is expected (2xx code).