website·Indexed 30 days ago
https://docs.i-pay.ioSearchable website documentation for I Pay from https://docs.i-pay.io.
Integrating iPay requires a combination of dashboard configuration and technical implementation. The process consists of five primary steps:
When a payment is successfully completed and funds are delivered to the wallet, i-pay.io sends an HTTP POST request with a JSON payload to the configured IPN URL. Note that there is no status field in the payload; the receipt of the callback itself indicates a completed payment.
Processing Workflow:
authorization header against your configured secret token.customerID (which corresponds to the customId passed in the payment URL) to identify the customer in your records.transferedAmount (the net amount received in the wallet).200 OK to confirm receipt.Technical Constraints:
Content-Type: application/jsontransferedAmount and transactionFeePrecent.POST /your-ipn-endpoint HTTP/1.1
Content-Type: application/json
authorization: <your secret token>After account approval, follow these steps to access the dashboard and complete the initial configuration:
authorization header. The callback payload contains the customerID (which corresponds to the customId sent in the payment URL) and the transferedAmount (the net USDT delivered to the wallet). Ensure your processing logic is idempotent to avoid duplicate credits for the same transaction ID.// Express route to handle iPay JSON callback
const express = require('express');
const app = express();
app.use(express.json()); // Parses JSON body
const SECRET_TOKEN = 'YOUR_SECRET_TOKEN'; // Optional secret token from iPay
app.post('/ipay-callback', (req, res) => {
// Verify the authorization header (if a secret token is configured)
if (SECRET_TOKEN && req.get('authorization') !== SECRET_TOKEN) {
return res.status(401).send('Invalid token');
}
const data = req.body || {};
if (data.customerID === undefined || data.transferedAmount === undefined) {
return res.status(400).send('Bad payload');
}
// Note the field spellings: transferedAmount (single r), transactionFeePrecent
const depositId = String(data.customerID); // your customId, returned as a string
const amountReceived = Number(data.transferedAmount); // net USDT delivered to your wallet
const txId = data.blockchainTxId;
// TODO: Update your CRM/database to mark depositId as completed with amountReceived.
// Make this idempotent: ignore the callback if depositId (or txId) was already credited.
console.log(`Deposit ${depositId} completed, amount: ${amountReceived} USDT (tx ${txId})`);
// Respond to acknowledge receipt
res.sendStatus(200);
});To receive payments, you must link a crypto wallet to your company account. iPay uses a decentralized settlement model where funds from customer purchases are sent directly to the wallet address you provide. Each added wallet is assigned a unique Account ID, which is included in callback data to identify the payment destination.
Steps to add a wallet:
Warning: Carefully verify the wallet address before saving. iPay forwards funds exactly to the address provided; incorrect addresses will result in lost funds.
To test the iPay integration, you must first have a configured callback URL, a registered redirect URL, an API key, and a constructed REST API URL. The testing process verifies that funds are correctly routed to your wallet and that your server receives the payment callback.
Testing Steps:
walletAddress parameter (e.g., ...&walletAddress=0x...). This is a unique, one-time Polygon wallet address (OTW).walletAddress and send any amount of USDT (Polygon) to it using a wallet like MetaMask. You do not need to send the exact amount shown in the widget.transferedAmount field matches the net amount received in your wallet.// Example of a generated payment URL for testing
https://us-central1-nfgdatabasedemo.cloudfunctions.net/app/api/invoice_external?apiKey=TTy7Xory54M6KDG8lb1fecVkEsgG3VZi&customId=72295640&onRampProvider=provider1&defaultFiatCurrency=GBP&defaultFiatAmount=1122&colorCode=D000F2&screenTitle=DepositTest1. Apply at: https://i-pay.io/
2. Activate at: https://dash.i-pay.io/ (via 'Forgot password' link)iPay provides a webhook secret token for each API key to ensure that incoming callback requests to your IPN URL are authentic and untampered. This token is transmitted in the authorization HTTP header of every POST request; it is not included in the JSON request body.
To implement this security measure:
authorization header against your stored token before processing the payment data.While this check is optional, it is highly recommended. If you choose not to use the secret token, you should protect your IPN endpoint using alternative methods such as IP whitelisting.
# Example Verification (Pseudo-code)
if request.headers.get('authorization') == stored_secret_token:
process_payment(request.json)
else:
reject_callback()authorization header against your secret token, parse the JSON body, and update the deposit record in your database. Ensure the operation is idempotent by checking if the customerID or blockchainTxId has already been credited. Respond with an HTTP 200 OK to acknowledge receipt.<?php
// iPay callback handler (e.g., callback.php)
if ($_SERVER['REQUEST_METHOD'] === 'POST') {
$secretToken = 'YOUR_SECRET_TOKEN'; // Optional secret token from iPay
// Verify the authorization header (if a secret token is configured)
$headers = array_change_key_case(getallheaders(), CASE_LOWER);
if ($secretToken !== '' && (($headers['authorization'] ?? '') !== $secretToken)) {
http_response_code(401);
exit('Invalid token');
}
$payload = json_decode(file_get_contents('php://input'), true);
if (!is_array($payload) || !isset($payload['customerID'], $payload['transferedAmount'])) {
http_response_code(400);
exit('Bad payload');
}
// Note the field spellings: transferedAmount (single r), transactionFeePrecent
$depositId = (string) $payload['customerID']; // your customId, returned as a string
$amountReceived = (float) $payload['transferedAmount']; // net USDT delivered to your wallet
$txId = $payload['blockchainTxId'] ?? null;
// TODO: Update deposit record $depositId in your CRM/database with $amountReceived.
// Make this idempotent: ignore the callback if $depositId (or $txId) was already credited.
// Send HTTP 200 OK to iPay
http_response_code(200);
exit('OK');
}