List deposits

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.lumepay.com/mcp

Standard setup for AI tools providing an mcp.json file

{
  "Lumepay API MCP server": {
    "url": "https://docs.lumepay.com/mcp"
  }
}

GET /api/v1/deposits

Returns the authenticated user's deposit history. Pagination, sorting, date filtering, and status filtering parameters are reserved for this list endpoint; current responses remain unpaginated until server-side pagination is enabled.

Headers

X-API-KEY string Required

Public API key issued from the Lumepay API key management flow.
X-API-SECRET string Required

API secret paired with the public API key.

Query parameters

page integer(int32)

Page number, zero-based.
size integer(int32)

Page size. Planned maximum: 100.
sort string

Sort expression: field,direction.
dateFrom string(date-time)

Lower timestamp bound.
dateTo string(date-time)

Upper timestamp bound.
status string

Deposit status filter.

Responses

200 application/json

Deposits returned successfully
Hide response attributes Show response attributes object
- currency string
  
  Deposit currency code.
- transactionId string
  
  Transaction id for deposit lookups.
- amount number
  
  Deposit amount.
- fee number
  
  Deposit fee.
- status string
  
  Deposit status.
  
  Values are SUBMITTED, PENDING, PROCESSING, COMPLIANCE_PENDING, COMPLETED, FAILED, CANCELLED, or REVERSED.
- completedAt string(date-time)
  
  Completion timestamp.
403 application/json

Authenticated API key is not allowed to perform this action
Hide response attributes Show response attributes object
- code integer(int32)
- message string
- httpStatus integer(int32)
- requestId string
- timestamp string(date-time)
- errors array[object]
  
  Hide errors attributes Show errors attributes object
  
  field string
  
  message string
500 application/json

Unexpected server error
Hide response attributes Show response attributes object
- code integer(int32)
- message string
- httpStatus integer(int32)
- requestId string
- timestamp string(date-time)
- errors array[object]
  
  Hide errors attributes Show errors attributes object
  
  field string
  
  message string
401 application/json

API key authentication failed
Hide response attributes Show response attributes object
- code integer(int32)
- message string
- httpStatus integer(int32)
- requestId string
- timestamp string(date-time)
- errors array[object]
  
  Hide errors attributes Show errors attributes object
  
  field string
  
  message string
400 application/json

Request validation failed
Hide response attributes Show response attributes object
- code integer(int32)
- message string
- httpStatus integer(int32)
- requestId string
- timestamp string(date-time)
- errors array[object]
  
  Hide errors attributes Show errors attributes object
  
  field string
  
  message string

GET /api/v1/deposits

curl \
 --request GET 'http://api.example.com/api/v1/deposits' \
 --header "X-API-KEY: string" \
 --header "X-API-SECRET: string"

Response examples (200)

[
  {
    "currency": "USDT",
    "transactionId": "DP9H2K7P",
    "amount": 100.0,
    "fee": 0.0,
    "status": "COMPLETED",
    "completedAt": "2026-05-11T10:15:30"
  }
]

Response examples (403)

{
  "errors": [],
  "timestamp": "2026-01-01T00:00:00Z",
  "code": 403,
  "message": "Authenticated API key is not allowed to perform this action",
  "requestId": "req_01HY0000000000000000000000",
  "httpStatus": 403
}

Response examples (500)

{
  "errors": [],
  "timestamp": "2026-01-01T00:00:00Z",
  "code": 500,
  "message": "Unexpected server error",
  "requestId": "req_01HY0000000000000000000000",
  "httpStatus": 500
}

Response examples (401)

{
  "errors": [],
  "timestamp": "2026-01-01T00:00:00Z",
  "code": 401,
  "message": "API key authentication failed",
  "requestId": "req_01HY0000000000000000000000",
  "httpStatus": 401
}

Response examples (400)

{
  "errors": [],
  "timestamp": "2026-01-01T00:00:00Z",
  "code": 400,
  "message": "Request validation failed",
  "requestId": "req_01HY0000000000000000000000",
  "httpStatus": 400
}