POST Book Drawdown (RM Only)

post

https://sandbox.api.alphagroup.com/v1/fx/trades/forwards/drawdowns

Send Drawdown request to make payments from the forward trade.

Body Params

A drawdown to be booked.

EntityId

string

required

length ≥ 1

The Entity ID of the client creating the drawdown.

TradeId

string

required

length ≥ 1

Trade ID.

Currency

string

required

length between 3 and 3

Currency to drawdown on.

Amount

number

required

Amount to drawdown.

ValueDate

date-time | null

The value date of drawdown in YYYY-MM-DD format, e.g. 2025-04-02, earliest settlement date will be used if not provided.

FundingMethod

enum

required

Currency Account, Wire Transfer, Pre-Authorized Debit The funding method you would like to use for this draw down. Currency Account will use the existing balance on your account, Wire Transfer will await fund settlement via wire, Pre-Authorized Debit can be used if trade is PAD approved.

Payments

array of objects | null

A list of payments to make from this Drawdown, if any. Any remaining funds will be added to your Alpha currency account.

Payments

Headers

Idempotency-Key

string | null

Optionally provide an idempotency key header. If an idempotency key is present and this is a duplicate request, a 409 status will be returned. A duplicate request is a request which has the same EntityId/idempotency-key pair as another recent request.

Responses

401

Unauthorized.

403

Forbidden.

404

Resource not found.

409

Duplicate request.

Language

Credentials

OAuth2

Response

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

application/json

201Drawdown request created successfully.

400There were errors in the request.

500Internal server error.