Variable Recurring Payments

Verify if funds are available or not

The GET /vrps/{id}/confirm-funds endpoint confirms whether the funds are available to initiate VRP.

get/vrps/{id}/confirm-funds

Request

  • Base URL
    https://api.token.io
  • URL
    https://api.token.io/vrps/{id}/confirm-funds
  • Auth
    • HTTP bearer
    • or API key in header Authorization

Path parameters

idstring required
Example:vc:12345abcd:abcde

The VRP consent id.

Query parameters

amountstring required

The amount to confirm availability for.

Response

Successful response

fundsAvailableboolean

A flag indicating whether funds are available or not. If set to true, funds are available for transfer.

Changes

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