> ## Documentation Index
> Fetch the complete documentation index at: https://docs.rheon.io/llms.txt
> Use this file to discover all available pages before exploring further.
# Take a one-off bank deposit
> Bank details for ONE incoming transfer, without opening a virtual account: for a user who pays once, or where you would rather not issue permanent details. The details follow the currency's rail (GET /v1/currencies) and carry the reference the transfer must quote. `reference` on the request makes the call idempotent.
The provider behind this endpoint is currently being connected, docs updating. Until then every answer carries `mock: true`, every money figure is the placeholder `1234567.89`, and ids and shapes are real and deterministic from your input.
**Provider sandbox on this deployment.** Our backend targets the bank provider's sandbox: bank details are test details, no real transfer settles, and settlement lands on a testnet (read `network` from GET /v1/config). Known limits: only the EUR/IBAN rail is wired for the simulated pay-in, and identity checks run on test-mode applicants. Every response says which environment answered in its `environment` field.
**Currently being connected, docs updating.** This endpoint answers `mock: true`: ids, shapes and statuses are real and deterministic from your input, every money figure is the placeholder `1234567.89`, and nothing is sent to a provider. Integrate against the shape; do not compute anything from the figures.
## OpenAPI
````yaml https://backend.rheon.io/openapi.json post /v1/bank/deposit
openapi: 3.1.0
info:
title: Rheon partner API
version: 1.0.0
description: >-
The /v1 surface a partner's backend calls with an API key.
**Authentication.** Every route takes `Authorization: Bearer `. One
kind of key: it carries its permissions and limits, and works from your
server, a page, or this playground alike - where it is called from is not
checked. Treat it as a secret all the same: anyone holding it acts under its
permissions until it is rotated.
**Rate limit.** Counted per key, at the requests-per-second rate configured
on the key - never per IP, so your users do not throttle each other. Over
it: `429 rate_limited`.
**Amounts.** Token amounts are decimal strings in the token's smallest unit;
fiat amounts are decimal strings in major units. Never JSON numbers.
**Errors.** One envelope everywhere: `{ error: { code, message } }`, with
`fields` added on bank refusals that named a field. A body that is not valid
JSON answers `400 invalid_request`; an endpoint that does not exist answers
`404 not_found`; a deployment with no partner keys configured answers `404
not_configured` for all of /v1.
**Environment.** Every response carries `environment` as its first field:
`sandbox` or `production`, derived from the upstreams this deployment is
configured against (never a flag). Read it off any response you paste into a
ticket. In `sandbox` no real money moves and the card corridor is the
provider's sandbox asset, which differs from production - read it from GET
/v1/config, not from these docs.
**Card corridor.** The asset and chain a card purchase settles as are fixed
per deployment, not chosen per request. GET /v1/config reports the one
actually configured.
servers:
- url: https://api.rheon.io
description: Production
security:
- bearerAuth: []
tags:
- name: Configuration
- name: Crypto deposits
- name: Orders
- name: Cards
- name: Bank transfers
- name: Virtual accounts
- name: Reference
- name: Sandbox only
paths:
/v1/bank/deposit:
post:
tags:
- Bank transfers
summary: Take a one-off bank deposit
description: >-
Bank details for ONE incoming transfer, without opening a virtual
account: for a user who pays once, or where you would rather not issue
permanent details. The details follow the currency's rail (GET
/v1/currencies) and carry the reference the transfer must quote.
`reference` on the request makes the call idempotent.
The provider behind this endpoint is currently being connected, docs
updating. Until then every answer carries `mock: true`, every money
figure is the placeholder `1234567.89`, and ids and shapes are real and
deterministic from your input.
operationId: bankDeposit
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/BankDepositRequest'
responses:
'200':
description: The details to show the payer.
content:
application/json:
schema:
$ref: '#/components/schemas/BankDeposit'
'400':
description: >-
Cannot issue this.
- `invalid_request`: accountId or walletId empty, fiatCurrency not
three letters, fiatAmount not a positive decimal string.
- `no_route`: No bank rail takes that currency - open a virtual
account or pick a listed currency.
x-error-codes:
- invalid_request
- no_route
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorEnvelope'
'401':
description: >-
No usable API key.
- `unauthorized`: Missing, malformed or unknown key. One
undifferentiated answer on purpose.
x-error-codes:
- unauthorized
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorEnvelope'
'403':
description: |-
Refused by permission.
- `permission_denied`: The key does not carry the `bank` permission.
x-error-codes:
- permission_denied
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorEnvelope'
'429':
description: >-
Over this key's rate.
- `rate_limited`: More requests per second than the key is
configured for. Counted PER KEY (all your users share one bucket),
never per IP.
x-error-codes:
- rate_limited
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorEnvelope'
'500':
description: >-
Our fault.
- `internal`: Unexpected server error. Detail is in our logs, never
on the wire.
x-error-codes:
- internal
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorEnvelope'
security:
- bearerAuth: []
components:
schemas:
BankDepositRequest:
type: object
properties:
accountId:
type: string
minLength: 1
description: The user paying. Onboard them first (POST /v1/fiat/onboard).
example: acct_8f2c91d0a4
walletId:
type: string
minLength: 1
description: >-
The registered wallet the settled stablecoin is delivered to (from
onboarding).
example: wlt_5b71e0c3
fiatCurrency:
$ref: '#/components/schemas/IsoCurrency'
description: >-
ISO 4217 code the user pays in. Must be a currency the bank rails
take (GET /v1/currencies, `fiat`); others are refused with no_route.
fiatAmount:
$ref: '#/components/schemas/DecimalMajorUnits'
description: >-
What the user will send, decimal string in major units. The details
are issued for this amount.
example: '500.00'
reference:
description: >-
Your idempotency key, up to 64 characters. A retry carrying the same
value answers the original object instead of creating a second one.
example: payout-2026-09-02-115
type: string
maxLength: 64
required:
- accountId
- walletId
- fiatCurrency
- fiatAmount
BankDeposit:
type: object
properties:
environment:
$ref: '#/components/schemas/Environment'
mock:
$ref: '#/components/schemas/MockFlag'
id:
type: string
description: The deposit id. Poll it on POST /v1/bank/deposit/status.
example: bdp_3a71f0c9e4d2b581
details:
type: object
propertyNames:
type: string
additionalProperties:
type: string
description: >-
The bank details to display, shaped by the rail (an `iban` and `bic`
for SEPA, an `accountNumber` for account-number rails, a `clabe` for
SPEI, a `key` for PIX), always with the `beneficiary` and the
payment `reference` the transfer must carry. Render what comes back
rather than assuming a shape. While the provider is being connected
the details are self-labelled test values that accept nothing.
example:
iban: IE00MOCK12345678901234
bic: MOCKIE2D
beneficiary: Rheon Payments
reference: RHN-3A71F0C9
rail:
type: string
description: The rail these details are on, as GET /v1/currencies names it.
example: sepa
expiresAt:
type: string
description: >-
ISO 8601. After this the details stop accepting money; a transfer
already in flight still settles.
example: '2026-09-15T17:30:00.000Z'
status:
$ref: '#/components/schemas/FundingStatus'
description: >-
`awaiting_deposit` on creation - the bank vocabulary GET
/v1/statuses lists.
required:
- environment
- mock
- id
- details
- rail
- expiresAt
- status
additionalProperties: false
ErrorEnvelope:
type: object
properties:
environment:
$ref: '#/components/schemas/Environment'
error:
type: object
properties:
code:
type: string
description: >-
Machine-readable error code. Branch on this, never on the
message.
example: invalid_request
message:
type: string
description: Human-readable explanation. Wording may change.
example: amount must be a decimal string of the token's smallest unit.
fields:
description: >-
Per-field complaints from the bank provider, when it named the
field it refused (bank routes only). Field names, never values.
example:
applicantInfo.nationality: iso3166_1_alpha2
type: object
propertyNames:
type: string
additionalProperties:
type: string
required:
- code
- message
additionalProperties: false
required:
- environment
- error
additionalProperties: false
description: The one error shape this API produces.
IsoCurrency:
type: string
pattern: ^[A-Za-z]{3}$
description: ISO 4217 currency code, three letters (case-insensitive on input).
example: EUR
DecimalMajorUnits:
type: string
pattern: ^\d+(\.\d+)?$
description: >-
Decimal string in the currency's major unit, e.g. "100" or "25.50".
Never a JSON number.
example: '100'
Environment:
type: string
enum:
- sandbox
- production
description: >-
Which environment answered. `sandbox`: at least one money upstream is
the provider's sandbox - no real money moves there, and the card
corridor is the sandbox's asset (read GET /v1/config), not the
documented production one. `production`: every configured upstream is
real. Derived from the configured upstream hosts at boot, never a flag.
example: sandbox
MockFlag:
type: boolean
const: true
description: >-
Always `true` on this endpoint: the provider behind it is currently
being connected, docs updating. Ids, shapes and statuses are real and
deterministic from your input; every money figure is the placeholder
`1234567.89`; nothing is sent to a provider. The field disappears the
day the provider is wired, so branch on its presence, not its value.
example: true
FundingStatus:
type: string
enum:
- awaiting_deposit
- funded
securitySchemes:
bearerAuth:
type: http
scheme: bearer
description: Your API key, issued by us and shown once at creation.
````