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

# Lookup a single QR Code

GET https://tenant.api.corpx.com/v1/accounts/{accountId}/pix/qr-code/lookup

Search for a single QR Code by its `identifier` (the value supplied
at creation time, or the auto-generated UUID returned by the
creation endpoints).

Returns the complete QR code record including payment info, payer
details, refund data, and an enriched `transaction` object with
full details when reconciled.


Reference: https://docs.api.corpx.com/baas/referencia/pix/lookup-qr-code

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

### Query parameters

- `identifier` (string, required) — Identifier assigned during QR creation. The alias `txid` is also accepted for backwards compatibility.

### Headers

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

## Response

### 200

QR code found.

- `txid` (string, required) — QR code internal ID (txid).
- `emv` (string, required) — EMV PIX copy-and-paste code (BR Code). Render it as the QR.
- `type` (enum, required) — QR code type.
  - Allowed values: `dynamic`, `static`, `due-date`, `location`
- `status` (enum, required) — QR code status (canonical, uppercase): - `ACTIVE` — created / awaiting - `BLOCKED` — Location QR not confirmed yet; refuses payment - `AWAITING-PAYMENT` — awaiting payment - `PAID` — payment received - `CANCELLED` — cancelled / rejected - `EXPIRED` — past expiration date - `UNKNOWN` — partner status outside the known mapping
  - Allowed values: `ACTIVE`, `AWAITING-PAYMENT`, `PAID`, `CANCELLED`, `EXPIRED`, `BLOCKED`, `UNKNOWN`
- `identifier` (string, required) — Client-provided identifier.
- `value` (double, optional) — QR code value in BRL.
- `message` (string, optional) — Message shown to the payer.
- `description` (string, optional) — Same as `message` (alias).
- `accountId` (string, optional)
- `pixKey` (string, optional) — PIX key used for this QR code.
- `allowChange` (boolean, optional) — Whether the payer may change the amount.
- `qrCodeFormat` (string, optional) — Partner QR format (when provided).
- `allowedPayerDocument` (string, optional) — CPF/CNPJ allowed to pay (when restricted).
- `payerPhysicalPerson` (boolean, optional)
- `createdAt` (datetime, optional)
- `expiresAt` (datetime, optional) — Expiration date (dynamic QR codes only).
- `paidAt` (datetime, optional) — Payment timestamp (present when status is `PAID`).
- `paidAmount` (double, optional) — Amount actually paid (may differ if `allowChange` was true).
- `endToEndId` (string, optional) — BACEN E2E identifier of the payment (present when paid).
- `payer` (Party, optional) — Payer details (present when the QR code has been paid). Populated from the underlying PIX transaction identified by `endToEndId`; typically includes `name` and `document`, plus `bankCode`/`branch`/`account` when the partner returns them.
- `payee` (Party, optional) — Receiver (your account) details.
- `locationId` (string, optional) — Location QR identifier at the settlement bank (Location QR only). Accepted instead of `identifier` on confirmation.
- `dueDate` (date, optional) — Due day (due-date and confirmed Location QR only).
- `daysAfterDueDate` (integer, optional) — Days after the due date the QR still accepts payment (due-date and confirmed Location QR only).
- `deduction` (double, optional) — Deduction in BRL (due-date and confirmed Location QR only).
- `discount` (double, optional) — Discount in BRL (due-date and confirmed Location QR only).
- `interest` (double, optional) — Interest in BRL (due-date and confirmed Location QR only).
- `penalty` (double, optional) — Penalty in BRL (due-date and confirmed Location QR only).
- `finalValue` (double, optional) — Amount to pay up to the due date (due-date and confirmed Location QR only).
- `debtor` (PixQrDebtor, optional) — Debtor given at issuance (due-date and confirmed Location QR only).
- `receiverName` (string, optional) — Receiver name shown to the payer (due-date and confirmed Location QR only).

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

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

### 500 Internal Server Error

Unexpected server 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

### Party

Payer or payee party information.

- `name` (string, optional) — Full name.
- `document` (string, optional) — CPF/CNPJ.
- `bankCode` (string, optional) — Bank code (COMPE/ISPB).
- `branch` (string, optional) — Branch number.
- `account` (string, optional) — Account number.
- `pixKey` (string, optional) — PIX key (when available).

### PixQrDebtor

Debtor of a due-date or Location charge. Who actually paid comes in `payer` after payment.

- `name` (string, required) — Debtor name.
- `document` (string, required) — Debtor CPF (11 digits) or CNPJ (14 digits). Punctuation is ignored.

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

### Paid dynamic QR code

**Response**

```json
{
  "txid": "5774a2eb0e2f40ac95686077a4a558bb",
  "emv": "00020101021226790014br.gov.bcb.pix2557brcode...",
  "type": "dynamic",
  "status": "PAID",
  "identifier": "order-12345",
  "value": 100,
  "message": "Payment for order #12345",
  "description": "Payment for order #12345",
  "accountId": "2e6b725b-84a0-400d-8740-22a5ba0f23e6",
  "pixKey": "db5c2a29-243e-42a2-862b-89737c0213aa",
  "allowChange": false,
  "createdAt": "2026-02-20T08:32:46Z",
  "expiresAt": "2026-02-20T16:37:44Z",
  "paidAt": "2026-02-20T08:33:39Z",
  "paidAmount": 100,
  "endToEndId": "E22896431202602200833NdtppklLCj2",
  "payer": {
    "name": "JOAO DA SILVA",
    "document": "12345678900",
    "bankCode": "36741675",
    "branch": "0001",
    "account": "200037834"
  },
  "payee": {
    "name": "MP TECH INTERMEDIACOES LTDA",
    "document": "64108263000100",
    "bankCode": "22896431",
    "account": "308112970"
  }
}
```

