# Pagamento

Quando um usuário completa um pagamento, a Xsolla envia os dados do pagamento 
em um webhook com o tipo payment ao URL do webhook.

Os códigos de resposta esperados estão descritos na seção Responses, mas 
você pode usar outros códigos de resposta também:


    
    
        Código de resposta
        Descrição
    
    
    
    
        200, 201, 204
        Uma resposta bem-sucedida.
    
    
        4xx
        Ocorreu um erro. Por exemplo, se o usuário especificado não foi encontrado ou uma assinatura inválida foi passada.
    
    
        5xx
        Erro temporário de servidor. Quando essa resposta é recebida, a Xsolla tentará reenviar o webhook automaticamente, gradualmente aumentando o intervalo entre as tentativas até que o ouvinte confirme o recebimento. A quantidade máxima de tentativas é de 12 reenvios ao longo de um período de 48 horas.
    
    


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 Settings > Webhooks > Testing > Payments > Advanced settings.




    
        Opção
        Descrição
    


    
        Exibir informações sobre a conta de pagamento salva
        As informações sobre a forma de pagamento salva são passadas no objeto personalizado payment_account.
    
    
        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
    
    
        Adicionar objeto de ordem ao webhook
        As informações sobre o pedido são passadas no objeto  order do webhook Pagamento.
    
    
        Enviar apenas os parâmetros de usuário necessários sem dados confidenciais
        Somente as seguintes informações sobre o usuário são passadas no webhook:IDpaís
    
    
        Exibir BIN e sufixo do cartão
        As seguintes informações sobre o número do cartão bancário são passadas no webhook:os primeiros 6 dígitos no parâmetro card_binos últimos 4 dígitos no card_suffix
    
    
        Exibir marca do cartão
        A bandeira do cartão utilizado para efetuar o pagamento. Por exemplo, Mastercard ou Visa.
    
    
        Mostrar o WHC do país e as taxas de aquisição de usuários.
        Os objetos payment_details.​country_wht e payment_details.​user_acquisition_fee serão passados no webhook. Essa opção fica ativada por padrão.
    
    
        Enviar informações da 3DS.
        O objeto cards contendo dados sobre a verificação 3-D Secure será passado no webhook.
    




Aviso
O conjunto de campos enviados em um webhook depende de:as configurações avançadas definidas na Conta de Distribuidoras configurações personalizadas definidas no lado da XsollaSe tiver alguma dúvida, entre em contato com seu Gerente de Sucesso do Cliente ou envie um e-mail para csm@xsolla.com.

Endpoint: POST payment
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.coupon` (object)
    Dados do cupom (objeto; se um cupom foi usado ao criar a assinatura).

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

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

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

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

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

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

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

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

  - `purchase.order` (object)
    Objeto que contém informações sobre um pedido. Para receber essas informações, defina a opção Adicionar objeto do pedido ao webhook como On na [Conta de Distribuidor](https://publisher.xsolla.com/) na seção Project settings > Webhooks > Advanced settings.

  - `purchase.order.id` (integer)
    ID do pedido.

  - `purchase.order.lineitems` (array)
    Matriz de parâmetros que contém informações sobre os itens.

  - `purchase.order.lineitems.price` (object)
    Objeto que contém informações sobre um preço de item.

  - `purchase.order.lineitems.price.amount` (number)
    Preço total do item na moeda selecionada.

  - `purchase.order.lineitems.price.currency` (string)
    Moeda do preço do item.

  - `purchase.order.lineitems.quantity` (integer)
    Quantidade do item.

  - `purchase.order.lineitems.sku` (string)
    SKU do item.

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

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

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

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

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

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

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

  - `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 de transação externo. Consulte o [FAQs](/pt/doc/pay-station/references/faq/#faq_payments_q_new_transaction_external_id) para saber mais.

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

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

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

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

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