Home About Us Utilities Services Community FAQ Contact
Free to sign up · No monthly fees

API Documentation

Complete reference for the VetandPay REST API v1.

Authentication

All API requests must include your API key in the Authorization header using the Bearer scheme.

Authorization: Bearer YOUR_API_KEY

Important: Keep your API keys secret. Never expose them in client-side code or public repositories.

Base URL

Live
https://api.vetandpay.ng/v1
Sandbox
https://sandbox.vetandpay.ng/v1

Escrow Endpoints

POST /escrow

Create a new escrow transaction.

{
  "buyer_email": "buyer@example.com",
  "seller_email": "seller@example.com",
  "amount": 250000,
  "currency": "NGN",
  "description": "Laptop purchase",
  "milestones": false
}
GET /escrow/{id}

Retrieve details of a specific escrow transaction.

POST /escrow/{id}/fund

Fund an escrow transaction (buyer action).

POST /escrow/{id}/release

Release funds to seller after verification.

POST /escrow/{id}/cancel

Cancel an escrow transaction (before funding).

Milestones

For multi-stage projects, create milestone-based escrow transactions. Funds are released progressively as each milestone is approved.

POST /escrow/{id}/milestones/{ref}/release

Request release of a specific milestone payment.

Disputes

Either party can raise a dispute at any point during the transaction. Disputes are reviewed by the VetandPay team and resolved within 48 hours.

Error Handling

Code Meaning
200 Success
400 Bad Request — missing or invalid parameters
401 Unauthorized — invalid or missing API key
403 Forbidden — insufficient permissions
404 Not Found — resource does not exist
422 Unprocessable — validation failed
429 Rate Limited — too many requests
500 Server Error — retry after a delay

Rate Limits

API requests are limited to 100 requests per minute per API key. Exceeding this limit returns a 429 status code.

Need higher limits? Contact us at api@vetandpay.ng to request a custom rate limit for your integration.

Need help integrating? Our developer support team is here for you.

Contact Developer Support