pineplechainDocs

Ferramentas

Referência da API

Todos os endpoints públicos, agrupados por recurso.

Todas as rotas ficam em https://api.pineplechain.com/v1 e usam o header x-api-key.

POST/invoices

Cria um link direto ou com escrow.

GET/invoices

Lista os links.

GET/invoices/{id}

Consulta um link e relê a XRPL.

POST/invoices/{id}/cancellations

Cancela um link open.

Pagamentos com escrow

POST/paymentsbeta

Cria um pagamento com escrow para um cliente verificado. Exige Idempotency-Key.

GET/paymentsbeta

Lista, com filtros de status, cliente e data.

GET/payments/{id}beta

Consulta um pagamento e o histórico de status.

POST/payments/{id}/releasesbeta

Libera um pagamento locked. Exige Idempotency-Key.

Clientes e verificação

POST/customers

Cria um cliente. external_ref é único por empresa.

GET/customers

Lista os clientes, com filtro kyc_status.

GET/customers/{id}

Consulta um cliente.

POST/kyc-sessions

Abre uma verificação para um cliente ou para a empresa.

GET/kyc-sessions/{id}

Consulta uma verificação.

POST/kyc-sessions/{id}/submissions

Envia os dados (pessoa física ou jurídica).

POST/kyc-sessions/{id}/documents

Envia um documento ou selfie.

GET/credentials

Credenciais gravadas na XRPL para um endereço (subject).

Disputas

POST/disputes

Abre uma disputa sobre um pagamento locked, dentro do prazo.

GET/disputes

Lista as disputas.

GET/disputes/{id}

Consulta uma disputa e a decisão.

Carteiras e assinaturas

POST/wallet-connections

Conecta a carteira de recebimento da empresa.

GET/wallets/{id}

Consulta uma carteira.

GET/wallets/{id}/balances

Saldo disponível, reservado e em escrow.

GET/signature-requests/{id}

Consulta um pedido de assinatura (QR e deeplink da Xaman).

Dados e conta

GET/ledger-transactions

Transações enviadas à XRPL.

GET/metrics/summary

Resumo do período (pagamentos com escrow).

GET/metrics/timeseries

Série temporal de uma métrica.

GET/billing

Plano, taxas do mês e fatura em aberto.

GET/network

Rede, reservas, taxa padrão e prontidão.

GET/me

Quem é a chave: empresa, papel e ambiente.

Pix com XRP

Em acesso antecipado. Os endpoints de Pix ainda não estão abertos na API pública.

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