Documentation

Overview

BRICS Pay provides a unified payment gateway that enables seamless cross-border transactions across BRICS member nations. This documentation covers integration for merchants, developers, and financial institutions.

Getting Started

Prerequisites

• Registered business entity in a BRICS member country
• BRICS Pay merchant account
• API credentials (Client ID and Client Secret)
• SSL certificate for your integration endpoint

Authentication

POST /oauth/token
Content-Type: application/json

{
  "grant_type": "client_credentials",
  "client_id": "your_client_id",
  "client_secret": "your_client_secret"
}

Response includes an access token valid for 1 hour.

Integration Guide

QR Code Integration

Generate a payment QR code for customers to scan with their BRICS Pay app:

POST /v1/payments/qr
Authorization: Bearer {access_token}

{
  "amount": 100.00,
  "currency": "CNY",
  "merchant_id": "MERCHANT_123",
  "order_id": "ORD_456789",
  "description": "Order #12345"
}

Webhooks

Configure webhooks to receive payment notifications:

• payment.completed - Payment successfully processed
• payment.failed - Payment failed
• refund.processed - Refund completed
• settlement.ready - Funds ready for settlement

Payment Flows

Standard Payment

1. Create payment order via API
2. Generate QR code or payment link
3. Customer scans and confirms in BRICS Pay app
4. Receive webhook confirmation
5. Settlement to merchant account

Refund Process

POST /v1/refunds
{
  "original_transaction_id": "TXN_123456",
  "amount": 50.00,
  "reason": "Customer request"
}

Security

• All API calls must use HTTPS
• Tokens expire after 1 hour
• Webhook payloads are signed with HMAC-SHA256
• Sensitive data should never be logged
• Implement idempotency keys for all transactions

Testing

Use the sandbox environment for testing:

• Sandbox URL: https://sandbox.bricspay.com/api
• Test Merchant ID: TEST_MERCHANT_001
• Test Cards: Use test card numbers provided in sandbox dashboard