/
BA
banqzinc
Search skmtc…
⌘K
Docs
Sign in
Docs
History
Schema
Generate
Retired
Filter operations
Account Information
10
Admin
13
Agreement
2
Auth
4
Bank Predictions
1
Banks
9
Branding
14
Command Palette
2
Countries
3
CrossBorder
5
Customer Bank Accounts
4
Customers
3
Dashboard
1
Default Rates
3
Embedded
8
Evidence
1
Go Live
2
Invoice
10
get
/api/v1/admin/invoices
List invoices across all billables with optional filters
post
/api/v1/admin/invoices
Create a draft invoice for a merchant over a (period, currency) window. Claims eligible transactions atomically; pre-settled fees produce an immediately_settled payment row.
get
/api/v1/admin/invoices/claimable
Preview claimable transactions for a (merchant, period) window. Uses the same eligibility predicate as create; surfaces conflicts when other invoices already own rows in the window. Used by the Create-invoice form to validate the window before submit.
get
/api/v1/admin/invoices/{invoiceId}
Get details of an invoice (any billable type)
get
/api/v1/admin/invoices/{invoiceId}/document
Returns the JSON document bundle that drives the PDF/CSV renderers — line items, per-currency subtotals, fee account, issuer block, FX snapshots. Powers the Console preview.
put
/api/v1/admin/invoices/{invoiceId}/status
Update invoice status. ISSUED issues a draft (auto-PAID if already covered by pre-settled fees); VOID releases the claimed transactions and reverts fees to PENDING (refused if any invoice_payment rows exist). `paid` is never set directly.
post
/api/v1/admin/invoices/{invoiceId}/payments
Record a payment or pre-issue credit against an invoice. payment_method=manual_bank_transfer requires ISSUED (records received funds); issue_credit allowed on DRAFT or ISSUED (write-off / pre-issue discount, requires `notes`). Idempotent on (invoice_id, external_reference).
get
/api/v1/merchants/{merchantId}/invoices
List the merchant's invoices (drafts are hidden — customers see ISSUED+ only)
get
/api/v1/merchants/{merchantId}/invoices/{invoiceId}
Get an invoice billed to the merchant
get
/api/v1/merchants/{merchantId}/invoices/{invoiceId}/document
Returns the JSON document bundle for a merchant invoice — line items, subtotals, fee account, issuer. Same 404 rules as the detail endpoint (cross-tenant, draft, never-issued).
Legal
1
Legal Entities
11
Merchant Bank Account Payment Schemes
1
Merchant Bank Accounts
6
Merchant Documents
2
Merchant Invitations
4
Merchant Rates
3
Merchants
16
Onboarding
3
Partner Invitations
4
Partners
6
Payment
1
Payment Links
6
Payment Schemes
1
Payments
8
Payout
6
Post-Processor Logs
2
Provider Configuration
4
Refund Resolution Links
4
Refunds
1
Seeds
2
Shareholder Documents
2
Shareholder Invitations
7
Shopify Orders
3
Transaction Updates (Token)
3
Transactions
14
User Invitations
2
Users
10
Webhook
3
Webhooks
5
Invoice
Copy
Copy Markdown
Copy Markdown
Copying…
Copied
Copy failed
Changes to Get details of an invoice (any billable type)
get
/api/v1/admin/invoices/{invoiceId}
Jun 17, 2026
b372e7d5563d
Revision changes
info
endpoint added
Nov 2, 2025
919eb7a392aa
Revision changes
breaking
api path removed without deprecation