Skip to content

Pagamentos e Checkout

Este módulo abrange tanto a gestão administrativa de links de pagamento quanto os endpoints públicos utilizados pelo checkout para processar as transações.


[GET] /billing/payment-links

Retorna todos os links de pagamento da conta.

Query Params

NomeTipoDescrição
statusstringFiltro por status (ex: active, draft)
per_pageintegerItens por página

Response (200 OK)

json
{
  "data": [
    {
      "id": 1,
      "external_id": "pl_5f0a1b2c",
      "client": { "id": 5, "name": "João Lima", "email": "joao@gmail.com" },
      "amount": 150.0,
      "payment_methods": [
        { "value": "pix", "label": "Pix" },
        { "value": "boleto", "label": "Boleto Bancário" }
      ],
      "due_date": { "raw": "2024-12-31", "formatted": "31/12/2024", "iso": "2024-12-31T00:00:00.000Z" },
      "status": { "id": 1, "name": "active", "label": "Ativo" },
      "reference_code": "REF-ABC12345",
      "description": "Mensalidade de exemplo",
      "is_variable_amount": false,
      "min_amount": 0,
      "max_amount": 0,
      "expires_at": null,
      "title": "Link para Dezembro",
      "max_uses": 0,
      "current_uses": 0,
      "success_url": "https://meusite.com/sucesso",
      "cancel_url": "https://meusite.com/cancelado",
      "webhook_url": "https://meusite.com/webhook",
      "pass_transaction_fee_to_customer": false,
      "send_client_id": false,
      "public_url": "https://checkout.fastgivemoney.com.br/pl_5f0a1b2c"
    }
  ],
  "meta": { "total": 10, "page": 1, "limit": 15 },
  "summary": {
    "all": { "count": 10, "amount": 1500.0 },
    "active": { "count": 8, "amount": 1200.0 },
    "closed": { "count": 2, "amount": 300.0 }
  }
}

[POST] /billing/payment-links

Request Body

json
{
  "amount": 150.00,
  "due_date": "2024-12-31",
  "title": "Ingresso Evento",
  "description": "Acesso VIP",
  "payment_methods": ["pix", "boleto"],
  "is_variable_amount": false
}

Response (201 Created)

json
{
  "data": {
    "id": 12,
    "external_id": "pl_newlink99",
    "amount": 150.0,
    "status": { "name": "active" },
    "public_url": "https://checkout.fastgivemoney.com.br/pl_newlink99"
  },
  "message": "Link de pagamento criado com sucesso."
}

🌐 Checkout Público

Buscar Cobrança

[GET] /public/charge?code={code}

Retorna os detalhes de uma cobrança específica para exibição na tela de pagamento.

Response (200 OK)

json
{
  "success": true,
  "data": {
    "charge": {
      "code": "ch_7a8b9c",
      "value": 150.0,
      "status": "pending",
      "due_date": "2024-12-25",
      "client": { "name": "João Lima", "email": "joao@gmail.com" },
      "pix": {
        "txid": "abc123456",
        "qrcode": "000201010212260014br.gov.bcb.pix...",
        "image": "data:image/png;base64,..."
      },
      "boleto": {
        "barcode": "00190500954014481606906809350314337370000000150",
        "digitableLine": "00190.50095 40144.816069 06809.350314 3 37370000000150"
      }
    }
  },
  "message": "Detalhes da Cobrança"
}

[GET] /public/paymentLink/{external_id}

Response (200 OK)

json
{
  "data": {
    "external_id": "pl_5f0a1b2c",
    "amount": 150.0,
    "title": "Ingresso Evento",
    "description": "Acesso VIP",
    "status": { "name": "active" }
  },
  "message": "Link de pagamento recuperado com sucesso."
}

Processar Pagamento (Checkout)

[POST] /public/paymentLink/{external_id}/pay

Processa o pagamento via Pix, Boleto ou Cartão através de um link público.

Request Body (Cartão de Crédito)

json
{
  "name": "Maria Souza",
  "document": "98765432109",
  "email": "maria@gmail.com",
  "phone": "11900000000",
  "payment_method": "credit_card",
  "card": {
    "card_number": "4111.1111.1111.1111",
    "brand": "visa",
    "cvv": "123",
    "expiry": "12/2026",
    "holder": "MARIA SOUZA"
  },
  "address": {
    "street": "Rua Central",
    "number": "500",
    "district": "Bairro",
    "city": "São Paulo",
    "state": "SP",
    "zipcode": "01001000"
  }
}

Response (200 OK - Cartão)

json
{
  "success": true,
  "data": {
    "transaction_id": "tx_abc789",
    "status": "paid",
    "amount": 150.0
  },
  "message": "Pagamento processado com sucesso!"
}

Consultar Status do Pagamento

[GET] /public/payment-status/{chargeId}/charge

Utilizado pelo checkout para polling do status de pagamento de uma cobrança.

Response (200 OK)

json
{
  "success": true,
  "data": {
    "charge_id": 102,
    "status": "paid",
    "paid_at": "2024-12-26T15:45:00.000Z"
  }
}

Documentação para Desenvolvedores