Balance

Overview

Retrieves the credit balance in your account. The credit balance gets updated when you recharge or verify emails.

Example Request

#GET 'http://api.removebounce.com/v1/balance'

curl --location --request GET 'http://api.removebounce.com/v1/balance' \
     --header 'X-RB-API-KEY: <YOUR_API_KEY_HERE>'

Example Response

# Balance object example

{
  "available": 200
  "pending": 72
}

Fields

Field Type Description
available integer Available credits in your account to be used
pending integer Pending credits in your account.

Error codes

Code Type Message Reason
400 bad_request X-RB-API-KEY header is missing. Occurs due to the absence of the X-RB-API-KEY header from the request.
401 authentication_error No valid API key provided. Occurs due to providing an invalid API key. If you don't have a valid API key or if it expired, go to Dashboard and generate a new key.
5xx N/A N/A Occurs when the API is down.
Last Updated: 4/20/2020, 6:50:46 PM