Partilhar via

Criar solicitação de exportação de pagamentos

Envie um pedido POST ao endpoint da API para enfileirar um novo pedido de exportação para pagamentos.

Pedido REST

Método Solicitar URI
Publicação https://api.partner.microsoft.com/v1.0/payouts/payments?$filter={$filter}&fileformat=csv

Parâmetros de solicitação

Nome Em Necessário Tipo Descrição
$filter Consulta Não Corda Embora seja um filtro opcional, é altamente recomendável usar filtros para um desempenho mais rápido e limitar seus dados de exportação em vez de exportar os últimos três anos de dados. Consulte a tabela a seguir para obter um conjunto completo de opções de $filter.
formato de ficheiro Consulta Não String Os valores suportados são .csv/.tsv. Se nenhum valor for fornecido, o padrão é .csv.
Nome Descrição Tipo Formato
nomedoprograma Filtre por um ou mais programas em que está inscrito. Valores de exemplo - 'Provedor Indireto CSP', 'Provedor Indireto 2T CSP', 'Parceiro de Fatura Direta CSP', 'Parceiro Direto 1T CSP', 'Revendedor Indireto CSP', 'Revendedor Indireto 2T CSP' String {baseUrl}/v1.0/payouts/payments?$filter=?$filter=programName=’CSP Indirect Provider’

Exemplo de filtro de pagamentos com vários parâmetros de solicitação

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

Cabeçalho da solicitação

Nome Necessário Tipo Descrição
Autorização Sim String Token de portador de 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 O identificador de idempotência da solicitação.

Para saber mais, consulte cabeçalhos REST do Partner Center.

Corpo do pedido

N/A

Resposta da API

HTTP/1.1 202 Accepted

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.
Valor Ação do cliente
ID de requisição Solicitar o ID do pedido de exportação
requestDateTime Data/hora de início do pedido de exportação
CaminhoSolicitado Caminho de consulta da solicitação de exportação.
requestQueryString Filtro usado como parte da solicitação de exportação.
Localização do Blob 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 fila: 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 várias tentativas, tente colocar uma nova solicitação na fila
  • Concluído: A operação de exportação foi concluída e o arquivo de exportação está pronto para download.

Exemplo de resposta:

{
    "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
}

A API retorna o status HTTP 202.

Nome Descrição
202 Aceito O pedido é aceite. Consulte o URL da solicitação GET para obter o status da solicitação.

Dependendo da solicitação, a API pode retornar outros status padrão:

Nome Descrição
400 Pedido Inválido 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 Demasiadas solicitações do mesmo tipo. Tente depois de algum tempo.
  • Last updated on