API & Webhooks

Integrate with a modern REST API, secure your connections with JWT authentication, and receive real-time event notifications via webhooks.

Get Started

What is the ZAPPY API & Webhook infrastructure?

ZAPPY provides a RESTful API with JWT-based authentication for managing PIX payments, Automatic PIX recurring billing, and digital accounts programmatically. Paired with a real-time webhook delivery system, the platform ensures your application is notified immediately when payment events occur — from successful transactions to consent updates and refund confirmations.

API & Webhook Capabilities

REST API

A modern, resource-oriented RESTful API with predictable endpoints, standard HTTP methods, and JSON request/response payloads.

JWT Authentication

Secure every API request with JSON Web Token authentication, ensuring only authorized applications access your payment data.

Secure Token Lifecycle

Manage authentication tokens with controlled creation, expiration, and renewal to maintain security across all API interactions.

Real-time Webhooks

Receive instant HTTP notifications for every payment event — transaction confirmed, refund processed, consent updated, and more.

Webhook Protection

Protect your webhook endpoints with Basic Auth or JWT authentication, ensuring only verified ZAPPY notifications reach your systems.

Full Documentation

Access comprehensive API documentation with endpoint references, authentication guides, webhook event catalogs, and integration examples.

API & Webhooks at a Glance

Technical specifications and key features of ZAPPY's REST API and webhook system.

Architecture

RESTful with JSON

Authentication

JWT tokens

Webhook delivery

Real-time

Webhook security

Basic Auth or JWT

Frequently Asked Questions

The ZAPPY API uses JWT (JSON Web Token) authentication. You generate a token using your API credentials, include it in the Authorization header of every request, and manage the token lifecycle with controlled expiration and renewal. This ensures secure, stateless authentication for all API interactions.

ZAPPY sends webhook notifications for all key payment events, including: PIX payment confirmed, PIX payment failed, refund processed, Automatic PIX consent approved, consent cancelled, recurring charge processed, and recurring charge failed. Each notification includes the full event payload with transaction details.

ZAPPY supports two webhook authentication methods: Basic Auth and JWT. You configure your preferred method in the dashboard or via the API. Every webhook notification includes the authentication credentials, allowing your endpoint to verify that the notification originates from ZAPPY.

Ready to transform your payments?

Access the ZAPPY dashboard to manage your PIX payments in real time, track transactions, and configure webhooks. All in one place.

Access Dashboard