Pular para o conteúdo
m MARX / docs

/ Receber

Links de pagamento

Um link de pagamento (bill) é uma página pronta da marx onde o cliente escolhe como pagar e conclui o pagamento. É a forma mais rápida de cobrar sem construir tela: crie o link pela API e envie a URL.

Dica

Toda cobrança Pix também tem um payment_url próprio. Use links de pagamento quando quiser que o cliente escolha a forma de pagamento na própria página.

POST /api/bills

Shell
curl -X POST https://marx.loco.ltd/api/bills \
  -H "X-Client-Id: $MARX_CLIENT_ID" -H "X-Client-Secret: $MARX_CLIENT_SECRET" \
  -H "Content-Type: application/json" -H "Accept: application/json" \
  -d '{"bill": {"amount": "89.00", "reference": "fatura-2026-10", "metadata": {"customer_id": "c_871"}}}'
Campo Tipo Obrigatório Descrição
amount texto sim Valor com ponto decimal ("89.00").
reference texto não Seu identificador.
payment_method texto não Envie "pix" para já gerar o Pix na criação; omita para o cliente escolher na página.
metadata objeto ou texto não Dados livres seus.

Resposta 201:

JSON
{
  "id": "7b3e0c2a-1f6d-4c8e-9a51-2d0e6f4b9c13",
  "amount": "89.0",
  "payment_token": "Xq2c9VbN1mLp0sRt",
  "payment_url": "https://marx.loco.ltd/pay/Xq2c9VbN1mLp0sRt",
  "payment_method": null,
  "status": "pending",
  "reference": "fatura-2026-10",
  "metadata": { "customer_id": "c_871" },
  "created_at": "2026-10-06T16:20:00-03:00"
}

Consultar

GET /api/bills/{id} devolve o mesmo formato. 404 se o link não existir.

Status

status Significado
pending Aguardando pagamento.
paid Pago.

A página de pagamento

O cliente abre o payment_url em qualquer navegador:

  1. vê o nome da sua empresa, o valor e a referência;
  2. escolhe Pix (cartão aparece como "em breve");
  3. recebe o QR Code e o copia e cola;
  4. paga no app do banco e a página confirma sozinha, em segundos.

A página é otimizada para celular, tem tema claro e escuro e não expõe dados da sua conta: só nome, valor, referência e o código Pix.

Nota

A confirmação do pagamento para o seu sistema chega pelo webhook da cobrança Pix gerada pelo link (reference igual ao do link).

Dúvidas sobre a integração? Fale com o time marx pelo seu canal de suporte.

© 2026 marx