# Callback Examples

## Deposit Callbacks

To provide authentication for the callback, WallexPay API signs the POST your API key and secret:

1. **X-Processing-Key** – Your public key
2. **X-Processing-Signature** – POST body, signed by your secret key HMAC-SHA512

{% tabs %}
{% tab title="BTC" %}

```
{
    "id": 1,
    "type": "deposit",
    "crypto_address": {
        "id": 1,
        "currency": "BTC",
        "address": "39mFf3X46YzUtfdwVQpYXPCMydc74ccbAZ",
        "foreign_id": "user-id:2048",
        "tag": null
    },
    "currency_sent": {
        "currency": "BTC",
        "amount": "6.53157512"
    },
    "currency_received": {
        "currency": "BTC",
        "amount": "6.53157512",
        "amount_minus_fee": "6.5119800"
    },
    "transactions": [
        {
            "id": 1,
            "currency": "BTC",
            "transaction_type": "blockchain",
            "type": "deposit",
            "address": "39mFf3X46YzUtfdwVQpYXPCMydc74ccbAZ",
            "tag": null,
            "amount": "6.53157512",
            "txid": "3950ad8149421a850d01dff88f024810e363ac18c9e8dd9bc0b9116e7937ad93",
            "riskscore": "0.5",
            "confirmations": 3
        }
    ],
    "fees": [
        {
            "type": "deposit",
            "currency": "BTC",
            "amount": "0.01959472"
        }
    ],
    "error": "",
    "status": "confirmed"
}
```

{% endtab %}

{% tab title="Deposit BTC with exchange to EUR" %}

```
{
    "id": 2686510,
    "type": "deposit_exchange",
    "crypto_address": {
        "id": 382270,
        "currency": "BTC",
        "convert_to": "EUR",
        "address": "31vnLqxVJ1iShJ5Ly586q8XKucECx12bZS",
        "tag": null,
        "foreign_id": "13a"
    },
    "currency_sent": {
        "currency": "BTC",
        "amount": "0.01000000"
    },
    "currency_received": {
        "currency": "EUR",
        "amount": "84.17070222",
        "amount_minus_fee": "79.96216711"
    },
    "transactions": [
        {
            "id": 714576,
            "currency": "BTC",
            "transaction_type": "blockchain",
            "type": "deposit",
            "address": "31vnLqxVJ1iShJ5Ly586q8XKucECx12bZS",
            "tag": null,
            "amount": "0.01000000",
            "txid": "3a491da90a1ce5a318d0aeff6867ab98a03219abae29ed68d702291703c3538b",
            "riskscore": "0.42",
            "confirmations": "1"
        },
        {
            "id": 714577,
            "currency": "BTC",
            "currency_to": "EUR",
            "transaction_type": "exchange",
            "type": "exchange",
            "amount": "0.01000000",
            "amount_to": "84.17070222"
        }
    ],
    "fees": [
        {
            "type": "exchange",
            "currency": "EUR",
            "amount": "4.20853511"
        }
    ],
    "error": "",
    "status": "confirmed"
}
```

{% endtab %}
{% endtabs %}

{% hint style="info" %}
**"riskscore"** is used for coin compliance analysis and to reveal and track malicious behavior. Available for deposits and deposits with exchange in BTC, BCH.
{% endhint %}

## Withdrawal Callbacks

{% tabs %}
{% tab title="BTC" %}

```
{
    "id": 1,
    "foreign_id": "10",
    "type": "withdrawal",
    "crypto_address": {
        "id": 1,
        "currency": "BTC",
        "address": "115Mn1jCjBh1CNqug7yAB21Hq2rw8PfmTA",
        "tag": null
    },
    "currency_sent": {
        "currency": "BTC",
        "amount": "0.02000000"
    },
    "currency_received": {
        "currency": "BTC",
        "amount": "0.02000000"
    },
    "transactions": [
        {
            "id": 1,
            "currency": "BTC",
            "transaction_type": "blockchain",
            "type": "withdrawal",
            "address": "115Mn1jCjBh1CNqug7yAB21Hq2rw8PfmTA",
            "tag": null,
            "amount": "0.02",
            "txid": "bb040d895ef7141ea0b06b04227d8f5dd4ee12d5b890e6e5633f6439393a666b",
            "confirmations": 3
        }
    ],
    "fees": [
        {
            "type": "mining",
            "currency": "BTC",
            "amount": "0.00007402"
        },
        {
            "type": "withdrawal",
            "currency": "BTC",
            "amount": "0.00002000"
        }
    ],
    "error": "",
    "status": "confirmed"
}
```

