PayZu API Reference

https://docs.payzu.com.br/reference
Admin
PayZu API provides a simple, secure, and efficient way to integrate real-time payments into systems,...
Tokens:63,986
Snippets:208
Trust Score:4
Update:8 months ago
Show doc for...
Tokens:
Raw
### Payment Chargeback Example (Payzu BR)

Source: https://docs.payzu.com.br/reference/get_charges__chargeid

Illustrates a successful chargeback scenario within the Payzu BR payment system. This example details the structure of a chargeback object, including its ID, amount, status, and associated dates. It serves as a reference for understanding chargeback data representation.

```json
{
  "id": 0,
  "number?": "string",
  "amount": 0,
  "status": "string",
  "reasonCode?": "string",
  "reasonDescription?": "string",
  "issuedAt": "date",
  "createdAt": "date",
  "updatedAt": "date"
}
```

--------------------------------

### Get User Account Information (Node.js)

Source: https://docs.payzu.com.br/reference/gest%C3%A3o-de-conta-1

Example of fetching PayZu user account details using Node.js. This snippet demonstrates making a GET request to the user endpoint and handling the JSON response.

```javascript
const fetch = require('node-fetch');

async function getUserInfo() {
  const response = await fetch('https://pix.payzu.io/v1/user', {
    method: 'GET',
    headers: {
      'accept': 'application/json'
    }
  });
  const data = await response.json();
  console.log(data);
}

getUserInfo();
```

--------------------------------

### Get User Account Information (Ruby)

Source: https://docs.payzu.com.br/reference/gest%C3%A3o-de-conta-1

Ruby example for retrieving PayZu user account information. This code uses the 'net/http' library to send a GET request and parse the JSON response.

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

uri = URI.parse('https://pix.payzu.io/v1/user')

request = Net::HTTP::Get.new(uri)
request['accept'] = 'application/json'

response = Net::HTTP.start(uri.hostname, uri.port, use_ssl: true) do |http|
  http.request(request)
end

puts JSON.parse(response.body)
```

--------------------------------

### Payment Success Example (Payzu BR)

Source: https://docs.payzu.com.br/reference/get_charges__chargeid

Provides a detailed example of a successful payment transaction in the Payzu BR system. This JSON structure outlines all fields associated with a successful payment, including customer details, cart items, and credit card payment information. It is useful for understanding the complete data payload of a successful transaction.

```json
{
  "id": "string",
  "externalId": "string",
  "postbackUrl?": "string",
  "amount": 0,
  "paymentType": "string",
  "createdAt": "date",
  "updatedAt": "date",
  "customer": {
    "id": 0,
    "name": "string",
    "identity": "string",
    "identityType": "string",
    "email": "string",
    "birthdate": "string",
    "phone": "string",
    "address?": {
      "street": "string",
      "number": "string",
      "zipCode": "string",
      "city": "string",
      "state": "string",
      "country": "string",
      "district": "string",
      "complement": "string"
    }
  },
  "cart": [
    {
      "name": "string",
      "quantity": 0,
      "sku": "string",
      "unitPrice": 0
    }
  ],
  "creditCardPayment": {
    "installments": 0,
    "authenticate": "boolean",
    "currency": "string",
    "acquirerTransactionId?": "string",
    "authorizationCode?": "string",
    "reasonCode": 0,
    "status": 0,
    "reversedAmount?": 0,
    "reversedDate?": "date",
    "chargeId": "string",
    "card": {
      "id": 0,
      "number": "string",
      "holder": "string",
      "expiration": "string",
      "brand": "string"
    },
    "chargebacks": [
      {
        "id": 0,
        "number?": "string",
        "amount": 0,
        "status": "string",
        "reasonCode?": "string",
        "reasonDescription?": "string",
        "issuedAt": "date",
        "createdAt": "date",
        "updatedAt": "date"
      }
    ]
  }
}
```

--------------------------------

### GET /proof/{id}

Source: https://docs.payzu.com.br/reference/gettransactionproof

Retrieve official PIX transaction proofs. Available in PDF for printing or Base64 for automatic integrations.

```APIDOC
## GET /proof/{id}

### Description
Baixe comprovantes oficiais de suas transações PIX. Disponível em PDF para impressão ou Base64 para integrações automáticas.

### Method
GET

### Endpoint
https://pix.payzu.io/v1/proof/{id}

### Parameters
#### Path Parameters
- **id** (string) - Required - Id da transação

#### Query Parameters
- **type** (string) - Optional - Tipo que o comprovante será retornado. Allowed values: "base64", "pdf". Default: "pdf"

### Request Example
```json
{
  "example": ""
}
```

### Response
#### Success Response (200)
- **base64** (string) - Base64 encoded proof (if type=base64)
- **application/pdf** (binary) - PDF proof (if type=pdf)

