Pular para o conteúdo

Smart Pix — Intelligent initiation (Sweeping)

Lina initiation APIs for Smart Pix streamline automatic payments and Sweeping (intelligent transfers under an Open Finance recurring consent). They reduce integration effort so you can offer a modern payment experience while using Open Finance as regulation permits.

With Smart Pix, you create an automatic-payment contract at the account holder, redirect the payer once for consent, then initiate transfers from the selected account to the same holder within the agreed limits.

Prerequisites

  1. Obtain an OAuth 2.0 access token as described in Get your credentials.
  2. Complete Onboarding so redirect domains are allow-listed for your sub-tenant.

Stage 0 — Create the contract (consent + first redirect)

  1. Call Get registered participants with header subTenantId so the payer can choose an institution.
  2. Call Create recurring consent with organisationId, authorisationServerId, and nested recurringConsent (including recurringConsent.redirectUri — see below).
  3. From 201 Created, persist data.id and data.consentId server-side, then send the user to data.redirectUrl to authenticate and approve the contract at the account holder.
  4. After approval, the holder redirects the browser to redirectUri you sent in the consent body. That URL must be owned and operated by your application (allow-listed on the sub-tenant); Lina does not host it.
  5. Poll Get payment request with path {automaticPaymentsRequestId} = data.id until data.consentStatus is AUTHORISED (see OpenAPI for other states).
  6. Call Create recurring payment with recurringConsentId set to data.consentId from step 3 (and the rest of the payment payload required by the API).
Stage 0 — User creates Smart Pix contract: institution selection, consent POST, holder redirect, callback, payment request polling, recurring payment

Stage 1 — Further transfers (contract already authorised)

When the contract is already AUTHORISED, you do not repeat the holder redirect for each transfer. Obtain a token and call Create recurring payment directly, then optionally Get recurring payment for details.

Stage 1 — New payment from an existing Smart Pix contract (no new consent redirect)

API Reference

Use the Smart Pix API group in the sidebar for full request and response schemas.