Skip to main content
GET
Get Payment Balance

Overview

GET /payment/balance returns the current pay-in and pay-out sub-balances for every wallet your company holds, with one entry per (currency, country) pair. Use this before initiating a payout to verify funds are available, or to render a balances widget in your dashboard.

When to use it

  • Pre-flight check before POST /payment/payout to avoid 400 Insufficient balance.
  • Render a wallet/balance summary on a dashboard.
  • Reconcile your local accounting balance against Cartevo.

Prerequisites

  • Authenticated as a company user.

Request

Headers

No query parameters or body.

Response

200 — Success

About the two sub-balances: Each wallet maintains a separate pay-in and pay-out sub-balance. Use POST /wallets/{id}/transfer-internal (currently undocumented; reach out to support) to move funds between them when needed. The USD wallet is also the source-of-funds for card issuance and funding.

Error responses

Code examples

cURL
Node.js (axios)

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Response

200 - application/json

Balance retrieved successfully

success
boolean
Example:

true

message
string
Example:

"Balance retrieved successfully"

data
object