Developers

Search for documents

Dev

Deposits

Operations related to deposits

All endpoints require a JWT Bearer token in the Authorization header; most also require an API key in the X-API-KEY header.

GET `/v1/deposits`

Get a list of deposits with pagination

Parameters

Name	In	Type	Required	Description
`limit`	query	`integer`	Yes	Maximum number of records to return. Starts from 1 to 1000.
`page`	query	`integer`	Yes	Page number to retrieve, starting from 0.
`enriched`	query	`boolean`	No	Include transaction data in the response. When true, enriches the dispute with transaction data where dispute.paymentPspReference === transaction.transactionId.
`selectFields`	query	`string`	No	Choose specific fields to include in the response (comma-separated). If provided, excludeFields will be ignored.
`excludeFields`	query	`string`	No	Exclude specific fields from the response (comma-separated).
`filter`	query	`string`	No	A JSON object representing the filter criteria in MongoDB Query Language (MQL) format.
`sort`	query	`string`	No	A JSON object representing the sort criteria in MongoDB Query Language (MQL) format.
`populateOptions`	query	`string`	No	Include related data in query results using a JSON object.

Responses

Status	Description
`200`	Successfully retrieved a paginated list of deposits.

GET `/v1/deposits/{id}`

Get a specific deposit by ID

Parameters

Name	In	Type	Required	Description
`id`	path	`string`	Yes	The depositId field
`enriched`	query	`boolean`	No	Include transaction data in the response. When true, enriches the dispute with transaction data where dispute.paymentPspReference === transaction.transactionId.
`selectFields`	query	`string`	No	Choose specific fields to include in the response (comma-separated). If provided, excludeFields will be ignored.
`excludeFields`	query	`string`	No	Exclude specific fields from the response (comma-separated).
`populateOptions`	query	`string`	No	Include related data in query results using a JSON object.

Responses

Status	Description
`200`	Deposit details retrieved successfully

Examples

GET `/v1/deposits`

First page of deposits, newest payout first:

curl "https://api.valpay.com/v1/deposits?limit=10&page=0&sort=%7B%22payoutDate%22%3A-1%7D" \
  -H "Authorization: Bearer YOUR_JWT_TOKEN" \
  -H "X-API-KEY: YOUR_API_KEY"

curl "https://api.valpay.com/v1/deposits?limit=10&page=0&sort=%7B%22payoutDate%22%3A-1%7D" \
  -H "Authorization: Bearer YOUR_JWT_TOKEN" \
  -H "X-API-KEY: YOUR_API_KEY"

curl "https://api.valpay.com/v1/deposits?limit=10&page=0&sort=%7B%22payoutDate%22%3A-1%7D" \
  -H "Authorization: Bearer YOUR_JWT_TOKEN" \
  -H "X-API-KEY: YOUR_API_KEY"

Response 200 (illustrative):

{
  "data": [
    {
      "_id": "665f1e2a9c8b4a0012d3e4a1",
      "depositId": "DEP_EXAMPLE_001",
      "merchantId": "665f1e2a9c8b4a0012d3e4f5",
      "amount": { "value": 482107, "currency": "USD" },
      "payoutDate": "2026-06-09T00:00:00.000Z"
    }
  ],
  "total": 96,
  "page": 0,
  "limit": 10
}

{
  "data": [
    {
      "_id": "665f1e2a9c8b4a0012d3e4a1",
      "depositId": "DEP_EXAMPLE_001",
      "merchantId": "665f1e2a9c8b4a0012d3e4f5",
      "amount": { "value": 482107, "currency": "USD" },
      "payoutDate": "2026-06-09T00:00:00.000Z"
    }
  ],
  "total": 96,
  "page": 0,
  "limit": 10
}

{
  "data": [
    {
      "_id": "665f1e2a9c8b4a0012d3e4a1",
      "depositId": "DEP_EXAMPLE_001",
      "merchantId": "665f1e2a9c8b4a0012d3e4f5",
      "amount": { "value": 482107, "currency": "USD" },
      "payoutDate": "2026-06-09T00:00:00.000Z"
    }
  ],
  "total": 96,
  "page": 0,
  "limit": 10
}

GET `/v1/deposits/{id}`

curl "https://api.valpay.com/v1/deposits/DEP_EXAMPLE_001?enriched=true" \
  -H "Authorization: Bearer YOUR_JWT_TOKEN" \
  -H "X-API-KEY: YOUR_API_KEY"

curl "https://api.valpay.com/v1/deposits/DEP_EXAMPLE_001?enriched=true" \
  -H "Authorization: Bearer YOUR_JWT_TOKEN" \
  -H "X-API-KEY: YOUR_API_KEY"

curl "https://api.valpay.com/v1/deposits/DEP_EXAMPLE_001?enriched=true" \
  -H "Authorization: Bearer YOUR_JWT_TOKEN" \
  -H "X-API-KEY: YOUR_API_KEY"

Response 200: the deposit object, enriched with transaction data.

Try it out