1. Reembolsos
SYNC-DOCUMENTATION
  • Auth Token
    • Gera o token de utilização da aplicação
      POST
  • Saldo
    • Retorna o Saldo do Usuário
      GET
  • Transações
    • Consulta status da transação
      GET
  • Utmify
    • Salvar Token
      POST
    • Desativa Token
      POST
  • Partner
    • Consulta dados do Parceiro
      GET
  • Cartão de Crédito
    • Selar um cartão
      POST
    • Cobrar no cartão
      POST
  • Pix - CashIn
    • Solicitação de depósito via Pix
      POST
  • Old API
    • CashIn
      POST
    • Consulta os dados do Parceiro
      GET
  • Assinaturas - Recorrência
    • Planos
      • Listar planos
      • Criar plano
      • Detalhe do plano
      • Editar plano
      • Arquivar plano
      • Assinantes do plano
    • Assinantes
      • Cadastrar assinante
      • Listar assinantes
      • Detalhe da assinatura
      • Cancelar assinatura
      • Pausar assinatura
      • Reativar assinatura
      • Reenviar cobrança
      • Trocar plano da assinatura
    • Notificações
      • Listar entregas de um webhook
    • Splits
      • Adicionar recebedor de split a um plano
      • Listar splits enviados (perspectiva do seller)
      • Listar convites recebidos (perspectiva do recebedor)
      • Aceitar convite de split
      • Rejeitar convite de split
      • Cancelar split (perspectiva do seller)
    • Produtos — Planos
      • Listar planos aninhados a um produto
      • Criar plano aninhado a um produto
      • Atualizar plano aninhado
      • Desativar plano aninhado
      • Marcar plano como padrão do produto
  • Reembolsos
    • Solicitar reembolso de uma venda
      POST
    • Consultar uma solicitação de reembolso
      GET
  • Raiz
  • Webhooks
    • Cash-In
      • Cash-in criado (cobrança PIX gerada)
      • Cash-in atualizado (mudança de status)
      • Cash-in legado (notificação mínima)
    • Cash-Out
      • Cash-out criado (saque solicitado)
      • Cash-out atualizado (mudança de status do saque)
    • Cartão de Crédito
      • Cartão de crédito — cobrança criada
      • Cartão de crédito — mudança de status
    • Transações - Completo
      • Cobrança de transação criada
      • Transação teve mudança de status
    • Listar webhooks
    • Criar webhook
    • Atualizar webhook
    • Excluir webhook
    • Rotacionar o segredo de assinatura
  • Esquemas
    • Webhook
      • CashIn
        • onCreate
        • onUpdate
        • CashinCreated
        • CashinUpdated
        • CashinOld
      • CashOut
        • onCreate
        • onUpdate
      • Cash-In
        • CashinCreated
        • CashinUpdated
        • CashinOld
    • TransactionEvent
    • BillingMethod
    • CardTokenRequest
    • WebhookInput
    • CreditCardCreatePayload
    • CashinCreated
    • CreditCardCreated
    • RefundReason
    • CashoutCreated
    • CreditCardUpdated
    • CreditCardStatusPayload
    • CardToken
    • Transaction
    • CashinUpdated
    • CashoutUpdated
    • Webhook
    • PlanStatus
    • RefundStatus
    • SplitStatus
    • CashinOld
    • RefundWebhookPayload
    • Customer
    • CreatedWebhook
    • CreditCardPaymentRequest
    • RefundRejectionCategory
    • PaymentMethod
    • CreditCardPaymentAccepted
    • DebtorAccount
    • SubscriptionSplit
    • WebhookListItem
    • Payment
    • WebhookDelivery
    • RefundRequest
    • SplitRecipientPayload
    • SimpleError
    • RefundTransaction
    • SubscriptionSplitInvite
    • StoreProductPlanRequest
    • RotatedWebhookSecret
    • Card
    • CodedError
    • RefundEvent
    • SubscriptionStatus
    • Checkout
    • UpdateProductPlanRequest
    • RefusedError
    • ChargeStatus
    • PaymentLink
    • AntiFraudError
    • Error
    • Tracking
    • ValidationError
    • PlanResource
    • PaginationMeta
    • ChargeResource
    • SubscriptionResource
    • EnrollPaymentQrCode
    • EnrollPaymentPixAutomatico
    • WebhookResource
    • NotFoundError
    • WebhookEnvelope
    • ChargeBlock
    • MandateBlock
    • WebhookDeliveryResource
  1. Reembolsos

