Create deposit

Request an on-demand deposit for a merchant's funding deposit to process the next banking day. On-demand deposits cannot be requested between 12:00 AM and 1:00 AM ET.

Returns 204 No Content. Once the deposit is scheduled, the deposit will be in the status of SCHEDULED and a deposit.scheduled webhook will trigger.

Subsequent requests with the same idempotency_key will return a 200 status code with the deposit created by the first request, or a 204 status code if the deposit has not been created yet.

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

The unique merchant identifier.

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

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.

metadata
object

Valid JSON key-value object specified by the platform to store additional information. Keys are queryable in list endpoints. Do not use the metadata field to store sensitive or confidential data.

Metadata must be less than 8 KB in size.

boolean

Bypasses the check that blocks an on-demand deposit when a deposit on the merchant's deposit frequency is already scheduled to process the next business day.

Only takes effect in sandbox, and has no effect for merchants on a DAILY deposit frequency.

Responses

204

No Content.

The on-demand deposit has been scheduled.

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