#### Response Example
```json
{
  "example": ""
}
```
```

--------------------------------

### Get User Account Information (Python)

Source: https://docs.payzu.com.br/reference/gest%C3%A3o-de-conta-1

Python code to retrieve PayZu user account details. This example uses the 'requests' library to perform a GET request and display the JSON response.

```python
import requests

url = "https://pix.payzu.io/v1/user"
headers = {
    'accept': 'application/json'
}

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

print(response.json())
```

--------------------------------

### Create Charge Request Example (cURL)

Source: https://docs.payzu.com.br/reference/dep%C3%B3sitos

This snippet demonstrates how to create a charge using a cURL request to the Payzu Pix API. It includes setting the request method, URL, and necessary headers for JSON content.

```shell
curl --request POST \
     --url https://pix.payzu.io/v1/pix \
     --header 'accept: application/json' \
     --header 'content-type: application/json'
```

--------------------------------

### GET /user/summary

Source: https://docs.payzu.com.br/reference/getusersummary

Retrieves a performance report with detailed business metrics, including transaction volumes, conversion rates, and trends over a specified period. Supports grouping by day or hour.

```APIDOC
## GET /user/summary

### Description
Analyses detailed business metrics. Visualize transacted volumes, conversion rates, and trends by period.

### Method
GET

### Endpoint
https://pix.payzu.io/v1/user/summary

### Parameters
#### Query Parameters
- **dateFrom** (string) - Optional - Initial date of the period. Example: "2025-01-01T00:00:00.000Z"
- **dateTo** (string) - Optional - Final date of the period. Example: "2025-01-31T23:59:59.999Z"
- **groupBy** (string) - Optional - Transaction grouping format. Allowed values: "day", "hour". Default: "day"
- **grouped** (boolean) - Optional - Whether to return grouped transactions.

### Response
#### Success Response (200)
- **totalTransactions** (number) - Total number of transactions.
- **deposit** (object) - Deposit details.
  - **totalAmount** (number) - Total amount deposited.
  - **totalTransactions** (number) - Total number of deposit transactions.
  - **statuses** (object) - Deposit transaction statuses.
  - **grouped** (array) - Array of deposit transactions grouped by date.
    - **date** (string) - Date of the grouped transactions.
    - **amount** (number) - Amount for the grouped transactions.
- **withdraw** (object) - Withdrawal details.
  - **totalAmount** (number) - Total amount withdrawn.
  - **totalTransactions** (number) - Total number of withdrawal transactions.
  - **statuses** (object) - Withdrawal transaction statuses.
  - **grouped** (array) - Array of withdrawal transactions grouped by date.
    - **date** (string) - Date of the grouped transactions.
    - **amount** (number) - Amount for the grouped transactions.
- **liquidation** (object) - Liquidation details.
  - **totalAmount** (number) - Total liquidation amount.
  - **totalTransactions** (number) - Total number of liquidation transactions.

#### Response Example
```json
{
  "totalTransactions": 150,
  "deposit": {
    "totalAmount": 10000.50,
    "totalTransactions": 100,
    "statuses": {
      "success": 95,
      "failed": 5
    },
    "grouped": [
      {
        "date": "2025-01-01",
        "amount": 500.75
      },
      {
        "date": "2025-01-02",
        "amount": 600.25
      }
    ]
  },
  "withdraw": {
    "totalAmount": 5000.25,
    "totalTransactions": 50,
    "statuses": {
      "success": 48,
      "failed": 2
    },
    "grouped": [
      {
        "date": "2025-01-01",
        "amount": 200.50
      },
      {
        "date": "2025-01-02",
        "amount": 250.00
      }
    ]
  },
  "liquidation": {
    "totalAmount": 15000.75,
    "totalTransactions": 150
  }
}
```
```

--------------------------------

### GET /charges

Source: https://docs.payzu.com.br/reference/get_charges

Retrieves a list of charges. This endpoint allows you to fetch all charges associated with your account, providing details such as IDs, amounts, payment types, and creation timestamps.

```APIDOC
## GET /charges

### Description
Retrieves a list of charges. This endpoint allows you to fetch all charges associated with your account, providing details such as IDs, amounts, payment types, and creation timestamps.

### Method
GET

### Endpoint
/charges

### Parameters
#### Query Parameters
- **page** (string) - Optional - The page number to retrieve.
- **limit** (string) - Optional - The number of items per page.
- **sortBy** (string) - Optional - The field to sort by.
- **sortOrder** (string) - Optional - The order to sort by (asc or desc).
- **status** (string) - Optional - The status of the charges to filter by.
- **paymentType** (string) - Optional - The payment type to filter by.
- **minAmount** (string) - Optional - The minimum amount to filter by.
- **maxAmount** (string) - Optional - The maximum amount to filter by.
- **minDate** (string) - Optional - The minimum creation date to filter by.
- **maxDate** (string) - Optional - The maximum creation date to filter by.

