v1

latestOpenAPI 3.0.02026-07-2412592575.3 KB
payments

Check if funds are available for a recurring payment

Requires recurring-payment:funds_confirmation scope.

post/recurring-payments/{recurringPaymentId}/funds-confirmation

Path parameters

recurringPaymentIdstring uuid required

The recurring payment Id

Request body

amountstring required

The amount to check funds for

currencystring

The currency code (defaults to GBP if not provided)

Example request

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

Response

Successful confirmation of funds response

metaobject