> This page is for BaaS.

> For clean Markdown of any page, append .md to the page URL.
> For a complete documentation index, see https://en.docs.api.corpx.com/llms.txt.
> For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://en.docs.api.corpx.com/_mcp/server.

# Request a Pix Automático recurrence

POST https://tenant.api.corpx.com/v1/accounts/{accountId}/pix/automatic/recurrences
Content-Type: application/json

Sends an authorization request to the payer's bank. The payer
approves it in their bank app; the result arrives as
`pix.automatic.recurrence.*`. Requires the `automatic_pix` feature and the
`pix.automatic` scope (or `pix_automatic.manage` in the panel).

Send exactly one of `value` (fixed amount) or `maximumValue` (variable
amount up to a ceiling). `recurrenceId` (UUID) identifies the recurrence in
this API; `recurrenceIdentifier` (`RR…`/`RN…`) is the Pix scheme id and
appears once assigned. Every path that takes `{recurrenceId}` accepts both.

Reference: https://en.docs.api.corpx.com/baas/referencia/pix-automatic/create-pix-automatic-recurrence

## Authentication

- `Authorization` header (bearer token, required) — Bearer authentication of the form `Bearer <token>`, where token is your auth token.

## Request

### Path parameters

- `accountId` (string, required) — Account identifier.

### Headers

- `X-Tenant-Id` (string, required) — Tenant context used for authorization and routing.
- `Idempotency-Key` (string, optional) — Optional client-generated idempotency token (recommended for safe retries).

### Body (application/json)

This endpoint expects a PixAutomaticRecurrenceRequest.

- `frequency` (enum, required)
  - Allowed values: `weekly`, `monthly`, `quarterly`, `semiannual`, `annual`
- `firstPaymentDate` (date, required)
- `contract` (PixAutomaticRecurrenceRequestContract, required)
- `payer` (PixAutomaticRecurrenceRequestPayer, required)
- `lastPaymentDate` (date, optional) — Omit for an open-ended recurrence.
- `value` (double, optional) — Fixed amount of every charge.
- `maximumValue` (double, optional) — Ceiling for variable-amount charges.
- `paymentRetry` (boolean, optional) — Allows settlement retries after a failed charge.
- `debtor` (PixAutomaticRecurrenceRequestDebtor, optional) — Person the charge refers to, when different from the payer.
- `requestExpiration` (datetime, optional) — Deadline for the payer to answer: after today and up to 30 days ahead (Brasília time). Default: 30 days.

## Response

### 201

Recurrence created, waiting for the payer's authorization

- `recurrenceId` (string, optional)
- `recurrenceIdentifier` (string, optional) — `RR…`/`RN…`, once assigned.
- `status` (enum, optional)
  - Allowed values: `awaiting_authorization`, `authorization_received`, `authorized`, `rejected`, `request_failed`, `authorization_failed`, `canceled`, `expired`
- `rejectionReason` (string, optional)
- `journey` (enum, optional)
  - Allowed values: `request`, `qr_code`, `composite_qr_code`, `after_payment`
- `frequency` (enum, optional)
  - Allowed values: `weekly`, `monthly`, `quarterly`, `semiannual`, `annual`
- `firstPaymentDate` (date, optional)
- `lastPaymentDate` (date, optional)
- `value` (double, optional)
- `maximumValue` (double, optional)
- `payerMaximumValue` (double, optional) — Ceiling set by the payer when authorizing.
- `paymentRetry` (boolean, optional)
- `contract` (PixAutomaticRecurrenceContract, optional)
- `payer` (PixAutomaticRecurrencePayer, optional)
- `receiver` (PixAutomaticRecurrenceReceiver, optional)
- `debtor` (PixAutomaticRecurrenceDebtor, optional)
- `qrCodeId` (string, optional)
- `requestedAt` (datetime, optional)
- `requestExpiration` (datetime, optional)
- `authorizedAt` (datetime, optional)
- `createdAt` (datetime, optional)
- `updatedAt` (datetime, optional)
- `history` (list of PixAutomaticHistoryEntry, optional)

## Errors

### 400 Bad Request Error

Invalid request sent by client.

