Retrieve your account

GET

/v1/account

Code sample: Shell / cURL

curl --request GET \
  --url https://api.b-paid.com/v1/account \
  --header 'X-Api-Key: <X-Api-Key>'

Retrieves the account your API key belongs to, with its available balance.

Authorizations

• ApiKey

Responses

200

Your account.

Media typeapplication/json

The account your API key belongs to.

object

id

The account’s bpid. Other b-paid accounts use it to pay you.

string

name

The account’s name.

string

available_balance

The account’s available balance in cents (USD): the money you can send now. Amounts set aside for scheduled payments you sent are already taken out. null until your account can send payments; if it stays null, contact b-paid support.

integer format: int64

nullable

Example

{
  "id": "ACC-ONE-000-BZ",
  "name": "Your Business",
  "available_balance": 12500000
}

400

A query parameter is unknown, empty or repeated (invalid_parameters_error).

401

The API key is missing, unknown or revoked (invalid_api_key_error).

403

API access isn’t turned on for your account (insufficient_permissions_error); b-paid support can turn it on. Or your business isn’t verified yet (verification_required_error); finish verifying it in the b-paid app.

429

Too many requests (rate_limited_error). Wait the number of seconds in the Retry-After header, then retry.

Headers

Retry-After

integer

Seconds to wait before retrying.

500

Something went wrong on our side (internal_server_error). Retry the same request.

503

The b-paid API is temporarily unavailable (service_unavailable_error). Retry the same request in a moment.