Encontrar transações

Encontrar transaçõesServer-sideAdmin

get/merchants/{merchant_id}/reports/transactions/search.{format}

Retorna uma lista de transações com base nos parâmetros de busca específicos. Em resposta, você obtém dados sobre todos os pagamentos feitos no seu jogo, mesmo que eles não tenham sido concluídos com sucesso. Você pode especificar não só o período de transação como também outros parâmetros. Exemplo: pesquisar por transações feitas por um usuário em particular ou com um status de pagamento específico. Você pode obter a lista no formato JSON ou CSV.

Aviso

Esta chamada de API não contém o trajeto-parâmetro project_id, então é preciso usar a chave API que for válida em todos os projetos da empresa para configurar a autorização.

SecuritybasicAuth

Request

path Parameters

merchant_id required	integer ID de comerciante.
format required	string Formato da data. Enum: "json" "csv" "xls"

query Parameters

datetime_from

string <datetime>

Início do período.

datetime_to

string <datetime>

Fim do período.

project_id

integer

ID do projeto.

transaction_id

integer

ID da transação.

type

string

Tipos de transações exibidas nos resultados da pesquisa.

Enum:	Description
all	Todas as transações.
canceled	Transações canceladas, excluindo transações de teste.
test	Transações de teste.
transferred	Transações bem-sucedidas, excluindo transações de teste.

phone

string

Número de telefone no formato internacional.

user_id

string

ID de usuário único no jogo armazenado do seu lado. Certifique-se de passar o ID de usuário existente. Em caso de erro, consulte às respostas às Perguntas Frequentes (FAQ).

user_name

string

Nome de usuário.

user_custom

string

Parâmetro personalizado para a identificação do usuário.

string <= 100 characters

E-mail do usuário.

external_id

string

ID de transação no jogo. Precisa ser único para cada pagamento de um usuário.

offset

integer

Número do elemento a partir do qual a lista é gerada (a quantidade começa a partir de 0).

limit

integer

Limite da quantidade de elementos na página.

status

string

Um status de transação.

Enum:	Description
awaitingRefund	A transação está aguardando a decisão sobre um reembolso. Depois que o usuário solicita um reembolso, o suporte ao cliente Xsolla processa a solicitação manualmente e toma uma decisão sobre o reembolso.
canceled	Há dois cenários possíveis: A transação foi cancelada no lado do sistema de pagamento. Por exemplo, houve fundos insuficientes na conta do usuário. O pagamento foi reembolsado ao usuário.
created	O usuário iniciou a transação mas ela ainda não foi processada.
done	A transação foi processada com sucesso.
error	Ocorreu um erro durante o processamento da transação. Tais pagamentos podem ser reembolsados contatando o suporte ao cliente Xsolla.
partiallyRefunded	O usuário recebeu um reembolso parcial.
processing	A transação está sendo processada.
refunded	Um reembolso foi feito ao saldo Xsolla do usuário.
review	O processamento da transação foi suspenso pelo sistema antifraude e a transação está atualmente sob verificação adicional.

Responses

200

OK.

Request samples

Response samples

application/json

[{"payment_details": {"payment": {"amount": 7.96,
"amount_from_ps": 7.96,
"currency": "RUB"
},
"sales_tax": {"amount": 0,
"percent": 0
}
},
"payment_system": {"decline_reason": null
},
"purchase": {"pin_codes": {"amount": null,
"content": null,
"currency": null
},
"simple_checkout": {"amount": 7.96,
"currency": "RUB"
},
"subscription": {"name": null
},
"virtual_currency": {"amount": 0,
"name": null
},
"virtual_items": null
},
"transaction": {"create_date": "2021-10-20",
"dry_run": 0,
"external_id": "example-external-id",
"id": 123456789,
"is_refund_allowed": 0,
"payment_method": {"id": 1,
"name": "PayPal"
},
"project": {"id": 123456,
"name": "Example"
},
"refund_reason": null,
"status": "done",
"transfer_date": "2021-10-20"
},
"user": {"country": "RU",
"custom": null,
"email": "email@example.com",
"id": "example-id",
"name": "Example",
"phone": null
}
}
]