Listar cargos en Recharge, con una API

Lista los cargos de la tienda, pasados y futuros, con estado, scheduled_at, processed_at, totales, cliente y artículos. Los cargos procesados hace más de 90 días no se devuelven. Ordenados por id ascendente por defecto; hasta 250 por página: envía el next_cursor de la respuesta como cursor para leer la página siguiente.

Identificador
recharge_list_charges

La llamada

POST https://connect.reportei.com/api/tools/recharge_list_charges/execute
Authorization: Bearer <merchant token>
x-customer-token: <customer token>
Content-Type: application/json
Accept: application/json

{
  "customer_toolkit": "<connection UUID>",
  "arguments": {
    "status": "<status>"
  }
}

Tu sistema envía el id de la conexión de tu cliente y los argumentos de la tool. Los headers son los mismos de toda la API de Connect: el token de tu producto y el token de tu cliente.

Parámetros

Las descripciones de los parámetros siguen la documentación oficial de la app, en inglés.

ParámetroTipoObligatorioDescripción
statusstringNoOnly charges in these statuses, comma-separated: success, queued, error, refunded, partially_refunded, skipped, pending_manual_payment or pending.
customer_idintegerNoOnly charges of this customer, the id from List customers.
address_idintegerNoOnly charges of this address, from the addresses of Get customer.
purchase_item_idintegerNoOnly charges of this subscription, the id from List subscriptions.
external_order_idstringNoOnly the charge of this order of the store platform, the value of external_order_id.ecommerce shown in Get charge.
discount_codestringNoOnly charges with this discount code.
idsstringNoComma-separated ids of charges from List charges.
scheduled_at_minstringNoOnly charges scheduled after this date, as YYYY-MM-DD.
scheduled_at_maxstringNoOnly charges scheduled before this date, as YYYY-MM-DD.
processed_at_minstringNoOnly charges processed on or after this date, as YYYY-MM-DD, within the last 90 days.
processed_at_maxstringNoOnly charges processed on or before this date, as YYYY-MM-DD.
sort_bystringNoOrder of the results. The default is id-asc.Valores: id-asc, id-desc, updated_at-asc, updated_at-desc, scheduled_at-asc, scheduled_at-desc
limitintegerNoCharges per page, up to 250. The default is 50.
cursorstringNoThe next_cursor or previous_cursor of the previous response.

Conexiones posibles

Tu cliente conecta su cuenta de Recharge una sola vez, con uno de los modos de abajo. La misma conexión sirve para todas las tools del toolkit.

Clave de API

Tu cliente pega la clave de la app en una pantalla de Connect, o tu sistema envía la clave con POST /api/customer-toolkits, sin pantalla.

La respuesta

Si la llamada tiene éxito, Connect conserva el status y el cuerpo de la respuesta de la app. Los errores HTTP devueltos por la app usan el objeto {error, api_error}; la autenticación o validación pueden fallar antes de la ejecución. El header X-Toolkit-Execution-Id identifica la ejecución registrada, disponible en GET /api/tools/executions/{uuid}.

Lista para agentes de IA

El input de esta tool es un JSON Schema, disponible en GET /api/tools/recharge_list_charges. Se convierte en la definición de tool de tu agente sin conversión.

Otras tools de Recharge

Ver las 12 tools

Toolkits de la misma categoría

Ver los 100 toolkits

Mira Connect aplicado a tu producto.

Pruébalo durante 15 días sin tarjeta, o cuéntale tu caso a nuestro equipo.