Skip to main content
GET
Get a pay-in session
Coming soon — not yet available. Hosted pay-in sessions are documented ahead of launch. Until they’re enabled for your company, creating one is refused with 400 no-suitable-provider. To receive fiat today, use a virtual bank account.
Requires scope: manage:pay-in-sessions — see Required scopes. Returns a single pay-in session from persisted state. It advances only when the payment provider reports back, so polling this endpoint can only ever show you PAYMENT_RECEIVED as its happy-path end — settlement is tracked on the pay-in, signalled by PAY_IN_SETTLED.

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

accountId
string<uuid>
required

Unique account identifier

sessionId
string<uuid>
required

Unique pay-in session identifier

Response

The pay-in session

success
boolean

Indicates whether the request was successful

result
object