Sign in
Deposits

Simulate merchant deposit creation

Only available in the Rainforest sandbox environment.

Simulate processing a deposit on a merchant. Any payins or refunds with the status of PROCESSING will be transitioned to the status of SUCCEEDED.

The expected webhooks will be sent for all payins and refunds while the deposit is processing. The deposit.processing webhook will be sent when the deposit has been processed and the deposit status is PROCESSING.

On a merchant with a Daily Net billing configuration, a deposit will be processed with an amount that corresponds to the payment activity, less any applicable fees.

On a merchant with a Daily Gross billing configuration, two deposits will be processed:

  1. A funding deposit with an amount that corresponds to the gross amount of the payment activity.
  2. A billing deposit with an amount that corresponds to the applicable billing fees of the payment activity.

On a merchant with a Monthly Gross billing configuration, only the funding deposit will be processed with an amount that corresponds to the gross amount of the payment activity.

post/v1/merchants/{merchant_id}/simulate_deposit

Path parameters

merchant_idstring required

The unique merchant identifier.

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

Parameters

#/paths/~1v1~1deposits/get/parameters/0 — unresolved $ref

Response

No Content.

The merchant deposit(s) have been processed with a deposit status of PROCESSING.

Changes

No recorded changes to this endpoint across all 1 revision of this API.