Skip to content
GRYPHEM PAY Docs
Search
Ctrl
K
Cancel
Select theme
Dark
Light
Auto
Select language
English
Português (Brasil)
Suomi
Menu
Start here
Introduction
Quickstart
Core concepts
Authentication & API keys
Idempotency
Errors
Pagination
Payments
Payment intents
The payment state machine
Hosted checkout
Invoices
Quotes & rounding
Networks & assets
Wallets
Webhooks
Webhooks
Verify webhook signatures
Operations & trust
Reconciliation & reports
Security model
Regulatory status
SDKs
TypeScript SDK
React helpers
Webhook verifier
Python SDK
Go SDK
API reference
Overview
Platform
Overview
Non-sensitive readiness summary
GET
Networks, assets and payment methods with honest availability
GET
List registered networks and their availability
GET
List registered assets
GET
Payment Intents
List payment intents
GET
Create a payment intent
POST
Get a payment intent
GET
List a payment intent's state events
GET
Cancel a payment intent
POST
Record a merchant decision for underpaid, overpaid, late or review states
POST
Checkout Sessions
Create a hosted checkout session for a payment intent
POST
Get a checkout session
GET
Invoices
List invoices
GET
Create an invoice
POST
Get an invoice
GET
Void an invoice
POST
Payment Links
List payment links
GET
Create a payment link
POST
Get a payment link
GET
Update a payment link
PATCH
Transactions
List observed chain transfers
GET
Get an observed chain transfer
GET
Wallets
List receive wallets
GET
Register a watch-only or simulated wallet
POST
Get a wallet
GET
Disable a wallet
POST
Create a wallet ownership challenge
POST
Submit a signed ownership proof
POST
Stores
List stores
GET
Create a store
POST
Get a store
GET
Update a store
PATCH
Replace a store's checkout branding
PUT
Webhooks
List webhook endpoints
GET
Create a webhook endpoint
POST
Get a webhook endpoint
GET
Update a webhook endpoint
PATCH
Rotate an endpoint's signing secret
POST
Send a webhook.test event to an endpoint
POST
List webhook deliveries
GET
Get a webhook delivery with its attempts
GET
Retry a webhook delivery now
POST
Events
List events
GET
Get an event
GET
Reports
Export payments as CSV or JSON
GET
Get reconciliation results and open discrepancies
GET
Billing
List platform billing invoices
GET
Get metered usage for the current period
GET
Balances & Payouts
Overview
List custodial balances
GET
List the assets the platform receives and pays out
GET
List allow-listed withdrawal addresses
GET
List payouts
GET
Request a payout
POST
Get a payout
GET
Cancel a payout that was not submitted yet
POST
Audit
List audit events
GET
Organizations
Get an organization
GET
Dashboard
List customers aggregated from payment intents
GET
Public Checkout
Get a hosted checkout session
GET
Choose network + asset; locks a quote and assigns a unique address
POST
Issue a new quote after the previous one expired (same network and address)
POST
Open the processor invoice (payment addresses) for a live checkout
POST
Server-sent events with payment status changes
GET
Get a public payment link
GET
Start a checkout session from a payment link
POST
Public Website
Get public pricing plans
GET
Get public service status and incidents
GET
Submit a contact request
POST
Webhooks
Payment intent created
POST
Invoice awaiting payment
POST
Payment detected (unconfirmed)
POST
Payment confirming
POST
Payment confirmed
POST
Payment needs a decision
POST
Payment expired
POST
Payment affected by a chain reorganization
POST
Payment resolved
POST
Payment canceled
POST
Test event
POST
Business verification updated
POST
Payout requested
POST
Payout approved by the merchant
POST
Payout rejected
POST
Payout canceled
POST
Payout broadcast
POST
Payout completed
POST
Payout failed
POST
Changelog
Changelog & versioning
Select theme
Dark
Light
Auto
Select language
English
Português (Brasil)
Suomi
Overview
Platform
Section titled “Platform”
Health, capabilities and the public registry.
Operations
Section titled “Operations”
GET
/v1/health
GET
/v1/capabilities
GET
/v1/networks
GET
/v1/assets