Skip to main content
GET
/
api
/
v1
/
customers
/
{customer_id}
/
balances
Get customer balances
curl --request GET \
  --url https://payments.oaknetwork.org/api/v1/customers/{customer_id}/balances \
  --header 'Authorization: Bearer <token>'
{
  "msg": "<string>",
  "data": {
    "as_of": "2023-11-07T05:31:56Z",
    "filters": {
      "customer_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "provider": "<string>",
      "role": "<string>"
    },
    "balances": [
      {
        "provider": "<string>",
        "role": "<string>",
        "available_balance": 123,
        "pending_balance": 123,
        "currency": "<string>"
      }
    ]
  }
}

Authorizations

Authorization
string
header
required

Merchant authentication token. Obtained via POST /api/v1/merchant/token/grant. Pass as: Authorization: Bearer

Path Parameters

customer_id
string<uuid>
required

Query Parameters

provider
string

Comma-separated provider names (case-insensitive)

role
string

Comma-separated roles (case-insensitive)

Response

Balance information

msg
string
required

Human-readable message describing the result

data
object
required

Response payload (null on error)