Solicitar reembolso de uma venda

POST
/api/partner/v1/transaction/{reference_id}/refund
Abre uma solicitação de reembolso para a venda identificada por
reference_id. A venda precisa pertencer ao seller dono do token.
Efeitos imediatos, na mesma transação de banco:
1.
retenção de valor bruto da venda + R$ 1,00 do saldo do seller;
2.
criação da solicitação em requested, com um code público;
3.
disparo do webhook refund com event = requested.
A venda não muda de status agora — ela só vai para refunding na
aprovação e para refunded na conclusão.
Não há PIN nem confirmação extra: a credencial é o próprio token do
parceiro.

Erros de negócio#

Todos com corpo { "message": …, "error": … }:
errorHTTPCausa
transaction_not_found404reference_id não existe ou não é do seller do token
transaction_not_completed422a venda não está completed
transaction_type_unsupported422não é PIX nem cartão de crédito
transaction_origin_unsupported422não é uma venda (split filho, comissão, taxa…)
invalid_transaction_amount422valor da venda menor ou igual a zero
seller_not_approved422conta do seller não está aprovada
refund_out_of_window422passou dos 90 dias do pagamento
transaction_under_med422venda em contestação MED aberta
transaction_already_refunded409venda já reembolsada ou em reembolso
refund_request_in_progress409já existe solicitação aberta para a venda
Os 409 são conflitos de estado: a venda pode voltar a ser
reembolsável (ex.: a solicitação anterior foi reprovada). Os 422 de
elegibilidade, exceto transaction_not_completed, são definitivos para
aquela venda — não vale a pena repetir a chamada.
Não há saldo mínimo: a retenção é aplicada mesmo que deixe o saldo do
seller negativo.

Requisição

Authorization
Forneça seu token bearer no cabeçalho
Authorization
ao fazer requisições para recursos protegidos.
Exemplo:
Authorization: Bearer ********************
Parâmetros de Caminho

Parâmetros Bodyapplication/jsonObrigatório

Examples

Respostas

🟢201
application/json
Solicitação criada, em requested. O bloco transaction traz os
dados do comprador; events não vem nesta resposta — use
GET /refunds/{code} para o histórico.
Bodyapplication/json

🟠404
🟠409
🟠422
🟠401Unauthorized
🟠403FeatureDisabled
🟠429TooManyRequests
Request Request Example
Shell
JavaScript
Java
Swift
cURL
curl --location '/api/partner/v1/transaction/9c1e2f3a-5b47-4d8e-9f21-6a0b3c4d5e6f/refund' \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{
    "reason": "product_not_delivered",
    "reason_details": "Cliente relatou que o produto nunca foi entregue e solicitou a devolução do valor."
}'
Response Response Example
201 - Sucesso
{
    "data": {
        "code": "rfd_7c02e5a1b3",
        "status": "requested",
        "status_label": "Solicitado",
        "amount": "250.00",
        "fee": "1.00",
        "total": "251.00",
        "reason": "product_not_delivered",
        "reason_label": "Produto não entregue",
        "reason_details": "Cliente relatou que o produto nunca foi entregue e solicitou a devolução do valor.",
        "rejection_category": null,
        "rejection_category_label": null,
        "rejection_reason": null,
        "provider_receipt": null,
        "executed_at": null,
        "requested_at": "2026-08-10T14:35:00.000000Z",
        "approved_at": null,
        "rejected_at": null,
        "completed_at": null,
        "cancelled_at": null,
        "transaction": {
            "reference_id": "9c1e2f3a-5b47-4d8e-9f21-6a0b3c4d5e6f",
            "end_to_end_id": "E1234567820260810143000abcdef123",
            "amount": "250.00",
            "paid_at": "2026-08-01T12:00:00.000000Z",
            "method": "pix",
            "fees": "12.45",
            "product": null,
            "client": {
                "name": "Maria Silva",
                "email": "maria@example.com",
                "document": "12345678901",
                "phone": "+5511999999999"
            }
        }
    }
}
Modificado em 2026-08-14 16:36:50
Página anterior
Marcar plano como padrão do produto
Próxima página
Consultar uma solicitação de reembolso
Built with