Xsolla-logoXsolla Developers
ou
Conta de Distribuidor

ReembolsoWebhook POST

Quando um pagamento é cancelado, a Xsolla envia detalhes da transação cancelada em um webhook com o tipo refund para o URL do webhook. Saiba mais sobre o processo de reembolso nestas instruções.

Se uma resposta com um código 5xx for recebida, a Xsolla reenvia um webhook com um intervalo de tempo maior até que seu ouvinte confirme o recebimento. O número máximo de tentativas é 12.

Aviso

Se a Xsolla iniciar um reembolso e uma resposta com um código 5xx for recebida para o webhook, o pagamento ainda será reembolsado.

When you save the webhook URL in Publisher Account, you can give permissions to receive detailed information in webhooks. To do that, set the following toggle to active in Publisher Account in the Project settings > Webhooks > Advanced settings section.

Note

If you registered in Publisher Account on or before January 22, 2025, you can find the toggles in the Project settings > Webhooks > Testing > Payments > Advanced settings section.

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 utilizado
    • 1 — o método de pagamento foi salvo ao efetuar o pagamento atual
    • 2 — o método de pagamento previamente guardado é utilizado
  • payment_type:
    • 1 — pagamento único
    • 2 — pagamento recorrente

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 Suspeita de fraude.
Recomendação: adicionar o usuário à lista de bloqueio.
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 recusado pelo sistema de pagamento. Potencial fraude detectada pelo PS.
Recomendação: adicionar o usuário à lista de bloqueio.
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.
12 Friendly fraud Fraude amigável denunciada.
13 Duplicate Duplique a transação para o mesmo invoice.
Request
Request Body schema: application/json
notification_type
required
string

Tipo de notificação.

required
object

Detalhes da transação (objeto).

agreement
integer

ID do contrato.

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.

external_id
string

ID externo de transação.

id
integer

ID de transação.

payment_method_order_id
string

ID de pagamento no sistema de pagamento.

required
object

Detalhes de pagamento (objeto).

object

Imposto retido na fonte aplicado em países específicos devido a transações internacionais (objeto).

amount
number <float>

Quantia.

currency
string

Moeda. Código da moeda de três letras de acordo com o ISO 4217.

percent
number <float>

Taxa de retenção na fonte do país, %.

object

Imposto retido direto na fonte.

amount
number <float>

Quantia.

currency
string

Moeda. Código da moeda de três letras de acordo com o ISO 4217.

percent
number <float>

Alíquota de retenção direta na fonte.

object

Valor pago pelo usuário (objeto).

amount
number <float>

Quantia.

currency
string

Moeda. Código da moeda de três letras de acordo com o ISO 4217.

object

Taxa do sistema de pagamento.

amount
number <float>

Quantia.

currency
string

Moeda. Código da moeda de três letras de acordo com o ISO 4217.

object

Valor debitado do sistema de pagamento.

amount
number <float>

Quantia.

currency
string

Moeda. Código da moeda de três letras de acordo com o ISO 4217.

object

Dados de pagamento (objeto).

amount
number <float>

Quantia.

currency
string

Moeda. Código da moeda de três letras de acordo com o ISO 4217.

payout_currency_rate
string

Taxa de câmbio entre as moedas de pagamento e remuneração.

object

Objeto com dados sobre os custos de repatriamento, imposto à Xsolla por terceiros.

amount
number <float>

Quantia.

currency
string

Moeda. Código da moeda de três letras de acordo com o ISO 4217.

object

Imposto sobre vendas (objeto; apenas EUA e Canadá).

amount
number <float>

Quantia.

currency
string

Moeda. Código da moeda de três letras de acordo com o ISO 4217.

percent
number <float>

Alíquota de imposto sobre vendas.

object

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

amount
number <float>

Quantia.

currency
string

Moeda. Código da moeda de três letras de acordo com o ISO 4217.

percent
number <float>

Proporção de taxa de aquisição de usuários, %.

object

Dados do IVA (objeto; apenas na UE).

amount
number <float>

Quantia.

