> This page is for BaaS.

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

# Get a Pix Automático recurrence

GET https://tenant.api.corpx.com/v1/accounts/{accountId}/pix/automatic/recurrences/{recurrenceId}

Live read from the settlement bank, including the status history.

Reference: https://docs.api.corpx.com/baas/referencia/pix-automatic/get-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.
- `recurrenceId` (string, required) — Recurrence UUID (`recurrenceId`) or its Pix scheme identifier (`RR…`/`RN…`).

### Headers

- `X-Tenant-Id` (string, required) — Tenant context used for authorization and routing.

## Response

### 200

Recurrence

- `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

### 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.

### 404 Not Found Error

Requested resource was not found.

- `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

### 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

**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
import requests

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

headers = {
    "X-Tenant-Id": "X-Tenant-Id",
    "Authorization": "Bearer <token>"
}

response = requests.get(url, headers=headers)

print(response.json())
```

```javascript
const url = 'https://tenant.api.corpx.com/v1/accounts/accountId/pix/automatic/recurrences/recurrenceId';
const options = {
  method: 'GET',
  headers: {'X-Tenant-Id': 'X-Tenant-Id', Authorization: 'Bearer <token>'}
};

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

```go
package main

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

func main() {

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

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("X-Tenant-Id", "X-Tenant-Id")
	req.Header.Add("Authorization", "Bearer <token>")

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

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

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

}
```

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

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

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

request = Net::HTTP::Get.new(url)
request["X-Tenant-Id"] = 'X-Tenant-Id'
request["Authorization"] = 'Bearer <token>'

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

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

HttpResponse<String> response = Unirest.get("https://tenant.api.corpx.com/v1/accounts/accountId/pix/automatic/recurrences/recurrenceId")
  .header("X-Tenant-Id", "X-Tenant-Id")
  .header("Authorization", "Bearer <token>")
  .asString();
```

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

$client = new \GuzzleHttp\Client();

$response = $client->request('GET', 'https://tenant.api.corpx.com/v1/accounts/accountId/pix/automatic/recurrences/recurrenceId', [
  'headers' => [
    'Authorization' => 'Bearer <token>',
    'X-Tenant-Id' => 'X-Tenant-Id',
  ],
]);

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

```csharp
using RestSharp;

var client = new RestClient("https://tenant.api.corpx.com/v1/accounts/accountId/pix/automatic/recurrences/recurrenceId");
var request = new RestRequest(Method.GET);
request.AddHeader("X-Tenant-Id", "X-Tenant-Id");
request.AddHeader("Authorization", "Bearer <token>");
IRestResponse response = client.Execute(request);
```

```swift
import Foundation

let headers = [
  "X-Tenant-Id": "X-Tenant-Id",
  "Authorization": "Bearer <token>"
]

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

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()
```