API Documentation

Comprehensive API reference for integrating with the CCS Platform

5
Endpoints
99.9%
Uptime
POST
Payments

Send Payment Instructions

API to allow CCS Members to send batch or individual payment instructions to FSPs for processing.

POST
Confirmations

Receive Payment Confirmations

API to receive payment instruction confirmations from FSPs after processing transactions.

POST
Statements

Receive Account Statements

API to receive account statements from FSPs for reconciliation and audit purposes.

POST
Disbursements

Disbursement Transfer Confirmations

API to receive disbursement account funds transfer confirmations from the Funding Agent FSP.

GET
Authentication

Web Browser Access API

API to allow authorised CCS member finance users to access SEND-P via a Web Browser for demand planning and reports.

Send Payment Instructions

API to allow CCS Members to send batch or individual payment instructions to FSPs for processing.

POST
/api/v1/payments/instructions
Payments
Authentication

Bearer Token

Rate Limit

100 requests/minute

Status
Operational
Parameters
batch_id
string
Required

Unique identifier for the payment batch

instructions
array
Required

Array of payment instruction objects

fsp_id
string
Required

Target FSP identifier

total_amount
number
Required

Total amount for the batch

Code Examples
Sample code to integrate with this API endpoint
curl -X POST https://api.ccs.org/v1/payments/instructions \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "batch_id": "BATCH_2024_001",
    "fsp_id": "kush-bank-001",
    "total_amount": 50000.00,
    "instructions": [
      {
        "beneficiary_id": "BEN_001",
        "account_number": "KB-001234567",
        "amount": 250.00,
        "reference": "Emergency Aid Q1"
      }
    ]
  }'
Additional Resources