- `errorCode` (string, required) — Stable machine-readable code. See `ErrorCode` for the known values.
- `message` (string, required) — Human-readable explanation (pt-BR). Presentation only; may change.
- `docs` (string, optional) — Link to this code in the public error catalogue.
- `requestId` (string, optional) — Gateway request id. Quote it when contacting support.
- `details` (map from string to any, optional) — Optional machine-readable context for the specific `errorCode` (for example `kind` on `identity_verification_monthly_limit_exceeded`, `maxBytes` on `payload_too_large`, `attemptsRemaining` on `facetec_attempts_exhausted`). Keys are documented per operation; absent when the code carries no extra context.
- `partner` (ErrorResponsePartner, optional) — Raw error from the settlement bank, when the failure came from it. Diagnostic only.

### 403 Forbidden Error

Requester does not have permission to perform the operation.

- `errorCode` (string, required) — Stable machine-readable code. See `ErrorCode` for the known values.
- `message` (string, required) — Human-readable explanation (pt-BR). Presentation only; may change.
- `docs` (string, optional) — Link to this code in the public error catalogue.
- `requestId` (string, optional) — Gateway request id. Quote it when contacting support.
- `details` (map from string to any, optional) — Optional machine-readable context for the specific `errorCode` (for example `kind` on `identity_verification_monthly_limit_exceeded`, `maxBytes` on `payload_too_large`, `attemptsRemaining` on `facetec_attempts_exhausted`). Keys are documented per operation; absent when the code carries no extra context.
- `partner` (ErrorResponsePartner, optional) — Raw error from the settlement bank, when the failure came from it. Diagnostic only.

### 422 Unprocessable Entity Error

Recurrence terms rejected (`automatic_pix_value_mismatch`, `automatic_pix_contract_blocked`, `automatic_pix_receiver_ineligible`)

- `errorCode` (string, required) — Stable machine-readable code. See `ErrorCode` for the known values.
- `message` (string, required) — Human-readable explanation (pt-BR). Presentation only; may change.
- `docs` (string, optional) — Link to this code in the public error catalogue.
- `requestId` (string, optional) — Gateway request id. Quote it when contacting support.
- `details` (map from string to any, optional) — Optional machine-readable context for the specific `errorCode` (for example `kind` on `identity_verification_monthly_limit_exceeded`, `maxBytes` on `payload_too_large`, `attemptsRemaining` on `facetec_attempts_exhausted`). Keys are documented per operation; absent when the code carries no extra context.
- `partner` (ErrorResponsePartner, optional) — Raw error from the settlement bank, when the failure came from it. Diagnostic only.

### 502 Bad Gateway Error

Banking partner returned an error.

- `errorCode` (string, required) — Stable machine-readable code. See `ErrorCode` for the known values.
- `message` (string, required) — Human-readable explanation (pt-BR). Presentation only; may change.
- `docs` (string, optional) — Link to this code in the public error catalogue.
- `requestId` (string, optional) — Gateway request id. Quote it when contacting support.
- `details` (map from string to any, optional) — Optional machine-readable context for the specific `errorCode` (for example `kind` on `identity_verification_monthly_limit_exceeded`, `maxBytes` on `payload_too_large`, `attemptsRemaining` on `facetec_attempts_exhausted`). Keys are documented per operation; absent when the code carries no extra context.
- `partner` (ErrorResponsePartner, optional) — Raw error from the settlement bank, when the failure came from it. Diagnostic only.

## Types

### PixAutomaticRecurrenceRequestContract

- `number` (string, required)
- `description` (string, optional)

### PixAutomaticRecurrenceRequestPayer

- `ispb` (string, required)
- `taxNumber` (string, required)
- `branch` (string, required)
- `account` (string, required)
- `ibgeCode` (string, required) — 7-digit IBGE code of the payer's city.
- `name` (string, optional)
- `bankCode` (string, optional)

### PixAutomaticRecurrenceRequestDebtor

Person the charge refers to, when different from the payer.

- `taxNumber` (string, optional)
- `name` (string, optional)

### PixAutomaticRecurrenceContract

- `number` (string, optional)
- `description` (string, optional)

### PixAutomaticRecurrencePayer

