Variable Recurring Payments

Initiate a confirmation of funds check against a mandate

Changed on

Allows the initiation of a confirmation of funds check against a mandate.

post/open-banking/mandates/{mandate_id}/confirm-funds

Request

Path parameters

mandate_idstring required

The unique ID assigned to the open banking mandate.

Headers

Company-Idstring uuid

Unique ID assigned by Acquired.com for your company.

Midstring uuid

Unique ID assigned by Acquired.com connecting to a specific acquiring bank.

Request body

amountnumber required

The amount to be checked for availability on the debtor account of the mandate.

currencystring required

ISO 4217 currency code in upper case.

Example request

{
  "amount": 19.99,
  "currency": "GBP"
}

Response

OK

funds_available'available' | 'not_available' | 'unknown' required

Indicates whether funds are available.

Example response

{
  "funds_available": "not_available"
}

Changes