Pix

Consultar chave no DICT

Mostra o titular de uma chave Pix antes do envio, para você confirmar para quem o dinheiro vai. Não movimenta saldo. Exige credencial com permissão de Pix. O accountId é o accPixOut da carteira de origem (GET /resource/wallets/{walletId}).

POSThttps://api.monkeypay.app/api/v2/payment/pix/dictBearer

Fluxo

Antes de chamar

  1. Chamada

    POSTEmitir token bearer

    /resource/auth/token

    Authorization: Bearer <seu-token>

  2. Chamada

    GETConsultar carteira

    /resource/wallets/{walletId}

    O accPixOut da carteira vai em accountId

Esta chamada

POSTConsultar chave no DICT

/payment/pix/dict

Respostas possíveis

Depois do sucesso

  1. Chamada

    POSTEnviar Pix

    /payment/pix/send

    Envie depois de aprovar o titular

Autorização

BearerRequer autenticação Bearer

Parâmetros

x-customer-idstringcabeçalhoopcional

Opcional. A versão atual da API não lê nem grava este header: a organização é sempre deduzida do token bearer. Enviá-lo não altera o resultado da chamada.

<x-customer-id>

Body

accountIdstringobrigatório

Conta de saída da carteira que fará o pagamento: use o campo `accPixOut` de GET /resource/wallets/{walletId}. Não é o `walletId`.

Tamanho1 ≤ tamanho
acc_01J9Z8K3M4N5P6Q7R8S9T0V1W2
pixKeystringobrigatório
Tamanho1 ≤ tamanho
[email protected]

Respostas

1{
2 "error": null,
3 "success": true,
4 "message": "Dict fetched successfully",
5 "data": {
6 "key": "[email protected]",
7 "keyType": "email",
8 "account": {
9 "ispb": "12345678",
10 "issuer": "0001",
11 "number": "123456"
12 },
13 "owner": {
14 "type": "NATURAL_PERSON",
15 "taxIdNumber": "12345678909",
16 "name": "Maria da Silva"
17 }
18 }
19}

Campos da resposta

errorobjectopcional

`null` no sucesso; mensagem de falha quando `success` é `false`.

<error>
successbooleanopcional
<success>
messagestringopcional
<message>
dataobjectopcional
<data>
keystringopcional
<key>
keyTypestringopcional

valores: cpfcnpjemailphonerandom

<keyType>
accountobjectopcional
<account>
ispbstringopcional
<ispb>
issuerstringopcional
<issuer>
numberstringopcional
<number>
accountTypestringopcional
<accountType>
ownerobjectopcional
<owner>
typestringopcional

valores: NATURAL_PERSONLEGAL_PERSON

<type>
taxIdNumberstringopcional
<taxIdNumber>
namestringopcional
<name>
Credenciais

Requisição

1curl --request POST \
2 --url 'https://api.monkeypay.app/api/v2/payment/pix/dict' \
3 --header 'Content-Type: application/json' \
4 --header 'Authorization: Bearer <seu-token>' \
5 --data '{
6 "accountId": "acc_01J9Z8K3M4N5P6Q7R8S9T0V1W2",
7 "pixKey": "[email protected]"
8 }'

Resposta

1{
2 "error": null,
3 "success": true,
4 "message": "Dict fetched successfully",
5 "data": {
6 "key": "[email protected]",
7 "keyType": "email",
8 "account": {
9 "ispb": "12345678",
10 "issuer": "0001",
11 "number": "123456"
12 },
13 "owner": {
14 "type": "NATURAL_PERSON",
15 "taxIdNumber": "12345678909",
16 "name": "Maria da Silva"
17 }
18 }
19}