# Pagamento bem-sucedido do pedido (com detalhes de pagamento e transação)

A Xsolla envia o webhook order_paid para o URL especificado quando 
o usuário paga pelo pedido com sucesso.

O webhook order_paid contém informações sobre os itens comprados, 
dados de pagamento e os detalhes da transação.

O webhook order_paid não é enviado se o pagamento não for bem-
sucedido. Por exemplo:
* o formulário de pagamento foi aberto, mas o usuário não pagou pelo pedido
* o formulário de pagamento foi aberto, mas houve erros durante o pagamento

Recomenda-se que o tempo de processamento do webhook order_paid 
seja inferior a 3 segundos.


Aviso
O conjunto de campos enviados em um webhook depende das seguintes configurações:as que você configurou na Conta de Distribuidor na seção Project settings > Webhooks > Advanced settings.as configuradas no lado da Xsolla.Se você tiver alguma dúvida, entre em contato com seu Gerente de Sucesso do Cliente ou envie um e-mail para csm@xsolla.com.


As respostas esperadas são descritas na seção Respostas. Você pode usar 
outros códigos de resposta. Dependendo do código da resposta e a conexão da 
funcionalidade de reembolso automático do pagamento, a lógica de processamento 
do webhook no lado da Xsolla funciona como a seguir:


    
    
        Código de resposta
        Reembolso automático de pagamento está desativado (por padrão)
        Reembolso automático de pagamento está ativado
    
    
    
    
        400, 401, 402, 403, 404, 409, 422, 415
        Nenhuma ação
        Reembolso automático ao usuário
    
    
        200, 201, 204
        Nenhuma ação
        Nenhuma ação
    
    
        Código diferente ou nenhuma resposta ao webhook
        Múltiplos webhooks são enviados dentro de um intervalo de tempo específico: 2 tentativas dentro de um intervalo de 5 minutos, 7 tentativas dentro de um intervalo de 15 minutos, 10 tentativas de dentro de um intervalo de 60 minutos.
        Múltiplos webhooks são enviados dentro de um intervalo de tempo específico: 2 tentativas dentro de um intervalo de 5 minutos, 7 tentativas dentro de um intervalo de 15 minutos, 10 tentativas de dentro de um intervalo de 60 minutos. Se todos os webhooks forem enviados mas não for recebida uma resposta bem-sucedida, um reembolso automático é emitido ao usuário.
    
    


Para conectar a funcionalidade de reembolso automático, entre em contato com 
seus Gerentes de Sucesso do Cliente ou envie um e-mail para csm@xsolla.com.

Endpoint: POST successful-order-payment
Version: 1.0

