Obter o pedido de exportação de um pagamento pelo ID
Obtém o status de uma solicitação de exportação em fila existente.
Pedido REST
GET https://api.partner.microsoft.com/v1.0/payouts/payments/{paymentsRequestId}
Parâmetros de solicitação
| Nome | Em | Necessário | Tipo | Descrição |
|---|---|---|---|---|
| ID de pedido | Consulta | Verdadeiro | Guia | ID do pedido de exportação |
Cabeçalho da solicitação
| Nome | Necessário | Tipo | Descrição |
|---|---|---|---|
| Autorização | Sim | String | Token ao portador da autorização. |
| MS-CorrelationID | Não | String | Um rastreador de solicitações internas. Cada solicitação gera um novo rastreador (GUID). |
| MS-RequestID | Não | cadeia de caracteres | O identificador de idempotência da solicitação. |
Corpo do pedido
N/A.
Carga útil de resposta
| Nome | Descrição |
|---|---|
| 200 Aceito | O pedido foi aceite. |
Com base na solicitação, a API pode retornar outros status padrão listados em Status de resposta da API padrão:
| Nome | Descrição |
|---|---|
| 400 Solicitação Inválida | Havia dados ausentes ou incorretos. |
| 401 Não autorizado | O chamador não é autenticado e deve autenticar-se com o serviço de API do parceiro antes de fazer a primeira chamada. |
| 403 Proibido | O chamador não está autorizado a fazer a solicitação. |
| 500 Erro interno do servidor | A API ou uma de suas dependências não consegue atender à solicitação. Tente novamente mais tarde. |
| 404 Não encontrado | Recurso não disponível com parâmetros de entrada. |
| 429 Limitação da taxa | Demasiados pedidos do mesmo tipo. Tente depois de algum tempo. |
A carga útil de resposta da API retorna os seguintes atributos:
| Nome | Opcional | Descrição |
|---|---|---|
| Valor | falso | Consulte a tabela a seguir para obter os valores e ações possíveis. |
Valores e ações possíveis
| Valor | Ação do cliente |
|---|---|
| ID de solicitação | Pedido de ID do pedido de exportação |
| requestDateTime | Data/hora de início do pedido de exportação |
| requestPath | Caminho de consulta da solicitação de exportação. |
| requestQueryString | Filtro usado como parte da solicitação de exportação. |
| blobLocalização | Recurso de Blob com token quando o arquivo de exportação estiver pronto |
| Situação | Status da operação de exportação. Consulte a seguinte lista de valores possíveis para status. |
Valores possíveis para status
- em espera: A operação de exportação não foi iniciada
- Processamento: A operação de exportação está em curso
- Falha: A operação de exportação falhou após tentativas repetidas, tente colocar um novo pedido na fila
- Concluído: A operação de exportação foi concluída e o arquivo de exportação está pronto para download.