PIX out

Introdução

O envio de PIX para contas de pagamentos instantâneos pode ser realizado através da consulta de um QR Code emitido pela conta destino ou para uma chave PIX da conta destino.

Todo envio de PIX ocorre de maneira síncrona

---

Envio de PIX via QR Code / Copia e cola

Para envio de PIX utilizando um QR Code emitido pela conta destino é necessário consultar o código hash EMV do QR Code e confirmar a transferência.

Consulta de código EMV

A consulta do código hash EMV é realizada através do método POST /pix/brcode/emv.

Exemplo de consulta de código hash EMV:

{
    "emv": "00020126330014BR.GOV.BCB.PIX011111361429917520400005303986540510.005802BR5918Xxxxxxxx xxx xxxxx6009SAO PAULO610805409000622405201DaXOOPpAAfVV7P5ummx6304A4F3"
}

Exemplo de retorno:

{
    "allow_value_change": false,
    "fine": "0",
    "interest": "0",
    "discount": "0",
    "deduction": "0",
    "final_amount": "1000.00",
    "original_amount": "1000.00",
    "status": "",
    "revision": 0,
    "qrcode_type": "Static",
    "tx_id": "xxxxxxxxx",
    "message": null,
    "url": "",
    "beneficiary": {
        "name": "",
        "trade_name": "",
        "tax_id": "",
        "dict_key": "xxxxxxxx",
        "ispb": "",
        "branch": "xxxxxx",
        "account_number": "xxxxxxx",
        "account_type": ""
    },
    "expiration": null,
    "due_date": null,
    "payer": {
        "name": "",
        "tax_id": ""
    },
    "additional_infos": []
}

Confirmação de transferência

Para confirmar a transferência o usuário deve utilizar o método POST /pix/out e informar os campos:

Campo	Tipo	Descrição
emv	string	Hash EMV informado na consulta de QR Code
amount	string	Valor e o ponto flutuante
type	string	Tipo de transferência PIX. Deve conter a expressão "emv" para indicar a leitura de um QR Code / Copia e Cola
description	string	Campo opcional para uso do usuário e sua comunicação com o destinatário

Exemplo de confirmação de transferência:

{
    "emv": "00020126330014BR.GOV.BCB.PIX011111361429917520400005303986540510.005802BR5918Xxxxxxxx xxx xxxxx6009SAO PAULO610805409000622405201DaXOOPpAAfVV7P5ummx6304A4F3",
    "amount": "1000.00",
    "type": "emv",
    "description": "Hello"
}

Exemplo de resposta:

// Some code

---

Envio de PIX para chave PIX

Para envio de PIX para uma chave PIX o usuário deve consultar uma chave PIX e posteriormente confirmar a transação utilizando a chave consultada.

Consulta de chave PIX

Para consulta de chave PIX o usuário deve utilizar o método POST /pix/key informando a chave da conta destino. A chave pode ser dos tipos e-mail, telefone, CPF/CNPJ e EVP.

O telefone consultado deve conter o valor completo com código de país, por exemplo "[phone]"

O documento consultado CPF/CNPJ não deve conter qualquer formatação, apenas números como "99999999999"

Exemplo de consulta de chave PIX:

{
    "dict_key": "xxxxxxxxxx"
}

Exemplo de resposta:

{
	"id": "",
	"initiation_id": "93e88672-f0db-411e-8d92-881cfce19f0c",
	"dict_key": "xxxxxxxxxxxx",
	"dict_key_type": "CPF",
	"owner_document": "***.xxx.xxx-**",
	"owner_name": "xxxxxx xxx xxx",
	"owner_trade_name": "",
	"owner_type": "NATURAL_PERSON",
	"ispb": "",
	"branch": "1",
	"account_number": "xxxxxxxx",
	"account_type": "TRAN"
}

Confirmação de transferência

Para confirmar a transferência o usuário deve utilizar o método POST /pix/out e informar os campos:

Campo	Tipo	Descrição
initiation_id	string	Hash gerada na consulta da chave PIX
dict_key	string	Chave PIX consultada anteriormente
amount	string	Valor e o ponto flutuante
type	string	Tipo de transferência PIX. Deve conter a expressão "dict" para indicar o envio para uma chave
description	string	Campo opcional para uso do usuário e sua comunicação com o destinatário

Exemplo de confirmação de transferência:

{
    "initiation_id": ""93e88672-f0db-411e-8d92-881cfce19f0c",
    "dict_key": "xxxxxxxxxxxx",
    "amount": "1000.00",
    "type": "dict",
    "description": "Hello"
}

Exemplo de resposta: