Skip to main content

13 docs tagged with "api-reference"

View all tags

Capture charge

Capture a previously authorized card payment — full or partial. Separate auth and capture for hotels, car rentals, marketplaces, and pre-order flows.

Charge Webhook

Handle charge status change webhooks with signature verification and status routing.

Create charge

Create a charge for any payment method — credit card, debit card, PIX, Boleto, SPEI, OXXO, Apple Pay, Google Pay, e-wallets, and more. One endpoint, one payload structure, method-specific fields shown on demand.

Create wallet

Create a wallet to hold funds for a merchant in a specific currency — the container for all charges, settlements, and balance operations.

Get charge

Retrieve charge details, current status, installment breakdown, and multi-currency amounts by charge and wallet UUID.

Get Subscription

Retrieve subscription details including status, billing cycle, and charge history.

Get wallet

Retrieve wallet details by UUID, email, or customer ID — check balance, verify status, and power reconciliation workflows.

List charges

List and filter charges with pagination — build reconciliation dashboards, financial reports, and dispute investigation tools.

Refund charge

Refund a captured charge — full or partial. Both charge_uuid and wallet_uuid go in the URL path. Installment payments are refunded in full across all installments.

Webhooks Overview

Configure and verify webhooks for real-time payment event notifications.