- `name` (string, optional)
- `taxNumber` (string, optional)
- `ispb` (string, optional)
- `branch` (string, optional)
- `account` (string, optional)

### PixAutomaticRecurrenceReceiver

- `name` (string, optional)
- `taxNumber` (string, optional)
- `ispb` (string, optional)
- `branch` (string, optional)
- `account` (string, optional)

### PixAutomaticRecurrenceDebtor

- `taxNumber` (string, optional)
- `name` (string, optional)

### PixAutomaticHistoryEntry

- `at` (datetime, optional)
- `status` (string, optional)
- `purpose` (string, optional)
- `error` (string, optional)

### ErrorResponsePartner

Raw error from the settlement bank, when the failure came from it. Diagnostic only.

- `code` (string, optional)
- `message` (string, optional)
- `field` (string, optional) — Field the partner pointed at, when any.

## Examples

**Request**

```json
{
  "frequency": "monthly",
  "firstPaymentDate": "2026-11-25",
  "contract": {
    "number": "CONTRATO-1001",
    "description": "Plano mensal"
  },
  "payer": {
    "ispb": "99999004",
    "taxNumber": "12345678909",
    "branch": "0001",
    "account": "123456",
    "ibgeCode": "3550308",
    "name": "MARIA DA SILVA"
  },
  "lastPaymentDate": "2027-10-25",
  "value": 149.9,
  "paymentRetry": true,
  "debtor": {
    "taxNumber": "12345678909",
    "name": "MARIA DA SILVA"
  },
  "requestExpiration": "2026-11-10T23:59:59-03:00"
}
```

**Response**

```json
{
  "recurrenceId": "f6c7cb5e-7dca-4195-bbbc-edda5c3868d9",
  "recurrenceIdentifier": "RR5087192120261103a1b2c3d4e5f",
  "status": "awaiting_authorization",
  "journey": "request",
  "frequency": "monthly",
  "firstPaymentDate": "2026-11-25",
  "lastPaymentDate": "2027-10-25",
  "value": 149.9,
  "paymentRetry": true,
  "contract": {
    "number": "CONTRATO-1001",
    "description": "Plano mensal"
  },
  "payer": {
    "name": "MARIA DA SILVA",
    "taxNumber": "12345678909",
    "ispb": "99999004",
    "branch": "0001",
    "account": "123456"
  },
  "requestedAt": "2026-11-01T13:00:00Z",
  "history": [
    {
      "at": "2026-11-01T13:00:00Z",
      "status": "awaiting_authorization"
    }
  ]
}
```

**SDK Code**

```python Pix Automatic_createPixAutomaticRecurrence_example
import requests

url = "https://tenant.api.corpx.com/v1/accounts/accountId/pix/automatic/recurrences"

payload = {
    "frequency": "monthly",
    "firstPaymentDate": "2026-11-25",
    "contract": {
        "number": "CONTRATO-1001",
        "description": "Plano mensal"
    },
    "payer": {
        "ispb": "99999004",
        "taxNumber": "12345678909",
        "branch": "0001",
        "account": "123456",
        "ibgeCode": "3550308",
        "name": "MARIA DA SILVA"
    },
    "lastPaymentDate": "2027-10-25",
    "value": 149.9,
    "paymentRetry": True,
    "debtor": {
        "taxNumber": "12345678909",
        "name": "MARIA DA SILVA"
    },
    "requestExpiration": "2026-11-10T23:59:59-03:00"
}
headers = {
    "X-Tenant-Id": "X-Tenant-Id",
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.json())
```

```javascript Pix Automatic_createPixAutomaticRecurrence_example
const url = 'https://tenant.api.corpx.com/v1/accounts/accountId/pix/automatic/recurrences';
const options = {
  method: 'POST',
  headers: {
    'X-Tenant-Id': 'X-Tenant-Id',
    Authorization: 'Bearer <token>',
    'Content-Type': 'application/json'
  },
  body: '{"frequency":"monthly","firstPaymentDate":"2026-11-25","contract":{"number":"CONTRATO-1001","description":"Plano mensal"},"payer":{"ispb":"99999004","taxNumber":"12345678909","branch":"0001","account":"123456","ibgeCode":"3550308","name":"MARIA DA SILVA"},"lastPaymentDate":"2027-10-25","value":149.9,"paymentRetry":true,"debtor":{"taxNumber":"12345678909","name":"MARIA DA SILVA"},"requestExpiration":"2026-11-10T23:59:59-03:00"}'
};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}
```

