Skip to main content

Documentation Index

Fetch the complete documentation index at: https://developers.kulmipay.com/llms.txt

Use this file to discover all available pages before exploring further.

Every Send Money request returns a tracking_id. Use it to check the overall payment file status and the status of every transaction in the file.

​
Check status

curl -X POST https://app.kulmipay.com/api/v1/send-money/status/ \
  -H "Authorization: Bearer ISSecretKey_live_xxxxxxxxxxxxxxxx" \
  -H "Content-Type: application/json" \
  -d '{
    "tracking_id": "550e8400-e29b-41d4-a716-446655440000"
  }'

​
File statuses

The status endpoint returns both a human-readable status and a machine-friendly status_code.
Status codeStatusMeaning
BP103Preview and approveFile has been created and is waiting for approval.
BP104Confirming balanceKulmiPay is checking that the wallet has enough funds.
BP109Sending paymentFunds are being debited and transactions are being queued.
BP110Processing paymentTransactions have been submitted to the provider.
BC100CompletedFile processing has ended. Check individual transaction statuses for success or failure.
BE111CancelledFile was cancelled before processing completed.
BF105Failed on low balanceThe source wallet did not have enough available balance.

​
Transaction statuses

Status codeStatusMeaning
TP101PendingTransaction is queued or waiting for file approval.
TP102Payment initiatedTransaction has been sent to the provider.
TP104Processing resultsProvider result is still pending.
TS100SuccessfulTransaction was delivered successfully.
TF103Initiation failedKulmiPay could not initiate the payment with the provider.
TF106UnsuccessfulTransaction failed. Check status_description.
TC108CancelledTransaction was cancelled.

​
Response shape

{
  "file_id": "FILE_123",
  "tracking_id": "550e8400-e29b-41d4-a716-446655440000",
  "status": "Completed",
  "status_code": "BC100",
  "transactions_count": 2,
  "paid_amount": "5000.00",
  "failed_amount": "0.00",
  "transactions": [
    {
      "transaction_id": "TX_123",
      "status": "Successful",
      "status_code": "TS100",
      "account": "254712345678",
      "amount": "2500",
      "provider_reference": "SAMPLE123",
      "status_description": "Processed successfully"
    }
  ]
}
For provider-specific failures, use status_code, status_description, and provider_reference when reconciling or reporting errors to support.