Listar cobranças no Recharge, por uma API

Lista as cobranças da loja, passadas e futuras, com status, scheduled_at, processed_at, totais, cliente e itens. Cobranças processadas há mais de 90 dias não são retornadas. Ordenadas por id crescente por padrão; até 250 por página: envie o next_cursor da resposta como cursor para ler a próxima página.

Identificador
recharge_list_charges

A chamada

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

Seu sistema envia o id da conexão do cliente e os argumentos da tool. Os headers são os mesmos de toda a API do Connect: o token do seu produto e o token do cliente.

Parâmetros

As descrições dos parâmetros seguem a documentação oficial do app, em inglês.

ParâmetroTipoObrigatórioDescrição
statusstringNãoOnly charges in these statuses, comma-separated: success, queued, error, refunded, partially_refunded, skipped, pending_manual_payment or pending.
customer_idintegerNãoOnly charges of this customer, the id from List customers.
address_idintegerNãoOnly charges of this address, from the addresses of Get customer.
purchase_item_idintegerNãoOnly charges of this subscription, the id from List subscriptions.
external_order_idstringNãoOnly the charge of this order of the store platform, the value of external_order_id.ecommerce shown in Get charge.
discount_codestringNãoOnly charges with this discount code.
idsstringNãoComma-separated ids of charges from List charges.
scheduled_at_minstringNãoOnly charges scheduled after this date, as YYYY-MM-DD.
scheduled_at_maxstringNãoOnly charges scheduled before this date, as YYYY-MM-DD.
processed_at_minstringNãoOnly charges processed on or after this date, as YYYY-MM-DD, within the last 90 days.
processed_at_maxstringNãoOnly charges processed on or before this date, as YYYY-MM-DD.
sort_bystringNãoOrder 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
limitintegerNãoCharges per page, up to 250. The default is 50.
cursorstringNãoThe next_cursor or previous_cursor of the previous response.

Conexões possíveis

O seu cliente conecta a conta do Recharge uma vez, por um dos modos abaixo. A mesma conexão serve para todas as tools do toolkit.

Chave de API

O cliente cola a chave do app numa tela do Connect, ou o seu sistema envia a chave por POST /api/customer-toolkits, sem tela.

A resposta

Em caso de sucesso, o Connect preserva o status e o corpo da resposta do app. Erros HTTP retornados pelo app usam o envelope {error, api_error}; falhas de autenticação ou validação podem ocorrer antes da execução. O header X-Toolkit-Execution-Id identifica a execução registrada, consultável em GET /api/tools/executions/{uuid}.

Pronta para agentes de IA

O input desta tool é um JSON Schema, disponível em GET /api/tools/recharge_list_charges. Ele vira a definição de tool do seu agente sem conversão.

Outras tools do Recharge

Ver as 12 tools

Toolkits da mesma categoria

Ver os 100 toolkits

Veja o Connect aplicado ao seu produto.

Teste por 15 dias sem cartão, ou mostre seu cenário ao nosso time.