Create beneficiary withdrawal Run in API Explorer

Add MCP server to your AI tool

Allow AI tools and LLMs to interact with the API documentation portal through MCP.

MCP server URL

https://docs.lumetrade.com/mcp

Standard setup for AI tools providing an mcp.json file

mcp.json 
{
  "Lumetrade API MCP server": {
    "url": "https://docs.lumetrade.com/mcp"
  }
}
Close
POST /api/v1/beneficiaries/withdrawals
X api key & X api secret

Creates a withdrawal using only the saved details from an existing confirmed beneficiary.

application/json

Body Required

  • beneficiaryId string

    Beneficiary id returned by the beneficiary endpoints.

    Minimum length is 1.

  • amount number Required

    Withdrawal amount in the beneficiary currency.

Responses

  • 201 application/json

    Withdrawal created successfully

    Hide response attributes Show response attributes object
    • transactionId string

      Created withdrawal transaction id.

    • status string

      Created withdrawal status.

      Values are PENDING, ACCEPTED, AWAITING_CONFIRMATION, PROCESSING, COMPLIANCE_PENDING, COMPLETED, FAILED, CANCELLED, or REVERSED.
  • 400 application/json

    Withdrawal request is invalid

    Hide response attributes Show response attributes object
    • transactionId string

      Created withdrawal transaction id.

    • status string

      Created withdrawal status.

      Values are PENDING, ACCEPTED, AWAITING_CONFIRMATION, PROCESSING, COMPLIANCE_PENDING, COMPLETED, FAILED, CANCELLED, or REVERSED.
  • 404 application/json

    Beneficiary was not found for the authenticated user

    Hide response attributes Show response attributes object
    • transactionId string

      Created withdrawal transaction id.

    • status string

      Created withdrawal status.

      Values are PENDING, ACCEPTED, AWAITING_CONFIRMATION, PROCESSING, COMPLIANCE_PENDING, COMPLETED, FAILED, CANCELLED, or REVERSED.
POST /api/v1/beneficiaries/withdrawals 
curl \
 --request POST 'https://api.lumetrade.com/api/v1/beneficiaries/withdrawals' \
 --header "X-API-KEY: $API_KEY" \
 --header "X-API-SECRET: $API_KEY" \
 --header "Content-Type: application/json" \
 --data '{"beneficiaryId":"ben_7K9Q2M","amount":101}'
Request examples 
{
  "beneficiaryId": "ben_7K9Q2M",
  "amount": 101
}
Response examples (201) 
{
  "transactionId": "WD5M8Q1P",
  "status": "PENDING"
}
Response examples (400) 
{
  "transactionId": "WD5M8Q1P",
  "status": "PENDING"
}
Response examples (404) 
{
  "transactionId": "WD5M8Q1P",
  "status": "PENDING"
}