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

# Get a scheduling

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

Live read, including the settlement (`settlement.settlementId`) once it exists.

Reference: https://en.docs.api.corpx.com/baas/referencia/pix-automatic/get-pix-automatic-scheduling

## 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.
- `schedulingId` (string, required) — Scheduling id returned by the scheduling or retry call.

### Headers

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

## Response

### 200

Scheduling

- `schedulingId` (string, optional)
- `recurrenceId` (string, optional)
- `recurrenceIdentifier` (string, optional)
- `endToEndId` (string, optional)
- `dueDate` (date, optional)
- `value` (double, optional)
- `status` (enum, optional)
  - Allowed values: `created`, `received`, `awaiting_confirmation`, `confirmed`, `rejected`, `confirmation_failed`, `settled`, `canceled`, `expired`
- `purpose` (enum, optional)
  - Allowed values: `scheduling`, `retry`
- `message` (string, optional)
- `createdAt` (datetime, optional)
- `updatedAt` (datetime, optional)
- `history` (list of PixAutomaticHistoryEntry, optional)
- `settlement` (PixAutomaticSchedulingSettlement, 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

### PixAutomaticHistoryEntry

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

### PixAutomaticSchedulingSettlement

- `settlementId` (string, optional)
- `status` (enum, optional)
  - Allowed values: `balance_reserved`, `insufficient_balance`, `settled`, `settled_with_error`, `not_settled`, `not_settled_with_error`
- `accountingDate` (date, optional)
- `settledAt` (datetime, optional)
- `createdAt` (datetime, optional)
- `history` (list of PixAutomaticHistoryEntry, 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
{
  "schedulingId": "0b1e7d6c-2f43-4c1a-9d55-3c1f0e2a7b88",
  "recurrenceId": "f6c7cb5e-7dca-4195-bbbc-edda5c3868d9",
  "recurrenceIdentifier": "RR5087192120261103a1b2c3d4e5f",
  "endToEndId": "E5087192120261123100000000000001",
  "dueDate": "2026-11-25",
  "value": 149.9,
  "status": "confirmed",
  "purpose": "scheduling",
  "history": [
    {
      "at": "2026-11-21T10:00:00Z",
      "status": "confirmed"
    }
  ]
}
```

**SDK Code**

```python
import requests

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

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/schedulings/schedulingId';
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/schedulings/schedulingId"

	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/schedulings/schedulingId")

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/schedulings/schedulingId")
  .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/schedulings/schedulingId', [
  '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/schedulings/schedulingId");
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/schedulings/schedulingId")! 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()
```