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

Artigo
11/13/2024

Envie uma solicitação POST para o ponto de extremidade da API para enfileirar uma nova solicitação de exportação para pagamentos.

Solicitação REST

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

Parâmetros da solicitação

Nome	Em	Obrigatório	Type	Descrição
$filter	Consulta	Não	String	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.
fileFormat	Consulta	Não	String	Os valores suportados são .csv/.tsv. O padrão é .csv se nenhum valor for fornecido.

Nome	Descrição	Type	Formatar
programName	Filtre por um ou mais programas nos quais você está inscrito. Valores de exemplo - 'Provedor indireto CSP', 'Provedor indireto CSP 2T', 'Parceiro de fatura direta CSP', 'Parceiro direto CSP 1T', 'Revendedor indireto CSP', 'Revendedor indireto CSP 2T'	String	{baseUrl}`/v1.0/payouts/payments?$filter=?$filter=programName=’CSP Indirect Provider’`

Filtro de pagamentos de amostra 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	Obrigatória	Type	Descrição
Autorização	Sim	String	Token de Autorização ao Portador.
ms-correlationid	Não	String	Um rastreador de solicitações interno. Cada solicitação gera um novo rastreador (GUID).
MS-RequestID	Não	String	O ID de idempotência da solicitação.

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

Corpo da solicitação

N/D

Resposta da API

HTTP/1.1 202 Accepted

A carga de resposta da API retorna os seguintes atributos:

Nome	Opcional	Descrição
Valor	false	Consulte a tabela a seguir para obter possíveis valores e ações.

Valor	Ação do cliente
requestId	ID da solicitação de exportação
requestDateTime	Data/hora de início 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.
blobLocalização	Recurso de blob com token quando o arquivo de exportação estiver pronto
Status	Status da operação de exportação. Consulte a lista a seguir de valores possíveis para status.

Valores possíveis para status

Enfileirado: 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 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.

Resposta de exemplo:

{
    "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 é aceito. Consulte a 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 Solicitação Incorreta	Havia dados ausentes ou incorretos.
401 Não Autorizado	O chamador não é autenticado e deve autenticar 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.
Erro interno de servidor 500	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	Muitos pedidos do mesmo tipo. Tente depois de algum tempo.

Compartilhar via