Skip to main content
GET
Get a pay-in
Requires scope: manage:pay-in-sessions — see Required scopes. Reads one settlement record. The payInId comes from a PAY_IN_SETTLED or PAY_IN_FAILED webhook. Unknown and foreign ids return the same 404 pay-in-not-found. Reconcile against netCryptoAmount — that is what reached the account wallet.

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"

Path Parameters

payInId
string<uuid>
required

Unique pay-in identifier — the payInId from a PAY_IN_SETTLED or PAY_IN_FAILED event

Response

The pay-in

success
boolean

Indicates whether the request was successful

result
object

A pay-in settlement record — one fiat credit, its conversion, and the crypto credited to the account wallet. Amounts are exact decimal strings. Nullable fields are omitted when absent, never substituted with zero. Provider references, raw failure text, internal transaction identifiers and idempotency keys are not exposed.