API Reference

Recurring Pix

Pix is an instant payment platform created and managed by the monetary authority of Brazil, the Central Bank of Brazil, which enables the quick execution of payments and transfers — including recurring payments.

Some important information for Recurring Pix Payments:

  • The amount in the transactions will always be in cents, so 100 cents = 1 BRL.
  • There's a maximum amount of 1.99 BRL (199 cents) when testing our API.
  • For specific information on the parameters, access the Recurring Pix object page.

Step 1. Create an Access Token

Get started by creating an Access Token. Read how to create an Access Token

Step 2. Create an Recurring pix

Read how to create an Recurring Pix

import fetch from 'node-fetch'

const response = await fetch('https://api.sqala.tech/core/v1/recurring-pix', {
    headers: { 
      'Authorization': 'Bearer ' + 'YOUR_ACCESS_TOKEN',
      'Content-Type': 'application/json' 
    },
    method: 'POST',
    body: JSON.stringify({
          code: "40040b70-89be-40ad-ab7f-7a123cb7ab6a",
          amount: 990,
          bankCode: "260",
          callbackUrl: "http://url.com"
          payer: {
              "name": "Bruce Wayne",
              "taxId": "06516763208" 
          },
        schedule: {
            dates: [
              "2025-04-01T09:00:00Z",
              "2025-05-01T09:00:00Z",
              "2025-06-01T09:00:00Z"
            ]
      }
    })
})

const data = await response.json()

console.log(data)

Output

{
  "id": "6a0b14a9-023c-4198-9ada-6e4684213340",
  "code": "40040b70-89be-40ad-ab7f-7a123cb7ab6a",
  "amount": 990,
  "url": "https://url.com",
  "payer": {
    "name": "Bruce Wayne",
    "taxId": "06516763208"
  },
  "schedule": [
    "2025-04-01T09:00:00Z",
    "2025-05-01T09:00:00Z",
    "2025-06-01T09:00:00Z"
  ],
  "split": null,
  "status": "PROCESSED",
  "createdAt": "2022-06-06T11:48:21Z",
  "processedAt": "2022-06-06T11:48:26Z",
  "paidAt": null,
  "failedAt": null,
  "metadata": null
}

Step 3. Create an Endpoint to receive the Webhooks

You can create an endpoint directly in the developer area and select which events you want to receive.