### Request Example
```json
{
  "example": "No request body for GET /charges"
}
```

### Response
#### Success Response (200)
- **page** (string) - The current page number.
- **total** (string) - The total number of charges.
- **totalPages** (string) - The total number of pages.
- **charges** (array) - A list of charge objects.
  - **id** (string) - The unique identifier for the charge.
  - **externalId** (string) - The external identifier for the charge.
  - **postbackUrl** (string) - The URL for postback notifications.
  - **amount** (number) - The amount of the charge.
  - **paymentType** (string) - The type of payment.
  - **createdAt** (string) - The timestamp when the charge was created.
  - **updatedAt** (string) - The timestamp when the charge was last updated.
  - **customer** (object) - The customer associated with the charge.
    - **id** (number) - The unique identifier for the customer.
    - **name** (string) - The name of the customer.
    - **identity** (string) - The customer's identification number.
    - **identityType** (string) - The type of the customer's identification.
    - **email** (string) - The email address of the customer.
    - **birthdate** (string) - The birthdate of the customer.
    - **phone** (string) - The phone number of the customer.
    - **address** (object) - The address of the customer.
      - **street** (string) - The street name.
      - **number** (string) - The street number.
      - **zipCode** (string) - The postal code.
      - **city** (string) - The city.
      - **state** (string) - The state.

#### Response Example
```json
{
  "page": "1",
  "total": "10",
  "totalPages": "1",
  "charges": [
    {
      "id": "ch_1234567890",
      "externalId": "ext_abcdef12345",
      "postbackUrl": "https://example.com/postback",
      "amount": 100.50,
      "paymentType": "credit_card",
      "createdAt": "2023-10-27T10:00:00Z",
      "updatedAt": "2023-10-27T10:05:00Z",
      "customer": {
        "id": 123,
        "name": "John Doe",
        "identity": "12345678901",
        "identityType": "cpf",
        "email": "john.doe@example.com",
        "birthdate": "1990-01-01",
        "phone": "11987654321",
        "address": {
          "street": "Main St",
          "number": "123",
          "zipCode": "01000-000",
          "city": "Sao Paulo",
          "state": "SP"
        }
      }
    }
  ]
}
```
```

--------------------------------

### Card Payment and Authentication

Source: https://docs.payzu.com.br/reference/post_charges

This section details the parameters required for processing card payments, including card details, installments, currency, and authentication options. It also covers external authentication parameters and fraud analysis information.

```APIDOC
## POST /websites/payzu_br_reference

### Description
This endpoint handles card payments and authentication for the Payzu Brazil reference project. It allows for specifying card details, payment installments, currency, and authentication preferences.

### Method
POST

### Endpoint
/websites/payzu_br_reference

### Parameters
#### Request Body
- **installments** (number) - Optional - Número de parcelas
- **card** (object) - Required - Detalhes do cartão
  - **number** (string) - Required - Número do cartão de crédito
  - **holder** (string) - Required - Nome do portador impresso no cartão de crédito
  - **expiration** (string) - Required - Data de validade do cartão de crédito
  - **cvv** (string) - Required - Código de segurança no verso do cartão de crédito
- **currency** (string) - Optional - Moeda da cobrança (default: "BRL")
- **authenticate** (boolean) - Optional - Define se o comprador será direcionado ao emissor para autenticação do cartão
- **externalAuthentication** (object) - Optional - External authentication details
  - **cavv** (string) - Required - Assinatura retornada nos cenários de sucesso na autenticação
  - **xid** (string) - Optional - XID retornado no processo de autenticação
  - **eci** (string) - Required - Electronic Commerce Indicator retornado no processo de autenticação
  - **version** (string) - Required - Versão do 3DS aplicado no processo de autenticação
  - **referenceId** (string) - Required - RequestID retornado no processo de autenticação
- **fraudAnalysis** (object) - Optional - Fraud analysis details
  - **fingerPrintId** (string) - Required - Identificador utilizado para cruzar informações obtidas do dispositivo do comprador
  - **browser** (object) - Required - Informações sobre o navegador do comprador
    - **cookiesAccepted** (boolean) - Required - Identifica se o browser do comprador aceita cookies
    - **email** (string) - Optional - E-mail registrado no browser do comprador
    - **hostName** (string) - Optional - Nome do host informado pelo browser do comprador e identificado através do cabeçalho HTTP
    - **ipAddress** (string) - Required - Endereço IP do comprador
  - **definedFields** (array) - Required - List of defined fields for fraud analysis

### Request Example
```json
{
  "installments": 1,
  "card": {
    "number": "1111111111111111",
    "holder": "John Doe",
    "expiration": "12/2025",
    "cvv": "123"
  },
  "currency": "BRL",
  "authenticate": true,
  "fraudAnalysis": {
    "fingerPrintId": "fp123",
    "browser": {
      "cookiesAccepted": true,
      "ipAddress": "192.168.1.1"
    },
    "definedFields": []
  }
}
```

