Creare una richiesta di esportazione dei pagamenti

Articolo
11/13/2024

Inviare una richiesta POST all'endpoint API per accodare una nuova richiesta di esportazione per i pagamenti.

Richiesta REST

metodo	URI della richiesta
POST	`https://api.partner.microsoft.com/v1.0/payouts/payments?$filter={$filter}&fileformat=csv`

Parametri della richiesta

Nome	Tra	Obbligatorio	Type	Descrizione
$filter	Query	No	String	Anche se si tratta di un filtro facoltativo, è consigliabile usare filtri per prestazioni più veloci e limitare i dati di esportazione anziché esportare gli ultimi tre anni di dati. Per un set completo di opzioni di $filter, vedere la tabella seguente.
fileFormat	Query	No	String	I valori supportati sono .csv/.tsv. L'impostazione predefinita è .csv se non viene specificato alcun valore.

Nome	Descrizione	Tipo	Formato
programName	Filtrare in base a uno o più programmi registrati. Valori di esempio : 'CSP Indirect Provider', 'CSP 2T Indirect Provider', 'CSP Direct Bill Partner', 'CSP 1T Direct Partner', 'CSP Indirect Reseller', 'CSP 2T Indirect Reseller'	String	{baseUrl}`/v1.0/payouts/payments?$filter=?$filter=programName=’CSP Indirect Provider’`

Filtro pagamenti di esempio con più parametri di richiesta

“?$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')”

Intestazione della richiesta

Nome	Obbligatorio	Type	Descrizione
Autorizzazione	Sì	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.

Per altre informazioni, vedere Intestazioni REST del Centro per i partner.

Corpo della richiesta

N/D

Risposta dell'API

HTTP/1.1 202 Accepted

Il payload della risposta API restituisce gli attributi seguenti:

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

Valore	Azione client
requestId	ID richiesta della richiesta di esportazione
requestDateTime	Data/ora di avvio 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
Status	Esportare lo stato dell'operazione. 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
Operazione non riuscita: 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.

Risposta di esempio:

{
    "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 restituisce lo stato HTTP 202.

Nome	Descrizione
202 - Accettato	La richiesta viene accettata. Eseguire una query sull'URL della richiesta GET per ottenere lo stato della richiesta.

A seconda della richiesta, l'API può restituire altri stati 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 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.
404 Not Found	Risorsa non disponibile con i parametri di input.
429 Limitazione della frequenza	Troppe richieste dello stesso tipo. Prova dopo qualche minuto.

Condividi tramite