Esta é a interface usada para
microtransações (compras em jogos).
Consulte o
Guia de implementação de microtransações para mais detalhes.
Para mais informações sobre como usar a Web API do Steamworks, consulte:
Web API Overview.
AdjustAgreement
POST https://partner.steam-api.com/ISteamMicroTxn/AdjustAgreement/v1/
Nome | Tipo | Obrigatório? | Descrição |
key | string | ✔ | Chave de autenticação da editora para a Web API do Steamworks. |
steamid | uint64 | ✔ | O SteamID do cliente que está a ajustar o acordo. |
agreementid | uint64 | ✔ | O ID único de 64 bits do acordo de cobrança do Steam. |
appid | uint32 | ✔ | O AppID do jogo a que o acordo se destina. |
nextprocessdate | string | ✔ | A data em que o próximo pagamento recorrente deve ser iniciado. O formato é AAAAMMDD. A data só pode ser ajustada para o futuro, indicando que pretende adicionar tempo à assinatura. Se a data exceder a data final da assinatura, esta será prolongada. |
oldnextprocessdate | string | | Parâmetro opcional, para fins de verificação, destinado à última data conhecida em que o próximo pagamento recorrente deve ser iniciado. O formato é AAAAMMDD. Se este parâmetro for fornecido, a API irá confirmar que a data do próximo pagamento recorrente não foi alterada antes de tentar ajustar as alterações do próximo processo ao acordo. |
Adiciona tempo ao ciclo de pagamentos de um acordo com o tipo de cobrança "steam". O "agreementid" pode ser recuperado ao usar
GetUserAgreementInfo.
ATENÇÃO: este método requer uma chave de API da editora. Por isso, esta API
TEM DE SER chamada a partir de um servidor seguro e nunca deverá ser usada diretamente por clientes!
Resposta: -
response
-
result
– O resultado da operação (OK ou Failure).
-
params
-
agreementid
– O ID único de 64 bits do acordo de cobrança do Steam.
-
nextprocessdate
– A data em que o próximo pagamento recorrente será iniciado. O formato é AAAAMMDD.
-
error
– Opcional, só é retornado se o valor de "result" for Failure.
CancelAgreement
POST https://partner.steam-api.com/ISteamMicroTxn/CancelAgreement/v1/
Nome | Tipo | Obrigatório? | Descrição |
key | string | ✔ | Chave de autenticação da editora para a Web API do Steamworks. |
steamid | uint64 | ✔ | O SteamID do cliente que está a cancelar o acordo. |
agreementid | uint64 | ✔ | O ID único de 64 bits do acordo de cobrança do Steam. |
appid | uint32 | ✔ | O AppID do jogo a que o acordo se destina. |
Cancela um acordo de cobrança recorrente (assinatura). O "agreementid" pode ser recuperado ao usar
GetUserAgreementInfo.
ATENÇÃO: este método requer uma chave de API da editora. Por isso, esta API
TEM DE SER chamada a partir de um servidor seguro e nunca deverá ser usada diretamente por clientes!
Resposta: -
response
-
result
– O resultado da operação (OK ou Failure).
-
params
-
agreementid
– O ID único de 64 bits do acordo de cobrança do Steam.
-
error
– Opcional, só é retornado se o valor de "result" for Failure.
FinalizeTxn
POST https://partner.steam-api.com/ISteamMicroTxn/FinalizeTxn/v2/
Nome | Tipo | Obrigatório? | Descrição |
key | string | ✔ | Chave de autenticação da editora para a Web API do Steamworks. |
orderid | uint64 | ✔ | O ID único de 64 bits do pedido de compra. |
appid | uint32 | ✔ | O AppID do jogo. |
Finaliza uma compra iniciada pela API
InitTxn.
Este comando captura fundos para uma transação e só deve ser chamado após o utilizador autorizar a transação e você receber a notificação de que a autorização foi bem-sucedida. A notificação da autorização é enviada pela aplicação Steam (o seu jogo regista-se para receber a notificação) ou pelo redirecionamento do utilizador ao seu site (o URL de retorno especificado quando redireciona a sessão web de um utilizador ao Steam). O valor de "usersession" especificado em InitTxn determina o mecanismo de notificação.
Uma resposta bem-sucedida a este comando significa que o pagamento foi concluído e pode conceder os itens ao utilizador com segurança. Na eventualidade de tempo limite excedido ou outro erro de comunicação, use as APIs
QueryTxn ou
GetReport para obter o estado da transação.
Este método tem versões antigas que já não são suportadas oficialmente. Ainda podem ser usadas, mas recomendamos vivamente que use a versão mais recente.
Histórico de alterações:
- Versão 2 – Principal mudança: alteração para números de 64 bits formatados em strings.
ATENÇÃO: este método requer uma chave de API da editora. Por isso, esta API
TEM DE SER chamada a partir de um servidor seguro e nunca deverá ser usada diretamente por clientes!
Resposta: -
response
-
result
– O resultado da operação (OK ou Failure).
-
params
-
orderid
– O ID único de 64 bits do pedido de compra.
-
transid
– O ID único de 64 bits da transação do Steam.
-
error
– Opcional, só é retornado se o valor de "result" for Failure.
Exemplo de resposta:<response>
<result>OK</result>
<params>
<orderid>938473</orderid>
<transid>374839</transid>
</params>
</response>
GetReport
GET https://partner.steam-api.com/ISteamMicroTxn/GetReport/v5/
Nome | Tipo | Obrigatório? | Descrição |
key | string | ✔ | Chave de autenticação da editora para a Web API do Steamworks. |
appid | uint32 | ✔ | O AppID do jogo cujos relatórios obter. |
type | string | | Tipo do relatório (valores possíveis: "GAMESALES", "STEAMSTORESALES", "SETTLEMENT", "CHARGEBACK") |
time | string | ✔ | A data e hora de início dos relatórios (no formato RFC 3339 UTC: 2010-01-01T00:00:00Z). |
maxresults | uint32 | | O número máximo de resultados (relatórios) a retornar (se nenhum valor for definido, será usado o valor 1000). Tenha em atenção que o número de resultados retornados poderá ser inferior a maxresults, mesmo se existirem mais. |
O Steam oferece relatórios de transações que podem ser transferidos para fins de reconciliação. Estes relatórios incluem informações detalhadas sobre cada transação que afetam a liquidação dos fundos nas suas contas.
ATENÇÃO: este método requer uma chave de API da editora. Por isso, esta API
TEM DE SER chamada a partir de um servidor seguro e nunca deverá ser usada diretamente por clientes!
ATENÇÃO: este método tem versões antigas que já não são suportadas oficialmente. Ainda podem ser usadas, mas recomendamos vivamente que use a versão mais recente. Histórico de alterações:
- Versão 2 – Principal mudança: alteração do resultado para retornar arrays.
- Versão 3 – Principal mudança: alteração para números de 64 bits formatados em strings.
- Versão 4 – Foi adicionada a secção
storepurchasereference
para retornar dados de vendas relacionadas com DLCs vendidos na loja que referenciam itens de microtransações.
- Versão 5 – Foram adicionados novos valores de estado de transação para indicar suspeita de fraude ou estorno fraudulento.
Resposta: -
response
-
result
– O resultado da operação (OK ou Failure).
-
params
-
timecreated
– A data e hora da transação (no formato RFC 3339 UTC: 2010-01-01T00:00:00Z).
-
orderid
– O ID único de 64 bits do pedido de compra. (Será 0 para assinaturas recorrentes iniciadas pela Loja Steam. Use transid
para isso.)
-
transid
– O ID único de 64 bits da transação do Steam.
-
steamid
– O SteamID do utilizador ao qual o pedido de compra/transação pertence.
-
status
– O estado do pedido de compra. Consulte: Anexo A: Valores referentes ao estado
-
currency
– O código ISO 4217 da moeda usada.
-
time
– A data e hora da atualização mais recente à transação (no formato RFC 3339 UTC: 2010-01-01T00:00:00Z).
-
country
– O código ISO 3166-1-alpha-2 do país.
-
usstate
– Estado norte-americano. Vazio se o valor de "country" não for "US".
-
items
-
itemid
– O número ID do item no jogo.
-
qty
– A quantidade do item.
-
amount
– O custo total para o utilizador, sem IVA (em cêntimos). Por exemplo, 199 para uma compra de 1,99 €.
-
vat
– O valor total do IVA ou impostos (em cêntimos). Por exemplo, 19 para um valor de 0,19 €.
-
itemstatus
– O estado dos itens contidos no pedido de compra.
-
storepurchasereference
– Opcional, só é retornado se a compra foi realizada através de um DLC na loja associado a um ID de item de microtransação do jogo:
-
packageid
– O pacote de DLC comprado na loja.
-
bundleid
– O ID do conjunto associado ao pacote do DLC, caso aplicável.
-
referenceid
– O ID de referência gerado pelo Steam do item associado ao pacote.
-
amount
– O preço pago pelo utilizador.
-
vat
– O valor do IVA, caso se aplique à compra.
-
currency
– A moeda usada para realizar a compra.
-
error
– Opcional, só é retornado se o valor de "result" for Failure.
Exemplo de resposta:{
"response": {
"result": "OK",
"params": {
"count": 4,
"orders": [
{
"orderid": "1233",
"transid": "1234567890123456788",
"steamid": "76561197972751825",
"status": "PartialRefund",
"currency": "USD",
"time": "2024-01-23T18:30:00Z",
"country": "US",
"usstate": "WA",
"timecreated": "2024-01-23T18:15:00Z",
"items": [
{
"itemid": 100,
"qty": 1,
"amount": 99,
"vat": 9,
"itemstatus": "Refunded"
},
{
"itemid": 101,
"qty": 1,
"amount": 1299,
"vat": 116,
"itemstatus": "Succeeded"
}
]
},
{
"orderid": "1234",
"transid": "1234567890123456789",
"steamid": "76561197972751825",
"status": "Failed",
"currency": "USD",
"time": "2024-01-23T18:40:30Z",
"country": "US",
"usstate": "WA",
"timecreated": "2024-01-23T18:39:00Z",
"items": [
{
"itemid": 100,
"qty": 1,
"amount": 99,
"vat": 9,
"itemstatus": "Failed"
}
]
},
{
"orderid": "1235",
"transid": "1234567890123456790",
"steamid": "76561197972751825",
"status": "Succeeded",
"currency": "USD",
"time": "2024-01-23T18:40:40Z",
"country": "US",
"usstate": "WA",
"timecreated": "2024-01-23T18:39:30Z",
"items": [
{
"itemid": 101,
"qty": 1,
"amount": 1299,
"vat": 116,
"itemstatus": "Succeeded"
}
]
},
{
"orderid": "1236",
"transid": "1234567890123456791",
"steamid": "76561197972751825",
"status": "Chargedback",
"currency": "USD",
"time": "2024-01-23T19:55:00Z",
"country": "US",
"usstate": "WA",
"timecreated": "2024-01-23T18:40:00Z",
"items": [
{
"itemid": 102,
"qty": 1,
"amount": 999,
"vat": 89,
"itemstatus": "Chargedback"
}
]
}
]
}
}
}
GetUserAgreementInfo
GET https://partner.steam-api.com/ISteamMicroTxn/GetUserAgreementInfo/v2/
Nome | Tipo | Obrigatório? | Descrição |
key | string | ✔ | Chave de autenticação da editora para a Web API do Steamworks. |
steamid | uint64 | ✔ | O SteamID do cliente. |
appid | uint32 | ✔ | O AppID do jogo a que o acordo se destina. |
Obtém informações detalhadas sobre todos os acordos de cobrança recorrente (assinaturas) associados a um utilizador.
ATENÇÃO: este método requer uma chave de API da editora. Por isso, esta API
TEM DE SER chamada a partir de um servidor seguro e nunca deverá ser usada diretamente por clientes!
Versão 2 – O valor "status" pode estar "em processamento" caso o Steam ainda não tenha cobrado o valor do acordo do utilizador. Antes, o valor "status" seria "ativo".
Resposta: -
response
-
result
– O resultado da operação (OK ou Failure).
-
params
-
agreements
-
agreement
-
agreementid
– O ID único de 64 bits do acordo de cobrança do Steam.
-
itemid
– O número ID do item no jogo.
-
status
– Ativo, cancelado ou em processamento.
-
period
– O período do acordo.
-
frequency
– O intervalo do período.
-
startdate
– A data de início do processamento de pagamentos recorrentes. O formato é AAAAMMDD.
-
enddate
– A data de conclusão do processamento de pagamentos recorrentes. O formato é AAAAMMDD.
-
recurringamt
– O valor que será cobrado (em cêntimos) a cada intervalo recorrente.
-
currency
– O código ISO 4217 da moeda usada no preço.
-
timecreated
– A data em que o acordo foi criado, no formato AAAAMMDD.
-
lastpayment
– A data do último pagamento bem-sucedido, no formato AAAAMMDD.
-
lastamount
– O valor do último pagamento bem-sucedido, em cêntimos.
-
nextpayment
– A data do próximo pagamento agendado, no formato AAAAMMDD.
-
outstanding
– O saldo pendente no momento, em cêntimos.
-
failedattempts
– O número de tentativas de cobrança do saldo pendente que foram malsucedidas.
-
error
– Opcional, só é retornado se o valor de "result" for Failure.
GetUserInfo
GET https://partner.steam-api.com/ISteamMicroTxn/GetUserInfo/v2/
Nome | Tipo | Obrigatório? | Descrição |
key | string | ✔ | Chave de autenticação da editora para a Web API do Steamworks. |
appid | uint32 | ✔ | O AppID do jogo no qual o utilizador irá efetuar uma compra. |
steamid | uint64 | | O SteamID do utilizador que pretende efetuar a compra. |
ipaddress | string | | String com o endereço IP do utilizador, no formato xxx.xxx.xxx.xxx. Só obrigatório se o valor de usersession em InitTxn for web. |
Obtém os detalhes dos dados de compras de um utilizador.
Estes detalhes baseiam-se na Carteira Steam do utilizador.
No caso de contas novas ou que ainda não tenham uma Carteira Steam, os dados retornados irão basear-se no endereço IP do utilizador. O endereço IP será obtido da sessão da aplicação Steam do utilizador se estiver com sessão iniciada. Caso contrário, será obtido do parâmetro "ipaddress". Se o utilizador não tiver uma Carteira Steam, não iniciou a sessão pela aplicação Steam e se não foi fornecido um endereço IP, esta chamada irá retornar um erro a indicar que o utilizador não tem sessão iniciada.
Este método tem versões antigas que já não são suportadas oficialmente. Ainda podem ser usadas, mas recomendamos vivamente que use a versão mais recente.
Histórico de alterações:
- Versão 2 – Principal mudança: alteração para números de 64 bits formatados em strings.
ATENÇÃO: este método requer uma chave de API da editora. Por isso, esta API
TEM DE SER chamada a partir de um servidor seguro e nunca deverá ser usada diretamente por clientes!
Resposta: -
response
-
result
– O resultado da operação (OK ou Failure).
-
params
-
state
– Estado norte-americano. Vazio se o valor de "country" não for "US".
-
country
– O código ISO 3166-1-alpha-2 do país.
-
currency
– O código ISO 4217 da moeda usada no preço.
-
status
– O estado da conta. Valores possíveis:
• Locked from purchasing – Impedida de efetuar compras.
• Active – Ativa. O estado predefinido de uma conta.
• Trusted – Confiável. Uma conta ativa com uma compra efetuada há mais de 90 dias, sem estornos.
-
error
– Opcional, só é retornado se o valor de "result" for Failure.
Exemplo de resposta:<response>
<result>OK</result>
<params>
<state>WA</state>
<country>US</country>
<currency>USD</currency>
</params>
</response>
InitTxn
POST https://partner.steam-api.com/ISteamMicroTxn/InitTxn/v3/
Nome | Tipo | Obrigatório? | Descrição |
key | string | ✔ | Chave de autenticação da editora para a Web API do Steamworks. |
orderid | uint64 | ✔ | O ID único de 64 bits do pedido de compra. |
steamid | uint64 | ✔ | O SteamID do utilizador que pretende efetuar a compra. |
appid | uint32 | ✔ | O AppID do jogo associado a esta transação. |
itemcount | uint32 | ✔ | O número de itens no carrinho. |
language | string | ✔ | O código ISO 639-1 do idioma das descrições dos itens. Só funciona com os 28 idiomas totalmente disponíveis no Steam. Consulte a lista de idiomas. |
currency | string | ✔ | O código ISO 4217 da moeda usada. Consulte Moedas disponíveis para saber como formatar cada moeda devidamente. |
usersession | string | | A sessão na qual o utilizador irá autorizar a transação. Opções válidas: "client" ou "web". Se este parâmetro não for fornecido, será assumido que a interface seja através de uma sessão iniciada na aplicação Steam. |
ipaddress | string | | String com o endereço IP do utilizador, no formato xxx.xxx.xxx.xxx. Só obrigatório se o valor de [param]usersession[/param] for web. |
itemid[0] | uint32 | ✔ | O ID do item definido pelo jogo. |
qty[0] | int16 | ✔ | A quantidade deste item. |
amount[0] | int64 | ✔ | O custo total (em cêntimos) dos itens a ser cobrado neste momento. Consulte Moedas disponíveis para saber como formatar cada quantia devidamente. Tenha em atenção que a quantia passada deve estar num formato que corresponda ao código de moeda passado em "currency". |
description[0] | string | ✔ | A descrição do item. Tamanho máximo de 128 caracteres. |
category[0] | string | | (Opcional) Uma descrição por texto de uma categoria para agrupamento deste item. Este valor é usado para agrupar dados de vendas nos relatórios do Steam e nunca aparece para utilizadores. 64 caracteres no máximo. |
associated_bundle[0] | uint32 | | (Opcional) O ID do conjunto associado. |
billingtype[0] | string | | (Opcional) O tipo de cobrança recorrente. Opções válidas: "Steam" ou "Game".
- Steam: o Steam volta a realizar a cobrança automaticamente.
- Game: o parceiro precisa de chamar a API ProcessAgreement para realizar a cobrança.
|
startdate[0] | string | | (Opcional) Data de início da cobrança recorrente (no formato RFC 3339 UTC: 2010-01-01T00:00:00Z). |
enddate[0] | string | | (Opcional) Data de conclusão da cobrança recorrente (no formato RFC 3339 UTC: 2010-01-01T00:00:00Z). |
period[0] | string | | (Opcional) O período da cobrança recorrente. Opções válidas: "Day", "Week" (semana), "Month" (mês), "Year" (ano). |
frequency[0] | uint32 | | (Opcional) A frequência de cobrança recorrente (em dias). Valores permitidos: 1 – 255 |
recurringamt[0] | int64 | | (Opcional) A quantia a ser cobrada para transações futuras de cobranças recorrentes. |
bundlecount | uint32 | | O número de conjuntos no carrinho. |
bundleid[0] | uint32 | | O ID do conjunto definido pelo jogo. Usa o mesmo espaço de IDs de itens de terceiros. |
bundle_qty[0] | uint32 | | A quantidade de conjuntos deste tipo. |
bundle_desc[0] | string | | A descrição do conjunto. 128 caracteres no máximo. |
bundle_category[0] | string | | (Opcional) Uma descrição por texto de uma categoria de conjunto para agrupamento deste item. Este valor é usado para agrupar dados de vendas nos relatórios do Steam e nunca aparece para utilizadores. Tamanho máximo de 64 caracteres. |
Cria uma compra nova. Envia os dados do pedido de compra com o SteamID para gerar a transação no Steam.
Este comando permite-lhe criar um carrinho de compras, com um ou mais itens, para um utilizador. O preço e as descrições destes itens irão aparecer para aprovação do utilizador. A interface de compra pode ser configurada pela aplicação Steam ou por um browser da web, dependendo de se a compra estiver a ser realizada dentro do jogo ou numa página web.
Formatação de moedas e quantias
Tenha em atenção que certas moedas devem ser cobradas em incrementos específicos. Por exemplo, a grívnia ucraniana (UAH) deve ser cobrada em incrementos de 100. Logo, se tentar vender um item a 1050 UAH, InitTxn vai falhar, com o erro k_EMicroTxnResultInvalidParam. Para uma lista completa de requisitos de preços, consulte
Moedas disponíveis.
Se não quiser definir preços na moeda local do utilizador para cada transação, o Steam pode converter qualquer compra na moeda da Carteira Steam do utilizador automaticamente com base na taxa de câmbio atual. Por exemplo, se o valor de
currency
for "USD" e o de
amount
for "999", um utilizador na Rússia será cobrado em rublos na taxa de câmbio atual para 9,99 $, ou seja, 614,90 pуб no momento em que a versão original deste artigo foi escrita. Porém, tenha em mente que a janela de confirmação da transação exibida aos utilizadores irá mostrar o preço e a moeda que especificou; a conversão será realizada durante a finalização da transação. No exemplo acima, utilizadores na Rússia iriam ver um preço de 9,99 $ na janela de confirmação, mas seriam cobrados 614,90 pуб quando a transação fosse finalizada. Recomendamos que defina preços personalizados para cada uma das moedas que espera serem usadas regularmente pelos utilizadores em transações.
Tenha em atenção que o valor de
amount
precisa de estar num formato que corresponda ao parâmetro
currency
.
Uma resposta bem-sucedida a este comando significa que a transação foi criada. Se a interface da compra for a aplicação Steam, será apresentada automaticamente ao utilizador uma janela de autorização a pedir aprovação. Para uma interface web, redirecione o utilizador para o URL do Steam retornado na resposta. Na eventualidade de tempo limite excedido ou outro erro de comunicação, abandone a transação e crie uma nova.
Quando uma sessão "client" for indicada por [param]usersession[/param], o utilizador será obrigado a aprovar a transação pelo Painel Steam sobreposto no jogo. Sessões web vão obrigar o utilizador a ter sessão iniciada no Steam pelo browser, onde a transação será apresentada com uma opção para a aprovar.
Este método tem versões antigas que já não são suportadas oficialmente. Ainda podem ser usadas, mas recomendamos vivamente que use a versão mais recente.
Histórico de alterações:
- Versão 2 – Principal mudança: alteração para números de 64 bits formatados em strings.
Este método tem versões antigas que já não são suportadas oficialmente. Ainda podem ser usadas, mas recomendamos vivamente que use a versão mais recente.
Histórico de alterações:
- Versão 3 – Principal mudança: alteração de valores de quantidades para serem sempre um número de 16 bits.
ATENÇÃO: este método requer uma chave de API da editora. Por isso, esta API
TEM DE SER chamada a partir de um servidor seguro e nunca deverá ser usada diretamente por clientes!
Resposta: -
response
-
result
– O resultado da operação (OK ou Failure).
-
params
-
orderid
– O ID único de 64 bits do pedido de compra.
-
transid
– O ID único de 64 bits da transação do Steam.
-
steamurl
– (Opcional) O URL retornado quando o valor de "usersession" for web. Este URL pode ser usado para redirecionar a sessão web do utilizador para o Steam, de modo que possa aprovar a transação.
-
agreements
– (Opcional) Lista de acordos quando o tipo de cobrança é recorrente.
-
error
– Opcional, só é retornado se o valor de "result" for Failure.
Exemplo de resposta:<response>
<result>OK</result>
<params>
<orderid>938473</orderid>
<transid>374839</transid>
</params>
</response>
<response>
<result>Failure</result>
<params>
<orderid>938474</orderid>
</params>
<error>
<errorcode>1001</errorcode>
<errordesc>Action not allowed</errordesc>
</error>
</response>
ProcessAgreement
POST https://partner.steam-api.com/ISteamMicroTxn/ProcessAgreement/v1/
Nome | Tipo | Obrigatório? | Descrição |
key | string | ✔ | Chave de autenticação da editora para a Web API do Steamworks. |
orderid | uint64 | ✔ | O ID único de 64 bits do pedido de compra. Se a assinatura recorrente foi iniciada a partir da Loja Steam, este valor será 0. |
steamid | uint64 | ✔ | O SteamID do cliente. |
agreementid | uint64 | ✔ | O ID único de 64 bits do acordo de cobrança do Steam. |
appid | uint32 | ✔ | O AppID do jogo associado ao acordo. |
amount | int32 | ✔ | O preço total (em cêntimos).
Este valor corresponde a uma quantia inicial que será cobrada uma única vez, de imediato. |
currency | string | ✔ | O código ISO 4217 da moeda usada no preço. |
Inicia um pagamento recorrente (assinatura) para o utilizador.
Uma resposta bem-sucedida significa que o Steam vai iniciar um ciclo de cobrança para o utilizador. Não significa que o ciclo de cobrança tenha sido concluído com sucesso. Use as APIs
GetReport ou
GetUserAgreementInfo para verificar o estado da cobrança.
ATENÇÃO: este método requer uma chave de API da editora. Por isso, esta API
TEM DE SER chamada a partir de um servidor seguro e nunca deverá ser usada diretamente por clientes!
Resposta: -
response
-
result
– O resultado da operação (OK ou Failure).
-
params
-
orderid
– O ID único de 64 bits do pedido de compra.
-
transid
– O ID único de 64 bits da transação do Steam.
-
agreementid
– O ID único de 64 bits do acordo de cobrança do Steam.
-
error
– Opcional, só é retornado se o valor de "result" for Failure.
QueryTxn
GET https://partner.steam-api.com/ISteamMicroTxn/QueryTxn/v3/
Nome | Tipo | Obrigatório? | Descrição |
key | string | ✔ | Chave de autenticação da editora para a Web API do Steamworks. |
appid | uint32 | ✔ | O AppID do jogo associado a esta transação. |
orderid | uint64 | | O ID único de 64 bits do pedido de compra. |
transid | uint64 | | O ID único de 64 bits da transação do Steam. |
Consulta o estado de um pedido de compra criado anteriormente por
InitTxn.
Este método tem versões antigas que já não são suportadas oficialmente. Ainda podem ser usadas, mas recomendamos vivamente que use a versão mais recente.
Histórico de alterações:
- Versão 2 – Principal mudança: alteração para números de 64 bits formatados em strings.
- Versão 3 – Foram adicionados novos valores de estado de transação para indicar suspeita de fraude ou estorno fraudulento.
ATENÇÃO: este método requer uma chave de API da editora. Por isso, esta API
TEM DE SER chamada a partir de um servidor seguro e nunca deverá ser usada diretamente por clientes!
Resposta: -
response
-
result
– O resultado da operação (OK ou Failure).
-
params
-
orderid
– O ID único de 64 bits do pedido de compra.
-
transid
– O ID único de 64 bits da transação do Steam.
-
steamid
– O SteamID do utilizador ao qual o pedido de compra/transação pertence.
-
status
– O estado do pedido de compra. Consulte: Anexo A: Valores referentes ao estado
-
currency
– O código ISO 4217 da moeda usada.
-
time
– A data e hora da transação (no formato RFC 3339 UTC: 2010-01-01T00:00:00Z).
-
country
– O código ISO 3166-1-alpha-2 do país.
-
usstate
– Estado norte-americano. Vazio se o país for outro.
-
items
-
itemid
– O número ID do item no jogo.
-
qty
– A quantidade do item.
-
amount
– O custo total para o utilizador, sem IVA (em cêntimos). Por exemplo, 199 para uma compra de 1,99 €.
-
vat
– O valor total do IVA ou impostos (em cêntimos). Por exemplo, 19 para um valor de 0,19 €.
-
itemstatus
– O estado dos itens contidos no pedido de compra.
-
error
– Opcional, só é retornado se o valor de "result" for Failure.
Exemplo de resposta:<response>
<result>OK</result>
<params>
<orderid>938474</orderid>
<transid>374839</transid>
<steamid>48392063</steamid>
<status>Succeeded</status>
<currency>GBP</currency>
<time>2010-01-01T00:23:45Z</time>
<items>
<item>
<itemid>12345</itemid>
<qty>1</qty>
<amount>199</amount>
<vat>38</vat>
<itemstatus>Succeeded</itemstatus>
</item>
<item>
<itemid>12345</itemid>
<qty>1</qty>
<amount>199</amount>
<vat>38</vat>
<itemstatus>Succeeded</itemstatus>
</item>
</items>
</params>
</response>
RefundTxn
POST https://partner.steam-api.com/ISteamMicroTxn/RefundTxn/v2/
Nome | Tipo | Obrigatório? | Descrição |
key | string | ✔ | Chave de autenticação da editora para a Web API do Steamworks. |
orderid | uint64 | ✔ | O ID único de 64 bits do pedido de compra a reembolsar. |
appid | uint32 | ✔ | O AppID do jogo. |
Informa o Steam de que um utilizador deve ser reembolsado por uma compra. Só é possível reembolsar o valor total do pedido de compra original.
Este método tem versões antigas que já não são suportadas oficialmente. Ainda podem ser usadas, mas recomendamos vivamente que use a versão mais recente.
Histórico de alterações:
- Versão 2 – Principal mudança: alteração para números de 64 bits formatados em strings.
ATENÇÃO: este método requer uma chave de API da editora. Por isso, esta API
TEM DE SER chamada a partir de um servidor seguro e nunca deverá ser usada diretamente por clientes!
Resposta: -
response
-
result
– O resultado da operação (OK ou Failure).
-
params
-
orderid
– O ID único de 64 bits do pedido de compra.
-
transid
– O ID único de 64 bits da transação do Steam.
-
error
– Opcional, só é retornado se o valor de "result" for Failure.
Exemplo de resposta:<response>
<result>OK</result>
<params>
<orderid>938474</orderid>
<transid>374839</transid>
</params>
</response>