Withdrawal callbacks

Withdrawal callbacks are sent whenever the status of a withdrawal changes. Use the status field to determine if the operation was successful or not. For cancelled or declined operations, use the error field to determine the reason. Use the end_user_reference field to identify the customer who received the withdrawn funds.

Sent when a withdrawal has been successfully completed and can be treated as final on your side.

{
  "id": 123,
  "foreign_id": "operation_987",
  "end_user_reference": "user_12345",
  "type": "withdrawal",
  "crypto_address": {
    "id": 123,
    "currency": "BTC",
    "address": "tb1qurv0m4ufsj8xqejvmn0y43kqew33kvqrrxswgm",
    "tag": null
  },
  "transactions": [
    {
      "id": 999,
      "currency": "BTC",
      "transaction_type": "blockchain",
      "type": "withdrawal",
      "address": "tb1qurv0m4ufsj8xqejvmn0y43kqew33kvqrrxswgm",
      "tag": null,
      "amount": "0.01000000",
      "txid": "bb040d895ef7141ea0b06b04227d8f5dd4ee12d5b890e6e5633f6439393a666b",
      "confirmations": "0"
    }
  ],
  "fees": [],
  "error": "",
  "status": "confirmed"
}

{
  "id": 123,
  "foreign_id": "operation_987",
  "end_user_reference": "user_12345",
  "type": "withdrawal_instant",
  "crypto_address": {
    "id": 123,
    "currency": "BTC",
    "address": "tb1qurv0m4ufsj8xqejvmn0y43kqew33kvqrrxswgm",
    "tag": null
  },
  "transactions": [
    {
      "id": 999,
      "currency": "BTC",
      "transaction_type": "blockchain",
      "type": "withdrawal",
      "address": "tb1qurv0m4ufsj8xqejvmn0y43kqew33kvqrrxswgm",
      "tag": null,
      "amount": "0.01000000",
      "txid": "bb040d895ef7141ea0b06b04227d8f5dd4ee12d5b890e6e5633f6439393a666b",
      "confirmations": "0"
    }
  ],
  "fees": [
    {
      "type": "mining",
      "currency": "BTC",
      "amount": "0"
    },
    {
      "type": "fee_crypto_withdrawal_from_crypto",
      "currency": "BTC",
      "amount": "0.00028735"
    }
  ],
  "error": "",
  "status": "confirmed"
}

Sent when a withdrawal with conversion has been successfully completed and can be treated as final on your side.

{
  "id": 123,
  "foreign_id": "operation_987",
  "end_user_reference": "user_12345",
  "type": "withdrawal_exchange",
  "crypto_address": {
    "id": 123,
    "currency": "BTC",
    "address": "tb1qurv0m4ufsj8xqejvmn0y43kqew33kvqrrxswgm",
    "tag": null
  },
  "currency_sent": {
    "currency": "EUR",
    "amount": "804.25693204"
  },
  "currency_received": {
    "currency": "BTC",
    "amount": "0.01000000"
  },
  "transactions": [
    {
      "id": 999,
      "currency": "BTC",
      "transaction_type": "blockchain",
      "type": "withdrawal",
      "address": "tb1qurv0m4ufsj8xqejvmn0y43kqew33kvqrrxswgm",
      "tag": null,
      "amount": "0.01000000",
      "txid": "bb040d895ef7141ea0b06b04227d8f5dd4ee12d5b890e6e5633f6439393a666b",
      "confirmations": "0"
    },
    {
      "id": 1000,
      "currency": "EUR",
      "currency_to": "BTC",
      "transaction_type": "exchange",
      "type": "exchange",
      "amount": "804.25693204",
      "amount_to": "0.01000000"
    }
  ],
  "fees": [
    {
      "type": "fee_crypto_withdrawal_from_fiat",
      "currency": "BTC",
      "amount": "0.00028735"
    }
  ],
  "error": "",
  "status": "confirmed"
}

