Create top-up payin config

post

https://api.sandbox.rainforestpay.com/v1/payin_configs/top_up

Create the configuration for a top-up payin to top up a merchant's balance. Top-up payin configs only support specifying the amount. All other payin configurations are not applicable to top-ups.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

merchant_id

string

required

The unique merchant identifier.

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

idempotency_key

string

required

length between 1 and 255

A unique identifier provided by the platform. This key will be used to detect subsequent retries of the same request. Subsequent requests with the same key will return the result of the first request, regardless if the first request succeeded or failed. This identifier should be generated by the platform and can be max 255 characters.

amount

integer

required

≥ 1

The amount to top up, in minor units.

For example, 100000 is 1,000.00 USD.

currency_code

string

enum

required

length between 3 and 3

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

Allowed:

Headers

Rainforest-Api-Version

string

enum

Defaults to 2024-10-16

Allowed:

Responses

200OK

400Bad request, check for validation errors.

401Authorization missing or invalid.

403Authorization insufficient for requested action.

5XXUnexpected error.