pineplechainDocs

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.

POST/invoices

Creates a direct or escrow link.

GET/invoices

Lists links.

GET/invoices/{id}

Retrieves a link and re-reads the XRPL.

POST/invoices/{id}/cancellations

Cancels an open link.

Escrow payments

POST/paymentsbeta

Creates an escrow payment for a verified customer. Requires Idempotency-Key.

GET/paymentsbeta

Lists, filtered by status, customer and date.

GET/payments/{id}beta

Retrieves a payment and its status history.

POST/payments/{id}/releasesbeta

Releases a locked payment. Requires Idempotency-Key.

Customers and verification

POST/customers

Creates a customer. external_ref is unique per business.

GET/customers

Lists customers, kyc_status filter.

GET/customers/{id}

Retrieves a customer.

POST/kyc-sessions

Opens a verification for a customer or for the business.

GET/kyc-sessions/{id}

Retrieves a verification.

POST/kyc-sessions/{id}/submissions

Submits the data (individual or company).

POST/kyc-sessions/{id}/documents

Uploads a document or selfie.

GET/credentials

Credentials recorded on the XRPL for an address (subject).

Disputes

POST/disputes

Opens a dispute on a locked payment, within the window.

GET/disputes

Lists disputes.

GET/disputes/{id}

Retrieves a dispute and its decision.

Wallets and signatures

POST/wallet-connections

Connects the business receiving wallet.

GET/wallets/{id}

Retrieves a wallet.

GET/wallets/{id}/balances

Available, reserved and escrowed balance.

GET/signature-requests/{id}

Retrieves a signature request (Xaman QR and deeplink).

Data and account

GET/ledger-transactions

Transactions sent to the XRPL.

GET/metrics/summary

Period summary (escrow payments).

GET/metrics/timeseries

Time series for one metric.

GET/billing

Plan, this month's fees and open invoice.

GET/network

Network, reserves, default fee and readiness.

GET/me

Who the key is: business, role and environment.

Pix with XRP

In early access. The Pix endpoints are not open on the public API yet.

Something wrong on this page? Let us know.