{% endtab %}

{% tab title="Withdraw EUR with exchange to BTC" %}

```
{
    "id": 1,
    "foreign_id": "20",
    "type": "withdrawal_exchange",
    "crypto_address": {
        "id": 1,
        "currency": "EUR",
        "convert_to": "BTC",
        "address": "1K2btnZ8cqNFBPhaq729Mdj8W6G3w2nBbL",
        "tag": null
    },
    "currency_sent": {
        "currency": "EUR",
        "amount": "381"
    },
    "currency_received": {
        "currency": "BTC",
        "amount": "0.10882300"
    },
    "transactions": [
        {
            "id": 1,
            "currency": "EUR",
            "currency_to": "BTC",
            "transaction_type": "exchange",
            "type": "exchange",
            "amount": 381,
            "amount_to": 0.10882300
        },
        {
            "id": 1,
            "currency": "BTC",
            "transaction_type": "blockchain",
            "type": "withdrawal",
            "address": "1K2btnZ8cqNFBPhaq729Mdj8W6G3w2nBbL",
            "tag": null,
            "amount": 0.10882300,
            "txid": "aa3345b96389e126f1ce88a670d1b1e38f2c3f73fb3ecfff8d9da1b1ce6964a6",
            "confirmations": 3
        }
    ],
    "fees": [
        {
            "type": "exchange",
            "currency": "EUR",
            "amount": "3.04800000"
        },
        {
            "type": "mining",
            "currency": "EUR",
            "amount": "0.04489780"
        }
    ],
    "error": "",
    "status": "confirmed"
}
```

{% endtab %}
{% endtabs %}

## Exchange Callbacks

{% tabs %}
{% tab title="Buy BTC for EUR" %}

```
{
    "id": 2686900,
    "type": "exchange",
    "currency_sent": {
        "currency": "EUR",
        "amount": "26.75248865"
    },
    "currency_received": {
        "currency": "BTC",
        "amount": "0.00300000"
    },
    "transactions": [
        {
            "id": 715072,
            "currency": "EUR",
            "currency_to": "BTC",
            "transaction_type": "exchange",
            "type": "exchange",
            "amount": "26.75248865",
            "amount_to": "0.00300000"
        }
    ],
    "fees": [
        {
            "type": "exchange",
            "currency": "EUR",
            "amount": "0.26752489"
        }
    ],
    "error": "",
    "status": "confirmed"
}
```

{% endtab %}

{% tab title="Sell BTC for USD" %}

```
{
    "id": 2686901,
    "type": "exchange",
    "currency_sent": {
        "currency": "BTC",
        "amount": "0.00300000"
    },
    "currency_received": {
        "currency": "USD",
        "amount": "29.50408884"
    },
    "transactions": [
        {
            "id": 715072,
            "currency": "BTC",
            "currency_to": "USD",
            "transaction_type": "exchange",
            "type": "exchange",
            "amount": "0.00300000",
            "amount_to": "29.50408884"
        }
    ],
    "fees": [
        {
            "type": "exchange",
            "currency": "USD",
            "amount": "0.29504089"
        }
    ],
    "error": "",
    "status": "confirmed"
}
```

{% endtab %}
{% endtabs %}

## Futures Callback

{% tabs %}
{% tab title="Calculate rates for futures" %}

```
{
    "data": {
        "addresses": [
            {
                "id": 1350020,
                "currency": "BTC",
                "convert_to": "EUR",
                "address": "your_deposit_address",
                "tag": null
            }
        ],
        "ts_fixed": 1584005304,
        "ts_release": 1584005904,
        "rates": {
            "BTCEUR": {
                "100.00000000": "6495.27045000",
                "500.00000000": "6495.27045000",
                "1000.00000000": "6495.26249000",
                "5000.00000000": "6495.26149500",
                "10000.00000000": "6494.86379350",
                "50000.00000000": "6494.08501695",
                "100000.00000000": "0.00000000"
            }
        }
    }
}
```

