Accounts

Get whether there are available funds for a requested amount

get/api/v2/accounts/{accountUid}/confirmation-of-funds

Request

  • Base URL
    https://api.starlingbank.com
  • Auth
    HTTP bearer

Path parameters

accountUidstring uuid required
Example:aaaaaaaa-aaaa-4aaa-aaaa-aaaaaaaaaaaa

Account uid

Query parameters

targetAmountInMinorUnitsinteger required

Target amount in minor units

Response

Successful operation

requestedAmountAvailableToSpendboolean

True if requested amount is available to spend

accountWouldBeInOverdraftIfRequestedAmountSpentboolean

True if spending the requested amount would put the account in overdraft

Example response

{
  "requestedAmountAvailableToSpend": true,
  "accountWouldBeInOverdraftIfRequestedAmountSpent": true
}

Changes

No recorded changes to this operation across all 14 revisions of this API.