API Documentation

{
  "event": "payment.approved",
  "transaction_id": "TXN-1234567890",
  "status": "approved",
  "amount": 5000.00,
  "received_amount": 5000.00,
  "payer_name": "John Doe",
  "bank": "GTBank",
  "payer_account_number": "0123456789",
  "account_number": "0987654321",
  "account_details": {
    "account_name": "Your Business Name",
    "bank_name": "GTBank"
  },
  "is_mismatch": false,
  "mismatch_reason": null,
  "name_mismatch": false,
  "name_similarity_percent": 100,
  "matched_at": "2024-01-15T10:30:00Z",
  "approved_at": "2024-01-15T10:35:00Z",
  "created_at": "2024-01-15T10:00:00Z",
  "timestamp": "2024-01-15T10:35:00Z",
  "website": {
    "id": 1,
    "url": "https://yourwebsite.com"
  },
  "charges": {
    "percentage": 50.00,
    "fixed": 50.00,
    "total": 100.00,
    "paid_by_customer": false,
    "business_receives": 4900.00
  },
  "email": {
    "subject": "Credit Alert",
    "from": "noreply@gtbank.com",
    "date": "2024-01-15T10:30:00Z"
  }
}

$apiKey = 'pk_your_api_key_here';
$apiUrl = 'https://check-outnow.com/api/v1';

$data = [
    'amount' => 5000.00,
    'payer_name' => 'John Doe', // Required
    'bank' => 'GTBank',
    'webhook_url' => 'https://yourwebsite.com/webhook/payment-status',
    'service' => 'Product Purchase'
];

$ch = curl_init($apiUrl . '/payment-request');
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_POST, true);
curl_setopt($ch, CURLOPT_POSTFIELDS, json_encode($data));
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    'Content-Type: application/json',
    'X-API-Key: ' . $apiKey
]);

$response = curl_exec($ch);
$httpCode = curl_getinfo($ch, CURLINFO_HTTP_CODE);
curl_close($ch);

$result = json_decode($response, true);

if ($httpCode === 201 && $result['success']) {
    echo "Payment created: " . $result['data']['transaction_id'];
    echo "Account Number: " . $result['data']['account_number'];
} else {
    echo "Error: " . $result['message'];
}

const apiKey = 'pk_your_api_key_here';
const apiUrl = 'https://check-outnow.com/api/v1';

const createPayment = async () => {
  const response = await fetch(`${apiUrl}/payment-request`, {
    method: 'POST',
    headers: {
      'Content-Type': 'application/json',
      'X-API-Key': apiKey
    },
    body: JSON.stringify({
      amount: 5000.00,
      payer_name: 'John Doe',
      bank: 'GTBank',
      webhook_url: 'https://yourwebsite.com/webhook/payment-status',
      service: 'Product Purchase'
    })
  });

  const result = await response.json();

  if (result.success) {
    console.log('Payment created:', result.data.transaction_id);
    console.log('Account Number:', result.data.account_number);
  } else {
    console.error('Error:', result.message);
  }
};

createPayment();

import requests
import json

api_key = 'pk_your_api_key_here'
api_url = 'https://check-outnow.com/api/v1'

data = {
    'amount': 5000.00,
    'payer_name': 'John Doe',  # Required
    'bank': 'GTBank',
    'webhook_url': 'https://yourwebsite.com/webhook/payment-status',
    'service': 'Product Purchase'
}

headers = {
    'Content-Type': 'application/json',
    'X-API-Key': api_key
}

response = requests.post(
    f'{api_url}/payment-request',
    headers=headers,
    data=json.dumps(data)
)

result = response.json()

if response.status_code == 201 and result['success']:
    print(f"Payment created: {result['data']['transaction_id']}")
    print(f"Account Number: {result['data']['account_number']}")
else:
    print(f"Error: {result['message']}")

<?php
// webhook-handler.php

$payload = json_decode(file_get_contents('php://input'), true);

if ($payload['event'] === 'payment.approved') {
    $transactionId = $payload['transaction_id'];
    $amount = $payload['amount'];
    $status = $payload['status'];
    
    // Update your database
    // Mark order as paid, send confirmation email, etc.
    
    // Always return 200 OK to acknowledge receipt
    http_response_code(200);
    echo json_encode(['status' => 'received']);
} else {
    http_response_code(400);
    echo json_encode(['error' => 'Unknown event']);
}
?>

{
  "success": false,
  "message": "Error description here"
}