pineplechainDocs

Guias

Links de pagamento

Cobranças em XRP com checkout pronto: diretas, ou com escrow para vendas com entrega.

Um link de pagamento (invoice) é uma cobrança com página de checkout própria. Ele pode ser direto, quando o XRP vai na hora para a sua carteira, ou com escrow, quando o valor fica travado na XRPL até a entrega.

Criar um link

curl -X POST https://api.pineplechain.com/v1/invoices \
  -H "x-api-key: $PINEPLECHAIN_API_KEY" \
  -H "content-type: application/json" \
  -H "idempotency-key: pedido-1842" \
  -d '{ "amount": "250", "description": "Pedido #1842", "expires_in_hours": 48 }'
CampoTipoObrigatórioDescrição
amountstringsimValor em XRP, com até 6 casas decimais. Mínimo "0.001".
descriptionstringnãoAté 200 caracteres. Aparece no checkout.
expires_in_hoursinteironãoDe 1 a 720. Padrão: 72.
kinddirect ou escrownãoPadrão: direct.
cancel_afterdata ISOsó no escrowEntre 1 hora e 365 dias no futuro.
metadataobjetonãoAté 20 chaves (40 caracteres) com valores de até 500 caracteres.

Antes de criar

A carteira de recebimento precisa estar conectada e ativada na XRPL (senão: 422). Em produção, a empresa precisa da verificação aprovada (403 kyb-required) e não pode ter fatura vencida (402 fees-overdue).

Direto ou escrow

Diretoopenpaid

O cliente envia um Payment para a sua carteira e a cobrança vira paid quando a XRPL valida a transação.

Escrowopenlockedreleasingreleased

O valor fica travado num escrow da XRPL. Quem pagou libera no próprio checkout quando recebe o pedido. Se não liberar até cancel_after, o valor volta para ele (refunding › refunded). O link de escrow para de aceitar pagamento 30 minutos antes de cancel_after.

Link com escrow
curl -X POST https://api.pineplechain.com/v1/invoices \
  -H "x-api-key: $PINEPLECHAIN_API_KEY" \
  -H "content-type: application/json" \
  -H "idempotency-key: pedido-1843" \
  -d '{
    "amount": "1200",
    "description": "Pedido #1843",
    "kind": "escrow",
    "cancel_after": "2026-11-15T12:00:00Z"
  }'

Qualquer link ainda open pode acabar em expired (passou de expires_at) ou cancelled.

Consultar, listar e cancelar

GET/invoices/{id}

Consulta um link. Cada chamada relê a XRPL.

GET/invoices

Lista os links, do mais novo ao mais antigo. Filtro status.

POST/invoices/{id}/cancellations

Cancela um link que ainda está open. Sem corpo.

curl "https://api.pineplechain.com/v1/invoices?limit=20&status=paid" \
  -H "x-api-key: $PINEPLECHAIN_API_KEY"

Algo errado nesta página? Fale com a gente.