Agent-readable docs index: /llms.txt. Full docs in one file: /llms-full.txt. Download /docs.zip to grep all markdown files locally.

Collections API: virtual account numbers for bank transfers

Collections gives you bank account numbers (issued on Rubies MFB). When someone transfers into one, the money lands in your NGN wallet and SendCheap sends a webhook.
Account typeEndpointUse it for
StaticPOST /payment/generate_business_account_v2One permanent account for your business
InvoicePOST /payment/generate_dynamic_account_v2A separate account per order, so every payment matches its invoice

Static account

POST /payment/generate_business_account_v2
{ "account_name": "ACME STORES" }
Response
{ "status": "success", "message": "wallet generated successfully", "data": { "account_name": "SENDCHEAP(ACME STORES)", "account_number": "9876543210", "bank_name": "Rubies MFB" } }
Calling it again returns the same account. Rename it any time with POST /payment/update_account_number_name.
Payers see the name as SENDCHEAP(<your name>) in their banking app.

Invoice account

Create one per checkout. Send your own invoice_id and the amount you expect.
POST /payment/generate_dynamic_account_v2
{ "invoice_id": "INV-10045", "tranx_amount": "25000", "account_name": "JOHN DOE" }
Response
{ "status": "success", "message": "account number generated", "data": { "account_name": "ACME STORES - JOHN DOE", "account_number": "9876501234", "invoice_id": "INV-10045", "tranx_amount": "25000", "settled_amount": 0 } }
  • Amount: tranx_amount is a number in naira, sent as a string. It must be higher than your collection fee, or you get unable to process transaction.. amount too small.
  • Invoice ID: up to 50 characters, unique per order.
  • Already paid: calling it again for a paid invoice returns HTTP 201 transaction with this invoice has been paid and processed successfully. and re-sends the webhook.

Confirm a payment

Always confirm before giving value, even after a webhook.
By invoice
curl "https://api.sendcheap.us/apps/business/payment/verify_transaction?invoice_id=INV-10045" \ -H "Authorization: Bearer $SENDCHEAP_TOKEN"
HTTPmessageMeaning
200transaction confirm successfullyPaid
400payment still pendingNot paid yet
To look a payment up from the payer's receipt, use GET /payment/verify_transaction_by_session_id?session_id=..., which returns the full transfer record.

Reports

  • GET /payment/get_money_received_transaction?cursor=0 lists incoming payments, newest first, 5 per page (cursor is the page number). Add search_key to filter by invoice, session ID or account number.
  • GET /payment/get_wallet_balance returns your NGN balance.