Payment Intents API
For detailed API documentation on payment intents, including endpoints, parameters, and response formats, please visit our API Reference .
Use Cases
The Payment Intents API enables various payment scenarios for your application:
- Gaming: Enable players to purchase in-game assets and withdraw earnings
- E-commerce: Accept cryptocurrency payments for products and services
- Digital Services: Offer subscription payments with crypto
- Marketplaces: Facilitate buyer-seller transactions using blockchain technology
- Loyalty Programs: Distribute rewards tokens to customers
API Endpoints
The Payment API provides several endpoints:
- Create Payment Intent (
POST /v1/studio/api/payment/intent): Generate a payment intent when a user wants to make a payment - Get Payment Intent (
GET /v1/studio/api/payment/intent/{id}): Retrieve details about a specific payment - List Payment Intents (
GET /v1/studio/api/payment/intents): Get all payment intents with optional filtering - Withdraw Tokens (
POST /v1/studio/api/asset_pro/transfer): Transfer tokens to users (for withdrawals)
Payment Intent Fields
A payment intent object contains the following fields:
| Field | Type | Description |
|---|---|---|
payment_intent_id | string | Unique identifier for the payment transaction |
payment_chain_id | string | Blockchain network identifier (e.g., “arb” for Arbitrum) |
payment_address | string | Blockchain wallet address for receiving payment |
token_address | string | Smart contract address of the payment token |
symbol | string | Token symbol (e.g., “USDT”) |
decimals | number | Number of decimal places supported by the token |
crypto_amount | string | Exact amount of cryptocurrency to be paid |
fiat_amount | string | Equivalent amount in fiat currency |
fiat_currency | 'TWD' | 'USD' | Fiat currency type (TWD or USD) |
payment_deadline | number | Payment expiration time (Unix timestamp) |
status | PaymentStatus | Current payment status |
payment_tx_hash | string | null | Blockchain transaction hash of the payment |
received_crypto_amount | string | null | Actual amount of cryptocurrency received |
aggregated_crypto_amount | string | null | Total amount including any combined payments |
refund_amount | string | null | Amount refunded if a refund was processed |
refund_tx_hash | string | null | Blockchain transaction hash of the refund |
callback_url | string | null | Webhook URL for payment status notifications |
order_data | Record<string, any> | null | Custom data related to the order |
group_key | string | null | Identifier for grouping related payments |
Payment Intent Statuses
When working with the Payment Intents API, you’ll encounter several possible statuses:
| Status | Description |
|---|---|
pending | Initial state - waiting for user payment |
success | Payment received and confirmed |
expired | Payment window closed without receiving funds |
insufficient_not_refunded | Received amount was too low, pending refund |
insufficient_refunded | Insufficient payment has been refunded |
Getting Started
To integrate the Payment Intents API into your application, you’ll need to:
- Obtain API Key - Get your API key from KryptoGO Studio
- Choose Integration Path - Select the integration approach that best fits your needs
- Implement API Calls - Set up your backend to communicate with KryptoGO services
Visit our API Quick Start Guide for step-by-step instructions to help you get started with your integration, whether you have your own server or need a server solution.