# Reembolso

Quando um pagamento é cancelado, a Xsolla envia detalhes da transação cancelada 
em um webhook com o tipo refund para o URL do webhook.

O mecanismo de repetição do webhook depende de quem iniciou o reembolso:
* Se o reembolso foi iniciado do seu lado, o webhook não é reenviado. O pagamento 
  é reembolsado ao usuário independentemente da resposta ao webhook.
* Se o reembolso foi iniciado por um terceiro — por exemplo, um sistema de 
  pagamento ou a equipe de Suporte ao Cliente da Xsolla — e, em resposta a um 
  webhook, um código de status 5xx foi retornado, o webhook é reenviado em 
  intervalos crescentes. O número máximo de tentativas é 12 em até 48 horas a 
  partir da primeira tentativa.

Para informações detalhadas sobre o processo de reembolso, consulte as 
instruções.


Aviso
O pagamento ainda será reembolsado ao usuário se todas as seguintes condições forem atendidas:O reembolso foi iniciado pela Xsolla.Em resposta a um webhook, um código de status 4xx foi retornado, ou nenhuma resposta foi recebida após todas as tentativas repetidas, ou um código de status 5xx foi retornado.


Quando você salva o URL do webhook na Conta de 
Distribuidor, você também pode configurar o recebimento de informações 
adicionais nos webhooks.


Observação
Se você se registrou na Conta de Distribuidor no dia 22 de janeiro de 2025 ou antes, você encontrará as opções no seu projeto na seção Project settings &gt; Webhooks &gt; Testing &gt; Payments &gt; Advanced settings.




    
        Opção
        Descrição
    


    
        Exibir informações sobre transações pelos métodos de pagamento salvos
        As informações são passadas nos seguintes parâmetros personalizados do webhook:saved_payment_method:0 — o método de pagamento guardado não foi utilizado1 — o método de pagamento foi salvo ao efetuar o pagamento atual2 — o método de pagamento previamente guardado é utilizadopayment_type:1 — pagamento único2 — pagamento recorrente
    
    
        Exibir informações sobre o motivo do reembolso.
        Informações detalhadas sobre os motivos do reembolso.
    



Códigos de reembolso:


    
    
        Código
        Motivo
        Descrição
    
    
    
    
        1
        Cancellation by the user request / the game request
        Cancelamento iniciado a partir da Publisher Account.
    
    
        2
        Chargeback
        Estorno de transação solicitado.
    
    
        3
        Integration error
        Problemas na integração entre a Xsolla e o jogo.Recomendação: não adicione o usuário à lista de bloqueio.
    
    
        4
        Potential fraud – AFS reject
        Transação rejeitada porque o sistema Xsolla Anti-fraud detectou uma fraude em potencial.
    
    
        5
        Test payment
        Transação de teste seguida de cancelamento.Recomendação: não adicione o usuário à lista de bloqueio.
    
    
        6
        User invoice expired
        Invoice vencido (utilizado no modelo pós-pago).
    
    
        7
        Fraud notification from PS
        Pagamento rejeitado porque o sistema de pagamento detectou uma fraude em potencial.Recomendação: adicione o usuário à lista de bloqueios.
    
    
        8
        Cancellation by the PS request
        Cancelamento solicitado pelo sistema de pagamento.Recomendação: não adicionar o usuário à lista de bloqueio.
    
    
        9
        Cancellation by the user request
        O usuário não ficou satisfeito com o jogo ou a compra por qualquer motivo.Recomendação: não adicionar o usuário à lista de bloqueio.
    
    
        10
        Cancellation by the game request
        Cancelamento solicitado pelo jogo.Recomendação: não adicionar o usuário à lista de bloqueio.
    
    
        11
        Account holder called to report fraud
        O proprietário da conta afirma que não fez a transação.Recomendação: adicione o usuário à lista de bloqueios.
    
    
        12
        Potential fraud – friendly fraud
        O portador legítimo do cartão contestou a transação.
    
    
        13
        Duplicate
        Duplique a transação para o mesmo invoice.
    
    
        21
        Potential fraud – BIN attack
        Cartões roubados de um ou vários BINs em um lote. Um indicador-chave é uma sequência de tentativas compartilhando uma faixa de BIN em um curto intervalo de tempo, frequentemente com números de cartão enumerados.
    
    
        22
        Potential fraud – monetization fraud
        Cartão roubado usado para comprar itens negociáveis para fins de revenda.
    
    
        23
        Potential fraud – low-scale card fraud
        Cartões roubados de um ou vários BINs. Não tão difundido e coordenado quanto o ataque BIN (código de reembolso 21).
    
    
        24
        Potential fraud – regional price abuse
        Preços regionais ou abuso de revenda de chaves. Os usuários exploraram preços regionais — tipicamente por meio de indicações de localização ou de métodos de pagamento falsas — para adquirir itens baratos para revenda em mercados mais caros.
    
    
        25
        Potential fraud – partner or PS exploit
        Roubo de credenciais e tomada de conta — abuso de uma conta ou integração do lado do parceiro ou do lado do sistema de pagamentos, em vez de abuso direto de cartão.
    
    
        26
        Potential fraud – not definable
        Fraude confirmada, mas não há evidências suficientes para determinar o tipo exato de ataque.
    
    
        27
        Fraud notification from PS – linked transactions
        A transação em si não foi especificada no relatório de fraude do sistema de pagamento, mas está conectada (ex.: através de um cartão ou dispositivo compartilhado) a transações que foram reembolsadas com base em fraudes.

