Pular para o conteúdo

Reembolsos

Cria um reembolso PIX. Requer scope CREATE_REFUND e o header Idempotency-Key (ausente → 400). id = ID da sub-transação.

Body:

CampoTipoObrigatórioRegras
amountCentsintnãopositivo; se omitido = reembolso total do disponível
reasonstringnãomáx 500

Resposta (201):

{ "refundId": "uuid", "status": "PROCESSING", "amountCents": 10000 }

status inicial PROCESSING; o desfecho final (COMPLETED/FAILED) chega via webhook transaction.refunded.

Requer scope CREATE_REFUND. Lista os reembolsos de uma sub-transação (escopo da empresa da chave). Retorna array de objetos de reembolso.

Requer scope CREATE_REFUND. Retorna um reembolso pelo seu ID. Não encontrado / de outra empresa → 404.

Objeto de reembolso (refundResponseSchema):

{
"id": "uuid",
"subTransactionId": "uuid",
"status": "COMPLETED",
"amount": 10000,
"currency": "BRL",
"reason": "string | null",
"providerRefundId": "string | null",
"pixReturnE2eId": "string | null",
"requestedAt": "ISO | null",
"completedAt": "ISO | null",
"failedReason": "string | null"
}

status ∈ REQUESTED | PROCESSING | COMPLETED | FAILED | CANCELED. amount em centavos.