---
title: "Get Settlement Account Balance"
method: GET
path: "/v1/payments/paymentToPlatform/{settlementAccountId}"
tags: ["Payment to Platform"]
---

# Get Settlement Account Balance

`GET /v1/payments/paymentToPlatform/{settlementAccountId}`

## Request

- Base URL: `https://sandbox-api.spinwheel.io`
- URL: `https://sandbox-api.spinwheel.io/v1/payments/paymentToPlatform/{settlementAccountId}`
- Auth: API key in header `Authorization`

Returns the balance for a specific settlement account identified by settlementAccountId.

## Path parameters

- `settlementAccountId` string, required

## Response `200`

Successful response

- GetSettlementAccountBalanceResponse
  - `status` ResponseStatus, required
    - `code` number
    - `desc` string
    - `messages` Message[]
      - `desc` string, required
      - `type` 'ERROR' | 'WARN' | 'INFO'
  - `data` SettlementAccountBalanceResponse, required
    - `balance` number, required: Balance of the settlement account.
    - `businessName` string, required: Name of the account's financial institution
    - `settlementAccountId` string, required: ID of the settlement account whose balance is returned.

## Other responses

- `400`: Bad request response
- `401`: Unauthorized response
- `404`: Settlement account not found for the given settlementAccountId.
- `500`: Balance is temporarily unavailable.

---

[API](https://skmtc.dev/spinwheel/apis/pay.md) - [All operations](https://skmtc.dev/spinwheel/apis/pay/llms.txt) - [OpenAPI document](https://skmtc.dev/spinwheel/apis/pay/revisions/58ba91f8ae13?raw)