Condividi tramite


Ottenere la richiesta di esportazione dei pagamenti in base all'ID

Ottiene lo stato di una richiesta di esportazione in coda esistente.

Richiesta REST

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

Parametri della richiesta

Nome In Obbligatoria Tipo Descrizione
requestId Query True Guid Esportare l'ID richiesta

Intestazione della richiesta

Nome Obbligatorio Tipo Descrizione
Autorizzazione string Token di connessione dell'autorizzazione.
ms-correlationid No string Strumento di rilevamento delle richieste interno. Ogni richiesta genera un nuovo tracker (GUID).
ms-requestid No string ID di idempotenza della richiesta.

Testo della richiesta

N/D.

Payload della risposta

Nome Descrizione
200 Accettato La richiesta è stata accettata.

In base alla richiesta, l'API può restituire altri stati standard elencati in Stati di risposta API Standard:

Nome Descrizione
400 - Richiesta non valida Dati mancanti o non corretti.
401 - Non autorizzato Il chiamante non è autenticato e deve eseguire l'autenticazione con il servizio API partner prima di effettuare la prima chiamata.
403 - Accesso negato Il chiamante non è autorizzato a effettuare la richiesta.
500 - Errore interno del server L'API o una delle relative dipendenze non è in grado di soddisfare la richiesta. Riprovare più tardi.
404 - Non trovato Risorsa non disponibile con i parametri di input.
429 Limitazione della frequenza Troppe richieste dello stesso tipo. Prova dopo un po' di tempo.

Il payload della risposta DELL'API restituisce gli attributi seguenti:

Nome Facoltativo Descrizione
Valore false Per i valori e le azioni possibili, vedere la tabella seguente.

Valori e azioni possibili

Valore Azione client
requestId ID richiesta della richiesta di esportazione
requestDateTime Data di inizio della richiesta di esportazione
requestPath Percorso della query della richiesta di esportazione.
requestQueryString Filtro utilizzato come parte della richiesta di esportazione.
blobLocation Risorsa BLOB con token quando il file di esportazione è pronto
Stato Stato dell'operazione di esportazione. Vedere l'elenco seguente dei valori possibili per lo stato.

Valori possibili per lo stato

  • Accodato: l'operazione di esportazione non è stata avviata
  • Elaborazione: l'operazione di esportazione è in corso
  • Non riuscito: l'operazione di esportazione non è riuscita dopo i tentativi, provare a accodare una nuova richiesta
  • Completato: l'operazione di esportazione è stata completata e il file di esportazione è pronto per il download.