Devolver um Pix recebido.

POST

/pix/payments/{endToEndId}/refund

Pix

Devolve total ou parcialmente um Pix recebido, identificado pelo endToEndId original.

A devolução gera um novo fluxo de saída e pode ser acompanhada pelos webhooks de transferência e de devolução.

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-Permite criar pagamentos Pix e gerenciar chaves Pix da conta

Parâmetros de Caminho

Parâmetros Header

Parâmetros Bodyapplication/jsonNecessário

Examples

Respostas

🟢202

application/json

Devolução aceita para processamento

Bodyapplication/json

🟠400

🟠401

🟠403

🟠412

🟠422

🟠429

🔴500

Request Example

Shell

JavaScript

Java

Swift

curl --location '/pix/payments//refund' \
--header 'x-idempotency-key;' \
--header 'Content-Type: application/json' \
--data '{
    "devolutionAmount": 0.01,
    "devolutionReason": "string"
}'

Response Example

202 - Exemplo 1

{
    "devolutionEndToEndId": "string",
    "devolutionAmount": 0
}

Página anterior

Iniciar pagamento Pix por chave Pix.

Próxima página

Consultar Pix por end-to-end-id.