LogoLogo
Release notesHomepageTry demo
  • Welcome to B2BINPAY docs
  • Get started
    • Quick start guide
    • Explore the Web interface
  • User guide
    • Wallet management
      • Wallets
      • Transfers
      • Deposits
      • Payouts
      • Events
      • Callbacks
    • Custody
      • Wallets
      • Requests
      • History
    • Staking
      • TRX staking
    • Rates
    • Swaps
      • Wallets
      • Swap
      • History
  • How-tos
    • Manage your profile and system
      • How to change your password
      • How to enable 2FA
      • How to whitelist IP addresses
      • How to access the API
      • How to enable additional AML check
    • Manage your wallets
      • How to create a wallet
      • How to grant access to your wallet
      • How to manage user roles
      • How to restrict access to your wallet
      • How to generate a report on wallet balances
      • How to set withdrawal thresholds
    • Manage your assets
      • How to create a deposit
      • How to create a payout
      • How to create a bank withdrawal
      • How to create an internal transfer
      • How to select the optimal blockchain fee
      • How to speed up your payout by changing the blockchain fee
      • How to whitelist a payout address
      • How to swap funds
      • How to top up or withdraw funds from your Custody wallet
  • API guide
    • API overview
    • Authentication
    • Wallet methods
    • Transfer methods
    • Deposit methods
    • Payout methods
    • Currency methods
    • Rate methods
  • References
    • Key terms
    • User roles
    • Transfer types
    • Currency codes
    • Block explorer list
    • Address types
    • Useful links
  • Troubleshooting
    • Error: No active account found with the given credentials
    • Error: Invalid 2FA code
    • Error: You IP is not whitelisted
    • Unresolved deposits
    • Missing deposits
    • Canceled transfers
    • Unconfirmed transfers
  • Release notes
Powered by GitBook
On this page
  • General information
  • Filtering
  • Callbacks
  • Date-time values
  • Destination object
  • API rate limits and accessibility
  • Base URLs

Was this helpful?

  1. API guide

API overview

PreviousHow to top up or withdraw funds from your Custody walletNextAuthentication

Last updated 3 months ago

Was this helpful?

General information

The B2BINPAY API is organized in accordance with JSON API paradigm. For a better understanding of the paradigm principles, read the .

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 and should contain HTTP header: Authorization: Bearer <Access Token>.

According to , all requests should contain HTTP header: Content-Type: application/vnd.api+json.

Filtering

Filters by object parameters can be applied to any GET-method according to the .

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 .

To receive callbacks, specify a callback URL when sending a or request. When a transaction receives the required number of confirmation blocks, the callback is sent via an HTTP POST-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

All date-time values are specified as per , with milliseconds precision and timezone included: YYYY-MM-DDThh:mm:ss[.SSSSSS]±hh:mm.

Destination object

The object contains the following fields:

  • 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):

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

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

"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

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

Code
Production
Sandbox

[base]

address_type (string or null) For wallets denominated in BTC, LTC, BCH, XRP: the address type. Refer to for supported values. For other wallets the value is null.

Address types
https://api.it.b2binpay.com
https://api-sandbox.b2binpay.com
JSON API Specification
JSON API Specification
JSON API Specification
ISO 8601-1:2019
Obtain token
Refresh token
Callback
Create payout
Create deposit