pineplechainDocs

Fundamentos

Convenções

Idempotência, paginação, valores, datas, IDs e limites de uso.

Idempotência

Envie Idempotency-Key (até 255 caracteres) nas criações. Se a mesma chamada for repetida com a mesma chave, a API devolve a resposta original com o header Idempotent-Replayed: true, sem criar nada de novo.

  • Obrigatória em POST /payments e POST /payments/{id}/releases.
  • Recomendada em POST /invoices e POST /customers.
  • Vale por 24 horas, por chave de API.
  • A mesma chave com outro corpo dá 422 idempotency-key-reused.
  • Respostas 4xx também ficam guardadas. Depois de corrigir o pedido, use uma chave nova.

Paginação

As listas usam limit (1 a 100, padrão 20) e cursor. A resposta traz data, has_more e next_cursor; passe o next_cursor como cursor para buscar a próxima página.

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

Valores, datas e IDs

  • Valores são texto decimal: { "value": "25.5", "asset": { "type": "XRP" } }. Em POST /invoices, amount é só o texto: "25.5".
  • XRP aceita até 6 casas decimais. Taxas são arredondadas para baixo.
  • Datas em ISO 8601, em UTC: 2026-10-30T14:00:00.000Z.
  • IDs têm prefixo pelo tipo: inv_ (link), pay_ (pagamento), cus_ (cliente), dsp_ (disputa).

Limites de uso

120 chamadas por minuto por chave. Acima disso, a resposta é 429 rate-limited, com os headers RateLimit e RateLimit-Policy. Toda resposta traz um X-Request-Id; mande ele quando falar com o suporte.

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