List inbound credits (money in)
Every credit to this business’s accounts, newest first. All of them are already credited.
Error codes: invalid_api_key, parameter_invalid, scope_missing, rate_limited.
Authorizations
Server API key, scoped. pk_test_ keys hit the sandbox tenant.
Headers
Optional client correlation id, up to 128 characters. It is not echoed: the response's X-Request-Id is always
our own req_… id. We log your value with the request as client_request_id, so support can find a request by
either id. A longer value is refused with 400 parameter_invalid.
128Query Parameters
Page size, 1–100.
1 <= x <= 100Cursor from the previous page's next_cursor. Returns older items. Don't send with before.
Cursor for the reverse direction: returns the items newer than this one. The page is still sorted newest first;
has_more and next_cursor then continue in the same (newer) direction, so pass next_cursor as before to
keep paging towards the newest items. Don't send with after.
Comma-separated statuses. unattached lists credits you can attach to an invoice.
Every inbound credit a business sees is already credited to one of its accounts.
matched: credited to your account and recorded against an invoice, payment link or static virtual account.unattached: credited to your account, but not tied to any invoice, link or virtual account (e.g. a transfer to Naira · Main without an invoice number). Attach it withmatchInboundCredit.
matched, unattached Only credits matched to this kind of collection.
What a credit was matched to. account means it was credited to the account only.
invoice, payment_link, virtual_account, account Only credits matched to this invoice.
Only credits matched to this payment link.
Only credits received into this static virtual account.
Only credits that settled into this account.
Free-text search.
200Only items created at or after this time.
Only items created at or before this time.
Set to total_count to add total_count to the list response.
total_count Response
A page of inbound credits.
Cursor page. Domain files compose this with allOf and set data.items.
"list"Items, newest first.
True when another page exists.
Cursor for the next page in the same direction: pass it as after if this page was read with after (or no cursor), as before if it was read with before. Null when has_more is false.
Only when include=total_count was sent.