Balance API

The balance API allows you to see the current balance of funds in your Pin Payments account. You can use this to confirm whether a transfer is possible.

GET /balance

Returns the current balance of your Pin Payments account. Transfers can only be made using the funds in the available balance. The pending amount will become available in accordance with the settlement schedule on your charges.

Example

curl https://test-api.pinpayments.com/1/balance -u your-secret-api-key:
200 OK
{
  "response": {
    "available": [
      {
        "amount": 400,
        "currency": "AUD"
      }
    ],
    "pending": [
      {
        "amount": 1200,
        "currency": "AUD"
      }
    ]
  }
}

Available balance

The Available amount represents the funds that are ready to be transferred with the Transfer API.

Pending balance

The Pending amount represents the funds that are ready to be transferred (the available balance), plus estimated funds from charges that are yet to settle.

Pin Payments is owned and operated by
Southern Payment Systems Pty Ltd
ABN: 46 154 451 582
Level 1, 34 Queen St,
Melbourne VIC 3000

Privacy Policy Terms Security Status

Australia