Share via

Obtenir une demande d’exportation de paiement par ID

  • Article

Obtient la status d’une demande d’exportation en file d’attente existante.

Demande REST

GET https://api.partner.microsoft.com/v1.0/payouts/payments/{paymentsRequestId}

Paramètres de la demande

Nom Dans Obligatoire Type Description
requestId Requête True Guid ID de demande d’exportation

En-tête de requête

Nom Obligatoire Type Description
Autorisation Oui String Jeton du porteur d’autorisation.
ms-correlationid Non String Un suivi de requête interne. Chaque requête génère un nouveau tracker (GUID).
ms-requestid Non String ID d’idempotency de la demande.

Corps de la demande

N/A.

Charge utile de réponse

Nom Description
200 Accepté La demande a été acceptée.

En fonction de la demande, l’API peut retourner d’autres status standard répertoriés dans les états de réponse de l’API Standard :

Nom Description
400 Demande incorrecte Il y avait des données manquantes ou incorrectes.
401 Non autorisé L’appelant n’est pas authentifié et doit s’authentifier auprès du service API partenaire avant d’effectuer le premier appel.
403 Interdit L’appelant n’est pas autorisé à effectuer la demande.
500 Erreur interne du serveur L’API ou l’une de ses dépendances ne peut pas répondre à la demande. Réessayez plus tard.
404 Introuvable Ressource non disponible avec les paramètres d’entrée.
429 Limitation des débits Trop de requêtes du même type. Essayez après un moment.

La charge utile de réponse de l’API retourne les attributs suivants :

Nom Facultatif Description
Valeur false Consultez le tableau suivant pour connaître les valeurs et actions possibles.

Valeurs et actions possibles

Valeur Action du client
requestId ID de demande de la demande d’exportation
requestDateTime Date d’initiation de la demande d’exportation
requestPath Chemin de requête de la demande d’exportation.
requestQueryString Filtre utilisé dans le cadre de la demande d’exportation.
blobLocation Ressource blob avec jeton lorsque le fichier d’exportation est prêt
Statut Status de l’opération d’exportation. Consultez la liste suivante des valeurs possibles pour status.

Valeurs possibles pour status

  • Mise en file d’attente : l’opération d’exportation n’a pas démarré
  • Traitement : l’opération d’exportation est en cours
  • Échec : l’opération d’exportation a échoué après les nouvelles tentatives, essayez de mettre en file d’attente une nouvelle demande
  • Terminé : l’opération d’exportation s’est terminée et le fichier d’exportation est prêt pour le téléchargement.