> ## Documentation Index
> Fetch the complete documentation index at: https://docs.localpayment.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Pix (Brasil)

A Localpayment permite que comerciantes processem pagamentos instantâneos por meio do sistema Pix, a plataforma revolucionária de pagamentos instantâneos do Brasil, desenvolvida pelo Banco Central do Brasil. Este guia descreve o processo para iniciar pagamentos Pix por meio da API da Localpayment, detalhando os parâmetros necessários, o tratamento de respostas e a interpretação de códigos de status para uma integração perfeita com a infraestrutura de pagamentos em tempo real do Brasil.

O Pix é o sistema de pagamentos instantâneos do Brasil, desenvolvido pelo Banco Central do Brasil (BCB). Ele permite que pessoas físicas e jurídicas enviem e recebam pagamentos em segundos, 24 horas por dia, 7 dias por semana, 365 dias por ano.

O Localpayment oferece suporte a dois métodos principais de pagamento Pix:

* **Código QR Pix:** Os clientes escaneiam um código QR dinâmico com o aplicativo bancário.
* **Pix Copiar e Colar (Copia e Cola):** Os clientes copiam um código Pix e colam-no na aplicação do seu banco ou carteira digital para iniciar a transferência.

Ambos os métodos utilizam o mesmo endpoint da API e proporcionam uma experiência de pagamento rápida e segura.

## Antes de começar

Certifique-se de ter:

