Developers
API reference
The uCrypto merchant API is being built. The first table lists what the API answers today, written from its OpenAPI contract, which is tested against the API itself. The second is the full plan it is built to.
| Method | Path | What it does | Key scope |
|---|---|---|---|
GET |
/v1/health |
Check the service and its database are answering | None |
GET |
/v1/balances |
Your token balances | read |
GET |
/v1/transactions |
Your transactions, newest first, a page at a time | read |
GET |
/v1/statements |
Your monthly statement, one per token unit, computed from the ledger | read |
GET |
/v1/checkout-sales |
Tokens customers bought at your checkout, and what has become of them | read |
POST |
/v1/redemption_intents |
Ask a customer to pay you in tokens | redeem |
GET |
/v1/redemption_intents/{id} |
One of your redemption intents | read |
POST |
/v1/redemption_intents/{id}/cancel |
Cancel an open intent | redeem |
GET |
/v1/payouts |
Your payouts, newest first, a page at a time | read |
POST |
/v1/payouts |
Ask to be paid your available balance to your bank account | payout |
GET |
/v1/api_keys |
List your API keys, without the keys themselves | keys |
POST |
/v1/api_keys |
Add a new API key alongside your current one | keys |
POST |
/v1/api_keys/{id}/revoke |
Revoke another of your API keys | keys |
POST |
/v1/sandbox/events |
Deliver a signed sample of a webhook event to your sandbox endpoints | read |
| Method | Path | Purpose | Status |
|---|---|---|---|
POST |
/v1/redemption_intents |
Ask to be paid in tokens (amount, order ref, return URL on a verified domain) | Available |
GET |
/v1/redemption_intents/{id} |
Read a redemption and its notice | Available |
POST |
/v1/redemption_intents/{id}/cancel |
Cancel before the customer confirms | Available |
POST |
/v1/redemption_intents/{id}/reverse |
Reverse a redemption back to the customer's wallet | Planned |
GET |
/v1/balances |
Pending, available and payout-locked balances | Available |
GET |
/v1/transactions |
Ledger-true transaction list, identical to UI and CSV | Available |
POST |
/v1/payouts |
Withdraw to a verified bank account | Available |
GET |
/v1/payouts |
Payout history and status | Available |
GET |
/v1/disputes |
Disputes affecting the merchant | Planned |
GET |
/v1/statements |
Monthly statements | Available |
POST |
/v1/webhook_endpoints |
Register a signed webhook endpoint | Planned |
GET |
/v1/events |
List events | Planned |
POST |
/v1/events/{id}/replay |
Re-deliver an event | Planned |