{% endtab %}

{% tab title="Confirm futures transaction request" %}

```
{
 "address": "your_deposit_address",
 "sender_currency": "BTC",
 "receiver_currency": "EUR",
 "receiver_amount": 100
}
```

{% endtab %}

{% tab title="Confirm futures transaction response" %}

```
{
    "data": {
        "futures_id": 29,
        "sender_currency": "BTC",
        "receiver_currency": "EUR",
        "fee_currency": "EUR",
        "price": "6495.27045000",
        "address": {
            "id": 1350020,
            "currency": "BTC",
            "convert_to": "EUR",
            "address": "your_deposit_address",
            "tag": null
        },
        "sender_amount": "0.01539581",
        "receiver_amount": "100.00000000",
        "fee_amount": "1.50000000",
        "ts_fixed": 1584005304,
        "ts_release": 1584005904
    }
}
```

{% endtab %}
{% endtabs %}

## Invoices

### Invoice types callbacks

{% tabs %}
{% tab title="1st Type of Invoice request" %}

```javascript
 "timer": false,
 "title": "Invoice Title",
 "currency": "EUR",
 "amount": 106.75,
 "foreign_id": "196",
 "url_success": "http://success.test",
 "url_failed": "http://failed.test",
 "email_user": "email@address.com"
```

{% endtab %}

{% tab title="1st Type of Invoice response" %}

```javascript
{
   "data":{
      "id": 127,
      "url": "https://wallet.wllxpay.io/invoice/iEU3uh",
      "foreign_id": "196",
      "address": null,
      "title": "Invoice Title",
      "status": "created",
      "currency": "EUR",
      "amount": "106.75000000",
      "sender_currency": null,
      "sender_amount": null,
      "fixed_at": null,
      "release_at": null,
      "seconds_left": null
   }
}
```

{% endtab %}

{% tab title="2nd Type of Invoice request" %}

```javascript
 "timer": true,
 "title": "Invoice Title",
 "currency": "BTC",
 "amount": 0.02,
 "foreign_id": "197",
 "url_success": "http://success.test",
 "url_failed": "http://failed.test",
 "email_user": "email@address.com"
```

{% endtab %}

{% tab title="2nd Type of Invoice response" %}

```javascript
{
    "data": {
        "id": 26,
        "url": "https://wallet.wllxpay.io/invoice/XJrbOG",
        "foreign_id": "197",
        "address": null,
        "title": "Invoice Title",
        "status": "pending",
        "currency": "BTC",
        "amount": "0.01000000",
        "sender_currency": null,
        "sender_amount": null,
        "fixed_at": 1592315493,
        "release_at": 1592316393,
        "seconds_left": 899
    }
}
```

{% endtab %}

{% tab title="3rd Type of Invoice request" %}

```javascript
 "timer": true,
 "title": "Invoice Title",
 "description": "Invoice description",
 "currency": "EUR",
 "sender_currency": "BTC",
 "amount": 35,
 "foreign_id": "200",
 "url_success": "http://success.test",
 "url_failed": "http://failed.test",
 "email_user": "email@address.com"
```

{% endtab %}

{% tab title="3rd Type of Invoice response" %}

```javascript
   "data":{
       "id": 28,
       "url": "https://wallet.wllxpay.io/invoice/zeUBm1",
       "foreign_id": "200",
       "address": "2NCMFo2k7S8HSDWp6qwQ2wiAMwz3XwEC4Gp",
       "title": "Invoice Title",
       "status": "pending",
       "currency": "EUR",
       "amount": "35.00000000",
       "sender_currency": "BTC",
       "sender_amount": "0.00413945",
       "fixed_at": 1592316313,
       "release_at": 1592317213,
       "seconds_left": 899
   }
}
```

{% endtab %}
{% endtabs %}

### Invoice payment callbacks

{% tabs %}
{% tab title="Invoice payment by installemts" %}

