Conventions

Idempotency#

Send Idempotency-Key (up to 255 characters) when creating objects. If the same call is repeated with the same key, the API returns the original response with the Idempotent-Replayed: true header and creates nothing new.

• Required on POST /payments and POST /payments/{id}/releases.
• Recommended on POST /invoices and POST /customers.
• Valid for 24 hours, per API key.
• The same key with a different body returns 422 idempotency-key-reused.
• 4xx responses are stored too. After fixing the request, use a new key.

Pagination#

Lists use limit (1 to 100, default 20) and cursor. The response has data, has_more and next_cursor; pass next_cursor as cursor to fetch the next page.

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

Amounts, dates and IDs#

• Amounts are decimal strings: { "value": "25.5", "asset": { "type": "XRP" } }. On POST /invoices, amount is just the string: "25.5".
• XRP accepts up to 6 decimals. Fees are rounded down.
• Dates are ISO 8601 in UTC: 2026-10-30T14:00:00.000Z.
• IDs are prefixed by type: inv_ (link), pay_ (payment), cus_ (customer), dsp_ (dispute).

Rate limits#

120 calls per minute per key. Above that, the response is 429 rate-limited, with RateLimit and RateLimit-Policy headers. Every response carries an X-Request-Id; include it when you contact support.