Retrieve the current balance of a merchant for a given region and currency.

Request Content

Enter any of the query parameters below into the request URL. For example:
services/2/balance/available-funds?vendorId=11111

Query Parameters

Response Details

If successful, the response HTTP status code is 200 OK.
The response contains the following fields:

Examples

Request Examples

curl -v -X GET https://sandbox.bluesnap.com/services/2/balance/available-funds?vendorId=11111 \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \ 
-H 'Authorization: Basic dXNlcm5hbWU6cGFzc3dvcmQ=' \
-d '

Response Examples

{
  "merchantId": 5718485,
  "balance": [
    {
      "legalEntity": "EU",
      "totalFundsUsd": 317.98,
      "totalPendingRefundsAmountUsd": 0,
      "currencies": [
        {
          "currency": "CAD",
          "funds": 433.24,
          "fundsUsd": 317.98
        }
      ]
    }
  ]
}

API Explorer

To test out a basic API request, click the "Try It!" button in the right-hand column to test using the default, pre-populated sample values. To test with your own values, edit the parameter fields below. You'll see them populate in the right-hand column and you can click the "Try It!" button to submit your test request and see a response.