{
  "id": 123,
  "foreign_id": "operation_987",
  "end_user_reference": "user_12345",
  "type": "withdrawal_instant_exchange",
  "crypto_address": {
    "id": 123,
    "currency": "BTC",
    "address": "tb1qurv0m4ufsj8xqejvmn0y43kqew33kvqrrxswgm",
    "tag": null
  },
  "currency_sent": {
    "currency": "EUR",
    "amount": "804.25693204"
  },
  "currency_received": {
    "currency": "BTC",
    "amount": "0.01000000"
  },
  "transactions": [
    {
      "id": 999,
      "currency": "BTC",
      "transaction_type": "blockchain",
      "type": "withdrawal",
      "address": "tb1qurv0m4ufsj8xqejvmn0y43kqew33kvqrrxswgm",
      "tag": null,
      "amount": "0.01000000",
      "txid": "bb040d895ef7141ea0b06b04227d8f5dd4ee12d5b890e6e5633f6439393a666b",
      "confirmations": "0"
    },
    {
      "id": 1000,
      "currency": "EUR",
      "currency_to": "BTC",
      "transaction_type": "exchange",
      "type": "exchange",
      "amount": "804.25693204",
      "amount_to": "0.01000000"
    }
  ],
  "fees": [
    {
      "type": "mining",
      "currency": "BTC",
      "amount": "0"
    },
    {
      "type": "fee_crypto_withdrawal_from_fiat",
      "currency": "BTC",
      "amount": "0.00028735"
    }
  ],
  "error": "",
  "status": "confirmed"
}

Sent when a withdrawal exceeds the configured withdrawals limits and is awaiting approval from a user with the Owner role.

{
  "id": 123,
  "foreign_id": "operation_987",
  "end_user_reference": "user_12345",
  "type": "withdrawal",
  "crypto_address": {
    "id": 123,
    "currency": "BTC",
    "address": "tb1qurv0m4ufsj8xqejvmn0y43kqew33kvqrrxswgm",
    "tag": null
  },
  "transactions": [
    {
      "id": 999,
      "currency": "BTC",
      "transaction_type": "blockchain",
      "type": "withdrawal",
      "address": "tb1qurv0m4ufsj8xqejvmn0y43kqew33kvqrrxswgm",
      "tag": null,
      "amount": "0.01000000",
      "txid": null,
      "confirmations": "0"
    }
  ],
  "fees": [],
  "error": "",
  "status": "pending"
}

{
  "id": 123,
  "foreign_id": "operation_987",
  "end_user_reference": "user_12345",
  "type": "withdrawal_instant",
  "crypto_address": {
    "id": 123,
    "currency": "BTC",
    "address": "tb1qurv0m4ufsj8xqejvmn0y43kqew33kvqrrxswgm",
    "tag": null
  },
  "transactions": [
    {
      "id": 999,
      "currency": "BTC",
      "transaction_type": "blockchain",
      "type": "withdrawal",
      "address": "tb1qurv0m4ufsj8xqejvmn0y43kqew33kvqrrxswgm",
      "tag": null,
      "amount": "0.01000000",
      "txid": null,
      "confirmations": "0"
    }
  ],
  "fees": [],
  "error": "",
  "status": "pending"
}

Sent when a withdrawal with conversion exceeds the configured withdrawals limits and is awaiting approval from a user with the Owner role.

{
  "id": 132533108,
  "foreign_id": "withdrawal_1230203",
  "end_user_reference": "user_12345",
  "type": "withdrawal_exchange",
  "crypto_address": {
    "id": 3776985,
    "currency": "BTC",
    "address": "tb1qj0d4rsczat6dx3yy065g98rrz5hewkrdcrz7je",
    "tag": null
  },
  "transactions": [
    {
      "id": 3779034,
      "currency": "BTC",
      "transaction_type": "blockchain",
      "type": "withdrawal",
      "address": "tb1qj0d4rsczat6dx3yy065g98rrz5hewkrdcrz7je",
      "tag": null,
      "amount": "0.00000000",
      "txid": null,
      "riskscore": null,
      "confirmations": "0"
    },
    {
      "id": 3779035,
      "currency": "EUR",
      "currency_to": "BTC",
      "transaction_type": "exchange",
      "type": "exchange",
      "amount": "100.00000000",
      "amount_to": "0.00000000"
    }
  ],
  "fees": [],
  "error": "",
  "status": "pending"
}

{
  "id": 132533109,
  "foreign_id": "withdrawal_123",
  "end_user_reference": "user_12345",
  "type": "withdrawal_instant_exchange",
  "crypto_address": {
    "id": 3776985,
    "currency": "BTC",
    "address": "tb1qj0d4rsczat6dx3yy065g98rrz5hewkrdcrz7je",
    "tag": null
  },
  "transactions": [
    {
      "id": 3779036,
      "currency": "BTC",
      "transaction_type": "blockchain",
      "type": "withdrawal",
      "address": "tb1qj0d4rsczat6dx3yy065g98rrz5hewkrdcrz7je",
      "tag": null,
      "amount": "0.00000000",
      "txid": null,
      "riskscore": null,
      "confirmations": "0"
    },
    {
      "id": 3779037,
      "currency": "EUR",
      "currency_to": "BTC",
      "transaction_type": "exchange",
      "type": "exchange",
      "amount": "100.00000000",
      "amount_to": "0.00000000"
    }
  ],
  "fees": [],
  "error": "",
  "status": "pending"
}

