Update merchant application

patch

https://api.sandbox.rainforestpay.com/v1/merchants/{merchant_id}/applications/{merchant_application_id}

Update a merchant application. Only fields included in the payload will be updated. Omitted fields will not be updated. To remove a field, set the value to null.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

merchant_id

string

required

The unique merchant identifier.

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

merchant_application_id

string

required

The unique merchant application identifier.

Prefix is "app" in production and "sbx_app" in sandbox.

Body Params

The merchant application. Applications are used for initial approval of a merchant and for updates to an existing merchant that must be re-approved.

name

string

length ≤ 100

The unique identifier for the merchant business name.

dba_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.

legal_name

string

length ≤ 100

The merchant legal registered business name.

merchant_type

string

enum

The merchant's type of business.

mcc

string

length between 1 and 4

The merchant category code.

string

The merchant business email.

website

string

length between 1 and 100

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

website_validation_disabled

string

Boolean indicating if website validation should be disabled.

phone_number

string

length between 1 and 100

The merchant phone number, including extension.

average_ticket

integer

≥ 1

The merchant average ticket amount, in USD minor units.

For example, 1000 is 10.00 USD.

high_ticket

integer

≥ 1

The merchant high ticket amount, in USD minor units.

For example, 1000 is 10.00 USD.

average_monthly_volume

integer

≥ 1

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

For example, 1000 is 10.00 USD.

address

object

encrypted_tax_id

string

The merchant tax ID, encrypted with RSA-OAEP-SHA256. Required for all merchant types except for INDIVIDUAL.

tax_id_last_4

string

length between 4 and 4

The last 4 digits of the merchant tax ID. Required for all merchant types except for INDIVIDUAL.

owner_1

object

owner_2

object

owner_3

object

owner_4

object

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.

underwriting_reviews

object | null

Underwriting review types when an application is in the status of Needs Information and Rainforest needs additional verification from the merchant before the application can be be approved. See the review reasons guide for requirements on each review type.

Keys will be set for the underwriting review types that are applicable to the merchant application.

If no underwriting review types are required, this value will be null.

underwriting_verifications

object | null

Underwriting verifications triggered by the real-time underwriting verifications flow. See the real-time underwriting verifications guide for details.

Values will be set for the underwriting verification types that are applicable to the merchant application.

If a given underwriting verification is not applicable, the value for that key will be null.

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.

404Resource not found.

5XXUnexpected error.