BVbvnk
Merchant IDs

Create merchant ID

Changed on

Generate a Merchant ID for your account to process pay-ins and pay-outs through our API.

A Merchant ID is essential as it designates the account wallet where incoming pay-ins will be settled. For instance, if a Merchant ID is associated with a EUR wallet ID, any incoming USDT payment will be automatically converted to EUR and deposited in the designated EUR wallet.

Vice versa, any outgoing USDT payment will be automatically converted and withdrawn from the designated EUR wallet.

post/api/v1/merchant

Request

Request body

displayNamestring required

The name of the merchant that will be displayed on the payments page.

webhookUrlstring

The URL that will recieve the webhooks.

Example request

{
  "displayName": "Test Merchant Name",
  "webhookUrl": "https://www.URL.com/to/send/webhooks/to",
  "wallet": {
    "id": "501098"
  }
}

Response

OK

idinteger

The ID of the Merchant ID.

merchantIdstring

The Merchant ID as a UUID.

displayNamestring

The name of the merchant displayed on the payments page.

secretstring

The secret key used to validate webhooks.

webhookUrlstring

The webhooks URL that webhoosk are sent to.

autoConvertInvalidPaymentsboolean

Is set to auto convert invalid payments.

defaultExpiryMinutesinteger

The default number of minutes before a payment expires for this Merchant ID.

webhookVersioninteger

The version of webhooks sent.

emailRecipientsstring

The recipients of event emails.

Example response

{
  "id": 1432,
  "merchantId": "b312436e-e477-49d4-be7f-9d027f9b9e34",
  "displayName": "Test Merchant Name",
  "secret": "MzI5OGUyZGMtN2FkOC00NzVkLThjNzEtMWVjMzk2ZjQ5OGMwYTBlZTBlOGYtMjBhNi00NjMxLWI1MTctMTI5MjlmMjdhYmM",
  "webhookUrl": "https://www.URL.com/to/send/webhooks/to",
  "defaultExpiryMinutes": 1440,
  "webhookVersion": 1,
  "wallet": {
    "address": "0x7be879d34f3Db833f70d9fE4873Bdd0cBcaC6bf6",
    "alternatives": [],
    "approxAvailable": "0.59573928",
    "approxBalance": "0.59573928",
    "available": 0.59573928,
    "balance": 0.59573928,
    "convertedAvailable": 20917.59,
    "currency": {
      "code": "ETH",
      "icon": "https://cdn.com/eth-icon.png",
      "id": 1432,
      "name": "Ethereum",
      "options": {
        "transaction": "https://etherscan.io/tx/{{hash}}",
        "explorer": "https://etherscan.io/",
        "address": "https://etherscan.io/address/{{address}}",
        "confirmations": 12
      },
      "protocols": [
        {
          "code": "ERC20",
          "network": "Ethereum"
        }
      ],
      "withdrawalFee": 0.01,
      "withdrawalParameters": [
        {
          "id": 1432,
          "code": "BTC",
          "name": "Bitcoin"
        }
      ]
    },
    "description": "ETH wallet",
    "id": 1432,
    "network": "ETHEREUM",
    "protocol": "ETH",
    "withdrawalFee": 0.001,
    "supportedTransferDestinations": [
      "LOCAL"
    ],
    "approxConvertedAvailable": "19.71",
    "lsid": "a:25061134333492:69iFbD6:1",
    "status": "ACTIVE"
  }
}

Changes

  • 97d6c0d2fe2eRevision changes
    • info

      the endpoint scheme security ApiKeyAuth was added to the API

    • info

      the endpoint scheme security Hawk was removed from the API