Partner payouts - Creates a new payments export request
Esta API permite criar um novo pedido de exportação de pagamentos. Recomendamos o uso de $filter param para cada solicitação. Veja abaixo sobre o uso dos filtros e todos os filtros disponíveis na interface da página de exportação (UX) também estão disponíveis através desta API, proporcionando flexibilidade e consistência na filtragem de dados.
POST https://api.partnercenter.microsoft.com/v{version}/payouts/paymentsPOST https://api.partnercenter.microsoft.com/v{version}/payouts/payments?$filter={$filter}&enrollmentParticipantId={enrollmentParticipantId}&paymentId={paymentId}&payoutStatusUpdateTS={payoutStatusUpdateTS}&paymentAmount={paymentAmount}&payoutOrderType={payoutOrderType}&Multiple filters={Multiple filters}Parâmetros do URI
| Name | Em | Necessário | Tipo | Description |
|---|---|---|---|---|
|
version
|
path | True |
string |
|
|
$filter
|
query |
string |
O $filter query param é um parâmetro opcional para criar uma operação de exportação. No entanto, é altamente recomendável usar $filter para um melhor desempenho e uma disponibilidade mais rápida do relatório de exportação. Abaixo estão alguns dos principais filtros de atributos que podem ser usados como parte da operação de exportação |
|
|
enrollment
|
query |
int |
Filtro de ID MPN inscrito para uma solicitação de exportação. Uso: {baseUrl}/payouts/payments?$filter=enrollmentParticipantId=12345 |
|
|
Multiple filters
|
query |
string |
Aqui está uma consulta de exemplo com vários filtros para uma solicitação de exportação. Uso: {baseUrl}/payouts/payments?$filter=payoutStatusUpdateTS ge 2023-01-01 e payoutStatusUpdateTS le 2023-05-31 e (enrollmentParticipantId eq 'XXXXXXX') e (programName eq 'CSP Direct Bill Partner') e (payoutOrderType eq 'REBATE') e (paymentId eq 'xxxxxxx') |
|
|
payment
|
query |
double |
Valor do pagamento para filtrar os pagamentos de uma solicitação de exportação. Uso: {baseUrl}/payouts/payments?$filter=paymentAmount ge 2000 e paymentAmount le 5000 |
|
|
payment
|
query |
int |
Filtro PaymentId para uma solicitação de exportação. Uso: {baseUrl}/payouts/payments?$filter=paymentId=123456 |
|
|
payout
|
query |
string |
Tipo de ordem de pagamento (Desconto, coop, Taxa, Venda) para filtrar os pagamentos de uma solicitação de exportação. Uso: {baseUrl}/payouts/payments?$filter=?$filter=payoutOrderType='REBATE' |
|
|
payout
|
query |
string |
Data de status do pagamento para filtrar os pagamentos de uma solicitação de exportação. Uso: {baseUrl}/payouts/transactionhistory?$filter=payoutStatusUpdateTS ge 2023-03-01 e payoutStatusUpdateTS le 2023-04-12 |
Cabeçalho do Pedido
| Name | Necessário | Tipo | Description |
|---|---|---|---|
| Authorization | True |
string |
Token de portador de autorização |
| Client-Request-ID |
string |
ID do pedido fornecido pelo utilizador |
Respostas
| Name | Tipo | Description |
|---|---|---|
| 202 Accepted |
O pedido foi aceite com sucesso para processamento. Cabeçalhos Request-ID: string |
|
| 400 Bad Request |
Havia uma entrada ausente ou inválida. O corpo da resposta fornecerá os detalhes do erro. |
|
| 401 Unauthorized |
O pedido não foi autenticado. O cliente precisa se autenticar com o serviço de API do parceiro primeiro. |
|
| 403 Forbidden |
O pedido foi autenticado, mas foi recusado, uma vez que o autor da chamada não tem o direito de o invocar. |
|
| 404 Not Found |
O recurso não foi encontrado. |
|
| 429 Too Many Requests |
Demasiados pedidos. |
|
| 500 Internal Server Error |
O serviço de API do parceiro ou uma de suas dependências não conseguiu atender à solicitação. Os chamadores podem tentar novamente. |
Definições
Microsoft.Partner.Service.PartnerPayout.Contracts.V1.Export
| Name | Tipo | Description |
|---|---|---|
| blobLocation |
string |
|
| processingStartDateTime |
string |
|
| requestDateTime |
string |
|
| requestId |
string |
|
| requestPath |
string |
|
| requestQueryString |
string |
|
| status |
enum:
|