Funding source
Every invoice requires afundingSource — either DEPOSIT or WALLET. This determines both how the payment is collected and which source currencies are accepted.
fundingSource | Accepted source currencies | How it works |
|---|---|---|
DEPOSIT | NGNX | Obiex provides a virtual NGN bank account. You transfer the required amount within 30 minutes. |
WALLET | NGNX, USDC, USDT | Obiex debits the required amount from your wallet immediately. Invoice goes straight to APPROVED. |
How it works
- DEPOSIT (NGNX)
- WALLET (NGNX, USDC, USDT)
Upload your invoice document
Upload the invoice file (image or PDF) via the document upload endpoint. You’ll receive a URL to include when creating the invoice.
Create the invoice
Submit the invoice with
fundingSource: "DEPOSIT", source: "NGNX", the target USD amount, beneficiary bank details, and the document URL. Obiex returns a virtual NGN bank account and the exact NGN amount to deposit.Deposit NGN
Transfer the exact NGN amount to the virtual account provided. The account is valid for 30 minutes. The invoice expires if no deposit is received within that window.
Invoice status lifecycle
| Status | Description |
|---|---|
PENDING | Invoice created, awaiting NGN deposit (DEPOSIT funding only) |
APPROVED | Deposit confirmed (DEPOSIT) or wallet debited (WALLET) — payout pending |
PROCESSING | USD payout is being processed |
COMPLETED | Payout completed. A trackingId is attached |
FAILED | Payout failed |
EXPIRED | Virtual account expired before deposit was received (DEPOSIT only) |
REFUNDED | Funds returned to your account |
Webhook notifications
Obiex sends a webhook to your callback URL on every status change. ForDEPOSIT invoices, the payload includes virtual account fields. For WALLET invoices, those fields are null.
Key endpoints
| Method | Endpoint | Description |
|---|---|---|
| POST | /uploads/invoices | Upload an invoice document (image or PDF) |
| POST | /invoices | Create an invoice |
| GET | /invoices/me | List all invoices for your account |
| GET | /invoices/{invoiceId} | Get a single invoice by ID |