Recaudo Docs
Criar conta

Pagamentos e clientes

Cobranças

Faça cobranças diretas em formas de pagamento salvas. Ideal para cobranças recorrentes ou pagamentos com um clique.

POST /v1/charges

Criar cobrança

Faz uma cobrança em uma forma de pagamento salva.

Parâmetros

Parâmetro Tipo Obrigatório Descrição
amount number Sim Valor em decimais (ex.: 100.00 = $100.00)
currency string Sim Código ISO da moeda
payment_method string Condicional* ID da forma de pagamento salva
token string Condicional* Token do cartão gerado com recaudo.js (tok_xxx para Conekta, pm_xxx para Stripe)
card object Não Informações do cartão do recaudo.js: { brand, last4, exp_month, exp_year }. Recomendado para melhor rastreamento
customer string Condicional* ID do cliente (obrigatório se usar payment_method)
description string Não Descrição da cobrança
Requisição 
curl -X POST https://recaudo.app/api/v1/charges \
  -H "Authorization: Bearer sk_live_xxx" \
  -H "Content-Type: application/json" \
  -d '{
    "amount": 250.00,
    "currency": "MXN",
    "token": "tok_abc123...",
    "card": {
      "brand": "visa",
      "last4": "4242",
      "exp_month": 12,
      "exp_year": 2027
    },
    "description": "Cargo por servicio premium"
  }'
Resposta 201 
{
  "id": "8d8f4fa9-cbab-4913-93b1-38bdc9999eb8",
  "object": "charge",
  "amount": 250.00,
  "currency": "MXN",
  "status": "succeeded",
  "customer_id": "8e250c25-9d84-4892-98ec-d71fc1fcd3c7",
  "payment_method_id": "pm_card_xyz123",
  "description": "Cargo por servicio premium",
  "payment_intent_id": "pi_789xyz",
  "receipt_url": "https://recaudo.app/receipt/8d8f4fa9-cbab-4913-93b1-38bdc9999eb8",
  "created_at": "2024-01-15T10:30:00Z"
}
POST /v1/charges/:id/refund

Reembolsar cobrança

Faz um reembolso total ou parcial de uma cobrança.

Requisição (reembolso parcial) 
curl -X POST https://recaudo.app/api/v1/charges/8d8f4fa9-cbab-4913-93b1-38bdc9999eb8/refund \
  -H "Authorization: Bearer sk_live_xxx" \
  -H "Content-Type: application/json" \
  -d '{
    "amount": 100.00,
    "reason": "customer_request"
  }'
Resposta 200 
{
  "id": "re_xyz789abc",
  "object": "refund",
  "amount": 100.00,
  "currency": "MXN",
  "charge_id": "8d8f4fa9-cbab-4913-93b1-38bdc9999eb8",
  "status": "succeeded",
  "reason": "customer_request",
  "created_at": "2024-01-15T11:00:00Z"
}
Esta página ajudou? Obrigado por avisar.
Esc