Mandates

Confirm funds

Confirm that the end user has the given funds.

This API can be called:

  • using the mandate_token associated with the mandate;
  • using a backend bearer token.
get/v3/mandates/{id}/funds

Request

  • Base URL
    https://api.truelayer-sandbox.com
  • URL
    https://api.truelayer-sandbox.com/v3/mandates/{id}/funds
  • Auth
    OAuth 2
    Client credentials
    Token URL: https://auth.truelayer.com/connect/token scopes: mandates

Path parameters

idstring required

Unique ID for the mandate

Example:be6db706-68f1-4e9c-ab09-b83d8e3ea60d

ID of the Mandate

Query parameters

amount_in_minorinteger required

A 'cent' value representing the amount, e.g. 100 == 1GBP.

currency'GBP' | 'EUR' required
Example:GBP

Response

Confirmation of funds

confirmedboolean required

Whether the funds are confirmed

confirmed_atstring datetime required

The date and time the funds were confirmed at

Changes

No recorded changes to this operation across all 1 revision of this API.