Pagamentos
Por chave
Iniciar pagamento Pix consultando a chave no DICT
Consulta a chave Pix no DICT, valida se a transação pode ser local (mesmo ISPB) e persiste o pagamento com status INICIADO (status: "0").
Endpoint
POST /api/v2/pix/pagamentos/chave
Scope: pix.write
Headers
| Header | Obrigatório | Descrição |
|---|---|---|
Authorization | Sim | Bearer {{access_token}} |
Accept | Sim | application/json |
Content-Type | Sim | application/json |
Body
{
"chave": "efca2b48-0d8a-4f10-9f07-26e6b5a1b921",
"txid": "qykhwjRKogXV28MnPcQTmC36iO",
"uuid": "794d7b9e-1a42-4a12-93c2-b48c0d63f730"
}
| Campo | Obrigatório | Descrição |
|---|---|---|
chave | Sim | Chave Pix do recebedor (e-mail, telefone, CPF/CNPJ ou EVP) |
txid | Não | Se omitido, gerado automaticamente (~26 caracteres) |
uuid | Não | UUID externo opcional para o pagamento |
Retorno (200)
Mesmo schema descrito em Visão geral. Características desta rota:
| Campo | Valor típico |
|---|---|
endToEndId | Sim — vem da consulta DICT |
chave | Sim — chave consultada |
valor | 0 — valor definido na confirmação |
tipo | 1 (dict) |
rec_status | null |
Exemplo de resposta
{
"id": "794d7b9e-1a42-4a12-93c2-b48c0d63f730",
"endToEndId": "E382973742026070812519TFXDFWFD11",
"chave": "efca2b48-0d8a-4f10-9f07-26e6b5a1b921",
"valor": 0,
"txid": "qykhwjRKogXV28MnPcQTmC36iO",
"status": "0",
"tipo": 1,
"id_req": null,
"recebedor": {
"pessoa": {
"nome": "Maria Souza Exemplo",
"cpfCnpj": "52998224725",
"tipo": 0
},
"conta": {
"ispb": "38297374",
"agencia": "0001",
"conta": "00001234",
"dataAbertura": "2025-06-18T11:21:45.000000Z",
"tipo": 0
}
},
"pagador": {
"pessoa": {
"nome": "João Silva Exemplo",
"cpfCnpj": "39053344705",
"tipo": 0
},
"conta": {
"ispb": "38297374",
"agencia": "0001",
"conta": "00005678",
"dataAbertura": "2026-06-26T20:06:56.000000Z",
"tipo": 0
}
},
"dataHoraAtualizacao": "2026-07-08T12:51:31.000000Z",
"dataHoraCriacao": "2026-07-08T12:51:31.000000Z",
"tipo_transacao": -1,
"rec_status": null
}
Exemplo cURL
curl --location 'https://api-h.nuvende.com.br/api/v2/pix/pagamentos/chave' \
--header 'Accept: application/json' \
--header 'Authorization: Bearer {{access_token}}' \
--header 'Content-Type: application/json' \
--data '{
"chave": "{{chave_pix_recebedor}}",
"txid": ""
}'
Erros
| HTTP | Situação |
|---|---|
| 403 | Conta pagadora = recebedora (bloqueio de transação local na iniciação) |
| 4xx | Falha DICT / validação |
Próximo passo
Use o id retornado em Confirmar pagamento com o valor desejado.