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

Create invoice account

/payment/generate_dynamic_account_v2POST
Creates a bank account number (Rubies MFB) for one invoice, so you know exactly which order a payment belongs to.
  • Send your own invoice_id (max 50 characters). It identifies the payment in webhooks and verification.
  • tranx_amount is the amount you expect, in naira. It must be higher than your collection fee.
  • If the invoice was already paid, you get HTTP 201 and the settlement webhook is sent again.
Authorization
bearerAuth *Bearer <token>
Your API token from the SendCheap business dashboard.
Request Bodyapplication/jsonrequired
invoice_id *string
Your unique invoice/order reference, 5 to 50 characters.
Example: "INV-10045"Min length: 5Max length: 50
tranx_amount *string
Expected amount in naira, as a numeric string. Must be higher than your collection fee.
Example: "25000"
account_name *string
Name shown to the payer, at least 5 characters.
Example: "JOHN DOE"Min length: 5
Response
200 · Account for this invoice
status *"success" | "failed"
success when the request did what you asked.
message *string
Human-readable result.
data *object
The result. Shape depends on the endpoint; null on most errors.
201 · Already paid
status *"success" | "failed"
success when the request did what you asked.
message *string
Human-readable result.
data *object
The result. Shape depends on the endpoint; null on most errors.
400 · Missing or invalid field
status *"success" | "failed"
success when the request did what you asked.
message *string
Human-readable result.
data *object
The result. Shape depends on the endpoint; null on most errors.
406 · Missing or invalid API token
status *"success" | "failed"
success when the request did what you asked.
message *string
Human-readable result.
data *object
The result. Shape depends on the endpoint; null on most errors.
Request example
curl -X POST "https://api.sendcheap.us/apps/business/payment/generate_dynamic_account_v2" \ -H "Authorization: Bearer <token>" \ -H "Content-Type: application/json" \ -d '{ "invoice_id": "INV-10045", "tranx_amount": "25000", "account_name": "JOHN DOE" }'
Response example
{ "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 } }