### Response
#### Success Response (200)
- **status** (string) - Status of the transaction
- **tid** (string) - Transaction ID

#### Response Example
```json
{
  "status": "approved",
  "tid": "txn12345"
}
```
```

--------------------------------

### Get User Account Information (PHP)

Source: https://docs.payzu.com.br/reference/gest%C3%A3o-de-conta-1

PHP snippet to fetch PayZu user account data. This example utilizes cURL to make the GET request and processes the JSON response.

```php
<?php

$ch = curl_init();

curl_setopt($ch, CURLOPT_URL, 'https://pix.payzu.io/v1/user');
curl_setopt($ch, CURLOPT_RETURNTRANSFER, 1);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'GET');
curl_setopt($ch, CURLOPT_HTTPHEADER, array('accept: application/json'));

$response = curl_exec($ch);

if (curl_errno($ch)) {
    echo 'Error:' . curl_error($ch);
} else {
    echo $response;
}

curl_close($ch);
?>
```

--------------------------------

### Initialize Payzu 3DS with Configuration

Source: https://docs.payzu.com.br/reference/inicializar-o-script

This JavaScript code demonstrates how to initialize the Payzu 3DS library after it has been loaded. It includes configuration options for transaction amount, currency, and enabling/disabling sandbox, debug, and challenge suppression.

```javascript
const config = {
  amount: 350,
  currency: 'BRL',
  options: {
    enabled: true,
    sandbox: true,
    debug: true,
    suppressChallenge: false
  }
};

payzu3DS.init(config);
```

--------------------------------

### POST /pix

Source: https://docs.payzu.com.br/reference/createpixcharge

Cria uma nova cobrança PIX para recebimento de pagamento. Permite especificar o valor, URL de callback, dados do pagador e tempo de expiração.

```APIDOC
## POST /pix

### Description
Cria uma nova cobrança PIX para recebimento de pagamento.

### Method
POST

### Endpoint
https://pix.payzu.io/v1/pix

### Parameters
#### Query Parameters
Nenhum parâmetro de query.

#### Request Body
- **amount** (number) - Required - Valor em BRL. Deve ser >= 1.
- **callbackUrl** (string) - Optional - URL para receber webhooks de atualização da transação.
- **generatedName** (string) - Optional - Nome completo do pagador. Apenas letras e espaços.
- **generatedEmail** (string) - Optional - Email do pagador.
- **generatedDocument** (string) - Optional - CPF (11 dígitos) ou CNPJ (14 dígitos) do pagador, sem pontuação.
- **expiresIn** (number) - Optional - Segundos até o QR Code expirar. Padrão: 600.
- **description** (string) - Optional - Descrição da transação.
- **clientReference** (string) - Optional - Referência externa (pedido, fatura, etc.).

### Request Example
```json
{
  "amount": 150.5,
  "callbackUrl": "https://webhook.cool/",
  "generatedName": "John Doe",
  "generatedEmail": "john.doe@example.com",
  "generatedDocument": "12345678901",
  "expiresIn": 600,
  "description": "Pagamento pedido #12345",
  "clientReference": "order_12345"
}
```

### Response
#### Success Response (200)
- **id** (string) - Identificador único da cobrança.
- **status** (string) - Status atual da cobrança (PENDING, COMPLETED, CANCELED, etc.).
- **amount** (number) - Valor da cobrança.
- **type** (string) - Tipo da transação (DEPOSIT, WITHDRAW, etc.).
- **qrCodeText** (string) - Texto do QR Code PIX.
- **qrCodeBase64** (string) - Imagem do QR Code em Base64.
- **qrCodeUrl** (string) - URL para visualização do QR Code.

#### Response Example
```json
{
  "id": "PAYZU20250817215911F49RDOBJ",
  "status": "PENDING",
  "amount": 150.50,
  "type": "DEPOSIT",
  "qrCodeText": "00020126870014br.gov.bcb.pix2565qrcode.payzu.com.br/dynamic/d7790b91-3979-4ad5-9d96-ee941e5a42765204000053",
  "qrCodeBase64": "iVBORw0KGgoAAAANSUhEUgAAAGQAAABkCAYAAABsZJv...",
  "qrCodeUrl": "https://pix.payzu.com/qr/d7790b91-3979-4ad5-9d96-ee941e5a4276"
}
```
```

--------------------------------

### Making mTLS Requests with cURL

Source: https://docs.payzu.com.br/reference/mutual-tls

This example demonstrates how to make a GET request to the Payzu API using cURL with Mutual TLS authentication. It requires the client certificate, private key, and CA certificate to be specified.

```curl
curl --request GET \
     --url https://api.sandbox.payzu.io/v1/charges \
     --header 'accept: application/json' \
     --cert cliente.crt \
     --key cliente.key \
     --cacert ca.pem
