Get a Pix charge

curl --request GET \
  --url https://api.banking.v2.portao3.com.br/realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/pix-billing/{pixId}

import requests

url = "https://api.banking.v2.portao3.com.br/realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/pix-billing/{pixId}"

response = requests.get(url)

print(response.text)

const options = {method: 'GET'};

fetch('https://api.banking.v2.portao3.com.br/realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/pix-billing/{pixId}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.banking.v2.portao3.com.br/realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/pix-billing/{pixId}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

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

func main() {

	url := "https://api.banking.v2.portao3.com.br/realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/pix-billing/{pixId}"

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

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

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

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("https://api.banking.v2.portao3.com.br/realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/pix-billing/{pixId}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.banking.v2.portao3.com.br/realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/pix-billing/{pixId}")

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

request = Net::HTTP::Get.new(url)

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

{
  "_id": "672a1f4eb4d3e80012c9b3e7",
  "environment": "LIVE",
  "realmId": "f495ff0c-ab54-4f99-8e92-ca8682e4de9b",
  "organizationId": "c4bd3f21-dfbd-44e8-8055-68ba15bed410",
  "accountId": "66f2a1c7b4d3e80012c9a0b4",
  "walletId": "66f2a3d1b4d3e80012c9a0d2",
  "status": "ACTIVE",
  "txnCurrency": "986",
  "txnAmount": 28500,
  "txnCanAmountChange": false,
  "txnFineAmount": {
    "amount": 2,
    "amountType": "PERCENT"
  },
  "txnInterestAmount": {
    "amount": 1,
    "amountType": "PERCENT_POINT_PER_MONTH_CALENDAR_DAYS"
  },
  "txnDiscountAmount": {
    "amount": 0,
    "amountType": "AMOUNT_PER_ANTICIPATION_CALENDAR_DAYS"
  },
  "txnRebateAmount": {
    "amount": 0,
    "amountType": "FIXED_VALUE"
  },
  "dueDate": "2026-11-20T00:00:00.000Z",
  "expiresAt": "2026-12-20T00:00:00.000Z",
  "description": "Pedido 4821",
  "customer": {
    "name": "Juliana Ribeiro",
    "document": "12345678909",
    "email": "juliana.ribeiro@exemplo.com.br",
    "address": {
      "street": "Avenida Paulista",
      "number": "1578",
      "neighborhood": "Bela Vista",
      "postalCode": "01310-200",
      "city": "São Paulo",
      "state": "SP",
      "complement": "Sala 12"
    }
  },
  "confirmedAmount": 0,
  "confirmedAmountAuthorized": 0,
  "createdAt": "2026-11-05T18:21:34.112Z",
  "updatedAt": "2026-11-05T18:21:35.004Z",
  "__v": 0,
  "emv": "00020101021226900014br.gov.bcb.pix2568qrcodes.exemplo.com.br/v2/cobv/b8c1d3e54f2a4c6b9d7e1a2b3c4d5e6f5204000053039865802BR5915Loja Exemplo6009Sao Paulo62070503***6304A1B2",
  "key": "financeiro@lojaexemplo.com.br",
  "confirmedAt": "2026-11-18T14:32:07.512Z",
  "canceledAt": "2026-11-19T09:15:42.087Z",
  "external": {
    "pixBillingId": "b8c1d3e5-4f2a-4c6b-9d7e-1a2b3c4d5e6f",
    "locationId": "d4e5f6a7-b8c9-4d0e-8f1a-2b3c4d5e6f7a",
    "transactionId": "672a1f4eb4d3e80012c9b3e70000"
  }
}

{
  "traceId": "1-68ee2a1b-3c4d5e6f7a8b9c0d1e2f3a4b",
  "code": "ACCOUNT_NOT_FOUND",
  "origin": "BANKING",
  "message": "Account not found"
}

{
  "traceId": "1-68ee2a1b-3c4d5e6f7a8b9c0d1e2f3a4b",
  "code": "BAD_REQUEST",
  "origin": "BANKING",
  "message": "Bad Request: Your request is invalid or incomplete. Please make sure you are requesting with the right fields.",
  "fields": [
    {
      "field": "organizationId",
      "message": "Invalid UUID",
      "code": "ORGANIZATIONID_UUID"
    }
  ]
}

GET

realms

{realmId}

organizations

{organizationId}

accounts

{accountId}

wallets

{walletId}

pix-billing

{pixId}

Get a Pix charge

curl --request GET \
  --url https://api.banking.v2.portao3.com.br/realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/pix-billing/{pixId}

import requests

url = "https://api.banking.v2.portao3.com.br/realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/pix-billing/{pixId}"

response = requests.get(url)

print(response.text)

const options = {method: 'GET'};

fetch('https://api.banking.v2.portao3.com.br/realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/pix-billing/{pixId}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.banking.v2.portao3.com.br/realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/pix-billing/{pixId}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

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

func main() {

	url := "https://api.banking.v2.portao3.com.br/realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/pix-billing/{pixId}"

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

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

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

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("https://api.banking.v2.portao3.com.br/realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/pix-billing/{pixId}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.banking.v2.portao3.com.br/realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/pix-billing/{pixId}")

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

request = Net::HTTP::Get.new(url)

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

{
  "_id": "672a1f4eb4d3e80012c9b3e7",
  "environment": "LIVE",
  "realmId": "f495ff0c-ab54-4f99-8e92-ca8682e4de9b",
  "organizationId": "c4bd3f21-dfbd-44e8-8055-68ba15bed410",
  "accountId": "66f2a1c7b4d3e80012c9a0b4",
  "walletId": "66f2a3d1b4d3e80012c9a0d2",
  "status": "ACTIVE",
  "txnCurrency": "986",
  "txnAmount": 28500,
  "txnCanAmountChange": false,
  "txnFineAmount": {
    "amount": 2,
    "amountType": "PERCENT"
  },
  "txnInterestAmount": {
    "amount": 1,
    "amountType": "PERCENT_POINT_PER_MONTH_CALENDAR_DAYS"
  },
  "txnDiscountAmount": {
    "amount": 0,
    "amountType": "AMOUNT_PER_ANTICIPATION_CALENDAR_DAYS"
  },
  "txnRebateAmount": {
    "amount": 0,
    "amountType": "FIXED_VALUE"
  },
  "dueDate": "2026-11-20T00:00:00.000Z",
  "expiresAt": "2026-12-20T00:00:00.000Z",
  "description": "Pedido 4821",
  "customer": {
    "name": "Juliana Ribeiro",
    "document": "12345678909",
    "email": "juliana.ribeiro@exemplo.com.br",
    "address": {
      "street": "Avenida Paulista",
      "number": "1578",
      "neighborhood": "Bela Vista",
      "postalCode": "01310-200",
      "city": "São Paulo",
      "state": "SP",
      "complement": "Sala 12"
    }
  },
  "confirmedAmount": 0,
  "confirmedAmountAuthorized": 0,
  "createdAt": "2026-11-05T18:21:34.112Z",
  "updatedAt": "2026-11-05T18:21:35.004Z",
  "__v": 0,
  "emv": "00020101021226900014br.gov.bcb.pix2568qrcodes.exemplo.com.br/v2/cobv/b8c1d3e54f2a4c6b9d7e1a2b3c4d5e6f5204000053039865802BR5915Loja Exemplo6009Sao Paulo62070503***6304A1B2",
  "key": "financeiro@lojaexemplo.com.br",
  "confirmedAt": "2026-11-18T14:32:07.512Z",
  "canceledAt": "2026-11-19T09:15:42.087Z",
  "external": {
    "pixBillingId": "b8c1d3e5-4f2a-4c6b-9d7e-1a2b3c4d5e6f",
    "locationId": "d4e5f6a7-b8c9-4d0e-8f1a-2b3c4d5e6f7a",
    "transactionId": "672a1f4eb4d3e80012c9b3e70000"
  }
}

{
  "traceId": "1-68ee2a1b-3c4d5e6f7a8b9c0d1e2f3a4b",
  "code": "ACCOUNT_NOT_FOUND",
  "origin": "BANKING",
  "message": "Account not found"
}

{
  "traceId": "1-68ee2a1b-3c4d5e6f7a8b9c0d1e2f3a4b",
  "code": "BAD_REQUEST",
  "origin": "BANKING",
  "message": "Bad Request: Your request is invalid or incomplete. Please make sure you are requesting with the right fields.",
  "fields": [
    {
      "field": "organizationId",
      "message": "Invalid UUID",
      "code": "ORGANIZATIONID_UUID"
    }
  ]
}

Use it to follow a charge after you create it: status moves from ACTIVE to PAID — with the amount received in confirmedAmount and the moment in confirmedAt — or to CANCELED. Use default as walletId for the organization’s main wallet. Any member of the organization can read it.

Headers

x-environment

enum<string>

Environment of the charge: LIVE (production) or TEST (sandbox). When you omit it, TEST is used; any other value is rejected.

Available options:

LIVE,

TEST

Path Parameters

realmId

string<uuid>

required

ID of your realm.

Format: UUID

organizationId

string<uuid>

required

ID of the organization.

Format: UUID

accountId

string

required

ID of the organization's account (24 hexadecimal characters).

Pattern: ^[0-9a-fA-F]{24}$

walletId

string

required

ID of the wallet the charge belongs to (24 hexadecimal characters), or default for the organization's main wallet.

Pattern: ^([0-9a-fA-F]{24}|default)$

pixId

string

required

ID of the Pix charge — its _id (24 hexadecimal characters).

Pattern: ^[0-9a-fA-F]{24}$

Response

Successful response

A Pix charge: a QR code the payer pays with Pix to credit the wallet.

_id

string

required

ID of the charge.

Example:

"672a1f4eb4d3e80012c9b3e7"

environment

enum<string>

required

LIVE (production) or TEST (sandbox).

Available options:

LIVE,

TEST

Example:

"LIVE"

realmId

string

required

ID of the realm.

Example:

"f495ff0c-ab54-4f99-8e92-ca8682e4de9b"

organizationId

string

required

ID of the organization.

Example:

"c4bd3f21-dfbd-44e8-8055-68ba15bed410"

accountId

string

required

ID of the account.

Example:

"66f2a1c7b4d3e80012c9a0b4"

walletId

string

required

ID of the wallet the charge belongs to.

Example:

"66f2a3d1b4d3e80012c9a0d2"

status

enum<string>

required

CREATING while the QR code is being issued — one that stays CREATING never got its QR code (emv) back, so it can't be shown to a payer; ACTIVE once it can be paid; PAID once paid; CANCELED once canceled.

Available options:

CREATING,

ACTIVE,

PAID,

CANCELED

Example:

"ACTIVE"

txnCurrency

string

required

Currency of the charge: 986 (Brazilian real).

Example:

"986"

txnAmount

number

required

Amount of the charge, in cents.

Example:

28500

txnCanAmountChange

boolean

required

Whether the payer can change the amount when paying.

Example:

false

txnFineAmount

object | null

required

Fine charged once when the charge is paid after dueDate. When it has none: null, or an amount of 0 (a static QR code keeps the object it was created with).

Show child attributes

txnInterestAmount

object | null

required

Interest charged for each day the charge is paid after dueDate. When it has none: null, or an amount of 0 (a static QR code keeps the object it was created with).

Show child attributes

txnDiscountAmount

object | null

required

Discount for paying before dueDate. When it has none: null, or an amount of 0 (a static QR code keeps the object it was created with).

Show child attributes

txnRebateAmount

object | null

required

Rebate deducted from the amount. When it has none: null, or an amount of 0 (a static QR code keeps the object it was created with).

Show child attributes

dueDate

string<date-time> | null

required

Due date of the charge — midnight UTC when it was sent as YYYY-MM-DD. null for a static QR code.

Example:

"2026-11-20T00:00:00.000Z"

expiresAt

string<date-time> | null

required

Last day the charge can be paid — midnight UTC when it was sent as YYYY-MM-DD. null when you didn't send one.

Example:

"2026-12-20T00:00:00.000Z"

description

string

required

Description of the charge. Empty when you didn't send one.

Example:

"Pedido 4821"

customer

object

required

The payer.

Show child attributes

confirmedAmount

number

required

Amount paid, in cents. 0 until the charge is PAID.

Example:

0

confirmedAmountAuthorized

number

required

Not used: always 0.

Example:

0

createdAt

string<date-time>

required

When the charge was created.

Example:

"2026-11-05T18:21:34.112Z"

updatedAt

string<date-time>

required

When the charge last changed.

Example:

"2026-11-05T18:21:35.004Z"

__v

number

required

Version of the record.

Example:

0

emv

string

The Pix Copia e Cola code: render it as a QR code or let the payer paste it in their bank's app. Absent while CREATING.

Example:

"00020101021226900014br.gov.bcb.pix2568qrcodes.exemplo.com.br/v2/cobv/b8c1d3e54f2a4c6b9d7e1a2b3c4d5e6f5204000053039865802BR5915Loja Exemplo6009Sao Paulo62070503***6304A1B2"

key

string

The Pix key the charge pays into — one of the receiving wallet's active keys. Absent while CREATING.

Example:

"financeiro@lojaexemplo.com.br"

confirmedAt

string<date-time>

When the payment was received. Only on a PAID charge.

Example:

"2026-11-18T14:32:07.512Z"

canceledAt

string<date-time>

When the charge was canceled. Only on a CANCELED charge.

Example:

"2026-11-19T09:15:42.087Z"

external

object

References of the charge at the payment institution. Absent while CREATING.

Show child attributes

Overview

Identity

Banking

Billing

Accounting

Registry

Platform

Notification

Rule Engine

Scheduling

Travel

Vehicles

Attachments

Get a Pix charge

Headers

Path Parameters

Response