Variable Recurring Payments

Confirm Funds for VRP Payment

Check whether the requested funds amount is available on the VRP consent.

Note that you should not call this before each VRP payment submission because we do it for you.

Required feature: VARIABLE_RECURRING_PAYMENT_FUNDS_CONFIRMATION

post/variable-recurring-payments/funds-confirmation

Request

  • Base URL
    https://api.yapily.com
  • Auth
    HTTP basic

Headers

consentstring required

The user's VRP Consent Token

Request body

referencestring

Optional. The reference/description associated with the VRP consent. Limited to a maximum of 18 characters long.

Example request

{
  "paymentAmount": {
    "amount": 10,
    "currency": "GBP"
  }
}

Response

Created

linksobject
tracingIdstring

Example response

{
  "data": {
    "reference": "Own Account Sweeping",
    "paymentAmount": {
      "amount": 10,
      "currency": "GBP"
    }
  }
}

Changes

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