Skip to main content
POST
JavaScript

Authorizations

Authorization
string
header
required

Rye API key

Body

application/json

Top-up parameters

amountSubunits
integer<int32>
required

Amount in smallest currency unit (e.g. cents).

Required range: x >= 1
Example:

500000

chargeAutomatically
boolean

Override whether to automatically charge the invoice. Defaults to the developer's drawdown config value if not specified.

Example:

false

Response

Created

bankTransferDetails
object
required

Vendor-agnostic bank transfer details for push-based payment

url
string | null
required
Example:

"https://invoice.stripe.com/i/acct_xxx/test_xxx"

amount
object
required
status
enum<string>
required
Available options:
draft,
open,
paid,
uncollectible,
void,
unknown
id
string
required
Example:

"in_abc123"