Obter pedido de exportação de pagamento por ID
Obtém o estado de um pedido de exportação em fila existente.
Pedido REST
GET https://api.partner.microsoft.com/v1.0/payouts/payments/{paymentsRequestId}
Parâmetros do pedido
| Name | Em | Necessário | Tipo | Description |
|---|---|---|---|---|
| requestId | Consulta | Verdadeiro | GUID | ID do pedido de exportação |
Cabeçalho do pedido
| Name | Necessário | Tipo | Description |
|---|---|---|---|
| Autorização | Sim | String | Token do Portador de Autorização. |
| ms-correlationid | Não | String | Um controlador de pedido interno. Cada pedido gera um novo controlador (GUID). |
| ms-requestid | Não | String | O ID de idempotência do pedido. |
Corpo do pedido
N/D.
Payload de resposta
| Nome | Descrição |
|---|---|
| 200 Aceite | O pedido foi aceite. |
Com base no pedido, a API pode devolver outro estado padrão listado nos estados de resposta da API Standard:
| Nome | Descrição |
|---|---|
| 400 Pedido Incorreto | Havia dados em falta ou incorretos. |
| 401 Não Autorizado | O autor da chamada não está autenticado e tem de se autenticar com o serviço de API do parceiro antes de efetuar a primeira chamada. |
| 403 Proibido | O autor da chamada não está autorizado a fazer o pedido. |
| Erro Interno do Servidor 500 | A API ou uma das respetivas dependências não consegue cumprir o pedido. Tente novamente mais tarde. |
| 404 Não Encontrado | Recurso não disponível com parâmetros de entrada. |
| Limitação da taxa 429 | Demasiados pedidos do mesmo tipo. Tente depois de algum tempo. |
O payload de resposta da API devolve os seguintes atributos:
| Name | Opcional | Descrição |
|---|---|---|
| Valor | false | Veja a tabela seguinte para ver possíveis valores e ações. |
Valores e ações possíveis
| Valor | Ação do cliente |
|---|---|
| requestId | ID do pedido de exportação |
| requestDateTime | Datetime de iniciação do pedido de exportação |
| requestPath | Caminho da consulta do pedido de exportação. |
| requestQueryString | Filtro utilizado como parte do pedido de exportação. |
| blobLocation | Recurso de blobs com token quando o ficheiro de exportação estiver pronto |
| Estado | Estado da operação de exportação. Veja a seguinte lista de valores possíveis para o estado. |
Valores possíveis para o estado
- Em fila: a operação de exportação ainda não foi iniciada
- Processamento: A operação de exportação está em curso
- Falha: a operação de exportação falhou após as repetições, tente colocar um novo pedido em fila
- Concluído: a operação de exportação foi concluída e o ficheiro de exportação está pronto para transferência.