GoCardlessDeveloper Docs
Create a sandbox account

Funds Availability

View as Markdown

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.

Funds availability#

GET/funds_availability/{mandate_id}

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.

Path Parameters

NameTypeDescription
mandate_idrequiredstring

The mandate id

Query Parameters

NameTypeDescription
amountstring
GET https://api.gocardless.com/funds_availability/MD123?amount=1000 HTTP/1.1
@client.funds_availabilities.check("MD123", params: { amount: "1000" })
client.funds_availabilities.check("MD123", params={"amount": "1000"})
const resp = await client.fundsAvailabilities.check("MD123", {
  amount: "1000"
});
$client->fundsAvailabilities()->check("MD123", [
  "params" => ["amount" => "1000"]
]);
client.fundsAvailabilities().check("MD123")
  .withAmount("1000")
  .execute();
fundsAvailabilityCheckParams := gocardless.FundsAvailabilityCheckParams{
  Amount: "1000",
}

fundsAvailability, err := client.FundsAvailabilities.Check(ctx, "MD123", fundsAvailabilityCheckParams)
var request = new GoCardless.Services.FundsAvailabilityCheckRequest()
{
  Amount = "1000"
};

var resp = await client.FundsAvailabilities.CheckAsync("MD123", request);
Responsehttp
HTTP/1.1 200 OK
Content-Type: application/json
{
  "available": true
}
Response 200

Successful response

availableboolean
Errors 400401404422500
400

Bad Request

401

Unauthorised

404

Not found

422

Validation Error

500

Internal Error

Error Body
errorobject

Generic error

6 properties
codeinteger
documentation_urlstring
errorsarray
6 properties
reasonstring
fieldstring
request_pointerstring
messagestring
metadataobject
linksobject
messagestring
request_idstring
typestring