* [Credenciais de API](https://docs.localpayment.com/pt-br/docs/api-keys-and-environments.md) válidas (token de acesso).

***

## Passo 1. Criar pagamento Pix

Para gerar um pagamento Pix para cobrança no Brasil, envie uma solicitação `POST` ao endpoint [Criar Payin](https://docs.localpayment.com/pt-br/reference/payins.md) com parâmetros específicos do Pix.

### Parâmetros-chave da solicitação

A solicitação requer vários objetos-chave específicos para pagamentos por QR Code:

| Objeto | Descrição | Obrigatório |
| - | - | - |
| `paymentMethod.type` | Deve ser `BankTransfer`. | ✅ |
| `paymentMethod.code` | Use `1314` para o Pix. | ✅ |
| `sender` | Informações do remetente para fins de conformidade. | ✅ |
| `merchant` | Detalhes do comerciante/empresa. | ✅ |
| `paymentMethod` | Configuração do método de pagamento. | ✅ |
| `amount` | Valor da transação. | ✅ |
| `currency` | Código da moeda da transação. | ✅ |
| `country` | Deve ser `BRA`. | ✅ |

Veja todos os [parâmetros disponíveis](https://docs.localpayment.com/pt-br/reference/payins.md) na solicitação.

> [!NOTE]
>
> **O mesmo endpoint serve para ambos os métodos:** esta única requisição à API é usada para gerar um pagamento tanto para o **Pix QR Code quanto para o Pix Copy and Paste (Copia e Cola)**. O método usado pelo cliente é determinado pela forma como você apresenta os detalhes do pagamento retornados na resposta.

### Exemplo de solicitação

Abaixo está um exemplo usando `curl`:

```bash curl theme={"theme":{"light":"github-light-high-contrast","dark":"github-dark-high-contrast"}}
curl --request POST \
     --url https://api.stage.localpayment.com/api/payin/ \
     --header 'accept: application/json' \
     --header 'Authorization: Bearer <your_access_token>' \
     --header 'content-type: application/json' \
     --data '
{
  "paymentMethod": {
    "type": "BankTransfer",
    "code": "1314",
    "flow": "DIRECT"
  },
  "currency": "USD",
  "merchant": {
    "type": "COMPANY",
    "document": {
      "type": "",
      "id": ""
    },
    "name": "Company",
    "email": ""
  },
  "payer": {
    "type": "INDIVIDUAL",
    "document": {
      "id": "75.518.609/0001-56",
      "type": "CNPJ"
    },
    "bank": {
      "account": {
        "type": "C"
      }
    },
    "name": "John",
    "lastname": "Doe"
  },
  "externalId": "3d3b3e1d-c234-4fde-8e87-cd61b7dde3cf",
  "country": "BRA",
  "amount": 1000,
  "accountNumber": "{{accountNumber}}",
  "conceptCode": "0003",
  "comment": "Any relevant information related to the transaction"
}
'
```

***

## Etapa 2. Lidar com a resposta

### Resposta bem-sucedida

A criação bem-sucedida de um pagamento Pix inclui os dados do código Pix e os detalhes do pagamento:

```json QR theme={"theme":{"light":"github-light-high-contrast","dark":"github-dark-high-contrast"}}
{
  "transactionType": "PayIn",
  "externalId": "3d3b3e1d-c234-4fde-8e87-cd61b7dde3cf",
  "internalId": "7e57a8ed-7fa4-4264-bcf3-a44d3ff2c132",
  "paymentMethod": {
    "type": "BankTransfer",
    "code": "1314",
    "flow": "DIRECT"
  },
  "country": "BRA",
  "currency": "USD",
  "amount": 1000,
  "accountNumber": "{{accountNumber}}",
  "confirmed": {
    "currency": "USD",
    "amount": 1000,
    "fxQuote": 1,
    "exchangeRateToken": null
  },
  "payment": {
    "installment": null,
    "currency": "BRL",
    "fxQuote": 4.96637604,
    "financingFee": 0,
    "amount": 4966.38
  },
  "localTaxes": [],
  "withHoldings": [],
  "fees": {
    "description": "Fee",
    "currency": "USD",
    "fxSource": 1,
    "fxQuote": 1,
    "amount": 11,
    "account": "{{accountNumber}}"
  },
  "status": {
    "code": "100",
    "description": "INPROGRESS",
    "detail": "The payin is pending the confirmation"
  },
  "ticket": null,
  "qr": {
    "image": "https://api.stage.localpayment.com/api/images/1314/00020126580014br.gov.bcb.pix013627a44d0a-0736-4bbf-a4a4-6e11063973315204000053039865406150.005802BR5911Telequiet496008Campinas62230519mpqrinter12397252666304FA23",
    "code": "00020126580014br.gov.bcb.pix013627a44d0a-0736-4bbf-a4a4-6e11063973315204000053039865406150.005802BR5911Telequiet496008Campinas62230519mpqrinter12397252666304FA23",
    "codeBase64": "iVBORw0KGgoAAAANSUhEUgAABWQAAAVkAQAAAAB79iscAAAI/UlEQVR42u3dW47kNgwFUO3A+9+ld6Agg3nY4pVcnQyCjHz80ejuKstH/iNIka3/QdfZaGlpaWlpaWlpaWlpaWlpaWlpaWlpaWlpaWlpaWlpaWlpaWlpaWlpaWlpaWlpaWlpaWlpaWl/v7aN13H/37c/f/z4+9b2/bYff367vn/w68/+88u/7mjXL18XODKDlpaWlpaWlpaWlpb2JdrjGrLdv3Z5WPHcFMMCw06vq/Trp1ftgkFLS0tLS0tLS0tLS7u9tqx+U1x/O37+eYv/Upw4hJzTe4dPC56WlpaWlpaWlpaWlval2vKV4x4xnjlOvG534LWAP8rytLS0tLS0tLS0tLS0tDfAWeohr8m+VLbZSmHmNRatiz69NFpaWlpaWlpaWlpa2hdoEz5l6K7POUINZS/pwenBuultX64RpaWlpaWlpaWlpaWl/dO16zX/sx//oqcKLS0tLS0tLS0tLS3tn6xdXyWo7LOjc8Nv6TTcrTfJkCNcXLS0tLS0tLS0tLS0tLtrU13lWfJ3w/G3KzmFobVfSSnlvHWPLI88aGlpaWlpaWlpaWlpX6O9ua9R36q9Y4kOp7x+33MvslTU+UnMS0tLS0tLS0tLS0tLu4t22tlx0m5k2pQ/D1UbDtadoanJpGElLS0tLS0tLS0tLS3tK7Q5/hsCvrZIzl0j0LOcqUvRZglcz4WblpaWlpaWlpaWlpZ2f21as85Jy1WSLe8l/cjb7WWQwENPFVpaWlpaWlpaWlpa2v20Na4b/pfTdJPnlMYjdSpb6k2SlqelpaWlpaWlpaWlpX2JNs2qTu7pYyedIqdNIhfNJJ+rLmlpaWlpaWlpaWlpaXfTpoBvGicucnq1hjKffGuzAQFtHobS0tLS0tLS0tLS0tLurB1Or5X7p/WXfTZZra5Xkoe1CcowQ+ChSwktLS0tLS0tLS0tLe1G2pJM6/eV2r3xSMsdJa+84x6VnvcAclJm+WHVJS0tLS0tLS0tLS0t7X7aHM2t83KpwrKWY5YoMo0PaLlr5XOXElpaWlpaWlpaWlpa2l20w7PLubihXeQRkoItn6TLBZwr3ic1orS0tLS0tLS0tLS0tLtpS/7uKLemKDL3F5lEgqn+sjzjKzWitLS0tLS0tLS0tLS0G2lLIu7MA7DLhOrJ4bg0d620i+xlKHY+OkdLS0tLS0tLS0tLS/sCbSmLPMJxteHU3BnqKlf4FIGWB9XXR0tLS0tLS0tLS0tL+xLtUUK6aZg3XOXk21FqN4dNpkg1PW0eRdLS0tLS0tLS0tLS0m6pLcZjUTQ5PPGjWWz1TF3a6SyopKWlpaWlpaWlpaWl3VlbHtszPlP6PWKsI9eK5yzH38qen2pEaWlpaWlpaWlpaWlpt9Km3iS5LUm7H2troVXJLX9XVpkkFKd1n7S0tLS0tLS0tLS0tC/Rtrxw0uZ03qTfZFmql/xd2kuJaGlpaWlpaWlpaWlpaffWJnIOKofzbimdV79XQsSWyyzTArS0tLS0tLS0tLS0tK/THqEE8pwp6oG5Yanp//LT+mczu2lpaWlpaWlpaWlpaffTnovQb5H7O4LieC6pbM9x5zKKpKWlpaWlpaWlpaWl3VKbB63dPi2H3lILkn5vz3+GKWrpnN0Xo0haWlpaWlpaWlpaWtqttLn68Qgj0vqikclwb9rz0NIkLfUcRdLS0tLS0tLS0tLS0u6nTXFi5k1GrqWQM4WD5XBczzWeH8a8tLS0tLS0tLS0tLS0+2h7iRiHPiTlERWVo8gjJ+yG3U9LL2lpaWlpaWlpaWlpaV+hLWfWUly3gg45wuv3esnzfVTZeY7vi5aWlpaWlpaWlpaWdmdtSuxdw8FhqNrQZCTtKk1gSzut/0u9JWlpaWlpaWlpaWlpaXfXLuoge+goOQ34ztbS2bYSVKaotC/mYdPS0tLS0tLS0tLS0u6uTUWTJUTsuVF/LpUc9jJ0PenlJF3JLz5l92hpaWlpaWlpaWlpabfSpjrIEv+dT0WTeYJ2rewsib360mhpaWlpaWlpaWlpaV+mTXWVTzFhK0WYZWupTvPIsn9WI0pLS0tLS0tLS0tLS7uLdhr/XaO+dGDuCDFmm3fmf8SnEk1aWlpaWlpaWlpaWtoXaEsA2RYRY9pBCv2GVfr9mhZwpndIS0tLS0tLS0tLS0u7u3YRDq4ekXaw2O6Kd909LS0tLS0tLS0tLS3ta7UD6pjVRh73bFydmz14cvLwDOnBYRgALS0tLS0tLS0tLS3tW7RTynAk7ikcPJepwBoslrnZ/f6COi0tLS0tLS0tLS0t7Uu0w4cp6lscmEtTsHOGrqXbyl6es3u0tLS0tLS0tLS0tLT7aSdPTOfT0ti01G6kRIwtfDD58iczCGhpaWlpaWlpaWlpabfSthIn5gb8PRdclhrKX6u0WZ3mcf3K8KCS9qOlpaWlpaWlpaWlpd1bO9w/5S0ScekRtZ4zHbsrJZ/9umdaWlpaWlpaWlpaWtqXaPvy9FpfNB6Z1mRO03nlLdXzc8uqS1paWlpaWlpaWlpa2v201xtSR5JUelnbjaTKyfxGjjA04OkkHS0tLS0tLS0tLS0t7Qu0bTGN+vqVyZm1YX9PAWQvg7K/FkXS0tLS0tLS0tLS0tJupE3X9DTcFLXoXDJsfN2csrUWajdpaWlpaWlpaWlpaWl31pYoroaNQ4SXdpXwOe3XS4OS1LTkOealpaWlpaWlpaWlpaXdR/uYzptm3p46/admkq3FFikfR5G0tLS0tLS0tLS0tLRbanPCLtVaplRgC5WTdZTadCpbDmEPWlpaWlpaWlpaWlraV2trG/+SjauPWESWRxm3Pc0MPmf3aGlpaWlpaWlpaWlpX6CtJ9oWg617Sc6V2PEs89nyGO0eJwfQ0tLS0tLS0tLS0tJury2o4RF1FPZASZnBReP/YeXbq3qOImlpaWlpaWlpaWlpaTfT1sLHFPXlELHlw2yLrQ1v6bzvoC5KS0tLS0tLS0tLS0u7u/b/f9HS0tLS0tLS0tLS0tLS0tLS0tLS0tLS0tLS0tLS0tLS0tLS0tLS0tLS0tLS0tLS0tLS0tLS/jbtX2Pf+2+J1zMMAAAAAElFTkSuQmCC",
    "expirationDate": "2022-08-13T12:28:09.695-04:00"
  },
  "beneficiary": null,
  "merchant": {
    "type": "COMPANY",
    "name": "Company",
    "document": {
      "id": "",
      "type": ""
    },
    "email": "",
    "phone": {
      "countryCode": "",
      "areaCode": "",
      "number": ""
    },
    "address": {
      "street": "",
      "number": "",
      "city": "",
      "state": "",
      "country": "",
      "zipCode": "",
      "comment": "Any relevant information related to the transaction"
    },
    "birthdate": "",
    "nationality": ""
  },
  "payer": {
    "type": "INDIVIDUAL",
    "name": "John",
    "lastname": "Doe",
    "document": {
      "id": "75.518.609/0001-56",
      "type": "CNPJ"
    },
    "email": "",
    "phone": {
      "countryCode": "",
      "areaCode": "",
      "number": ""
    },
    "address": {
      "street": "",
      "number": "",
      "city": "",
      "state": "",
      "country": "",
      "zipCode": ""
    },
    "birthdate": "",
    "nationality": ""
  },
  "intermediaries": null,
  "wireInstructions": null,
  "date": {
    "creationDate": "2025-02-19T20:57:50.253+00:00",
    "processedDate": "2025-02-19T20:57:50.507088",
    "expirationDate": "2025-02-21T20:57:50.507088"
  },
  "card": null,
  "errors": []
} 
```

```json Copia e Cola theme={"theme":{"light":"github-light-high-contrast","dark":"github-dark-high-contrast"}}
{
    "transactionType": "PayIn",
    "externalId": "18c12cfb-a4ea-c0bd-983b-51ac394a7439",
    "internalId": "8d9c5ae3-929d-105b-c59d-1c59e3096688",
    "paymentMethod": {
        "type": "BankTransfer",
        "code": "1314",
        "flow": "DIRECT"
    },
    "country": "BRA",
    "currency": "BRL",
    "amount": 1000.0,
    "accountNumber": "{{accountNumber}}",
    "confirmed": {
        "currency": "BRL",
        "amount": 1000.0,
        "fxQuote": 1.0
    },
    "payment": {
        "currency": "BRL",
        "fxQuote": 1.0,
        "financingFee": 0.0,
        "amount": 1000.0
    },
    "localTaxes": [
        {
            "code": "0028",
            "percentage": 3.5,
            "description": "NUEVO IOF",
            "currency": "BRL",
            "fxSource": 5.388318,
            "fxQuote": 0.0,
            "amount": 35.0,
            "account": "{{accountNumber}}"
        }
    ],
    "withHoldings": [],
    "fees": {
        "description": "Fee",
        "currency": "BRL",
        "fxSource": 5.388318,
        "fxQuote": 1.0,
        "amount": 0.0,
        "account": "{{accountNumber}}"
    },
    "status": {
        "code": "100",
        "description": "INPROGRESS",
        "detail": "The payin is pending the confirmation"
    },
    "qr": {
        "image": "https://api.stage.localpayment.com/api/images/QR/00020101021226880014br.gov.bcb.pix2566qrcode-h.fitbank.com.br%2FQR%2Fcob%2FC5F29B1D537A2040C62359BA425F7D5B09B5204000053039865802BR5912Localpayment6008CAMPINAS61081310582262070503%2A%2A%2A630475C7",
        "code": "00020101021226880014br.gov.bcb.pix2566qrcode-h.fitbank.com.br/QR/cob/C5F29B1D537A2040C62359BA425F7D5B09B5204000053039865802BR5912Localpayment6008CAMPINAS61081310582262070503***630475C7",
        "codeBase64": "iVBORw0KGgoAAAANSUhEUgAAAMgAAADIAQAAAACFI5MzAAAC4klEQVR4Xu2XMc7bMAyFaWjQZl9AgK6hTVdyLuDYF4ivpE3XMKAL2JsGwexjij9Oi3aIBBQdfiFIYn1B6JDU4wvx3xb9vvFa3+SbyPqXJFCXC3l1+nJjXiORbiCRj8CzVrNTD1dGbbHTQOiWt9Hx6WgI9tSmayRhI0/3YBfeet9Msj09z2TIl4EbCR8xsQRBUk3Hv2TnY4L6RHO7Hr9U7mOCldPC9mCLKu3+51YtCTTSdo94tqcr95AeAmtJNpOzs+M1IBnb5O36lYMaEjbEmXS5RfUg02V0ZQPJKAgN8ma7B3Vq6lsIq5kSYBft7rZR895CgplIsoimvmVcm943ELZLNkNQKz7i1e54+cpoDcnmHkwvYqCOqFamoYUEfDd6x0Jjdo++tkcLyfah0Ttp19vopXeuTqwgEXuli+mIuHe7hPTqxBrC6fQ0+jLpbYCguisHNSQkXEH5iNLpkIO33qkg2SKpeH3oQsQPr96y8zmJG5GCtOxEkza3cN11DZGjRkNGX6sD0qJLE+GCidH755nzpteShgZi7ngrcUBEZq44FSSjMpg/ZSTqibqATDSQ5zmDBiwyOnjNfNWngiCOL9B4aPPpZeSOb3fwOSk9ld49vYmIlp1fcSqIFFmm0IThw+bdodQQDAoHI4CDq3BiDkhpG5k9dFTKsuMc++3q+ArCdsV4hETphF9/vmlVDYl2pkIOMB3BkDbXHVQQ5hNjltPuCA2+ZF5lr5aISdw6eAovskf6rXcqSOCTYCswxCDJCHLloIbARHhCRjG9V5YcvHxiFYGIliHbNdhd0x05aCHBHhmeAjpqH26biPAPoJ5gRVQ7iU/0Uqu3an9OICpIqlcLDOwzBy+tqiHw15AEBxsrXhga//JiVYRuUbQKaopmhJq+eqeSYOw4PhDH4xK2opGg+3DUEnRr95ZlVRPYavwjQRycYIjf5a9riNRHPOwQ4KHEeF5uo4L8eX2TbyLrfyY/AFFaGvzwyar/AAAAAElFTkSuQmCC",
        "expirationDate": "2026-01-15T23:59:59",
        "paymentInstructions": "<div><b>Two ways to pay:</b></div><div><ul><li>Scan the QR code:</li></ul></div><div>Open your bank app → Scan → Pay</div><div>-OR-</div><div><ul><li>Copy &amp; paste (“Copia e Cola”)</li></ul></div><div>Copy “Copia e Cola” ID→ Open your bank app → Paste → Pay</div>"
    },
    "merchant": {
        "type": "COMPANY",
        "name": "Merchant",
        "document": {
            "type": "CNPJ",
            "id": "34669130000133"
        },
        "email": "info@email.com"
    },
    "payer": {
        "bank": {
            "name": "Bank name",
            "code": "341",
            "branch": {
                "code": "0004",
                "name": "Santander"
            },
            "account": {
                "type": "s",
                "number": "000000000"
            }
        },
        "type": "COMPANY",
        "name": "Payer Name",
        "lastname": "BRASIL",
        "document": {
            "type": "CNPJ",
            "id": "34669131234567"
        },
        "email": "user@example.com"
    },
    "intermediaries": [],
    "date": {
        "creationDate": "2026-01-08T15:01:33.44+00:00",
        "processedDate": "2026-01-08T15:01:37.6484808",
        "expirationDate": "2026-01-15T23:59:59"
    },
    "paymentInstructions": "<div><b>Two ways to pay:</b></div><div><ul><li>Scan the QR code:</li></ul></div><div>Open your bank app → Scan → Pay</div><div>-OR-</div><div><ul><li>Copy &amp; paste (“Copia e Cola”)</li></ul></div><div>Copy “Copia e Cola” ID→ Open your bank app → Paste → Pay</div>",
    "errors": []
}
```

### Campos de resposta principais

| Parâmetro | Descrição | Caso de uso |
| - | - | - |
| `qr.image` | Imagem PNG do código QR codificada em Base64. | Exibição direta sem geração adicional. |
| `qr.code` | Carga útil Raw Pix no padrão EMVCo. | Essa sequência pode ser exibida como um código QR ou apresentada como um código de texto para o cliente copiar e colar em seu aplicativo bancário (Copia e Cola). |
| `qr.codeBase64` | Carga útil alternativa de QR Code codificada em base64. | Backup para renderização personalizada de QR Code. |
| `qr.expirationDate` | Registro de data e hora em que o QR Code se torna inválido. | Exibir cronômetro de contagem regressiva e lidar com a lógica de expiração. |
| `externalId` | Seu número de referência original. | Conciliação interna e correspondência de pedidos. |
| `status.code` | Estado atual da transação (`100` = `INPROGRESS`) | Determine os próximos passos no fluxo de pagamento. |
| `date.creationDate` | Quando a transação foi criada. | Análise e monitoramento de desempenho. |

#### Resposta de erro

Quando a geração do Pix falhar para o Brasil, você receberá informações de erro específicas:

```json theme={"theme":{"light":"github-light-high-contrast","dark":"github-dark-high-contrast"}}
{
  "externalId": "ce0aaa1a-4532-43b9-930a-26e780aba99b",
  "status": {
    "code": "812",
    "description": "REJECTED"
  },
  "errors": [
    {
      "code": "812",
      "detail": "External Id already used - duplication"
    }
  ]
}
```

***

## Etapa 3. Apresente o pagamento Pix

Você pode apresentar o pagamento Pix ao seu cliente de duas maneiras. A resposta da API fornece os dados necessários para ambas.

### Opção A: Exibir como um código QR

1. **Renderize o código QR:** Use a sequência do campo `qr.code` na resposta da API para gerar uma imagem de código QR que possa ser escaneada, usando qualquer biblioteca de QR Code.
2. **Escaneamento pelo cliente:** O cliente escaneia o código QR com o aplicativo do banco.
3. **Autorizar:** O cliente confirma os detalhes do pagamento e autoriza a transferência dentro do aplicativo.
4. **Confirmação em tempo real**: o Localpayment recebe notificação de pagamento instantaneamente.
5. **Atualização de status**: Seu sistema recebeu um webhook com a confirmação de pagamento.

![](https://mintcdn.com/localpayment-1fee3d41/thasGykLOKju8tM0/images/docs/394b3fdfbeba2cbacc7141ef18cf19061ddf9e2eefee79d1502da0f5c88e50a8-qr-bra.png?fit=max\&auto=format\&n=thasGykLOKju8tM0\&q=85\&s=eb4f15fb05d974faad84ea221108773d)

#### Melhores práticas para exibição de QR Code

* Tamanho mínimo de exibição: 250x250 pixels para digitalização em dispositivos móveis.
* Mantenha a proporção de 1:1 sem distorção.
* Garanta alto contraste (escuro sobre fundo claro).
* Adicione uma zona de silêncio (borda branca) ao redor do código QR.
* Inclua um texto alternativo (ex.: "Pagamento por código QR").
* Exibir instruções de pagamento claras.
* Gerenciar o tempo de vida (TTL) e a expiração.

### Opção B: Exibir como um código para copiar e colar (Copia e Cola)

1. **Apresente o código:** Exiba a sequência completa do campo `qr.code` ao seu cliente como texto selecionável.
2. **O cliente copia e cola o código:** o cliente copia todo o código e abre o aplicativo do banco ou da carteira digital.
3. **Colar e pagar:** O cliente cola o código no campo "Pagar com código Pix" ou similar do aplicativo para carregar os detalhes do pagamento.
4. **Autorizar:** O cliente analisa e autoriza a transferência.
5. **Confirmação em tempo real**: o Localpayment recebe notificação de pagamento instantaneamente.
6. **Atualização de status**: Seu sistema recebeu um webhook com a confirmação de pagamento.

![](https://mintcdn.com/localpayment-1fee3d41/oFZuSE0fcOk5ECyA/images/docs/ea6d8e8edff3b9c964eeeb700f2ed6cdcbf8c9354f5f6cf375304cc02bb5e0f0-pix-copia-e-cola.png?fit=max\&auto=format\&n=oFZuSE0fcOk5ECyA\&q=85\&s=dbc93d945dba5d5dbbc37fede1827bcb)

***

## Etapa 4. Acompanhe o status da transação

Acompanhe o progresso dos pagamentos da Pix por meio destes métodos:

> [card] [Webhooks (Recomendado)](https://docs.localpayment.com/pt-br/docs/webhooks.md)
>
> Receba notificações em tempo real quando o status da transação mudar. Ideal para ambientes de produção.

> [card] [Endpoint da API de Status](https://docs.localpayment.com/pt-br/reference/get-transaction-status.md)
>
> Consultar o status da transação programaticamente. Útil para consultar ou recuperar notificações de webhook perdidas.

> [card] [Visualização do Business Portal](https://docs.localpayment.com/pt-br/docs/dashboard-overview.md)
>
> Interface visual para monitoramento de transações. Ideal para supervisão manual e análise detalhada de transações.

### Códigos de status comuns

A API Localpayment fornece vários códigos de status para indicar o progresso e o resultado do pagamento na resposta.

| Código | Status | Descrição |
| :- | :- | :- |
| `103` | `APPROVED` | O Payin foi confirmado, mas ainda não foi creditado. |
| `200` | `Completed` | O Payin foi concluído. |
| `811` | `Rejected` | O valor solicitado é maior ou menor que os valores máximo/mínimo permitidos. |

> [!NOTE]
>
> **Referência completa**
>
> Consulte todos os códigos de status em nossa [Documentação de Status da Transação](https://docs.localpayment.com/pt-br/reference/transaction-status-error-codes).

***

## Testando sua integração

### Ambiente de Sandbox

Utilize o ambiente de teste para realizar os procedimentos:

```
https://api.stage.localpayment.com/api/payin/
```

### Cenários de teste de QR Code

Verifique se sua integração lida com esses cenários:

1. **Pagamento efetuado com sucesso**: Conclua o pagamento da Pix com liquidação instantânea.
2. **Validade do QR Code**: Lide com pagamentos Pix expirados de forma adequada.
3. **Múltiplas tentativas de pagamento**: o mesmo código QR foi lido várias vezes.
4. **Atualizações de status**: gerenciamento de webhooks e consulta de status.

***

## Próximos passos

Após implementar os pagamentos Pix, considere estas funcionalidades adicionais:

> [card] [Reembolsar a transação](https://docs.localpayment.com/pt-br/docs/refund-apm-payment.md)
>
> Caso necessário, você pode reembolsar o pagamento ao cliente. Consulte a documentação para obter detalhes.

> [card] [Analisar detalhes da transação](https://docs.localpayment.com/pt-br/reference/get-transaction-status.md)
>
> Você pode obter informações detalhadas sobre as transações usando a API Localpayment.


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.