The Valpay API Internal Service lets internal tools manage merchants, transactions, deposits, disputes, users, and related payment resources. This guide covers the basics you need before calling any endpoint.

Base URL

All requests are made to https://api.valpay.com and every endpoint is versioned under the /v1 prefix, for example https://api.valpay.com/v1/users.

Conventions

The API speaks JSON: send Content-Type: application/json on requests with a body, and expect JSON responses. List endpoints support pagination, MongoDB Query Language (MQL) filtering and sorting, and field selection. Aggregation endpoints accept a read-only MongoDB-style pipeline.

Authentication

Every endpoint requires a JWT Bearer token in the Authorization header. See the Authentication guide for details.

Making your first request

curl https://api.valpay.com/v1/brands?limit=10&page=0 \
  -H "Authorization: Bearer YOUR_TOKEN"

curl https://api.valpay.com/v1/brands?limit=10&page=0 \
  -H "Authorization: Bearer YOUR_TOKEN"

curl https://api.valpay.com/v1/brands?limit=10&page=0 \
  -H "Authorization: Bearer YOUR_TOKEN"

Available resources

The API is organised into the following resource groups, each documented under the API section: API Keys, Transactions, Deposits, Disputes, Users, Permissions, Brands, Client Key, Fee Profile Templates, Jobs, Industry Codes, and Terminals.

Next steps

Read the Authentication, Pagination, and Filtering, Sorting & Fields guides to learn the patterns shared across every list endpoint.