Sent when a user with the Owner role declines a withdrawal that exceeds the configured withdrawals limits.

{
  "id": 123,
  "foreign_id": "operation_987",
  "end_user_reference": "user_12345",
  "type": "withdrawal",
  "crypto_address": {
    "id": 123,
    "currency": "BTC",
    "address": "tb1qurv0m4ufsj8xqejvmn0y43kqew33kvqrrxswgm",
    "tag": null
  },
  "transactions": [
    {
      "id": 999,
      "currency": "BTC",
      "transaction_type": "blockchain",
      "type": "withdrawal",
      "address": "tb1qurv0m4ufsj8xqejvmn0y43kqew33kvqrrxswgm",
      "tag": null,
      "amount": "0.01000000",
      "txid": null,
      "confirmations": "0"
    }
  ],
  "fees": [],
  "error": "Declined by user ID:777",
  "status": "declined"
}

{
  "id": 123,
  "foreign_id": "operation_987",
  "end_user_reference": "user_12345",
  "type": "withdrawal_instant",
  "crypto_address": {
    "id": 123,
    "currency": "BTC",
    "address": "tb1qurv0m4ufsj8xqejvmn0y43kqew33kvqrrxswgm",
    "tag": null
  },
  "transactions": [
    {
      "id": 999,
      "currency": "BTC",
      "transaction_type": "blockchain",
      "type": "withdrawal",
      "address": "tb1qurv0m4ufsj8xqejvmn0y43kqew33kvqrrxswgm",
      "tag": null,
      "amount": "0.01000000",
      "txid": null,
      "confirmations": "0"
    }
  ],
  "fees": [],
  "error": "Declined by user ID:777",
  "status": "declined"
}

Sent when a withdrawal is cancelled and will not be completed. Use the error field to determine the reason, for example:

Address is invalid

There is a mistake in the specified address, and it does not match the format required for the specific currency.

Not enough money on balance

At the time of initiating the withdrawal, you did not have enough funds in the balance of the specific currency being withdrawn. Top up the balance and reinitiate the withdrawal.The system requires the balance to be available in the exact currency being withdrawn, because automatic conversion is not possible for security reasons. You must convert the funds manually.

Total of negative balances exceeds the allowed value

The total negative balances across all currencies exceed 20 EUR. Top up your balance and reinitiate the withdrawal.

Destination account tag is required

The destination address requires a tag (also called a memo or destination tag) to correctly credit the recipient, but none was provided in the withdrawal request. Specify the required tag and reinitiate the withdrawal.

{
  "id": 123,
  "foreign_id": "operation_987",
  "end_user_reference": "user_12345",
  "type": "withdrawal",
  "crypto_address": {
    "id": 123,
    "currency": "BTC",
    "address": "tb1qurv0m4ufsj8xqejvmn0y43kqew33kvqrrxswgm",
    "tag": null
  },
  "transactions": [
    {
      "id": 999,
      "currency": "BTC",
      "transaction_type": "blockchain",
      "type": "withdrawal",
      "address": "tb1qurv0m4ufsj8xqejvmn0y43kqew33kvqrrxswgm",
      "tag": null,
      "amount": "0.01000000",
      "txid": null,
      "confirmations": "0"
    }
  ],
  "fees": [],
  "error": "Not enough money on balance",
  "status": "cancelled"
}

{
  "id": 123,
  "foreign_id": "operation_987",
  "end_user_reference": "user_12345",
  "type": "withdrawal_instant",
  "crypto_address": {
    "id": 123,
    "currency": "BTC",
    "address": "tb1qurv0m4ufsj8xqejvmn0y43kqew33kvqrrxswgm",
    "tag": null
  },
  "transactions": [
    {
      "id": 999,
      "currency": "BTC",
      "transaction_type": "blockchain",
      "type": "withdrawal",
      "address": "tb1qurv0m4ufsj8xqejvmn0y43kqew33kvqrrxswgm",
      "tag": null,
      "amount": "0.01000000",
      "txid": null,
      "confirmations": "0"
    }
  ],
  "fees": [],
  "error": "Not enough money on balance",
  "status": "cancelled"
}

Reference

Deposits & withdrawals

Invoices

Currencies

Exchange

Transactions

Account balance

System Health