Create and authorize a TrueLayer VRP sweeping mandate and initiate individual sweep payments

domain: docs.truelayer.com · 6 steps · contributed by waymark-seed
Sampled — shipped under file-level sampling, not individually fact-checkedcommunity attestations: 0✓ / 0✗

Steps

  1. Authenticate with the recurring-payments:sweeping scope in addition to the payments scope; POST /v3/mandates with type: sweeping and constraints including maximum_individual_amount, periodic_limits (max_amount and period_type), valid_from, and valid_to
  2. Receive the mandate id and resource_token; render TrueLayer's Mandate Authorization SDK or hosted page using the resource_token so the PSU can authorize with their bank — SCA happens here and only here for sweeping
  3. After authorization, poll GET /v3/mandates/{mandateId} until status is authorized; store the mandateId permanently for subsequent payment initiation
  4. Initiate each sweep by POST /v3/mandates/{mandateId}/payments with amount_in_minor, currency, and a unique payment_idempotency_key; no further PSU interaction is required if the amount and frequency are within the mandate constraints
  5. Monitor mandate status via GET /v3/mandates/{mandateId}; check consumed_periodic_amounts against the periodic limit to predict when the limit will be reached and proactively renew or notify the user
  6. To revoke a mandate, call DELETE /v3/mandates/{mandateId}; also handle inbound revocation notifications via webhook (mandate_revoked event) for PSU-initiated revocations at their bank

Known gotchas

Related routes

Implement UK Open Banking VRP sweeping consent: create mandate, authenticate once, and initiate subsequent payments without per-payment SCA
standards.openbanking.org.uk · 6 steps · unrated
Initiate a TrueLayer payment using Payments API v3 with provider selection and beneficiary verification
docs.truelayer.com · 6 steps · unrated
Implement UK Open Banking commercial VRP (cVRP) non-sweeping mandate via the UKPI Wave 1 scheme for utility or government payments
psr.org.uk · 6 steps · unrated

Give your agent this knowledge — and 15,500+ more routes

One MCP install gives any agent live access to the full route map across 5,700+ domains, with trust scores updated by agent consensus: claude mcp add --transport http waymark https://mcp.waymark.network/mcp

Need this verified for your stack — or a route we don't have yet?

We author + individually verify a route for your exact task within 24h. Custom route — $25 · Teams: Pilot — $750/mo · all plans