currency
string

Moeda. Código da moeda de três letras de acordo com o ISO 4217.

percent
number <float>

Taxa de IVA.

object

Valor debitado do saldo Xsolla.

amount
number <float>

Quantia.

currency
string

Moeda. Código da moeda de três letras de acordo com o ISO 4217.

object

Taxa Xsolla (objeto).

amount
number <float>

Quantia.

currency
string

Moeda. Código da moeda de três letras de acordo com o ISO 4217.

custom_parameters
object

Seus parâmetros personalizados.

object

Dados da compra (objeto).

required
object

Preço total de compra (objeto).

amount
number <float>

Valor total do pagamento.

currency
string

Moeda. Código da moeda de três letras de acordo com o ISO 4217.

object

Dados do checkout (objeto).

amount
number <float>

Valor da compra.

currency
string

Moeda. Código da moeda de três letras de acordo com o ISO 4217.

object

Dados da assinatura (objeto).

amount
number <float>

Preço em moeda real.

currency
string

Moeda. Código da moeda de três letras de acordo com o ISO 4217.

date_create
string

Data de criação da assinatura. Data e hora de acordo com o ISO 8601.

plan_id
string

ID do plano (externo se o plano foi criado via API).

subscription_id
integer

ID de assinatura no banco de dados Xsolla.

tags
Array of strings

Rótulos do plano.

object

Detalhes do reembolso (objeto).

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
code
integer

ID do código.

reason
string

Motivo do reembolso.

object

Configurações personalizadas do projeto (objeto).

merchant_id
integer

ID de comerciante.

project_id
integer

ID do projeto. Você pode encontrar esse parâmetro em sua Conta de Distribuidor ao lado do nome do projeto.

object

Dados do usuário (objeto).

id
required
string

ID de usuário.

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.

email
string

E-mail do usuário.

ip
string

IP do usuário.

name
string

Nome de usuário.

phone
string

Telefone do usuário.

zip
string

CEP ou código postal do usuário.

Responses
204

Retorne para indicar o processamento bem-sucedido.

400

Retorne em caso de erro nas informações fornecidas (por exemplo, um parâmetro obrigatório ausente, falha na autorização, etc.).

500

Retorne para indicar erros temporários com seus servidores.

Request samples 
curl -v 'https://your.hostname/your/uri' \
-X POST \
-d '{
        "notification_type": "refund",
        "settings": {
          "project_id": 18404,
          "merchant_id": 2340
        },
        "purchase": {
            "subscription": {
                "plan_id": "b5dac9c8",
                "subscription_id": "10",
                "date_create": "2014-09-22T19:25:25+04:00",
                "currency": "USD",
                "amount": 9.99
            },
            "checkout": {
                "currency": "USD",
                "amount": 50
            },
            "total":{
                "currency": "USD",
                "amount": 200
            }
        },
        "user": {
            "ip": "127.0.0.1",
            "phone": "18777976552",
            "email": "email@example.com",
            "id": "1234567",
            "name": "John Smith",
            "country": "US"
        },
        "transaction": {
            "id": 1,
            "external_id": 1,
            "dry_run": 1,
            "agreement": 1
        },
        "refund_details": {
            "code": 4,
            "reason": "Potential fraud"
        },
        "payment_details": {
            "sales_tax": {
                "currency": "USD",
                "amount": 0
            },
            "direct_wht": {
                "currency": "USD",
                "amount": 0.70
            },
            "xsolla_fee": {
                "currency": "USD",
                "amount": "10"
            },
            "payout": {
                "currency": "USD",
                "amount": "200"
            },
            "payment_method_fee": {
                "currency": "USD",
                "amount": "20"
            },
            "payment": {
                "currency": "USD",
                "amount": "230"
            },
            "repatriation_commission": {
                "currency": "USD",
                "amount": 10
            }
        }
    }
}'
Response samples
application/json
{
  • "error": {
    }
}
System statusAll services operational

Privacy Settings

Privacy PolicyEnd User License Agreement© 2006–2025 Xsolla Inc.