Skip to content

Varmply Backend API (0.1.0)

Varmply API – MVP backend for campaigns, wallets, authentication, and influencer participation.

Download OpenAPI description
openapi.json
openapi.yaml
Languages
Servers
Mock server
https://docs-staging.varmply.com/_mock/openapi/
Local development server
http://localhost:3000/
Staging environment
https://api-staging.varmply.com/
Production environment
https://api.varmply.com/

Health

Health check endpoints

Operations

Authentication

User registration and authentication

Operations

Wallet

Wallet balance and operations

Operations

Get wallet balance

Request

Retrieve the authenticated user's wallet balance for a specific currency. Returns 404 if the wallet does not exist. Requires a valid JWT access token.

Security
bearerAuth
Query
currencystringrequired

ISO currency code for the wallet

Enum"NGN""USD"
Example: currency=NGN
curl -i -X GET \
  'https://docs-staging.varmply.com/_mock/openapi/wallet/balance?currency=NGN' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Wallet balance retrieved successfully

Bodyapplication/json
currencystringrequired

ISO currency code

Example: "NGN"
balanceAmountCentsintegerrequired

Wallet balance in cents (smallest currency unit)

Example: 0
Response
application/json
{
  "currency": "NGN",
  "balanceAmountCents": 0
}

Create a new wallet

Request

Create a new wallet for the authenticated user in a specific currency. Returns 201 Created on success, 409 Conflict if wallet already exists. Requires a valid JWT access token.

Security
bearerAuth
Bodyapplication/jsonrequired
currencyCodestringrequired

ISO currency code for the wallet

Enum"NGN""USD"
Example: "NGN"
curl -i -X POST \
  https://docs-staging.varmply.com/_mock/openapi/wallet \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "currencyCode": "NGN"
  }'

Responses

Wallet created successfully

Bodyapplication/json
walletIdstringrequired

Unique identifier for the wallet

Example: "wallet_abc123"
currencystringrequired

ISO currency code

Example: "NGN"
balanceAmountCentsintegerrequired

Initial wallet balance in cents (always 0 for new wallets)

Example: 0
Response
application/json
{
  "walletId": "wallet_abc123",
  "currency": "NGN",
  "balanceAmountCents": 0
}

Dev

Development-only endpoints for testing (not available in production)

Operations

Campaigns

Campaign creation, management, and funding

Operations

Participation

Campaign participation and content submission

Operations

OAuth

Social media OAuth connection flows

Operations

Metrics

Content metrics and analytics endpoints

Operations