Create a new cash raise

post

https://live.moment-api.com/v1/account/{account_id}/cash-raise/

Submit a cash raise request for a particular account.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

account_id

string

required

Account ID

Body Params

requested_amount

double

The size of the cash raise. Provide exactly one of requested_amount or liquidation_request; sending both, or neither, is rejected with a 400.

target_date

date

required

The date by which the requested quantity of cash should be available for withdrawal.

annotation

string | null

A note about the request.

effective_at

date | null

The planned activation date of the cash raise. Must not be in the past. Defaults to today when omitted.

liquidation_request

boolean

When true, the cash raise liquidates all available cash in the account rather than raising a fixed requested amount. Provide exactly one of requested_amount or liquidation_request; sending both, or neither, is rejected with a 400. A liquidation claims the whole account, so it cannot coexist with an activated cash raise there — see the 412 response. Cash raises that have not activated yet, including future-dated ones, do not block it; they simply stay unactivated until the liquidation is resolved. Defaults to false.

activation_lead_days

integer | null

0 to 60

Plans activation the given number of business days before target_date, stamping the planned activation date as effective_at (the "Activate N days before due date" field, shared with recurring schedules). Mutually exclusive with effective_at. A plan whose date has already arrived activates on creation.

Responses

Language

URL

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200Successful response

400Bad request

403Forbidden