**SDK Code**

```python Paid dynamic QR code
import requests

url = "https://tenant.api.corpx.com/v1/accounts/accountId/pix/qr-code/lookup"

querystring = {"identifier":"identifier"}

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

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

print(response.json())
```

```javascript Paid dynamic QR code
const url = 'https://tenant.api.corpx.com/v1/accounts/accountId/pix/qr-code/lookup?identifier=identifier';
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 Paid dynamic QR code
package main

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

func main() {

	url := "https://tenant.api.corpx.com/v1/accounts/accountId/pix/qr-code/lookup?identifier=identifier"

	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 Paid dynamic QR code
require 'uri'
require 'net/http'

url = URI("https://tenant.api.corpx.com/v1/accounts/accountId/pix/qr-code/lookup?identifier=identifier")

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 Paid dynamic QR code
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/qr-code/lookup?identifier=identifier")
  .header("X-Tenant-Id", "X-Tenant-Id")
  .header("Authorization", "Bearer <token>")
  .asString();
```

```php Paid dynamic QR code
<?php
require_once('vendor/autoload.php');

$client = new \GuzzleHttp\Client();

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

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

```csharp Paid dynamic QR code
using RestSharp;

var client = new RestClient("https://tenant.api.corpx.com/v1/accounts/accountId/pix/qr-code/lookup?identifier=identifier");
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 Paid dynamic QR code
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/qr-code/lookup?identifier=identifier")! 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()
```

### Active (unpaid) QR code

**Response**

```json
{
  "txid": "abc123def456",
  "emv": "00020101021226790014br.gov.bcb.pix...",
  "type": "dynamic",
  "status": "ACTIVE",
  "identifier": "order-67890",
  "value": 250,
  "message": "Invoice #67890",
  "description": "Invoice #67890",
  "accountId": "2e6b725b-84a0-400d-8740-22a5ba0f23e6",
  "pixKey": "db5c2a29-243e-42a2-862b-89737c0213aa",
  "allowChange": false,
  "createdAt": "2026-02-21T10:00:00Z",
  "expiresAt": "2026-02-21T18:00:00Z"
}
```

**SDK Code**

```python Active (unpaid) QR code
import requests

url = "https://tenant.api.corpx.com/v1/accounts/accountId/pix/qr-code/lookup"

querystring = {"identifier":"identifier"}

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

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

print(response.json())
```

```javascript Active (unpaid) QR code
const url = 'https://tenant.api.corpx.com/v1/accounts/accountId/pix/qr-code/lookup?identifier=identifier';
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 Active (unpaid) QR code
package main

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

func main() {

	url := "https://tenant.api.corpx.com/v1/accounts/accountId/pix/qr-code/lookup?identifier=identifier"

	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 Active (unpaid) QR code
require 'uri'
require 'net/http'

url = URI("https://tenant.api.corpx.com/v1/accounts/accountId/pix/qr-code/lookup?identifier=identifier")

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 Active (unpaid) QR code
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/qr-code/lookup?identifier=identifier")
  .header("X-Tenant-Id", "X-Tenant-Id")
  .header("Authorization", "Bearer <token>")
  .asString();
```

```php Active (unpaid) QR code
<?php
require_once('vendor/autoload.php');

$client = new \GuzzleHttp\Client();

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

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

```csharp Active (unpaid) QR code
using RestSharp;

var client = new RestClient("https://tenant.api.corpx.com/v1/accounts/accountId/pix/qr-code/lookup?identifier=identifier");
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 Active (unpaid) QR code
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/qr-code/lookup?identifier=identifier")! 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()
```

### Expired QR code

**Response**

```json
{
  "txid": "9f1c2b3a4d5e6f708192a3b4c5d6e7f8",
  "emv": "00020101021226790014br.gov.bcb.pix...",
  "type": "dynamic",
  "status": "EXPIRED",
  "identifier": "order-99999",
  "value": 500,
  "message": "Order #99999",
  "description": "Order #99999",
  "accountId": "2e6b725b-84a0-400d-8740-22a5ba0f23e6",
  "pixKey": "db5c2a29-243e-42a2-862b-89737c0213aa",
  "allowChange": false,
  "createdAt": "2026-02-19T14:00:00Z",
  "expiresAt": "2026-02-19T15:00:00Z"
}
```

**SDK Code**

```python Expired QR code
import requests

url = "https://tenant.api.corpx.com/v1/accounts/accountId/pix/qr-code/lookup"

querystring = {"identifier":"identifier"}

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

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

print(response.json())
```

```javascript Expired QR code
const url = 'https://tenant.api.corpx.com/v1/accounts/accountId/pix/qr-code/lookup?identifier=identifier';
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 Expired QR code
package main

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

func main() {

	url := "https://tenant.api.corpx.com/v1/accounts/accountId/pix/qr-code/lookup?identifier=identifier"

	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 Expired QR code
require 'uri'
require 'net/http'

url = URI("https://tenant.api.corpx.com/v1/accounts/accountId/pix/qr-code/lookup?identifier=identifier")

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 Expired QR code
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/qr-code/lookup?identifier=identifier")
  .header("X-Tenant-Id", "X-Tenant-Id")
  .header("Authorization", "Bearer <token>")
  .asString();
```

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

$client = new \GuzzleHttp\Client();

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

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

```csharp Expired QR code
using RestSharp;

var client = new RestClient("https://tenant.api.corpx.com/v1/accounts/accountId/pix/qr-code/lookup?identifier=identifier");
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 Expired QR code
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/qr-code/lookup?identifier=identifier")! 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()
```