```

--------------------------------

### Mutual TLS Authentication Example

Source: https://docs.payzu.com.br/reference/seguran%C3%A7a-e-autentica%C3%A7%C3%A3o

This section provides an example of how to make a request using Mutual TLS authentication with cURL. It demonstrates the necessary headers and certificate configurations.

```APIDOC
## GET /v1/charges

### Description
This endpoint retrieves a list of charges. Mutual TLS authentication is required for this request.

### Method
GET

### Endpoint
https://api.sandbox.payzu.io/v1/charges

### Parameters
#### Query Parameters
None

#### Request Body
None

### Request Example
```bash
curl --request GET \
     --url https://api.sandbox.payzu.io/v1/charges \
     --header 'accept: application/json' \
     --cert cliente.crt \
     --key cliente.key \
     --cacert ca.pem
```

### Response
#### Success Response (200)
- **charges** (array) - A list of charge objects.

#### Response Example
```json
{
  "charges": [
    {
      "id": "ch_12345",
      "amount": 1000,
      "currency": "BRL",
      "status": "paid"
    }
  ]
}
```
```

--------------------------------

### GET /charges/{chargeId}

Source: https://docs.payzu.com.br/reference/get_charges__chargeid

Retrieves the details of a specific charge using its ID.

```APIDOC
## GET /charges/{chargeId}

### Description
Retrieves the details of a specific charge using its ID.

### Method
GET

### Endpoint
https://api.sandbox.payzu.io/v1/charges/{chargeId}

### Parameters
#### Path Parameters
- **chargeId** (string) - Required - The unique identifier of the charge to consult.

### Response
#### Success Response (200)
- **id** (string) - The unique identifier of the charge.
- **externalId** (string) - An external identifier for the charge.
- **postbackUrl** (string) - The URL to send postback notifications to (optional).
- **amount** (number) - The amount of the charge.
- **paymentType** (string) - The type of payment for the charge.
- **createdAt** (string) - The timestamp when the charge was created.
- **updatedAt** (string) - The timestamp when the charge was last updated.
- **customer** (object) - Details about the customer associated with the charge.
  - **id** (number) - The customer's unique identifier.
  - **name** (string) - The customer's name.
  - **identity** (string) - The customer's identification number.
  - **identityType** (string) - The type of customer identification.
  - **email** (string) - The customer's email address.
  - **birthdate** (string) - The customer's birthdate.
  - **phone** (string) - The customer's phone number.
  - **address** (object) - The customer's address details (optional).
    - **street** (string) - The street name.
    - **number** (string) - The street number.
    - **zipCode** (string) - The postal code.
    - **city** (string) - The city.
    - **state** (string) - The state or province.
    - **country** (string) - The country.
    - **district** (string) - The district or neighborhood.
    - **complement** (string) - Additional address information.
- **cart** (array) - A list of items included in the charge.
  - **name** (string) - The name of the item.
