ValPay API Quickstart
This guide will help you make your first request to the ValPay API.
The ValPay API allows partners and merchants to retrieve reporting and operational data from the ValPay platform, including:
Transactions
Deposits
Disputes
Merchants
Stores
Statements
Branding configuration
Most endpoints are read-only and return data from the ValPay platform.
The only endpoint that allows modifying data is:
PATCH /v1/transactions/{id}This endpoint allows updating a transaction’s customFields.
Step 1 - Obtain an API Key
To use the API you must first obtain an API Key from ValPay.
API keys can be created for:
A partner integration
A specific merchant
Contact ValPay Support to request access.
Step 2 - Choose an Environment
Test Environment
Use this environment during development and testing.
https://api.valpay.dev
Documentation:
https://api.valpay.dev/api-docs/
Production Environment
Production should only be used once your integration is fully tested.
https://api.valpay.com
Documentation:
https://api.valpay.com/api-docs/
Step 3 — Make Your First Request
Example: retrieve transactions.
curl -X 'GET' \ 'https://api.valpay.dev/v1/transactions?limit=10&page=0' \
-H 'accept: application/json' \
-H 'X-API-KEY: YOUR_API_KEY'
Example response:
{
"data": [
{
"transactionId": "12345",
"netAmount": 335,
"date": 1720454969000,
"transactionAmount": 335,
"brand": "example_brand",
"status": "SETTLED",
"paid": true,
"currency": "USD"
},
{
"transactionId": "13123",
"netAmount": 100,
"date": 1691164874000,
"transactionAmount": 335,
"brand": "example_brand",
"status": "REFUSED",
"paid": false,
"currency": "USD"
}
],
"total": 500,
"message": "Transactions retrieved successfully" }