Tools
API reference
Every public endpoint, grouped by resource.
All routes live under https://api.pineplechain.com/v1 and use the x-api-key header.
Payment links
/invoicesCreates a direct or escrow link.
/invoicesLists links.
/invoices/{id}Retrieves a link and re-reads the XRPL.
/invoices/{id}/cancellationsCancels an open link.
Escrow payments
/paymentsbetaCreates an escrow payment for a verified customer. Requires Idempotency-Key.
/paymentsbetaLists, filtered by status, customer and date.
/payments/{id}betaRetrieves a payment and its status history.
/payments/{id}/releasesbetaReleases a locked payment. Requires Idempotency-Key.
Customers and verification
/customersCreates a customer. external_ref is unique per business.
/customersLists customers, kyc_status filter.
/customers/{id}Retrieves a customer.
/kyc-sessionsOpens a verification for a customer or for the business.
/kyc-sessions/{id}Retrieves a verification.
/kyc-sessions/{id}/submissionsSubmits the data (individual or company).
/kyc-sessions/{id}/documentsUploads a document or selfie.
/credentialsCredentials recorded on the XRPL for an address (subject).
Disputes
/disputesOpens a dispute on a locked payment, within the window.
/disputesLists disputes.
/disputes/{id}Retrieves a dispute and its decision.
Wallets and signatures
/wallet-connectionsConnects the business receiving wallet.
/wallets/{id}Retrieves a wallet.
/wallets/{id}/balancesAvailable, reserved and escrowed balance.
/signature-requests/{id}Retrieves a signature request (Xaman QR and deeplink).
Data and account
/ledger-transactionsTransactions sent to the XRPL.
/metrics/summaryPeriod summary (escrow payments).
/metrics/timeseriesTime series for one metric.
/billingPlan, this month's fees and open invoice.
/networkNetwork, reserves, default fee and readiness.
/meWho the key is: business, role and environment.