Pagamento PIX por QR Code (EMV)
Este endpoint permite realizar um pagamento PIX via QR Code / Copia e Cola (EMV). O fluxo completo envolve duas etapas:
- Consulta do código EMV: obter dados do recebedor e valor.
- Realização do pagamento: enviar a transação PIX com o código EMV e valor.
As requisições deve ser enviadas conforme os exemplos abaixo.
1. Consulta do Código EMV
Endpoint: POST https://api.intrapay.io/api/financial/v1/pix/emv/consult
Exemplo JSON de Request
{
"emv": "00020126580014br.gov.bcb.pix01361234567890123456789052040000530398654052500"
}
- emv: Código EMV (QR Code / Copia e Cola). Obrigatório.
Exemplo JSON de Response
{
"type": "STATIC_QRCODE",
"endToEndId": "E20018120145123456789",
"payerQuestion": "Pergunta ao pagador",
"additionalInfo": [
{
"key": "Info1",
"value": "Valor 1"
}
],
"amount": {
"original": 10000,
"final": 10000,
"abatement": 4,
"discount": 2,
"interest": 1,
"fine": 0,
"canModifyFinalAmount": true
},
"receiver": {
"name": "João da Silva",
"participant": "12345678",
"documentNumber": "***.789.123-**"
},
"debtor": {
"name": "Maria de Souza",
"documentNumber": "***.789.123-**"
},
"calendar": {
"expirationDate": "2024-12-31T23:59:59Z"
}
}
- type: Tipo do código EMV (
STATIC_QRCODEouDYNAMIC_QRCODE). - payerQuestion: Pergunta opcional para o pagador.
- additionalInfo: Informações adicionais presentes no código EMV.
- key: Chave da informação adicional.
- value: Valor da informação adicional.
- endToEndId: Identificador ponta a ponta para realizar a transação.
- amount: Detalhes do valor do pagamento.
- original: Valor original da cobrança.
- final: Valor final após ajustes.
- abatement: Valor de abatimento.
- discount: Valor de desconto.
- interest: Valor de juros.
- fine: Valor de multa.
- canModifyFinalAmount: Indica se o valor final pode ser modificado (No caso de QR Codes estáticos será obrigatório informar o valor na etapa de pagamento).
- receiver: Dados do recebedor.
- name: Nome do recebedor.
- participant: Código do participante (ISP) do recebedor.
- documentNumber: Documento do recebedor (mascarado).
- debtor: Dados do pagador (se informado no QR Code).
- name: Nome do pagador.
- documentNumber: Documento do pagador (mascarado).
- calendar: Informações de validade do código EMV.
- expirationDate: Data e hora de expiração do código EMV.
warning
Se o pagamento for uma cobrança estática e o campo canModifyFinalAmount estiver true, será obrigatório informar o valor do pagamento na etapa de envio da transação.
2. Realização do Pagamento PIX
Endpoint: POST https://api.intrapay.io/api/financial/v1/pix-cash-out/transfer
Exemplo JSON de Request
{
"endToEndId": "00020126580014br.gov.bcb.pix01361234567890123456789052040000530398654052500",
"amount": 2500
}
- endToEndId: Identificador ponta a ponta da transação. Obrigatório.
- amount: Valor do pagamento (ex.: R$ 25,00).
Exemplo JSON de Response
{
"id": "e6be76d5-5144-4c94-b1de-b8806be86fce",
"endToEndId": "E200181201451234567894356789",
"amount": 2500,
"fee": 5,
"status": "PENDING"
}
Tabela de Erros
| Código | Erro |
|---|---|
| 400 | end to end id inválido |
| 400 | ocorreu um erro ao transferir |
| 400 | O valor da transfêrencia é obrigatório |
| 400 | O valor da transfêrencia não pode ser alterado |
| 400 | Não é possivel enviar descrição em pagamentos de qr code |
| 404 | Código EMV não encontrado |
| 422 | Valor do pagamento inválido |
| 500 | Erro interno do servidor |