```go Pix Automatic_createPixAutomaticRecurrence_example
package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://tenant.api.corpx.com/v1/accounts/accountId/pix/automatic/recurrences"

	payload := strings.NewReader("{\n  \"frequency\": \"monthly\",\n  \"firstPaymentDate\": \"2026-11-25\",\n  \"contract\": {\n    \"number\": \"CONTRATO-1001\",\n    \"description\": \"Plano mensal\"\n  },\n  \"payer\": {\n    \"ispb\": \"99999004\",\n    \"taxNumber\": \"12345678909\",\n    \"branch\": \"0001\",\n    \"account\": \"123456\",\n    \"ibgeCode\": \"3550308\",\n    \"name\": \"MARIA DA SILVA\"\n  },\n  \"lastPaymentDate\": \"2027-10-25\",\n  \"value\": 149.9,\n  \"paymentRetry\": true,\n  \"debtor\": {\n    \"taxNumber\": \"12345678909\",\n    \"name\": \"MARIA DA SILVA\"\n  },\n  \"requestExpiration\": \"2026-11-10T23:59:59-03:00\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("X-Tenant-Id", "X-Tenant-Id")
	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}
```

```ruby Pix Automatic_createPixAutomaticRecurrence_example
require 'uri'
require 'net/http'

url = URI("https://tenant.api.corpx.com/v1/accounts/accountId/pix/automatic/recurrences")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["X-Tenant-Id"] = 'X-Tenant-Id'
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"frequency\": \"monthly\",\n  \"firstPaymentDate\": \"2026-11-25\",\n  \"contract\": {\n    \"number\": \"CONTRATO-1001\",\n    \"description\": \"Plano mensal\"\n  },\n  \"payer\": {\n    \"ispb\": \"99999004\",\n    \"taxNumber\": \"12345678909\",\n    \"branch\": \"0001\",\n    \"account\": \"123456\",\n    \"ibgeCode\": \"3550308\",\n    \"name\": \"MARIA DA SILVA\"\n  },\n  \"lastPaymentDate\": \"2027-10-25\",\n  \"value\": 149.9,\n  \"paymentRetry\": true,\n  \"debtor\": {\n    \"taxNumber\": \"12345678909\",\n    \"name\": \"MARIA DA SILVA\"\n  },\n  \"requestExpiration\": \"2026-11-10T23:59:59-03:00\"\n}"

response = http.request(request)
puts response.read_body
```

```java Pix Automatic_createPixAutomaticRecurrence_example
import com.mashape.unirest.http.HttpResponse;
import com.mashape.unirest.http.Unirest;

HttpResponse<String> response = Unirest.post("https://tenant.api.corpx.com/v1/accounts/accountId/pix/automatic/recurrences")
  .header("X-Tenant-Id", "X-Tenant-Id")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"frequency\": \"monthly\",\n  \"firstPaymentDate\": \"2026-11-25\",\n  \"contract\": {\n    \"number\": \"CONTRATO-1001\",\n    \"description\": \"Plano mensal\"\n  },\n  \"payer\": {\n    \"ispb\": \"99999004\",\n    \"taxNumber\": \"12345678909\",\n    \"branch\": \"0001\",\n    \"account\": \"123456\",\n    \"ibgeCode\": \"3550308\",\n    \"name\": \"MARIA DA SILVA\"\n  },\n  \"lastPaymentDate\": \"2027-10-25\",\n  \"value\": 149.9,\n  \"paymentRetry\": true,\n  \"debtor\": {\n    \"taxNumber\": \"12345678909\",\n    \"name\": \"MARIA DA SILVA\"\n  },\n  \"requestExpiration\": \"2026-11-10T23:59:59-03:00\"\n}")
  .asString();
```

