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

# Get Account Balance

`GET /v1/payments/paymentToPlatform`

## Request

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

This API will allow you to get the balance of your master payment to platform account.

## Response `200`

- GetPaymentToPlatformBalanceResponse
  - `status` ResponseStatus, required
    - `code` number
    - `desc` string
    - `messages` Message[]
      - `desc` string, required
      - `type` 'ERROR' | 'WARN' | 'INFO'
  - `data` PaymentToPlatformBalanceResponse, required
    - `balance` number, required
    - `businessName` string, required

## Other responses

- `400`: Partners with multiple settlement accounts must specify a settlementAccountId.
- `401`: Unauthorized response
- `404`: Not found response
- `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)