Home

PIX · Card · Boleto

Charging, reconciling and paying out, in one place.

Every section below describes what the API does today — with its exact limits and defaults.

methods: ["PIX"]

PIX

Dynamic QR and copy-paste string generated at charge creation, settling to your balance same-day.

pixCopyPaste00020126...
  • Configurable expiry from 5 minutes to 7 days — 60-minute default
  • Full or partial refund via API, once per charge
  • MED disputes tracked on the platform, with MED_RECEIVED and MED_RESOLVED events
  • endToEndId available for bank reconciliation

methods: ["CARD"]

Credit card

Direct single-payment charges, with optional two-step pre-authorization.

authorizeOnlyAUTHORIZEDcapture → PAIDvoid → CANCELLED
  • authorizeOnly holds the amount; capture or void in a dedicated call
  • Brand and last four digits in the response, never the full number
  • R$ 5.00 minimum amount
  • No installments: single-payment transactions

methods: ["BOLETO"]

Boleto

Payment line, barcode and PDF in the creation response.

  • Due date configurable up to 1 year out
  • Late fine, interest and early-payment discount, per boleto
  • A boleto paid after its due date still settles to your balance
  • R$ 5.00 minimum amount

mode: "hosted"

Hosted checkout

mode: hosted returns a ready payment URL; the payer picks the method and the charge advances on its own.

PENDING_METHOD_SELECTIONPIX · CARD · BOLETOPAID
  • A dedicated URL per charge on checkout.yuvexpay.com
  • Offered methods set per charge in the methods field
  • returnUrl and completionUrl to bring the payer back
  • PENDING_METHOD_SELECTION status until the payer chooses

/v1/products

Product catalog

Products with price and image, referenced on charges by productId.

  • Full CRUD via API and dashboard
  • externalId to match your own catalog
  • Available in the sandbox too

ledger

Ledger and reports

Every entry records the resulting balance — the ledger closes by construction, and you can prove it.

ledgeramountbalance
PAYMENT_RECEIVED+ 129,908.412,05
FEE− 6,688.405,37
WITHDRAWAL− 2.500,005.905,37
  • Ledger with balance after each entry and on-demand integrity verification
  • Exports of payments, payouts and ledger in CSV, XLSX, PDF and OFX
  • Fee breakdowns and settlement forecast by period
  • Filters by status, method, dates and amounts on every listing

HMAC-SHA256

Webhooks

Every status change becomes a signed event at your endpoint.

X-Webhook-Signature: v1=8f2ba9...X-Webhook-Timestamp: 1784822400X-Webhook-Event: PAYMENT_PAIDX-Webhook-Attempt: 1
  • Twelve events, from PAYMENT_CONFIRMED to WITHDRAWAL_FAILED
  • HMAC-SHA256 signature with timestamp and a 300-second anti-replay window
  • Retries with exponential backoff — 3 by default, up to 10
  • Delivery headers with unique event, attempt and delivery ids

Start in the sandbox.

Every account starts in sandbox, with test keys and real webhooks. Going live doesn't change a line of your code.

Webhooks signed with HMAC-SHA256Same-day PIX settlementFull or partial refunds via APIExports in CSV, XLSX, PDF and OFXLedger with integrity verificationCard pre-authorization and captureSandbox with real webhooksLGPD: data export and erasure