```

--------------------------------

### Initiate PIX Transfer via QR Code - OpenAPI

Source: https://docs.payzu.com.br/reference/createwithdrawqrcode

Defines the POST request for initiating a PIX transfer using a QR Code. It requires the amount and the PIX QR Code string, with optional fields for callback URL, description, and client reference. The response includes transaction details such as ID, status, and amount.

```json
{
  "openapi": "3.0.0",
  "info": {
    "version": "1.0.0",
    "title": "API Conta Digital",
    "description": "API completa para operações de pagamento PIX, TED, transferências internas e gerenciamento de conta digital."
  },
  "servers": [
    {
      "url": "https://pix.payzu.io/v1"
    }
  ],
  "tags": [
    {
      "name": "Saques",
      "description": "Envie dinheiro instantaneamente via PIX. Transfira usando chaves PIX, QR Codes ou dados bancários completos."
    }
  ],
  "paths": {
    "/withdraw/qrcode": {
      "post": {
        "summary": "Transferir via QR Code",
        "description": "Pague instantaneamente escaneando ou colando um QR Code PIX. Ideal para pagamentos em estabelecimentos ou transferências rápidas.",
        "operationId": "createWithdrawQrCode",
        "tags": [
          "Saques"
        ],
        "security": [
          {
            "BearerAuth": []
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "type": "object",
                "required": [
                  "amount",
                  "qrCode"
                ],
                "properties": {
                  "amount": {
                    "type": "number",
                    "description": "Valor da transação em reais, deve ser maior do que 1"
                  },
                  "qrCode": {
                    "type": "string",
                    "description": "String do QR Code PIX do destinatário",
                    "example": "00020126870014br.gov.bcb.pix2565qrcode.payzu.com.br/dynamic/d7790b91-3979-4ad5-9d96-ee941e5a42765204000053"
                  },
                  "callbackUrl": {
                    "type": "string",
                    "description": "Url na qual será enviado notificações sobre mudanças no status da transação"
                  },
                  "description": {
                    "type": "string",
                    "description": "Descrição da transação"
                  },
                  "clientReference": {
                    "type": "string",
                    "description": "Referência externa (pedido, fatura, etc.)",
                    "example": "order_12347"
                  }
                }
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "Transferência iniciada",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "properties": {
                    "id": {
                      "type": "string",
                      "example": "PAYZU20250817215911F49RDOBJ"
                    },
                    "status": {
                      "type": "string",
                      "enum": [
                        "PENDING",
                        "COMPLETED",
                        "CANCELED",
                        "WAITING_FOR_REFUND",
                        "REFUNDED",
                        "EXPIRED",
                        "ERROR"
                      ]
                    },
                    "amount": {
                      "type": "number",
                      "example": "150.50"
                    },
                    "type": {
                      "type": "string",
                      "enum": [
                        "DEPOSIT",
                        "WITHDRAW",
                        "COMMISSION",
                        "LIQUIDATION",
                        "INTERNAL_TRANSFER"
                      ]
                    },
                    "qrCodeText": {
                      "type": "string",
                      "nullable": true,
                      "example": "00020126870014br.gov.bcb.pix2565qrcode.payzu.com.br/dynamic/d7790b91-3979-4ad5-9d96-ee941e5a42765204000053"
                    },
                    "qrCodeBase64": {
                      "type": "string",
                      "nullable": true
                    },
                    "qrCodeUrl": {
                      "type": "string",
                      "nullable": true
                    },
                    "generatedName": {
                      "type": "string",
                      "nullable": true
                    },
                    "generatedDocument": {
                      "type": "string",
                      "nullable": true
                    },
                    "generatedEmail": {
                      "type": "string",
                      "nullable": true
                    },
                    "payerName": {
                      "type": "string",
                      "nullable": true
                    },
                    "payerDocument": {
                      "type": "string",
                      "nullable": true
                    },
                    "payerInstitutionIspb": {
                      "type": "string",
                      "nullable": true
                    }
                  }
                }
              }
            }
          }
        }
      }
    }
  }
}
```

--------------------------------

### GET /transactions

Source: https://docs.payzu.com.br/reference/get_charges

Retrieves a list of transactions with optional filtering by date, limit, and page.

```APIDOC
## GET /transactions

### Description
Retrieves a list of transactions with optional filtering by date, limit, and page.

### Method
GET

### Endpoint
/transactions

### Parameters
#### Query Parameters
- **startDate** (string) - Optional - Data inicial para filtrar os resultados
- **endDate** (string) - Optional - Data final para filtrar os resultados
- **limit** (number) - Optional - Limite máximo de itens a serem retornados na consulta (default: 10)
- **page** (number) - Optional - Número da página para a paginação dos resultados (default: 1)

### Request Example
```json
{
  "example": "GET /transactions?startDate=2023-01-01&endDate=2023-12-31&limit=20&page=1"
}
```

### Response
#### Success Response (200)
- **id** (integer) - Transaction ID
- **number** (string) - Transaction number
- **holder** (string) - Cardholder name
- **expiration** (string) - Card expiration date
- **brand** (string) - Card brand
- **chargebacks** (array) - List of chargebacks associated with the transaction
  - **id** (integer) - Chargeback ID
  - **number?** (string) - Chargeback number (optional)
  - **amount** (number) - Chargeback amount
  - **status** (string) - Chargeback status
  - **reasonCode?** (string) - Chargeback reason code (optional)
  - **reasonDescription?** (string) - Chargeback reason description (optional)
  - **issuedAt** (date) - Date the chargeback was issued
  - **createdAt** (date) - Date the chargeback was created
  - **updatedAt** (date) - Date the chargeback was updated

#### Response Example
```json
{
  "example": {
    "transactions": [
      {
        "id": 123,
        "number": "TXN456789",
        "holder": "John Doe",
        "expiration": "12/25",
        "brand": "Visa",
        "chargebacks": [
          {
            "id": 1,
            "number": "CBK12345",
            "amount": 50.00,
            "status": "open",
            "reasonCode": "54",
            "reasonDescription": "Disputed transaction",
            "issuedAt": "2023-10-26T10:00:00Z",
            "createdAt": "2023-10-26T10:05:00Z",
            "updatedAt": "2023-10-26T10:05:00Z"
          }
        ]
      }
    ]
  }
}
```
```

--------------------------------

### GET /websites/payzu_br_reference/infractions

Source: https://docs.payzu.com.br/reference/get_infractions

Retrieves a list of infractions with associated details. Supports pagination and filtering.

```APIDOC
## GET /websites/payzu_br_reference/infractions

### Description
Retrieves a list of infractions with associated details. Supports pagination and filtering.

### Method
GET

### Endpoint
/websites/payzu_br_reference/infractions

