API Reference

Create merchant

post
https://api.sandbox.rainforestpay.com/v1/merchants

Create a merchant with an initial merchant application.

Body Params
string

The unique billing profile identifier. If omitted, the merchant will be assigned the platform's default billing profile.

Prefix is "bpf" in production and "sbx_bpf" in sandbox.

string
required
length ≤ 100

The unique identifier for the merchant business name.

string
length ≤ 100

The merchant’s public-facing name. This may be the same as the legal name if the merchant does not operate under a different name.

string
length ≤ 100

The merchant legal registered business name.

string
enum

The merchant's type of business.

string
length between 1 and 4

The merchant category code.

string

The merchant business email.

string
length between 1 and 100

The merchant website. Must begin with http:// or https://

string
length between 1 and 100

The merchant phone number, including extension.

integer
≥ 1

The merchant average ticket amount, in USD minor units.

For example, 1000 is 10.00 USD.

integer
≥ 1

The merchant high ticket amount, in USD minor units.

For example, 1000 is 10.00 USD.

integer
≥ 1

The merchant average monthly volume amount, in USD minor units.

For example, 1000 is 10.00 USD.

address
object
string

The merchant tax ID, formatted with no spaces (e.g 123456789). Required for all merchant types except for INDIVIDUAL.

Setting this field requires Rainforest approval. Platforms that meet all requirements and are approved by Rainforest can send the tax ID to Rainforest via a direct API integration.

owner_1
object
owner_2
object
owner_3
object
owner_4
object
string
enum

The merchant billing frequency. If omitted, the merchant will be assigned the platform's default billing frequency.

Allowed:
string
enum

The merchant billing type. If omitted, the merchant will be assigned the platform's default billing type.

Allowed:
string
enum

The merchant deposit frequency for funding deposits. Supported values are DAILY, WEEKLY, or MONTHLY.

Platform must be configured for the specified deposit frequency, please reach out to Support or your Platform Success Manager if not configured for a deposit frequency.

If omitted, the merchant will be assigned the platform's default deposit frequency.

Allowed:
integer

The number of business days after processing until Card payments are made available to the merchant in a deposit.

For example, 1 is T+1 and 2 is T+2

integer

The number of business days after processing until ACH payments are made available to the merchant in a deposit.

For example, 1 is T+1 and 2 is T+2

integer

The number of business days after processing until Validated ACH payments are made available to the merchant in a deposit.

For example, 1 is T+1 and 2 is T+2

integer

The number of business days after processing until Balance-Checked Validated ACH payments are made available to the merchant in a deposit.

For example, 1 is T+1 and 2 is T+2

integer

The number of business days after processing until PayPal Wallet payments are made available to the merchant in a deposit.

For example, 1 is T+1 and 2 is T+2

integer

The number of business days after processing until Venmo payments are made available to the merchant in a deposit.

For example, 1 is T+1 and 2 is T+2

integer

The number of business days after processing until PayPal Pay Later payments are made available to the merchant in a deposit.

For example, 1 is T+1 and 2 is T+2

available_deposit_method_ids
array of strings

This field is only utilized by the Merchant Onboarding Component on the deposit method step. It defines the available deposit methods in the bank account selector for the merchant to choose from.

available_deposit_method_ids
deposit_routes
object

Object with key names that correspond to the purpose of deposit method.

For example, the deposit route for the PAYMENTS key represents the deposit method being used for the merchant's funding deposits. The deposit route for the BILLING key represents the deposit method being used for the merchant's billing deposits, only applicable for merchants on gross billing.

additional_underwriting_data
object

Additional underwriting data for the platform to send merchant specific information. Reach out to your Platform Success Manager or Support to utilize this data to decision the merchant for payment processing.

boolean

Boolean indicating if card account updater is enabled.

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

Updated 7 months ago

Language
Credentials
Bearer
APIKey
URL
Response 
Click Try It! to start a request and see the response here! Or choose an example:
application/json
Updated 7 months ago