Skip to main content
GET
/
v1
/
c
/
customer
/
{customer_id}
/
balance
Return an array with the balances of a customer (one balance per currency)
curl --request GET \
  --url http://127.0.0.1:8080/v1/c/customer/{customer_id}/balance \
  --header 'wb-key: <api-key>'
[
  {
    "currency": "usd",
    "customer_id": "Cust_c40bea18-c0c9-44b1-bd0c-43f5283e1670",
    "deposits": {},
    "invoices": {},
    "total_invoices_ready_for_payment": "<string>",
    "wb_customer_id": "Cust_c40bea18-c0c9-44b1-bd0c-43f5283e1670"
  }
]

Authorizations

​
wb-key
string
header
required

Path Parameters

​
customer_id
string
required

Id of the Customer

Response

200 - application/json

Customer Balance

​
currency
enum<string>
required

A supported currency

The format for parsing and reading is the lowercased ISO 4217 currency code (e.g. "usd")

Available options:
usd,
eur,
gbp,
brl,
ars
​
customer_id
string
required

Unique identifier of an object. Consists of object class prefix and a UUID

Example:

"Cust_c40bea18-c0c9-44b1-bd0c-43f5283e1670"

​
deposits
object
required

List of Deposit Transactions

​
invoices
object
required

List of invoices

​
total_invoices_ready_for_payment
string
required

Sum of the totals of the invoices which are either without any started payment, with a payment in progress or with a payment failed. This is "due". This value can also be found in invoices.ready_for_payment.total

​
wb_customer_id
string
required

Unique identifier of an object. Consists of object class prefix and a UUID

Example:

"Cust_c40bea18-c0c9-44b1-bd0c-43f5283e1670"