Quick Start

Welcome to the Coinom API. This guide shows you how to accept your first cryptocurrency payment in just a few minutes. By the end of this guide, you will be able to:

Create a payment
Redirect your customer to the Coinom payment page
Verify the payment
Complete your order securely

Prerequisites

Before you start, make sure you have:

A Coinom account
An active merchant
An API Key

If you haven’t created a merchant yet, follow the Create Merchant & Generate API Key guide.

Payment Flow

Every payment follows the same simple flow.

Your Server
     │
     │  Create Payment
     ▼
Coinom API
     │
     │  Returns trackId
     ▼
Your Website
     │
     │  Redirect Customer
     ▼
Coinom Checkout
     │
     │  Customer Pays
     ▼
Callback URL
     │
     │  Verify Payment
     ▼
Your Server
     │
     ▼
Order Completed

Step 1 — Create a Payment

Create a payment by sending a POST request to the Coinom API.

POST https://app.coinom.com/api/v1/request
Content-Type: application/json

Example request

{
    "merchant": "coinom_xxxxxxxxxxxxxxxxx",
    "amount": 99.99,
    "description": "Premium Plan",
    "callbackUrl": "https://example.com/payment/callback",
    "returnUrl": "https://example.com/payment/success"
}

Successful response

{
    "result": 100,
    "trackId": "9D7F1A5D",
    "message": "success"
}

When the request succeeds, Coinom returns a unique trackId. You’ll use this value to redirect the customer and verify the payment later.

For a complete description of all request fields and responses, see Create Payment.

Step 2 — Redirect the Customer

Redirect your customer to the Coinom hosted checkout page.

https://app.coinom.com/pay/{trackId}

Example

https://app.coinom.com/pay/9D7F1A5D

The customer can securely complete the payment using any supported cryptocurrency.

Step 3 — Wait for the Callback

After the payment is completed, Coinom sends an HTTP request to the callbackUrl you provided when creating the payment. This callback notifies your server that the payment status has changed.

Do not rely on the customer returning to your website. Always verify the payment on your server.

Step 4 — Verify the Payment

Verify the payment using the Verify Payment endpoint.

POST https://app.coinom.com/api/v1/verify

Example request

{
    "merchant": "coinom_xxxxxxxxxxxxxxxxx",
    "trackId": "9D7F1A5D"
}

Successful response

{
    "result": 100,
    "amount": 99.99,
    "refNumber": "CO-10235"
}

Only treat the payment as successful when:

result equals 100
The returned amount matches your original payment amount

Never mark an order as paid before verifying it using the Verify Payment endpoint.

Complete Flow

// 1. Create payment
POST /request

// 2. Receive trackId
$trackId = $response->trackId;

// 3. Redirect customer
https://app.coinom.com/pay/{trackId}

// 4. Customer completes payment

// 5. Coinom calls your callback URL

// 6. Verify payment
POST /verify

// 7. If result == 100
// Mark the order as paid

Next Steps

Continue with the detailed API documentation.

Create Payment

Learn how to create a new payment.

Verify Payment

Verify completed payments.

Response Codes

Understand every API response code.

Telegram Bot

Accept payments inside Telegram bots.

Getting Started

Plugins

API

Prerequisites

Payment Flow

Step 1 — Create a Payment

Step 2 — Redirect the Customer

Step 3 — Wait for the Callback

Step 4 — Verify the Payment

Complete Flow

Next Steps

Create Payment

Verify Payment

Response Codes

Telegram Bot

​Prerequisites

​Payment Flow

​Step 1 — Create a Payment

​Step 2 — Redirect the Customer

​Step 3 — Wait for the Callback

​Step 4 — Verify the Payment

​Complete Flow

​Next Steps

Create Payment

Verify Payment

Response Codes

Telegram Bot

Prerequisites

Payment Flow

Step 1 — Create a Payment

Step 2 — Redirect the Customer

Step 3 — Wait for the Callback

Step 4 — Verify the Payment

Complete Flow

Next Steps