Lumetrade Staging API
POST /api/v1/beneficiaries/withdrawals

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

Headers

  • X-API-KEY string Required

    Public API key issued from the Lumetrade API key management flow.

  • X-API-SECRET string Required

    API secret paired with the public API key.

application/json

Body Required

  • beneficiaryId string

    Beneficiary id returned by the beneficiary endpoints.

  • 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 "Content-Type: application/json" \
 --header "X-API-KEY: string" \
 --header "X-API-SECRET: string" \
 --data '{"beneficiaryId":"ben_7K9Q2M","amount":101}'
Request examples 
# Headers
X-API-KEY: string
X-API-SECRET: string

# Payload
{
  "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"
}