Skip to main content
GET
List pay-ins
Requires scope: manage:pay-in-sessions — see Required scopes. Lists the pay-in ledger — one record per fiat credit that arrived on a virtual bank account or through a pay-in session, with its settlement status, the gross and net crypto amounts, and the on-chain transaction. See Pay-ins. All filters combine with AND. Unknown or foreign accountId / virtualBankAccountId values match nothing. Records stay readable after the resources they reference are closed.

Authorizations

FlowClient Credentials
Token URL
https://login-staging.venly.io/auth/realms/VenlyFinance/protocol/openid-connect/token

Headers

x-tenant-id
string<uuid>

Which tenant the request is scoped to, among those your token grants. Omit it when the token grants exactly one tenant; it is required when the token grants more than one. A supplied value must exactly match a tenant the token grants.

Absent when required, blank, malformed, or naming a tenant the token does not grant — each gets the same generic 403 forbidden, which reveals neither whether a tenant exists nor which ones you may use. Send the header once: a repeated header is rejected the same way.

Example:

"3fa85f64-5717-4562-b3fc-2c963f66afa6"

Query Parameters

accountId
string<uuid>

Only pay-ins attributed to this account

virtualBankAccountId
string<uuid>

Only pay-ins received on this virtual bank account

from
string<date-time>

Inclusive lower bound on createdAt (UTC instant)

to
string<date-time>

Exclusive upper bound on createdAt; must be after from when both are supplied

status
enum<string>

Exact settlement status Settlement lifecycle of a pay-in, independent of the initiating session's status.

  • RECEIVED — the fiat credit was observed
  • SETTLING — conversion and the on-chain credit are in progress
  • SETTLED — the crypto is in the account wallet. PAY_IN_SETTLED fires
  • FAILED — the deposit ended without crediting the account. PAY_IN_FAILED fires
  • RETURNED — the fiat was sent back to the payer
Available options:
RECEIVED,
SETTLING,
SETTLED,
FAILED,
RETURNED
page
integer<int32>
default:1

Page number (1-based indexing)

Required range: x >= 1
size
integer<int32>
default:100

Number of items per page

Required range: x >= 1
sortOn
enum<string>
default:createdAt

Field to sort by. Only createdAt is accepted.

Available options:
createdAt
sortOrder
enum<string>
default:DESC

Sort direction. Applied only together with sortOn — on its own it is ignored and the default ordering (createdAt descending) is used, so ?sortOrder=ASC alone does not reverse a list.

Available options:
ASC,
DESC

Response

A page of pay-ins

success
boolean

Indicates whether the request was successful

result
object[]
pagination
object

Pagination metadata (top-level sibling of result)