Skip to content
GRYPHEM PAYGRYPHEM PAYGRYPHEM PAY Docs

Overview

Multi-tenant crypto payment gateway API for merchants.

GRYPHEM PAY API 2026-10-01

Section titled “GRYPHEM PAY API 2026-10-01”

The GRYPHEM PAY API lets merchants create payment intents, hosted checkout sessions, invoices and payment links, register watch-only receive wallets, subscribe to signed webhooks and reconcile chain observations.

Availability. Every API key is a live key and every payment is real. Sign-up, organizations, stores and the merchant application are open to everyone. Live payments are enabled once your account is verified and approved: live API keys, payments and payouts answer feature_unavailable_error until your account is activated. Live payments are custodial, processed through the platform’s Bitcart account: received funds are held as your balance until you withdraw them with a payout. No licence, audit or partner agreement is implied by this API.

Conventions. JSON with snake_case fields; timestamps are UTC ISO-8601; amounts are decimal strings and never floating point; crypto amounts also carry integer *_base_units strings. Every response carries a Request-Id header. Creating organizations, stores, wallets, payment intents, checkout sessions, invoices, payment links and webhook endpoints honors an Idempotency-Key header (24 h, scoped to the organization and environment). Lists use cursor pagination (limit, starting_after). Exceeding a rate limit returns 429 with Retry-After; webhooks are documented in the webhooks section.

Audiences. Operations are tagged with x-audience: public (merchant API, API key or dashboard session), dashboard (dashboard session only), checkout (customer-facing, capability URL), operator (internal console), internal (chain watchers on the internal listener).

This reference contains the merchant API and the hosted checkout endpoints. Dashboard, operator and internal endpoints are intentionally omitted.

Information

  • License: Proprietary
  • OpenAPI version: 3.1.0

Operations

Section titled “Operations”
GET
/v1/health
GET
/v1/capabilities
GET
/v1/networks
GET
/v1/assets
GET
/v1/payment-intents
POST
/v1/payment-intents
GET
/v1/payment-intents/{payment_intent_id}
GET
/v1/payment-intents/{payment_intent_id}/timeline
POST
/v1/payment-intents/{payment_intent_id}/cancel
POST
/v1/payment-intents/{payment_intent_id}/resolve
POST
/v1/checkout-sessions
GET
/v1/checkout-sessions/{session_id}
GET
/v1/invoices
POST
/v1/invoices
GET
/v1/invoices/{invoice_id}
POST
/v1/invoices/{invoice_id}/void
GET
/v1/payment-links
POST
/v1/payment-links
GET
/v1/payment-links/{payment_link_id}
PATCH
/v1/payment-links/{payment_link_id}
GET
/v1/transactions
GET
/v1/transactions/{transaction_id}
GET
/v1/wallets
POST
/v1/wallets
GET
/v1/wallets/{wallet_id}
POST
/v1/wallets/{wallet_id}/disable
POST
/v1/wallets/{wallet_id}/ownership-challenge
POST
/v1/wallets/{wallet_id}/ownership-proof
GET
/v1/stores
POST
/v1/stores
GET
/v1/stores/{store_id}
PATCH
/v1/stores/{store_id}
PUT
/v1/stores/{store_id}/branding
GET
/v1/webhook-endpoints
POST
/v1/webhook-endpoints
GET
/v1/webhook-endpoints/{webhook_endpoint_id}
PATCH
/v1/webhook-endpoints/{webhook_endpoint_id}
POST
/v1/webhook-endpoints/{webhook_endpoint_id}/rotate-secret
POST
/v1/webhook-endpoints/{webhook_endpoint_id}/test
GET
/v1/webhook-deliveries
GET
/v1/webhook-deliveries/{webhook_delivery_id}
POST
/v1/webhook-deliveries/{webhook_delivery_id}/retry
GET
/v1/events
GET
/v1/events/{event_id}
GET
/v1/reports/payments
GET
/v1/reports/reconciliation
GET
/v1/billing/invoices
GET
/v1/billing/usage
GET
/v1/balances
GET
/v1/payout-assets
GET
/v1/payout-destinations
GET
/v1/payouts
POST
/v1/payouts
GET
/v1/payouts/{payout_id}
POST
/v1/payouts/{payout_id}/cancel
GET
/v1/audit-events
GET
/v1/organizations/{organization_id}
GET
/v1/customers
GET
/v1/public/checkout-sessions/{session_id}
POST
/v1/public/checkout-sessions/{session_id}/select-option
POST
/v1/public/checkout-sessions/{session_id}/refresh-quote
POST
/v1/public/checkout-sessions/{session_id}/processor-invoice
GET
/v1/public/checkout-sessions/{session_id}/events
GET
/v1/public/payment-links/{slug}
POST
/v1/public/payment-links/{slug}/checkout-sessions
GET
/v1/public/pricing
GET
/v1/public/status
POST
/v1/public/contact
POST
Payment intent created WEBHOOK
POST
Invoice awaiting payment WEBHOOK
POST
Payment detected (unconfirmed) WEBHOOK
POST
Payment confirming WEBHOOK
POST
Payment confirmed WEBHOOK
POST
Payment needs a decision WEBHOOK
POST
Payment expired WEBHOOK
POST
Payment affected by a chain reorganization WEBHOOK
POST
Payment resolved WEBHOOK
POST
Payment canceled WEBHOOK
POST
Test event WEBHOOK
POST
Business verification updated WEBHOOK
POST
Payout requested WEBHOOK
POST
Payout approved by the merchant WEBHOOK
POST
Payout rejected WEBHOOK
POST
Payout canceled WEBHOOK
POST
Payout broadcast WEBHOOK
POST
Payout completed WEBHOOK
POST
Payout failed WEBHOOK

Authentication

Section titled “Authentication”

ApiKey

Section titled “ApiKey”

Secret live API key (gp_live_…), available once your account is activated. Keep it on your server; never send it to a browser or a mobile app.

Security scheme type: http

Bearer format: gp_live_…

Session

Section titled “Session”

Dashboard session token held server-side by the SvelteKit BFF; never exposed to browser JavaScript.

Security scheme type: http

Bearer format: gps_…