Endpoint: POST refund
Version: 1.0

## Request fields (application/json):

  - `custom_parameters` (object)
    Seus parâmetros personalizados.

  - `notification_type` (string, required)
    Tipo de notificação.

  - `payment_details` (object, required)
    Detalhes de pagamento (objeto).

  - `payment_details.country_wht` (object)
    Objeto com dados sobre custos de retenção aplicados em países específicos devido a transações transfronteiriças.

  - `payment_details.country_wht.amount` (number)
    Quantia.

  - `payment_details.country_wht.currency` (string)
    Moeda. Código da moeda de três letras de acordo com o [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217).

  - `payment_details.country_wht.percent` (number)
    Percentual da taxa de custo de retenção.

  - `payment_details.direct_wht` (object)
    Imposto retido direto na fonte.

  - `payment_details.direct_wht.amount` (number)
    Quantia.

  - `payment_details.direct_wht.currency` (string)
    Moeda. Código da moeda de três letras de acordo com o [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217).

  - `payment_details.direct_wht.percent` (number)
    Alíquota de retenção direta na fonte.

  - `payment_details.payment` (object)
    Valor pago pelo usuário (objeto).

  - `payment_details.payment.amount` (number)
    Quantia.

  - `payment_details.payment.currency` (string)
    Moeda. Código da moeda de três letras de acordo com o [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217).

  - `payment_details.payment_method_fee` (object)
    Taxa do sistema de pagamento.

  - `payment_details.payment_method_fee.amount` (number)
    Quantia.

  - `payment_details.payment_method_fee.currency` (string)
    Moeda. Código da moeda de três letras de acordo com o [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217).

  - `payment_details.payment_method_sum` (object)
    Valor debitado do sistema de pagamento.

  - `payment_details.payment_method_sum.amount` (number)
    Quantia.

  - `payment_details.payment_method_sum.currency` (string)
    Moeda. Código da moeda de três letras de acordo com o [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217).

  - `payment_details.payout` (object)
    Dados de pagamento (objeto).

  - `payment_details.payout.amount` (number)
    Quantia.

  - `payment_details.payout.currency` (string)
    Moeda. Código da moeda de três letras de acordo com o [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217).

  - `payment_details.payout_currency_rate` (string)
    Taxa de câmbio entre as moedas de pagamento e remuneração.

  - `payment_details.repatriation_commission` (object)
    Objeto com dados sobre os custos de repatriamento, imposto à Xsolla por terceiros.

  - `payment_details.repatriation_commission.amount` (number)
    Quantia.

  - `payment_details.repatriation_commission.currency` (string)
    Moeda. Código da moeda de três letras de acordo com o [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217).

  - `payment_details.sales_tax` (object)
    Imposto sobre vendas (objeto; apenas EUA e Canadá).

  - `payment_details.sales_tax.amount` (number)
    Quantia.

  - `payment_details.sales_tax.currency` (string)
    Moeda. Código da moeda de três letras de acordo com o [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217).

  - `payment_details.sales_tax.percent` (number)
    Alíquota de imposto sobre vendas.

  - `payment_details.user_acquisition_fee` (object)
    Valor total das taxas de aquisição de usuários deduzidas para as compras feitas por meio de redes afiliadas e influenciadores (objeto).

  - `payment_details.user_acquisition_fee.amount` (number)
    Quantia.

  - `payment_details.user_acquisition_fee.currency` (string)
    Moeda. Código da moeda de três letras de acordo com o [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217).

  - `payment_details.user_acquisition_fee.percent` (number)
    Proporção de taxa de aquisição de usuários, %.

  - `payment_details.vat` (object)
    Dados do IVA (objeto; apenas na UE).

  - `payment_details.vat.amount` (number)
    Quantia.

  - `payment_details.vat.currency` (string)
    Moeda. Código da moeda de três letras de acordo com o [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217).

  - `payment_details.vat.percent` (number)
    Taxa de IVA.

  - `payment_details.xsolla_balance_sum` (object)
    Valor debitado do saldo Xsolla.

  - `payment_details.xsolla_balance_sum.amount` (number)
    Quantia.

  - `payment_details.xsolla_balance_sum.currency` (string)
    Moeda. Código da moeda de três letras de acordo com o [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217).

  - `payment_details.xsolla_fee` (object)
    Taxa Xsolla (objeto).

  - `payment_details.xsolla_fee.amount` (number)
    Quantia.

  - `payment_details.xsolla_fee.currency` (string)
    Moeda. Código da moeda de três letras de acordo com o [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217).

  - `purchase` (object)
    Dados da compra (objeto).

  - `purchase.checkout` (object)
    Dados do checkout (objeto).

  - `purchase.checkout.amount` (number)
    Valor da compra.

  - `purchase.checkout.currency` (string)
    Moeda. Código da moeda de três letras de acordo com o [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217).

  - `purchase.subscription` (object)
    Dados da assinatura (objeto).

  - `purchase.subscription.amount` (number)
    Preço em moeda real.

  - `purchase.subscription.currency` (string)
    Moeda. Código da moeda de três letras de acordo com o [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217).

  - `purchase.subscription.date_create` (string)
    Data de criação da assinatura. Data e hora de acordo com o [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601).

  - `purchase.subscription.plan_id` (string)
    ID do plano (externo se o plano foi criado via API).

  - `purchase.subscription.subscription_id` (integer)
    ID de assinatura no banco de dados Xsolla.

  - `purchase.subscription.tags` (array)
    Rótulos do plano.

  - `purchase.total` (object, required)
    Preço total de compra (objeto).

  - `purchase.total.amount` (number)
    Valor total do pagamento.

  - `purchase.total.currency` (string)
    Moeda. Código da moeda de três letras de acordo com o [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217).

  - `refund_details` (object)
    Detalhes do reembolso (objeto).

  - `refund_details.author` (string)
    Iniciador de reembolso. O valor do campo é passado de acordo com a tabela:


    
    
        Iniciador de reembolso
        Valor do campo
    
    
    
    
        Jogo (via API).
        API
    
    
        Usuário da Publisher Account (reembolso automático).
        E-mail do usuário
    
    
        Usuário da Publisher Account (com assistência do suporte ao cliente Xsolla).
        support@xsolla.com
    
    
        Xsolla (com assistência do suporte ao cliente Xsolla).
        support@xsolla.com

  - `refund_details.code` (integer)
    ID do código.

  - `refund_details.reason` (string)
    Motivo do reembolso.

  - `settings` (object)
    Configurações personalizadas do projeto (objeto).

  - `settings.merchant_id` (integer)
    ID de comerciante.

  - `settings.project_id` (integer)
    ID do projeto. Você pode encontrar esse parâmetro em sua [Conta de Distribuidor](https://publisher.xsolla.com/) ao lado do nome do projeto.

  - `transaction` (object, required)
    Detalhes da transação (objeto).

  - `transaction.agreement` (integer)
    ID do contrato.

  - `transaction.dry_run` (integer)
    Transação de teste. O parâmetro tem valor 1 se for uma transação de teste ou não for enviado se a transação for real.

  - `transaction.external_id` (string)
    ID externo de transação.

  - `transaction.id` (integer)
    ID de transação.

  - `transaction.payment_method_order_id` (string)
    ID de pagamento no sistema de pagamento.

  - `user` (object)
    Dados do usuário (objeto).

  - `user.country` (string)
    País do usuário. Código de país de duas letras maiúsculas, de acordo com o [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2).

  - `user.email` (string)
    E-mail do usuário.

  - `user.id` (string, required)
    ID de usuário.

  - `user.ip` (string)
    IP do usuário.

  - `user.name` (string)
    Nome de usuário.

  - `user.phone` (string)
    Telefone do usuário.

  - `user.zip` (string)
    CEP ou código postal do usuário.

## Response 400 fields (application/json):

  - `error` (object)

  - `error.code` (string)

  - `error.message` (string)


## Response 204 fields

## Response 500 fields