### Parameters
#### Query Parameters
- **page** (integer) - Optional - The page number to retrieve.
- **limit** (integer) - Optional - The number of items per page.

### Request Example
```json
{
  "example": ""
}
```

### Response
#### Success Response (200)
- **infractions** (array) - A list of infraction objects.
  - **id** (string) - The unique identifier for the infraction.
  - **protocol** (string) - The protocol number associated with the infraction.
  - **status** (string) - The current status of the infraction (e.g., OPEN, CLOSED).
  - **type** (string) - The type of infraction (e.g., FRAUD).
  - **reportedBy** (string) - The entity that reported the infraction.
  - **reportDetails** (string) - Detailed information about the infraction report.
  - **analysisResult** (string) - The result of the analysis, if performed.
  - **analysisDetails** (string) - Details of the analysis.
  - **reportedAt** (string) - The timestamp when the infraction was reported.
  - **expiresAt** (string) - The timestamp when the infraction expires.
  - **createdAt** (string) - The timestamp when the infraction record was created.
  - **updatedAt** (string) - The timestamp when the infraction record was last updated.
  - **transaction** (object) - Details of the related transaction.
    - **id** (string) - The transaction ID.
    - **amount** (number) - The transaction amount.
    - **payerName** (string) - The name of the payer.
    - **payerDocument** (string) - The document number of the payer.
    - **receiverName** (string) - The name of the receiver.
    - **receiverDocument** (string) - The document number of the receiver.
    - **endToEndId** (string) - The end-to-end transaction ID.
  - **defenseHistory** (array) - A history of defenses submitted for the infraction.
    - **id** (string) - The defense ID.
    - **defense** (string) - The defense statement.
    - **status** (string) - The status of the defense.
    - **createdAt** (string) - The timestamp when the defense was created.
    - **updatedAt** (string) - The timestamp when the defense was last updated.
- **pagination** (object) - Pagination details for the response.
  - **page** (integer) - The current page number.
  - **limit** (integer) - The number of items per page.
  - **totalItems** (integer) - The total number of items available.
  - **totalPages** (integer) - The total number of pages.

#### Response Example
```json
{
  "infractions": [
    {
      "id": "infraction_id",
      "protocol": "PROTOCOL123",
      "status": "OPEN",
      "type": "FRAUD",
      "reportedBy": "DEBITED_PARTICIPANT",
      "reportDetails": "Transação não autorizada",
      "analysisResult": null,
      "analysisDetails": null,
      "reportedAt": "2024-01-15T10:30:00Z",
      "expiresAt": "2024-02-15T10:30:00Z",
      "createdAt": "2024-01-15T10:30:00Z",
      "updatedAt": "2024-01-15T10:30:00Z",
      "transaction": {
        "id": "transaction_id",
        "amount": 100.5,
        "payerName": "João Silva",
        "payerDocument": "12345678901",
        "receiverName": "Maria Santos",
        "receiverDocument": "12345678901",
        "endToEndId": "E12345678202401151030001"
      },
      "defenseHistory": [
        {
          "id": "defense_id",
          "defense": "Esta transação foi autorizada pelo cliente",
          "status": "PENDING",
          "createdAt": "2024-01-16T14:20:00Z",
          "updatedAt": "2024-01-16T14:20:00Z"
        }
      ]
    }
  ],
  "pagination": {
    "page": 1,
    "limit": 20,
    "totalItems": 45,
    "totalPages": 3
  }
}
```
```

--------------------------------

### POST /v1/withdraw

Source: https://docs.payzu.com.br/reference/saques

Realize transferências instantâneas usando qualquer tipo de chave PIX. Suporta CPF, CNPJ, e-mail, telefone ou chaves aleatórias (EVP).

```APIDOC
## POST /v1/withdraw

### Description
Realize transferências instantâneas usando qualquer tipo de chave PIX. Suporta CPF, CNPJ, e-mail, telefone ou chaves aleatórias (EVP).

### Method
POST

### Endpoint
https://pix.payzu.io/v1/withdraw

### Parameters
#### Request Body
- **amount** (number) - Required - Valor da transação em reais, deve ser maior do que 1
- **pixKey** (string) - Required - Chave Pix do destinatário que receberá o valor
- **pixType** (string) - Required - Tipo da chave Pix fornecida. Allowed: `cpf`, `cnpj`, `phone`, `email`, `evp`
- **callbackUrl** (string) - Optional - Url na qual será enviado notificações sobre mudanças no status da transação
- **description** (string) - Optional - Descrição da transação
- **clientReference** (string) - Optional - Referência externa (pedido, fatura, etc.)

### Request Example
```json
{
  "amount": 100.50,
  "pixKey": "chave_aleatoria_exemplo",
  "pixType": "evp",
  "callbackUrl": "https://example.com/callback",
  "description": "Pagamento de Fatura 123",
  "clientReference": "PEDIDO-XYZ"
}
```

