Partner payouts - Creates a new payments export request
Cette API permet de créer une demande d’exportation de paiements. Nous vous recommandons d’utiliser $filter param pour chaque requête. Consultez ci-dessous l’utilisation des filtres et tous les filtres disponibles dans l’interface de page d’exportation (UX) sont également disponibles via cette API, ce qui offre une flexibilité et une cohérence dans le filtrage des données.
POST https://api.partnercenter.microsoft.com/v{version}/payouts/paymentsPOST https://api.partnercenter.microsoft.com/v{version}/payouts/payments?$filter={$filter}&enrollmentParticipantId={enrollmentParticipantId}&paymentId={paymentId}&payoutStatusUpdateTS={payoutStatusUpdateTS}&paymentAmount={paymentAmount}&payoutOrderType={payoutOrderType}&Multiple filters={Multiple filters}Paramètres URI
| Nom | Dans | Obligatoire | Type | Description |
|---|---|---|---|---|
|
version
|
path | True |
string |
|
|
$filter
|
query |
string |
L'$filter l’analyseur de requête est un paramètre facultatif pour la création d’une opération d’exportation. Toutefois, nous vous recommandons vivement d’utiliser $filter pour améliorer les performances et accélérer la disponibilité du rapport d’exportation. Voici quelques-uns des filtres d’attributs clés qui peuvent être utilisés dans le cadre de l’opération d’exportation |
|
|
enrollment
|
query |
int |
Filtre d’ID MPN inscrit pour une demande d’exportation. Utilisation : {baseUrl}/payments/payments ?$filter=enrollmentParticipantId=12345 |
|
|
Multiple filters
|
query |
string |
Voici un exemple de requête avec plusieurs filtres pour une demande d’exportation. Utilisation : {baseUrl}/payments/payments ?$filter=paymentsStatusUpdateTS ge 2023-01-01 et paymentsStatusUpdateTS le 2023-05-05-31 et (enrollmentParticipantId eq 'XXXXXXX') et (programName eq 'CSP Direct Bill Partner') et (paymentOrderType eq 'REBATE') et (paymentId eq 'xxxxxxx') |
|
|
payment
|
query |
double |
Montant du paiement pour filtrer les paiements d’une demande d’exportation. Utilisation : {baseUrl}/payments/payments ?$filter=paymentAmount ge 2000 et paymentAmount le 5000 |
|
|
payment
|
query |
int |
Filtre PaymentId pour une demande d’exportation. Utilisation : {baseUrl}/payments/payments ?$filter=paymentId=123456 |
|
|
payout
|
query |
string |
Type de commande de paiement (remise, coop, frais, vente) pour filtrer les paiements d’une demande d’exportation. Utilisation : {baseUrl}/payments/payments ?$filter= ?$filter=paymentsOrderType='REBATE' |
|
|
payout
|
query |
string |
Date d’état du paiement pour filtrer les paiements d’une demande d’exportation. Utilisation : {baseUrl}/payouts/transactionhistory ?$filter=payoutStatusUpdateTS ge 2023-03-01 et payoutStatusUpdateTS le 2023-04-12 |
En-tête de la demande
| Nom | Obligatoire | Type | Description |
|---|---|---|---|
| Authorization | True |
string |
Jeton du porteur d’autorisation |
| Client-Request-ID |
string |
ID de la demande fournie par l’utilisateur |
Réponses
| Nom | Type | Description |
|---|---|---|
| 202 Accepted |
La demande a été acceptée pour traitement. En-têtes Request-ID: string |
|
| 400 Bad Request |
Une entrée est manquante ou non valide. Le corps de la réponse fournit les détails de l’erreur. |
|
| 401 Unauthorized |
La demande n’a pas été authentifiée. Le client doit d’abord s’authentifier auprès du service d’API partenaire. |
|
| 403 Forbidden |
La demande a été authentifiée, mais a été refusée, car l’appelant n’a pas les droits de l’appeler. |
|
| 404 Not Found |
La ressource est introuvable. |
|
| 429 Too Many Requests |
Trop de demandes. |
|
| 500 Internal Server Error |
Le service d’API partenaire ou l’une de ses dépendances n’a pas pu répondre à la demande. Les appelants peuvent réessayer. |
Définitions
Microsoft.Partner.Service.PartnerPayout.Contracts.V1.Export
| Nom | Type | Description |
|---|---|---|
| blobLocation |
string |
|
| processingStartDateTime |
string |
|
| requestDateTime |
string |
|
| requestId |
string |
|
| requestPath |
string |
|
| requestQueryString |
string |
|
| status |
enum:
|