Iniciar um pagamento por chave Pix.

POST

/pix/payments/dict

Pix

Este endpoint permite solicitar uma ordem de pagamento Pix (cash-out) usando qualquer um dos tipos permitidos de chave Pix: CPF, CNPJ, endereço de e-mail, número de telefone, EVP (chave aleatória).

Requisição

Authorization

OAuth 2.0

Client Credentials

Adicionar o parâmetro

Authorization

a Cabeçalhos, cujo valor é concatenar o Token após o Bearer.

Exemplo:

Authorization: Bearer ********************

Token URL: /oauth/token

Scopes:

pix.write-Access to make cashout Pix

Parâmetros Header

Parâmetros Bodyapplication/jsonNecessário

Examples

Respostas

🟢202

application/json

Aceito

Bodyapplication/json

🟠400

🟠401

🟠403

🟠412

🟠422

🟠429

🔴500

🔴503

🔴504

Request Example

Shell

JavaScript

Java

Swift

curl --location '/pix/payments/dict' \
--header 'x-idempotency-key;' \
--header 'Content-Type: application/json' \
--data '{
    "pixKey": "string",
    "creditorDocument": "string",
    "endToEndId": "string",
    "priority": "HIGH",
    "description": "string",
    "paymentFlow": "INSTANT",
    "expiration": 600,
    "payment": {
        "currency": "BRL",
        "amount": 0
    },
    "ispbDeny": [
        "string"
    ]
}'

Response Example

202 - Exemplo 1

{
    "endToEndId": "string",
    "eventDate": "2019-08-24T14:15:22.123Z",
    "id": 0,
    "payment": {
        "currency": "BRL",
        "amount": 0
    },
    "type": "string"
}

Página anterior

Iniciar um pagamento usando dados bancários.

Próxima página

Obter detalhes da transação por end-to-end-id.