Reembolsar pagamento capturado

post

https://sandbox-api.pagaleve.io/v1/payments/{id}/refund

Este endpoint é para reembolsar um pagamento capturado. Ele suporta reembolsos totais, parciais e múltiplos até o valor total capturado.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

string

required

Payment Id

Body Params

amount

number

required

Valor a ser reembolsado em centavos

description

string

Campo de descrição para adicionar observações sobre o reembolso

reference

string

Id do reembolso vindo do lojista

reason

string

enum

Motivo do reembolso

Allowed:

recipients

array of objects

Lojistas caso a operação seja para um pedido do tipo marketplace.

recipients

Headers

Authorization

string

required

Token de autorização Bearer

Idempotency-Key

string

A API suporta idempotency para a segurança em retentativas de requisições evitando assim executar a mesma operação duas vezes.

Subsidiary-Id

string

Para uma holding consultar dados de uma subsidiária esse campo deve ser preenchido obrigatoriamente com o id da subsidiária.

Responses

Language

Credentials

Bearer

URL

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200

400Este erro ocorre quando os recipient não é um marketplace.

404Este erro aparece quando o pagamento, provider ou recipients passado não são encontrados na base de dados.

409Este erro ocorre quando um reembolso está em processamento para o mesmo payment_id (ActionInProgressException) ou está em processamento para a mesma idempotency_key (ActionAlreadyExistsException).

412Este erro ocorre quando o merchant tenta realizar essa ação e não é uma holding company, quando não foram enviados valores válidos de taxa de comissão ou valor repassado para os recipients não é válido.