Obter solicitação de exportação de pagamento por ID
Obtém o status de uma solicitação de exportação na fila existente.
Solicitação REST
GET https://api.partner.microsoft.com/v1.0/payouts/payments/{paymentsRequestId}
Parâmetros da solicitação
| Nome | Em | Obrigatório | Tipo | Descrição |
|---|---|---|---|---|
| requestId | Consulta | True | Guid | Exportar ID da solicitação |
Cabeçalho da solicitação
| Nome | Obrigatório | Tipo | Descrição |
|---|---|---|---|
| Autorização | Sim | String | Token de portador de autorização. |
| ms-correlationid | Não | String | Um rastreador de solicitação interno. Cada solicitação gera um novo GUID (rastreador). |
| ms-requestid | Não | String | A ID de id de id de solicitação. |
Corpo da solicitação
N/D
Payload de resposta
| Nome | Descrição |
|---|---|
| 200 Aceito | A solicitação foi aceita. |
Com base na solicitação, a API pode retornar outros status padrão listados nos status de resposta da API Standard:
| Nome | Descrição |
|---|---|
| 400 Solicitação Inválida | Havia dados ausentes ou incorretos. |
| 401 Não Autorizado | O chamador não está autenticado e deve se autenticar no 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. |
| Erro interno de servidor 500 | A API ou uma de suas dependências não consegue atender à solicitação. Tente novamente depois. |
| 404 Não Encontrado | Recurso não disponível com parâmetros de entrada. |
| Limitação de taxa 429 | Muitas solicitações do mesmo tipo. Tente depois de algum tempo. |
O conteúdo da resposta da API retorna os seguintes atributos:
| Nome | Opcional | Descrição |
|---|---|---|
| Valor | false | Consulte a tabela a seguir para obter valores e ações possíveis. |
Valores e ações possíveis
| Valor | Ação do cliente |
|---|---|
| requestId | ID de solicitação da solicitação de exportação |
| requestDateTime | Datetime de inicialização da solicitação de exportação |
| requestPath | Caminho de consulta da solicitação de exportação. |
| requestQueryString | Filtro usado como parte da solicitação de exportação. |
| blobLocation | Recurso de blob com token quando o arquivo de exportação estiver pronto |
| Status | Exportar status de operação. Consulte a lista a seguir de possíveis valores para status. |
Valores possíveis para status
- Enfileirada: a operação de exportação não foi iniciada
- Processamento: a operação de exportação está em andamento
- Falha: a operação de exportação falhou após novas tentativas, tente enfileirar uma nova solicitação
- Concluído: a operação de exportação foi concluída e o arquivo de exportação está pronto para download.