```php Pix Automatic_createPixAutomaticRecurrence_example
<?php
require_once('vendor/autoload.php');

$client = new \GuzzleHttp\Client();

$response = $client->request('POST', 'https://tenant.api.corpx.com/v1/accounts/accountId/pix/automatic/recurrences', [
  'body' => '{
  "frequency": "monthly",
  "firstPaymentDate": "2026-11-25",
  "contract": {
    "number": "CONTRATO-1001",
    "description": "Plano mensal"
  },
  "payer": {
    "ispb": "99999004",
    "taxNumber": "12345678909",
    "branch": "0001",
    "account": "123456",
    "ibgeCode": "3550308",
    "name": "MARIA DA SILVA"
  },
  "lastPaymentDate": "2027-10-25",
  "value": 149.9,
  "paymentRetry": true,
  "debtor": {
    "taxNumber": "12345678909",
    "name": "MARIA DA SILVA"
  },
  "requestExpiration": "2026-11-10T23:59:59-03:00"
}',
  'headers' => [
    'Authorization' => 'Bearer <token>',
    'Content-Type' => 'application/json',
    'X-Tenant-Id' => 'X-Tenant-Id',
  ],
]);

echo $response->getBody();
```

```csharp Pix Automatic_createPixAutomaticRecurrence_example
using RestSharp;

var client = new RestClient("https://tenant.api.corpx.com/v1/accounts/accountId/pix/automatic/recurrences");
var request = new RestRequest(Method.POST);
request.AddHeader("X-Tenant-Id", "X-Tenant-Id");
request.AddHeader("Authorization", "Bearer <token>");
request.AddHeader("Content-Type", "application/json");
request.AddParameter("application/json", "{\n  \"frequency\": \"monthly\",\n  \"firstPaymentDate\": \"2026-11-25\",\n  \"contract\": {\n    \"number\": \"CONTRATO-1001\",\n    \"description\": \"Plano mensal\"\n  },\n  \"payer\": {\n    \"ispb\": \"99999004\",\n    \"taxNumber\": \"12345678909\",\n    \"branch\": \"0001\",\n    \"account\": \"123456\",\n    \"ibgeCode\": \"3550308\",\n    \"name\": \"MARIA DA SILVA\"\n  },\n  \"lastPaymentDate\": \"2027-10-25\",\n  \"value\": 149.9,\n  \"paymentRetry\": true,\n  \"debtor\": {\n    \"taxNumber\": \"12345678909\",\n    \"name\": \"MARIA DA SILVA\"\n  },\n  \"requestExpiration\": \"2026-11-10T23:59:59-03:00\"\n}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);
```

```swift Pix Automatic_createPixAutomaticRecurrence_example
import Foundation

let headers = [
  "X-Tenant-Id": "X-Tenant-Id",
  "Authorization": "Bearer <token>",
  "Content-Type": "application/json"
]
let parameters = [
  "frequency": "monthly",
  "firstPaymentDate": "2026-11-25",
  "contract": [
    "number": "CONTRATO-1001",
    "description": "Plano mensal"
  ],
  "payer": [
    "ispb": "99999004",
    "taxNumber": "12345678909",
    "branch": "0001",
    "account": "123456",
    "ibgeCode": "3550308",
    "name": "MARIA DA SILVA"
  ],
  "lastPaymentDate": "2027-10-25",
  "value": 149.9,
  "paymentRetry": true,
  "debtor": [
    "taxNumber": "12345678909",
    "name": "MARIA DA SILVA"
  ],
  "requestExpiration": "2026-11-10T23:59:59-03:00"
] as [String : Any]

let postData = JSONSerialization.data(withJSONObject: parameters, options: [])

let request = NSMutableURLRequest(url: NSURL(string: "https://tenant.api.corpx.com/v1/accounts/accountId/pix/automatic/recurrences")! as URL,
                                        cachePolicy: .useProtocolCachePolicy,
                                    timeoutInterval: 10.0)
request.httpMethod = "POST"
request.allHTTPHeaderFields = headers
request.httpBody = postData as Data

let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
  if (error != nil) {
    print(error as Any)
  } else {
    let httpResponse = response as? HTTPURLResponse
    print(httpResponse)
  }
})

dataTask.resume()
```