## Request fields (application/json):

  - `billing` (object)
    Detalhes da transação e do pagamento.

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

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

  - `billing.payment_details.country_wht` (object)
    Imposto retido na fonte aplicado em países específicos devido a transações internacionais (objeto).

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

  - `billing.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).

  - `billing.payment_details.country_wht.percent` (number)
    Taxa de retenção na fonte do país, %.

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

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

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

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

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

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

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

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

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

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

  - `billing.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).

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

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

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

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

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

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

  - `billing.purchase.coupon` (object)
    Dados do cupom (objeto; se um cupom foi usado ao criar a assinatura).

  - `billing.purchase.coupon.campaign_code` (string)
    Código da campanha.

  - `billing.purchase.coupon.coupon_code` (string)
    Código de cupom.

  - `billing.purchase.gift` (object)
    Detalhes do presente (objeto).

  - `billing.purchase.gift.giver_id` (string)
    ID do doador.

  - `billing.purchase.gift.hide_giver_from_receiver` (string)
    Se a identidade do doador deve ou não ser ocultada do recipiente.

  - `billing.purchase.gift.message` (string)
    Mensagem do doador.

  - `billing.purchase.gift.receiver_email` (string)
    E-mail do recipiente do presente.

  - `billing.purchase.gift.receiver_id` (string)
    ID do recipiente do presente.

  - `billing.purchase.promotions` (array)
    Promoções aplicadas a esta transação.

  - `billing.purchase.promotions.id` (integer)
    ID da promoção.

  - `billing.purchase.promotions.technical_name` (string)
    Nome técnico da promoção.

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

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

  - `billing.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).

  - `billing.purchase.subscription.date_next_charge` (string)
    Data da próxima cobrança. Data e hora de acordo com o [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601).

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

  - `billing.purchase.subscription.product_id` (string)
    ID do produto (se enviado no token de acesso).

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

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

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

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

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

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

  - `billing.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.

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

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

  - `billing.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.

  - `billing.transaction.external_id` (string)
    ID de transação externo. Consulte o [FAQs](/pt/doc/pay-station/references/faq/#faq_payments_q_new_transaction_external_id) para saber mais.

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

  - `billing.transaction.payment_date` (string)
    Data de pagamento.

  - `billing.transaction.payment_method` (integer)
    ID de método de pagamento.

  - `billing.transaction.payment_method_name` (string)
    Nome do método de pagamento.

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

  - `custom_parameters` (object)
    Informações adicionais.

  - `items` (array, required)
    Lista de itens comprados pelo usuário.

O conjunto de parâmetros incluídos na matriz depende da versão do webhook. A 
versão 2 inclui parâmetros adicionais: is_free, is_bonus, e 
is_bundle_content. Para alternar a versão, passe seu número no parâmetro 
version na chamada API [Atualizar informações de configurações do 
webhook](/pt/api/igs/operation/update-webhook/).

  - `order` (object, required)
    Informações sobre o pedido.

  - `order.amount` (string, required)
    O custo total de um carrinho com base na moeda escolhida.

  - `order.comment` (string,null, required)
    Comentário do usuário ao pedido.

  - `order.coupons` (array)
    Cupons aplicados. Se o cupom não for aplicado, a matriz não retornará.

  - `order.coupons.code` (string)
    O código de um cupom aplicado.

  - `order.coupons.external_id` (string)
    ID externo.

  - `order.currency` (string, required)
    Moeda de ordem. A moeda virtual usa o SKU e a moeda real usa um código [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) de três letras.

  - `order.currency_type` (string, required)
    Tipo de moeda de pagamento. Para pedidos gratuitos, o valor unknown é especificado.
    Enum: "real", "virtual", "unknown", "loyalty_point"

  - `order.id` (integer, required)
    Identificador exclusivo do pedido do usuário no lado da Xsolla.

  - `order.invoice_id` (string,null, required)
    ID da fatura de pagamentos em moeda real. Pagamentos em moedas virtuais ou itens grátis têm um valor null.

  - `order.mode` (string, required)
    Modalidade de pagamento. default é usado para pagamentos reais; sandbox para pagamentos de testes.
    Enum: "default", "sandbox"

  - `order.platform` (string,null, required)
    Plataforma de pagamento. O valor xsolla é usado para pagamentos via Xsolla. Para outros pagamentos, é utilizado o valor correspondente ao nome da plataforma de publicação de jogos.
    Enum: "xsolla", "playstation_network", "xbox_live", "pc_standalone", "nintendo_shop", "google_play", "app_store_ios", "android_standalone", "ios_standalone", "android_other", "ios_other", "pc_other"

  - `order.promocodes` (array)
    Códigos promocionais aplicados. Se o código promocional não for aplicado, a matriz não retornará.

  - `order.promocodes.code` (string)
    O código de um código promocional aplicado.

  - `order.promotions` (array, required)
    Promoções aplicadas para o pedido inteiro.
A matriz é retornada nos seguintes casos:
  - Uma promoção afeta o valor total da compra, como um código promocional com a configuração Desconto na compra.
  - Nenhum desconto é aplicado à compra, mas itens bônus são adicionados ao pedido. Nesse caso, os valores do custo com desconto ([amount_with_discount](/pt/webhooks/#operation/order-cancellation!path=order/promotions/amount_with_discount&t=request)) e sem desconto ([amount_without_discount](/pt/webhooks/#operation/order-cancellation!path=order/promotions/amount_without_discount&t=request)) são retornados e idênticos, já que nenhum desconto é aplicado.

Se nenhuma promoção de nível de pedido for aplicada, é retornada uma matriz vazia.

  - `order.promotions.amount_with_discount` (string)
    Custo total dos itens com desconto.

  - `order.promotions.amount_without_discount` (string)
    Custo total dos itens sem desconto.

  - `order.promotions.sequence` (integer)
    Ordem de aplicação de promoções.

  - `order.status` (string, required)
    Status do pedido.

  - `user` (object, required)
    Informações do usuário.

  - `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, required)
    Endereço de e-mail do usuário.

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


## Response 200 fields

## Response 400 fields