17 docs tagged with "api-reference"

Cancel an active subscription and stop future billing.

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

Handle charge status change webhooks from A55 — payload structure, all statuses, and how to fetch full charge details.

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.

Generate a shareable payment link for hosted checkout experiences.

Send money out of a wallet — PIX, TED, SPEI, LATAM bank transfer, or cash pickup. One endpoint, selected by the type_payout discriminator.

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

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

Retrieve a single payout scoped to a wallet by payout_uuid and wallet_uuid.

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

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

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

List the payouts of a wallet with pagination and MagicQuery filters and sorting.

Receive payout status change notifications. A55 posts to your webhook_url whenever a payout moves through its lifecycle.

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

Validate a card without charging it using a zero-value authorization.

Configure webhooks to receive real-time charge status notifications from A55.