VerityPay Payments Developer Resources
Sign in

Developer Resources

Welcome to the VerityPay developer resources hub. Everything in this section is publicly accessible — no account required — and is designed to help platform integrators, partners, and internal engineers understand how to consume the VerityPay platform.

What you'll find here

  • API Documentation — REST API reference, authentication, and integration patterns for tenant-facing endpoints.
  • Postman collection & MCP — A ready-to-import Postman collection plus instructions for connecting AI agents through the Postman MCP server.

At a glance

VerityPay is a B2C digital-payments platform that delivers payments via SMS. The public API gives you programmatic access to:

  • Contacts — the recipients of your payouts and senders of your collections.
  • Receivables — money you collect from customers (one-tap payment links).
  • Payables — money you pay to customers (claims, refunds, settlements, commissions).
  • Custom fields — your own extensions to the contact and transaction schemas.
  • Suppression list — phone numbers that should never receive transactional SMS.
  • Webhook endpoints — register signed outbound event deliveries and inspect delivery history.
  • AI gateway — a feature-gated resolve → prepare → confirm flow purpose-built for AI agents (REST and MCP).

Get started

  1. Read API Conventions to understand how the API is structured, versioned, and authenticated.
  2. Mint an API token in your tenant dashboard (Settings → API Tokens) and grant it the abilities you need — see Authentication.
  3. Import the Postman collection to start exploring endpoints in seconds.
  4. Or wire up an AI agent with the Postman MCP integration.
  5. Going live? Follow the Sandbox → Production migration guide before your cutover date.

Need help?

Working on an integration and stuck? Email api-support@veritypay.com with:

  • the request_id returned in the failing response (every error envelope contains one), and
  • a brief description of what you were trying to do.

Looking for the internal architecture and runbooks? Those live in the authenticated platform admin under Documentation. This public hub only carries developer-facing material.