Créer une demande d’exportation de paiements

Article
12/19/2023

Envoyez une demande POST au point de terminaison de l’API pour mettre en file d’attente une nouvelle demande d’exportation pour les paiements.

Demande REST

Méthode	URI de demande
POST	`https://api.partner.microsoft.com/v1.0/payouts/payments?$filter={$filter}&fileformat=csv`

Paramètres de la demande

Nom	Dans	Obligatoire	Type	Description
$filter	Requête	Non	Chaîne	Même s’il s’agit d’un filtre facultatif, nous vous recommandons vivement d’utiliser des filtres pour accélérer les performances et limiter vos données d’exportation au lieu d’exporter les trois dernières années de données. Consultez le tableau suivant pour obtenir un ensemble complet d’options de $filter.
fileFormat	Requête	Non	Chaîne	Les valeurs prises en charge sont .csv/.tsv. La valeur par défaut est .csv si aucune valeur n’est fournie.

Nom	Description	Type	Mettre en forme
programName	Filtrez par un ou plusieurs programmes que vous êtes inscrit. Exemples de valeurs : « Fournisseur indirect CSP », « Fournisseur indirect CSP 2T », « Partenaire de facturation directe CSP », « Partenaire direct CSP 1T », « Revendeur indirect CSP », « Revendeur indirect CSP 2T »	Chaîne	{baseUrl}`/v1.0/payouts/payments?$filter=?$filter=programName=’CSP Indirect Provider’`

Exemple de filtre de paiements avec plusieurs paramètres de requête

“?$filter=payoutStatusUpdateTS le 2019-09-25T23:11:55.647Z and (enrollmentParticipantId eq 'XXXXXXX') and (programName eq 'CSP Direct Bill Partner') and (payoutOrderType eq 'REBATE') and (paymentId eq '000000000000')”

En-tête de requête

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

Pour en savoir plus, consultez les en-têtes REST de l’Espace partenaires.

Corps de la demande

S/O

Réponse de l’API

HTTP/1.1 202 Accepted

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

Nom	Facultatif	Description
active	false	Consultez le tableau suivant pour connaître les valeurs et les 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 d’accès de requête de la demande d’exportation.
requestQueryString	Filtre utilisé dans le cadre de la demande d’exportation.
blobLocation	Ressource d’objet blob avec jeton lorsque le fichier d’exportation est prêt
État	État de l’opération d’exportation. Consultez la liste suivante des valeurs possibles pour l’état.

Valeurs possibles pour l’état

Mis 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 requête
Terminé : l’opération d’exportation est terminée et le fichier d’exportation est prêt à être téléchargé.

Exemple de réponse :

{
    "value": [
        {
            "requestId": "93c2b3cf-c6d8-4e7e-ade1-007768a6eba4",
            "requestDateTime": "2023-05-25T21:20:46.3727561Z",
            "requestPath": "/v1.0/payouts/payments",
            "requestQueryString": "paymentDate ge 2023-03-01 and paymentDate le 2023-04-12",
            "blobLocation": "",
            "status": "Queued"
        }
    ],
    "nextLink": null,
    "totalCount": 1
}

L’API retourne l’état HTTP 202.

Nom	Description
202 Accepté	La demande est acceptée. Interrogez l’URL de la requête GET pour obtenir l’état de la demande.

En fonction de la demande, l’API peut retourner d’autres états standard :

Nom	Description
400 Requête 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 d’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 ultérieurement.
404 Not Found	Ressource non disponible avec les paramètres d’entrée.
Limitation du taux de 429	Trop de requêtes du même type. Essayez après un certain temps.

Partager via