Lumetrade Staging API
GET /api/v1/beneficiaries

Returns confirmed beneficiaries belonging to the authenticated API key owner.

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.

Query parameters

  • currency string

    Optional beneficiary currency code filter.

Responses

  • 200 application/json

    Beneficiaries returned successfully

    Hide response attributes Show response attributes object
    • id string

      Beneficiary id used by external beneficiary endpoints.

    • currency string

      Saved beneficiary currency.

    • nickname string

      Beneficiary nickname.

    • withdrawFormDetails object

      Raw withdrawal details stored as JSON object.

      Additional properties are allowed.

      Hide withdrawFormDetails attributes Show withdrawFormDetails attributes object
      • pojo boolean
      • int boolean
      • double boolean
      • bigDecimal boolean
      • bigInteger boolean
      • nodeType string

        Values are ARRAY, BINARY, BOOLEAN, MISSING, NULL, NUMBER, OBJECT, POJO, or STRING.

      • container boolean
      • short boolean
      • long boolean
      • valueNode boolean
      • missingNode boolean
      • floatingPointNumber boolean
      • integralNumber boolean
      • string boolean
      • boolean boolean
      • object boolean
      • textual boolean Deprecated
      • binary boolean
      • number boolean
      • array boolean
      • empty boolean
      • null boolean
      • float boolean
      • embeddedValue boolean
    • createdAt string(date-time)

      Beneficiary creation timestamp.
GET /api/v1/beneficiaries 
curl \
 --request GET 'https://api.lumetrade.com/api/v1/beneficiaries' \
 --header "X-API-KEY: string" \
 --header "X-API-SECRET: string"
Response examples (200) 
[
  {
    "id": "ben_7K9Q2M",
    "currency": "ZAR",
    "nickname": "FNB Savings",
    "withdrawFormDetails": {
      "bankName": "FNB",
      "accountNumber": "1234567890"
    },
    "createdAt": "2026-05-11T10:15:30Z"
  }
]