RESOURCES · API DOCS

API reference for developers.

Authentication, endpoints, webhooks, idempotency, and error handling — the technical reference for integrating Vertlo.

Book a callSee how it works
VERTLO APILIVE
STYLE
REST · JSON
AUTHAPI KEYS
WEBHOOKSSIGNED
VERSIONINGSTABLE
OVERVIEW

The reference your engineers actually need.

The API reference documents Vertlo's REST endpoints in detail: authentication, request and response shapes, idempotency, pagination, error codes, and signed webhooks for every state change.

It is written for engineers integrating payments into a production system, where predictability and accurate error handling matter more than marketing prose.

BENEFITS

Reference built for production

Predictable REST

Consistent, versioned resources with clear shapes.

Signed webhooks

Verifiable events for every state change.

Idempotency

Safe retries documented for payment reliability.

Clear errors

Every error code documented with handling guidance.

HOW IT WORKS

Inside the API reference

Configured with your acquiring, routing, and reporting during onboarding — and supported by a team that knows the account.

Book a call
01

Endpoint reference

Every resource with request and response detail.

02

Auth & environments

Keys, sandbox, and live.

03

Webhook catalogue

Event types with payloads and signatures.

04

Errors & idempotency

Codes, retries, and safe request patterns.

USE CASES

What developers reference

01

Authentication

API keys, environments, and scopes.

02

Payment endpoints

Create, capture, refund, and query.

03

Webhook handling

Events, signatures, and retries.

FAQ

API reference FAQs

Answers to the questions merchants ask most about this part of the platform.

How is authentication handled?+

The API uses API keys with separate sandbox and live environments. Secrets use reveal, copy, rotate, and revoke controls and are never exposed by default.

Are webhooks signed?+

Yes — every webhook carries a verifiable signature so your systems can trust the payload's origin, with documented retry behaviour.

How do I avoid duplicate charges?+

Idempotency keys let you safely retry requests without duplicating actions; the reference documents how to use them across payment endpoints.

Is the API versioned?+

Yes — resources are versioned for stability so integrations do not break unexpectedly as the platform evolves.

RELATED ON THE PLATFORM
DocumentationAPI & Developer PlatformIntegrations

Ready to read the reference and start building?

Book a call

WE REVIEW EVERY BUSINESS INDIVIDUALLY. APPROVAL IS SUBJECT TO UNDERWRITING, COMPLIANCE, JURISDICTION, AND ELIGIBILITY REQUIREMENTS.