Rechercher des transactions

Rechercher des transactionsServer-sideAdmin

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

Renvoie une liste de transactions selon des critères de recherche spécifiques. Vous recevrez des données sur tous les paiements dans votre jeu, y compris ceux échoués. Vous pouvez définir la période de transaction et d'autres critères de recherche, comme un utilisateur particulier ou le statut de paiement. La liste est fournie au format JSON ou CSV.

Remarque

Cet appel API ne contient pas le paramètre de chemin project_id, vous devez donc utiliser la clé API valide dans tous les projets de l'entreprise pour l'autorisation.

SecuritybasicAuth

Request

path Parameters

merchant_id required	integer ID de commerçant.
format required	string Format de données. Enum: "json" "csv" "xls"

query Parameters

datetime_from

string <datetime>

Début de la période.

datetime_to

string <datetime>

Fin de la période.

project_id

integer

ID de projet.

transaction_id

integer

ID de transaction.

type

string

Type de transactions affichées dans les résultats de la recherche :

Enum:	Description
all	Toutes les transactions.
canceled	Transactions annulées, à l'exclusion des transactions test.
test	Transactions test.
transferred	Transactions réussies, à l'exclusion des transactions test.

phone

string

Numéro de téléphone au format international.

user_id

string

ID utilisateur unique dans le jeu stocké de votre côté. Assurez-vous de passer l'ID existant. En cas d'erreur, consultez les réponses de la FAQ.

user_name

string

Nom d'utilisateur.

user_custom

string

Paramètre personnalisé pour l'identification utilisateur.

string <= 100 characters

Adresse e-mail de l'utilisateur.

external_id

string

ID de transaction dans le jeu. Il doit être unique pour chaque paiement d'utilisateur.

offset

integer

Numéro de l'élément à partir duquel la liste est générée (le décompte commence à 0).

limit

integer

Nombre maximal d'éléments sur une page.

status

string

Statut de la transaction.

Enum:	Description
awaitingRefund	La transaction est en attente d'une décision de remboursement. Une fois que l'utilisateur a demandé un remboursement, le service client Xsolla traite manuellement la demande et prend une décision sur le remboursement.
canceled	Il existe deux scénarios possibles : La transaction a été annulée par le système de paiement. Par exemple, le compte de l'utilisateur n'était pas suffisamment approvisionné. Le paiement a été remboursé à l'utilisateur.
created	L'utilisateur a initié la transaction, mais celle-ci n'a pas encore été traitée.
done	La transaction a été traitée avec succès.
error	Une erreur s'est produite lors du traitement de la transaction. Pour obtenir un remboursement, contactez le service client Xsolla.
partiallyRefunded	L'utilisateur a reçu un remboursement partiel.
processing	La transaction est en cours de traitement.
refunded	Un remboursement a été effectué sur le solde Xsolla de l'utilisateur.
review	La transaction a été suspendue par le système anti-fraude. Elle fait actuellement l'objet d'une vérification supplémentaire.

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
}
}
]