Download OpenAPI specification:Download
Documentation for the API of Funtico Payment Service Provider
Create a transaction
required | Array of objects (Item) non-empty Items to be purchased in the transaction. At least one item is required. |
| metadata | object or null (TransactionMetadata) Metadata of the transaction specified by the game |
| success_url | string or null <url> (SuccessURL) URL to redirect to after the transaction is successfully completed. Nullable in case of new_tab UI mode. |
| cancel_url | string or null <url> (CancelURL) URL to redirect to after the transaction is cancelled or failed |
| ui_mode required | string (UIMode) Enum: "redirect" "new_tab" UI mode of the transaction |
| expiration_sec required | integer Expiration time of the transaction in seconds |
{- "items": [
- {
- "name": "Magic Coin",
- "description": "A magic coin that can be used to buy power-ups",
- "metadata": {
- "xp": 100,
- "rarity": "common",
- "category": "power-up"
}, - "quantity": 10,
- "unit_price": 0.1,
- "currency": "tico"
}
], - "metadata": {
- "in_game_user_id": 1234,
- "user_ip": "127.0.0.1",
- "user_country": "US"
}, - "ui_mode": "redirect",
- "expiration_sec": 3600
}{- "status": "transaction_created",
- "data": {
- "id": "a433d089-38da-45c9-862e-539c377545cb",
- "items": [
- {
- "name": "Magic Coin",
- "description": "A magic coin that can be used to buy power-ups",
- "metadata": {
- "xp": 100,
- "rarity": "common",
- "category": "power-up"
}, - "quantity": 10,
- "unit_price": 0.1,
- "currency": "tico"
}
], - "metadata": {
- "in_game_user_id": 1234,
- "user_ip": "127.0.0.1",
- "user_country": "US"
}, - "ui_mode": "redirect",
- "expires_at": "2025-06-12T05:54:05.180573Z",
- "created_at": "2025-06-10T07:54:05.180573Z",
- "updated_at": "2025-06-10T07:54:05.180573Z",
- "current_status": {
- "current": "failed",
- "reason": "Insufficient balance"
}
}
}Get a transaction by ID
| id required | string <uuid> |
{- "status": "ok",
- "data": {
- "id": "a433d089-38da-45c9-862e-539c377545cb",
- "items": [
- {
- "name": "Magic Coin",
- "description": "A magic coin that can be used to buy power-ups",
- "metadata": {
- "xp": 100,
- "rarity": "common",
- "category": "power-up"
}, - "quantity": 10,
- "unit_price": 0.1,
- "currency": "tico"
}
], - "metadata": {
- "in_game_user_id": 1234,
- "user_ip": "127.0.0.1",
- "user_country": "US"
}, - "ui_mode": "redirect",
- "expires_at": "2025-06-12T05:54:05.180573Z",
- "created_at": "2025-06-10T07:54:05.180573Z",
- "updated_at": "2025-06-10T07:54:05.180573Z",
- "current_status": {
- "current": "failed",
- "reason": "Insufficient balance"
}
}
}