Create Withdrawal

Request a new withdrawal. On successful request, the withdrawal must be accepted before it is queued for execution. Withdrawals accepted before

SecurityOAuth2: OAuth2Flow

Request

header Parameters

Authorization	string OAuth bearer token (see authentication flows)
x-l2f-request-id	string Optional Unique ID per request, useful for fault resolution/diagnosis and audit.
x-l2f-idempotency-id	string Unique ID used to safely retry an operation. See idempotency section for more details.

Request Body schema: application/json

withdrawal_rail required	string The rail to be used for the withdrawal. The destination counterparty must have the appropriate rail configuration. ACH
description	string Description of the transaction
source_account_id required	string Source account ID from which funds will be withdrawn.
purpose required	string Purpose of the withdrawal. Enum: "PERSONAL_ACCOUNT" "FAMILY" "INSURANCE" "INVESTMENT" "REAL_ESTATE" "TUITION" "MEDICAL" "TRAVEL" "TRADE_TRANSACTIONS" "UTILITY" "TAX" "LOAN" "BILLS" "PAYROLL" "TELECOM" "INTELLECTUAL_PROPERTY" "OTHER_BUSINESS_SERVICES" "CHARITABLE_DONATIONS" "MORTGAGE" "EXPENSES_REIMBURSEMENT" "PROFESSIONAL_SERVICES" "MARKETING" "RENTAL_PROPERTY" "OTHER"
amount required	number Amount to be withdrawn (uses the source account currency)
destination_counterparty_id required	string Destination counterparty where funds will be sent. This counterparty must be configured with the required rail information.
memo	string <= 10 characters Memo to provide on the outbound ACH

Responses

200

Success

400

Bad Request

401

Unauthorized

404

Not Found

500

Internal Error

post/v1/withdrawals

Request samples

Payload

application/json

{"withdrawal_rail": "ACH",
"description": "string",
"source_account_id": "string",
"purpose": "PERSONAL_ACCOUNT",
"amount": 0,
"destination_counterparty_id": "string",
"memo": "string"
}

Response samples

application/json

{"data": {"id": "string",
"status": "REQUESTED"
}
}