```javascript
{
  "id": 588,
  "foreign_id": "8FW1KI7LesB9yxWcK1K",
  "type": "invoice",
  "crypto_address": {
    "id": 386897,
    "currency": "BTC",
    "address": "2Mvo6FMduhHz1BTDHsQ5GyRoifcG3y4ycpk",
    "tag": null
  },
  "currency_sent": {
    "currency": "BTC",
    "amount": "0.02000000",
    "remaining_amount": "0.01000000"
  },
  "currency_received": {
    "currency": "BTC",
    "amount": "0.02000000"
  },
  "transactions": [
    {
      "id": 750294,
      "currency": "BTC",
      "transaction_type": "blockchain",
      "type": "deposit",
      "address": "2Mvo6FMduhHz1BTDHsQ5GyRoifcG3y4ycpk",
      "tag": null,
      "amount": "0.01000000",
      "txid": "528dcda13270f8590853405600bf5634d53aa66d2ce5d3a873006a670f9da788",
      "confirmations": "0"
    }
  ],
  "fees": [],
  "error": "",
  "status": "pending",
  "fixed_at": 1592307241,
  "expires_at": 1592308141
}
```

{% endtab %}

{% tab title="Transaction is in the mempool" %}

```javascript
{
  "id": 22,
  "foreign_id": "229-hdsa",
  "type": "invoice",
  "crypto_address": {
    "id": 1845,
    "currency": "BTC",
    "convert_to": "EUR",
    "address": "2N8pvnVKEFjVCP4TteJVCPTbg9Aqibfws8C",
    "tag": null
  },
  "currency_sent": {
    "currency": "BTC",
    "amount": "0.00309556",
    "remaining_amount": "0.00000000"
  },
  "currency_received": {
    "currency": "EUR",
    "amount": "26.00000000"
  },
  "transactions": [
    {
      "id": 1504,
      "currency": "BTC",
      "transaction_type": "blockchain",
      "type": "deposit",
      "address": "2N8pvnVKEFjVCP4TteJVCPTbg9Aqibfws8C",
      "tag": null,
      "amount": "0.00309556",
      "txid": "3e68744626ba23d591dc1b548b8b9b126ab0f49e6da020958f66ee64c38ec7ed",
      "confirmations": "0"
    }
  ],
  "fees": [],
  "error": "",
  "status": "processing",
  "fixed_at": 1592308917,
  "expires_at": 1592395375
}
```

{% endtab %}

{% tab title="Successful payment" %}

```javascript
{
  "id": 588,
  "foreign_id": "8FW1KI7LesB9yxWcK1K",
  "type": "invoice",
  "crypto_address": {
    "id": 386897,
    "currency": "BTC",
    "address": "2Mvo6FMduhHz1BTDHsQ5GyRoifcG3y4ycpk",
    "tag": null
  },
  "currency_sent": {
    "currency": "BTC",
    "amount": "0.02000000",
    "remaining_amount": "0.00000000"
  },
  "currency_received": {
    "currency": "BTC",
    "amount": "0.02000000"
  },
  "transactions": [
    {
      "id": 750294,
      "currency": "BTC",
      "transaction_type": "blockchain",
      "type": "deposit",
      "address": "2Mvo6FMduhHz1BTDHsQ5GyRoifcG3y4ycpk",
      "tag": null,
      "amount": "0.01000000",
      "txid": "6647cf5cae701507b7076b32ca12f19d8e9fe037407c02e09b04abdaede99fd0",
      "confirmations": "1"
    },
    {
      "id": 750384,
      "currency": "BTC",
      "transaction_type": "blockchain",
      "type": "deposit",
      "address": "2Mvo6FMduhHz1BTDHsQ5GyRoifcG3y4ycpk",
      "tag": null,
      "amount": "0.01000000",
      "txid": "528dcda13270f8590853405600bf5634d53aa66d2ce5d3a873006a670f9da788",
      "confirmations": "1"
    }
  ],
  "fees": [
    {
      "type": "fee_crypto_deposit",
      "currency": "BTC",
      "amount": "0.0008"
    }
  ],
  "error": "",
  "status": "confirmed",
  "fixed_at": 1592307241,
  "expires_at": 1592394104
}
```

{% endtab %}

{% tab title="Timer expired" %}

