Payment to Platform

Get Settlement Account Balance

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

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

Path parameters

settlementAccountIdstring required

The ID of the settlement account to check balance for.

Response

Successful response

Example response

{
  "status": {
    "code": 200,
    "desc": "success",
    "messages": [
      {
        "desc": "Example description"
      }
    ]
  },
  "data": {
    "balance": 4523.28,
    "businessName": "Axis Bank Pvt. Ltd.",
    "settlementAccountId": "7a1b2c3d-4e5f-6a7b-8c9d-0e1f2a3b4c5d"
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.