GOgocardless
Funds Availability

Funds availability

Checks if the payer's current balance is sufficient to cover the amount the merchant wants to charge within the consent parameters defined on the mandate.

<p class="notice--warning"><strong>Warning</strong>: Funds availability check is available for VRP mandates only.</p>
get/funds_availability/{mandate_id}

Request

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

Path parameters

mandate_idstring required

The mandate id

Query parameters

amountstring

The amount of the payment

Example:1000

Headers

GoCardless-Versionstring required

Response

Successful response

availableboolean

Indicates if the amount is available

Changes

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