Pagamento PIX por Chave PIX
Este endpoint permite realizar um pagamento PIX via Chave. O fluxo completo envolve duas etapas:
- Consulta da Chave: obter dados do recebedor e valor.
- Realização do pagamento: enviar endToEndId da transação e valor.
As requisições deve ser enviadas conforme os exemplos abaixo.
1. Consulta de Chave PIX
Endpoint: POST https://api.intrapay.io/api/financial/v1/pix/dict/consult
Exemplo JSON de Request
{
"key": "[email protected]"
}
- key: Chave PIX do recebedor. Obrigatório.
Exemplo JSON de Response
{
"key": "123e4567-e89b-12d3-a456-426614174000",
"keyType": "EVP",
"endtoEndId": "E12345678920251024000123456789",
"account": {
"participant": "12345678",
"accountType": "CACC",
"branch": "0001",
"account": "1234567-8"
},
"owner": {
"name": "Maria Souza",
"type": "NATURAL_PERSON",
"tradeName": "Maria Confeitaria",
"documentNumber": "12345678909"
}
}
- key: Chave PIX consultada.
- keyType: Tipo da chave (
EVP,CNPJ,CPF,PHONE,EMAIL). - endtoEndId: Identificador ponta a ponta da transação.
- account: Dados da conta do recebedor.
- participant: Código do participante (banco).
- accountType: Tipo da conta.
- branch: Agência da conta.
- account: Número da conta do recebedor.
- owner: Dados do titular da chave.
- name: Nome do titular.
- type: Tipo do titular (
NATURAL_PERSON,LEGAL_PERSON). - tradeName: Nome fantasia (se aplicável).
- documentNumber: Número do documento (CPF/CNPJ) do titular.
2. Realização do Pagamento PIX
Endpoint: POST https://api.intrapay.io/api/financial/v1/pix-cash-out/transfer
Exemplo JSON de Request
{
"endToEndId": "E12345678920251024000123456789",
"amount": 25.0
}
- 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": 25.0,
"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 | Chave PIX não encontrada |
| 422 | Valor do pagamento inválido |
| 500 | Erro interno do servidor |