### Response
#### Success Response (200)
- **status** (string) - Status da transação
- **message** (string) - Mensagem de confirmação
- **transactionId** (string) - ID único da transação

#### Response Example
```json
{
  "status": "PENDING",
  "message": "Transferência PIX iniciada com sucesso.",
  "transactionId": "txn_12345abcde"
}
```
```

--------------------------------

### Get User Account Information (OpenAPI)

Source: https://docs.payzu.com.br/reference/getuser

This snippet defines the GET /user endpoint in OpenAPI 3.0.0 format. It allows retrieval of comprehensive user account details, including balances, limits, and associated bank information. Authentication is handled via Bearer token.

```json
{
  "openapi": "3.0.0",
  "info": {
    "version": "1.0.0",
    "title": "API Conta Digital",
    "description": "API completa para operações de pagamento PIX, TED, transferências internas e gerenciamento de conta digital."
  },
  "servers": [
    {
      "url": "https://pix.payzu.io/v1"
    }
  ],
  "tags": [
    {
      "name": "Gestão de Conta",
      "description": "Gerencie sua conta PayZu. Consulte saldos, extratos, métricas de performance e informações da conta."
    }
  ],
  "paths": {
    "/user": {
      "get": {
        "summary": "Informações da Conta",
        "description": "Acesse dados completos da sua conta PayZu incluindo limites operacionais, taxas configuradas, chave PIX vinculada e permissões ativas.",
        "operationId": "getUser",
        "tags": [
          "Gestão de Conta"
        ],
        "security": [
          {
            "BearerAuth": []
          }
        ],
        "responses": {
          "200": {
            "description": "Dados da conta obtidos com sucesso",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "properties": {
                    "id": {
                      "type": "string"
                    },
                    "name": {
                      "type": "string"
                    },
                    "role": {
                      "type": "string"
                    },
                    "balanceAvailable": {
                      "type": "number"
                    },
                    "balanceBlocked": {
                      "type": "number"
                    },
                    "status": {
                      "type": "string"
                    },
                    "allowWithdraw": {
                      "type": "boolean"
                    },
                    "allowDeposit": {
                      "type": "boolean"
                    },
                    "allowInfraction": {
                      "type": "boolean"
                    },
                    "cashInTicketMin": {
                      "type": "number"
                    },
                    "cashInTicketMax": {
                      "type": "number"
                    },
                    "cashOutTicketMin": {
                      "type": "number"
                    },
                    "cashOutTicketMax": {
                      "type": "number"
                    },
                    "createdAt": {
                      "type": "string"
                    },
                    "updatedAt": {
                      "type": "string"
                    },
                    "account": {
                      "type": "object",
                      "properties": {
                        "number": {
                          "type": "string"
                        },
                        "digit": {
                          "type": "string"
                        },
                        "branch": {
                          "type": "string"
                        },
                        "document": {
                          "type": "string"
                        },
                        "bank": {
                          "type": "object",
                          "properties": {
                            "code": {
                              "type": "string"
                            },
                            "ispb": {
                              "type": "string"
                            },
                            "name": {
                              "type": "string"
                            }
                          }
                        }
                      }
                    },
                    "ServiceFee": {
                      "type": "object",
                      "properties": {
                        "cashInMinimum": {
                          "type": "number"
                        },
                        "cashInFixed": {
                          "type": "number"
                        },
                        "cashInPercent": {
                          "type": "number"
                        },
                        "cashOutMinimum": {
                          "type": "number"
                        },
                        "cashOutFixed": {
                          "type": "number"
                        },
                        "cashOutPercent": {
                          "type": "number"
                        }
                      }
                    }
                  },
                  "x-readme-ref-name": "User"
                }
              }
            }
          }
        }
      }
    }
  },
  "components": {
    "securitySchemes": {
      "BearerAuth": {
        "type": "http",
        "scheme": "bearer"
      }
    }
  }
}
```

--------------------------------

### Initiate Withdrawal Request (cURL)

Source: https://docs.payzu.com.br/reference/saques

This cURL command demonstrates how to initiate a withdrawal request to the Payzu BR API. It specifies the endpoint, HTTP method, and required headers, along with a sample JSON payload for the request body.

```shell
curl --request POST \
     --url https://pix.payzu.io/v1/withdraw \
     --header 'accept: application/json' \
     --header 'content-type: application/json' \
     --data '{"pixType":"cpf"}'
```

--------------------------------

### Handle Payzu 3DS Ready Event in JavaScript

Source: https://docs.payzu.com.br/reference/eventos

This snippet demonstrates how to use the `payzu3DS.on()` method to listen for the 'ready' event. This event signifies that the checkout script has loaded successfully and is ready to initiate the authentication process. No specific input parameters are required for this event handler.

```javascript
payzu3DS.on("ready", function (e) {
  
});
```
Tokens:
Raw