Skip to main content
GET
List inbound credits (money in)

Authorizations

Authorization
string
header
required

Server API key, scoped. pk_test_ keys hit the sandbox tenant.

Headers

X-Request-Id
string

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.

Maximum string length: 128

Query Parameters

limit
integer
default:25

Page size, 1–100.

Required range: 1 <= x <= 100
after
string

Cursor from the previous page's next_cursor. Returns older items. Don't send with before.

before
string

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.

status
enum<string>[]

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 with matchInboundCredit.
Available options:
matched,
unattached
matched_to_type
enum<string>

Only credits matched to this kind of collection. What a credit was matched to. account means it was credited to the account only.

Available options:
invoice,
payment_link,
virtual_account,
account
invoice_id
string

Only credits matched to this invoice.

Only credits matched to this payment link.

virtual_account_id
string

Only credits received into this static virtual account.

account_id
string

Only credits that settled into this account.

q
string

Free-text search.

Maximum string length: 200
created_gte
string<date-time>

Only items created at or after this time.

created_lte
string<date-time>

Only items created at or before this time.

include
enum<string>

Set to total_count to add total_count to the list response.

Available options:
total_count

Response

A page of inbound credits.

Cursor page. Domain files compose this with allOf and set data.items.

object
string
required
Allowed value: "list"
data
object[]
required

Items, newest first.

has_more
boolean
required

True when another page exists.

next_cursor
string | null

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.

total_count
integer

Only when include=total_count was sent.