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.

Pedido REST

Método	URI do pedido
POST	`https://api.partner.microsoft.com/v1.0/payouts/payments?$filter={$filter}&fileformat=csv`

Parâmetros de solicitação

Nome	Está presente em	Obrigatório	Type	Description
$filter	Query	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	Query	Não	String	Os valores suportados são .csv/.tsv. O padrão é .csv se nenhum valor for fornecido.

Nome	Descrição	Type	Formato
nomedoprograma	Filtre por um ou mais programas em que está inscrito. Valores de exemplo - 'CSP Indirect Provider', 'CSP 2T Indirect Provider', 'CSP Direct Bill Partner', 'CSP 1T Direct Partner', 'CSP Indirect Reseller', 'CSP 2T Indirect Reseller'	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 do pedido

Nome	Obrigatório	Type	Description
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	String	O ID 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	Description
valor	false	Consulte a tabela a seguir para obter os valores e ações possíveis.

valor	Ação do cliente
requestId	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
Status	Status da operação de exportação. Consulte a seguinte lista de valores possíveis para status.

Valores possíveis para o status

Em fila: 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.

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 Incorreto	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 de Servidor Interno	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.

Partilhar via