API Reference
  1. Payouts
  2. Payouts

Get top-up quote

get
https://api.sandbox.rainforestpay.com/v1/top_up_quotes

The quote calculates the total amount of the top-up, including the top-up fee, and estimates when the top-up is processed and the funds become available.

A top-up quote can be provided for either a payment_method_id or payment_method_type.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
string

The unique merchant identifier.

Prefix is "mid" in production and "sbx_mid" in sandbox.

string

The unique payment method identifier.

Prefix is "mtd" in production and "sbx_mtd" in sandbox.

string
enum

The type of payment method.

integer
required
≥ 1

The net amount to add to the merchant's balance after fees, in minor units.

For example, 100000 is 1,000.00 USD.

string
enum
required
length between 3 and 3

Three-letter ISO currency code, in uppercase. Currently, only USD is supported.

Allowed:
Headers
string
enum
Defaults to 2024-10-16
Allowed:
Responses

Updated 3 days ago

Did this page help you?
Language
Credentials
Bearer
APIKey
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 3 days ago

Did this page help you?