Creación de una solicitud de exportación de pagos

Artículo
12/19/2023

Envíe una solicitud POST al punto de conexión de API para poner en cola una nueva solicitud de exportación para los pagos.

Solicitud REST

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

Parámetros de solicitud

Nombre	En	Obligatorio	Type	Descripción
$filter	Consultar	No	Cadena	Aunque es un filtro opcional, se recomienda encarecidamente usar filtros para un rendimiento más rápido y limitar los datos de exportación en lugar de exportar los últimos tres años de datos. Consulte la tabla siguiente para obtener un conjunto completo de opciones de $filter.
fileFormat	Consultar	No	Cadena	Los valores admitidos son .csv/.tsv. El valor predeterminado es .csv si no se proporciona ningún valor.

Nombre	Description	Tipo	Format
programName	Filtre por uno o varios programas en los que esté inscrito. Valores de ejemplo: "Proveedor indirecto de CSP", "Proveedor indirecto de CSP 2T", "Csp Direct Bill Partner", "CSP 1T Direct Partner", "CSP Indirect Reseller", "CSP 2T Indirect Reseller"	Cadena	{baseUrl}`/v1.0/payouts/payments?$filter=?$filter=programName=’CSP Indirect Provider’`

Filtro de pagos de ejemplo con varios parámetros de solicitud

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

Encabezado de solicitud

Nombre	Obligatorio	Type	Descripción
Authorization	Sí	Cadena	Token de portador de autorización.
ms-correlationid	No	Cadena	Un rastreador de solicitudes interno. Cada solicitud genera un nuevo rastreador (GUID).
ms-requestid	No	Cadena	Identificador de idempotency de solicitud.

Para más información, consulte Encabezados REST del Centro de partners.

Cuerpo de la solicitud

N/D

Respuesta de la API

HTTP/1.1 202 Accepted

La carga de respuesta de la API devuelve los atributos siguientes:

Nombre	Opcionales	Descripción
Valor	false	Consulte la tabla siguiente para ver los posibles valores y acciones.

Valor	Acción del cliente
requestId	Identificador de solicitud de la solicitud de exportación
requestDateTime	Fecha y hora de inicio de la solicitud de exportación
requestPath	Ruta de acceso de consulta de la solicitud de exportación.
requestQueryString	Filtro usado como parte de la solicitud de exportación.
blobLocation	Recurso de blob con token cuando el archivo de exportación está listo
Estado	Estado de la operación de exportación. Consulte la siguiente lista de valores posibles para el estado.

Valores posibles para el estado

En cola: la operación de exportación no se ha iniciado
Procesamiento: la operación de exportación está en curso
Error: error en la operación de exportación después de reintentos, intente poner en cola una nueva solicitud.
Completado: la operación de exportación se completó y el archivo de exportación está listo para su descarga.

Respuesta de ejemplo:

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

LA API devuelve el estado HTTP 202.

Nombre	Descripción
202 - Aceptado	Se acepta la solicitud. Consulte la dirección URL de solicitud GET para el estado de la solicitud.

En función de la solicitud, la API puede devolver otros estados estándar:

Nombre	Descripción
400 Solicitud incorrecta	Faltaban datos o eran incorrectos.
401 No autorizado	El autor de la llamada no está autenticado y debe autenticarse con el servicio de API de asociado antes de realizar la primera llamada.
403 Prohibida	El autor de la llamada no está autorizado para realizar la solicitud.
500 Error interno del servidor	La API o una de sus dependencias no pueden cumplir la solicitud. Vuelva a intentarlo más tarde.
404 No encontrado	Recurso no disponible con parámetros de entrada.
429 Limitación de velocidad	Demasiadas solicitudes del mismo tipo. Pruebe después de algún tiempo.

Compartir vía