GETTING STARTED

Introduction

The Máximo Pay API is a REST API with predictable resources, JSON request and response bodies and standard HTTP status codes. Every endpoint is served under the /v1 prefix on the base URL delivered with your credentials.

Monetary values are always integers in the smallest unit of the currency (cents for BRL): R$ 150.00 is represented as 15000. Dates use ISO 8601 in UTC. Field names are camelCase in both requests and responses.

At this stage the only enabled payment method is Pix (paymentMethod: "PIX" and withdrawalMethod: "PIX"). Requests with any other method are rejected.

The resources below cover the whole Pix flow: create a charge (QR Code + copy-and-paste code), fetch and list charges, cancel a pending charge and move the balance through payouts.

Every list is paginated with the page (starting at 1) and limit (default 20) parameters. Responses are automatically scoped to the authenticated merchant.