```javascript
{
  "id": 23,
  "foreign_id": "77xa2pd",
  "type": "invoice",
  "crypto_address": {
    "id": 1846,
    "currency": "BTC",
    "address": "2MyL2ftBdNsmpsx1EKggPzNVuoiZCWdVaLX",
    "tag": null
  },
  "currency_sent": {
    "currency": "BTC",
    "amount": "0.02000000",
    "remaining_amount": "0.02000000"
  },
  "currency_received": {
    "currency": "BTC",
    "amount": "0.02000000"
  },
  "transactions": [],
  "fees": [],
  "error": "Timer expired. User not paid.",
  "status": "failed",
  "fixed_at": 1592309817,
  "expires_at": 1592310717
}
```

{% endtab %}

{% tab title="Processing status for more than 24 hours" %}

```javascript
{
  "id": 21,
  "foreign_id": "88smaan2",
  "type": "invoice",
  "crypto_address": {
    "id": 1844,
    "currency": "BTC",
    "address": "2NCfH4keMq2SZj3H73VeQYtb8yBgTuUrACf",
    "tag": null
  },
  "currency_sent": {
    "currency": "BTC",
    "amount": "0.01000000",
    "remaining_amount": "0.00990000"
  },
  "currency_received": {
    "currency": "BTC",
    "amount": "0.01000000"
  },
  "transactions": [
    {
      "id": 1505,
      "currency": "BTC",
      "transaction_type": "blockchain",
      "type": "deposit",
      "address": "2NCfH4keMq2SZj3H73VeQYtb8yBgTuUrACf",
      "tag": null,
      "amount": "0.00010000",
      "txid": "6dd68265eb2b3a1be0dd4a40975345155d0fbbe244c84efcc7f6b910629a38f9",
      "confirmations": "0"
    }
  ],
  "fees": [],
  "error": "Timer expired. Transactions were in status processing too long.",
  "status": "failed",
  "fixed_at": 1592308709,
  "expires_at": 1592309609
}
```

{% endtab %}

{% tab title="Payment is lesser than invoice amount" %}

```javascript
{
  "id": 21,
  "foreign_id": "88smaan2",
  "type": "invoice",
  "crypto_address": {
    "id": 1844,
    "currency": "BTC",
    "address": "2NCfH4keMq2SZj3H73VeQYtb8yBgTuUrACf",
    "tag": null
  },
  "currency_sent": {
    "currency": "BTC",
    "amount": "0.01000000",
    "remaining_amount": "0.00990000"
  },
  "currency_received": {
    "currency": "BTC",
    "amount": "0.01000000"
  },
  "transactions": [
    {
      "id": 1505,
      "currency": "BTC",
      "transaction_type": "blockchain",
      "type": "deposit",
      "address": "2NCfH4keMq2SZj3H73VeQYtb8yBgTuUrACf",
      "tag": null,
      "amount": "0.00010000",
      "txid": "6dd68265eb2b3a1be0dd4a40975345155d0fbbe244c84efcc7f6b910629a38f9",
      "confirmations": "2"
    }
  ],
  "fees": [],
  "error": "Timer expired. User paid less than requested.",
  "status": "failed",
  "fixed_at": 1592308709,
  "expires_at": 1592309609
}
```

{% endtab %}
{% endtabs %}

## Callbacks with other statuses

{% tabs %}
{% tab title="Not confirmed" %}

```
{
    "id": 2686579,
    "type": "deposit",
    "crypto_address": {
        "id": 381711,
        "currency": "BTC",
        "address": "2N9zXNdiT8ucZp7zZSrucqYGCD6xYF8F3di",
        "tag": null,
        "foreign_id": "991904"
    },
    "currency_sent": {
        "currency": "BTC",
        "amount": "0.01000000"
    },
    "currency_received": {
        "currency": "BTC",
        "amount": "0.01000000",
        "amount_minus_fee": "0.01000000"
    },
    "transactions": [
        {
            "id": 714680,
            "currency": "BTC",
            "transaction_type": "blockchain",
            "type": "deposit",
            "address": "2N9zXNdiT8ucZp7zZSrucqYGCD6xYF8F3di",
            "tag": null,
            "amount": "0.01000000",
            "txid": "998c4d9bb7145aafd88658b292f41fe05973c217f7adcd6052bcafe2309e7e02",
            "confirmations": "0"
        }
    ],
    "fees": [],
    "error": "",
    "status": "not_confirmed"
}
```

{% endtab %}
{% endtabs %}


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://wallexpay.gitbook.io/api-doc/api-documentation/callback-examples.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.