<Callout type="error">
  This API version is deprecated and will no longer be supported after December 1, 2025.
  Refer to [API v3](/b2binpay-business/api-guide/api-overview) for updated descriptions.
</Callout>

## General information [#general-information]

The B2BINPAY API is organized in accordance with JSON API paradigm. For a better understanding of the paradigm principles, read the [JSON API Specification](https://jsonapi.org/format/).

We use conventional HTTP response codes, OAuth 2.0 protocol for authentication, and HMAC-SHA256 algorithm for encryption.

All methods are private. All requests except for [Obtain token](/b2binpay-business/api-guide-v2-deprecated/authentication#obtain-token) and [Refresh token](/b2binpay-business/api-guide-v2-deprecated/authentication#refresh-token) should contain HTTP header: `Authorization: Bearer <Access Token>`.

According to [JSON API Specification](https://jsonapi.org/format/), all requests should contain HTTP header: `Content-Type: application/vnd.api+json`.

## Filtering [#filtering]

Filters by object parameters can be applied to any <span class="gb-mark-green">`GET`</span>-method according to the [JSON API Specification](https://jsonapi.org/format/).

## Callbacks [#callbacks]

The B2BINPAY API also provides flexible options for callback — an asynchronous notification about changing statuses of deposits and payouts.
To learn more, refer to [Callback](/b2binpay-business/references/key-terms#callback).

To receive callbacks, specify a callback URL when sending a [Create deposit](/b2binpay-business/api-guide-v2-deprecated/deposit-methods#create-deposit) or [Create payout](/b2binpay-business/api-guide-v2-deprecated/payout-methods#create-payout) request. When a transaction receives the required number of confirmation blocks, the callback is sent via an HTTP <span class="gb-mark-blue">`POST`</span>-request to the specified URL. If you also want to be notified when the number of confirmations received for a transaction doesn’t reach a specific threshold or exceeds it, indicate the required number of confirmations in the request.

## Date-time values [#date-time-values]

All date-time values are specified as per [ISO 8601-1:2019](https://www.iso.org/standard/70907.html), with milliseconds precision and timezone included: `YYYY-MM-DDThh:mm:ss[.SSSSSS]±hh:mm`.

## Destination object [#destination-object]

The object contains the following fields:

* `address_type` (string or null)\
  For wallets denominated in BTC, LTC, BCH, XRP: the address type. Refer to [Address types](/b2binpay-business/references/address-types) for supported values.\
  For other wallets the value is null.
* `address` (string)\
  The deposit address.\
  For payments in XRP, an array of objects is returned containing the `x-address` and `address` (with a destination `tag` additionally specified):

```json
"destination": [
  {
    "address_type": "x-address",
    "address": "X7dBkB9KmvUh6GGHbjhxdu4LfkwhJ74oVWbGRoy7VLnHdJ6"
  },
  {
    "address_type": "address",
    "address": "rsxXXvBXmKUkCyCeNCHUFpfCX9pQdxQhv5",
    "tag": "0"
  }
]
```

For payments in XLM, the `destination` object is as follows:

```json
"destination": {
  "address_type": "address",
  "address": "GCZJFWB5NVQHVBMV4U6CCJIXXBGINGYF2W33PMD5REBD5VQ6H6BLCJR5",
  "tag_type": 0,
  "tag": ""
}
```

where:

* `address_type` is always `"address"`.
* `address` is a string value containing the wallet address.
* `tag_type` is a number value containing tag or memo type. Possible values:
  * `0` — no memo
  * `1` — a 64-bit unsigned integer
* `tag` is a string value containing the tag.

## API rate limits and accessibility [#api-rate-limits-and-accessibility]

The number of requests to the endpoint without prior authentication is limited to 15 per 1 minute.

To check the network availability of the system, use the `/ping` endpoint without authorization headers.

## Base URLs [#base-urls]

<RawHtml b64="PHRhYmxlPgogICAgPHRoZWFkPgogICAgICAgIDx0cj4KICAgICAgICAgICAgPHRoIHdpZHRoPSIxMzciPkNvZGU8L3RoPgogICAgICAgICAgICA8dGggd2lkdGg9IjI0NCI+UHJvZHVjdGlvbjwvdGg+CiAgICAgICAgICAgIDx0aD5TYW5kYm94PC90aD4KICAgICAgICA8L3RyPgogICAgPC90aGVhZD4KICAgIDx0Ym9keT4KICAgICAgICA8dHI+CiAgICAgICAgICAgIDx0ZD48Y29kZT5bYmFzZV08L2NvZGU+PC90ZD4KICAgICAgICAgICAgPHRkPjxhIGhyZWY9Imh0dHBzOi8vYXBpLml0LmIyYmlucGF5LmNvbSI+aHR0cHM6Ly9hcGkuaXQuYjJiaW5wYXkuY29tPC9hPjwvdGQ+CiAgICAgICAgICAgIDx0ZD48YSBocmVmPSJodHRwczovL2FwaS1zYW5kYm94LmIyYmlucGF5LmNvbSI+aHR0cHM6Ly9hcGktc2FuZGJveC5iMmJpbnBheS5jb208L2E+PC90ZD4KICAgICAgICA8L3RyPgogICAgPC90Ym9keT4KPC90YWJsZT4=" />
