API Reference

Create a new cash raise

post
https://live.moment-api.com/v1/account//cash-raise/

Submit a cash raise request for a particular account.

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

Account ID

Body Params
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.

date
required

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

string | null

A note about the request.

date | null

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

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. Defaults to false.

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

Updated about 2 months ago

Did this page help you?
Language
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated about 2 months ago

Did this page help you?