Cancelamento do pedido (sem detalhes de pagamento e transação)

Cancelamento do pedido (sem detalhes de pagamento e transação)Webhook POST

A Xsolla envia o webhook order_canceled para o URL especificado quando o pagamento é cancelado pelo usuário, parceiro ou automaticamente. O webhook contém informações sobre itens devolvidos e detalhes do pedido cancelado.

O webhook não é enviado se o pagamento não for bem-sucedido. Por exemplo:

o formulário da interface de pagamento foi aberto, mas o usuário não pagou pelo pedido.
o formulário da interface de pagamento foi aberto, mas houve erros durante o pagamento.

O tempo recomendado para processamento do webhook é de dentro de 3 segundos.

Request

Request Body schema: application/json

notification_type

required

string

Tipo de notificação.

required

Array of versão = 1 (object) or versão = 2 (object)

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.

Array

One of:

sku

required

string

ID do item único. Para itens com o tipo game_key, é usado um valor no formato sku_drm.

type

required

string

Tipo de item. Para itens do tipo bundle, incluindo pacotes de moeda virtual, a matriz items exibirá:

parâmetros do conjunto ou pacote de moeda virtual
itens incluídos no conjunto ou moedas incluídas no pacote.

O tipo value_point é usado em operações de pontos de fidelidade – quando pontos são gastos ou concedidos.

Enum: "virtual_good" "virtual_currency" "game_key" "bundle" "value_point"

quantity

required

integer

Quantidade de itens.

amount

required

string

Custo total dos itens com base na quantidade.

required

Array of objects

Promoções aplicadas para itens específicos no pedido. A matriz é retornada nos seguintes casos:

Uma promoção de desconto é configurada para um item específico.
Um código promocional com a configuração Desconto em itens selecionados é aplicado.

Se nenhuma promoção no nível de itens for aplicada, será retornada uma matriz vazia.

Array

amount_with_discount	string Custo total dos itens com desconto.
amount_without_discount	string Custo total dos itens sem desconto.
sequence	integer Ordem de aplicação de promoções.

is_pre_order

required

boolean

Se true, o item está em pré-venda.

custom_attributes

object

Um objeto JSON contendo atributos e valores de item.

required

object

Informações sobre o pedido.

required

integer

Identificador exclusivo do pedido do usuário no lado da Xsolla.

mode

required

string

Modalidade de pagamento. default é usado para pagamentos reais; sandbox para pagamentos de testes.

Enum: "default" "sandbox"

currency_type

required

string

Tipo de moeda de pagamento. Para pedidos gratuitos, o valor unknown é especificado.

Enum:	Description
loyalty_point	pontos de fidelidade
real	moeda real
unknown	pedido gratuito
virtual	moeda virtual

currency

required

string

Moeda de ordem. A moeda virtual usa o SKU e a moeda real usa um código ISO 4217 de três letras.

amount

required

string

O custo total de um carrinho com base na moeda escolhida.

status

required

string

Status do pedido.

platform

required

string or null

Plataforma de pagamento. O valor xsolla é usado para pagamentos via Xsolla. Para outros pagamentos, o valor correspondente ao nome da plataforma de publicação de jogos é usado: playstation_network, xbox_live, pc_standalone, nintendo_shop, google_play, app_store_ios, android_standalone, ios_standalone, android_other, ios_other, pc_other.

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"

comment

required

string or null

Comentário do usuário ao pedido.

invoice_id

required

string or null

ID da fatura de pagamentos em moeda real. Pagamentos em moedas virtuais ou itens grátis têm um valor null.

required

Array of objects

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) e sem desconto (amount_without_discount) 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.

Array

amount_with_discount	string Custo total dos itens com desconto.
amount_without_discount	string Custo total dos itens sem desconto.
sequence	integer Ordem de aplicação de promoções.

Array of objects

Cupons aplicados. Se o cupom não for aplicado, a matriz não retornará.

Array

code	string O código de um cupom aplicado.
external_id	string ID externo.

Array of objects

Códigos promocionais aplicados. Se o código promocional não for aplicado, a matriz não retornará.

Array

code	string O código de um código promocional aplicado.
external_id	string ID externo.

required

object

Informações do usuário.

external_id required	string ID de usuário.
email required	string Endereço de e-mail do 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.

custom_parameters

object

Informações adicionais.

Responses

200

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

Request samples

CURL
HTTP

curl -v 'https://your.hostname/your/uri' \
-X POST \
-H 'accept: application/json' \
-H 'content-type: application/json' \
-H 'authorization: Signature d09695066c52c1b8bdae92f2d6eb59f5b5f89843' \
-d '{
    "notification_type": "order_canceled",
    "items": [
      {
        "sku": "com.xsolla.v.item_1",
        "type": "virtual_good",
        "is_pre_order": false,
        "quantity": 3,
        "amount": "1000",
        "promotions": [
          {
            "amount_without_discount": "6000",
            "amount_with_discount": "5000",
            "sequence": 1
          },
          {
            "amount_without_discount": "5000",
            "amount_with_discount": "4000",
            "sequence": 2
          }
        ],
        "custom_attributes": {
            "purchased": 0,
            "attr": "value"
          }
      },
      {
        "sku": "com.xsolla.v.item_new_1",
        "type": "bundle",
        "is_pre_order": false,
        "quantity": 1,
        "amount": "1000",
        "promotions": []
      },
      {
        "sku": "com.xsolla.gold_1",
        "type": "virtual_currency",
        "is_pre_order": false,
        "quantity": 1500,
        "amount": "[null]",
        "promotions": []
      }
    ],
    "order": {
      "id": 1,
      "mode": "default",
      "currency_type": "virtual",
      "currency": "sku_currency",
      "amount": "2000",
      "status": "paid",
      "platform": "xsolla",
      "comment": null,
      "invoice_id": "1",
      "promotions": [
        {
          "amount_without_discount": "4000",
          "amount_with_discount": "2000",
          "sequence": 1
        }
      ],
      "promocodes": [
        {
          "code": "promocode_some_code",
          "external_id": "promocode_sku"
        }
      ],
      "coupons": [
        {
          "code": "WINTER2021",
          "external_id": "coupon_sku"
        }
      ]
    },
    "user": {
      "external_id": "id_xsolla_login_1",
      "email": "email@example.com",
      "country": "US"
    }

}'