Integration — API reference

Fundamentals

Overview Platform architecture Getting started Authentication Environments & credentials

Accept payments

Create a charge Payment methods Lifecycle & status Refunds & chargebacks Payment Links & Checkout Subscriptions & recurring

Card services

Tokenization Zeroauth & validation

Pay out

Payouts FX & multi-currency

Integration

Webhooks API reference Merchant portal

Testing

Test cards

Integration

API reference

Complete reference of the platform public endpoints. All calls use Authorization: Bearer <token>.

Wallets

GET/api/v1/bank/wallet/

Lists the wallets of the authenticated account.

POST/api/v1/bank/wallet/

Creates a wallet (additional wallets tied to the entity).

Charges

POST/api/v1/bank/wallet/charge/

Creates a Pix, boleto, card or other charge.

GET/api/v1/bank/wallet/charge/

Lists wallet charges with filters by status and period.

POST/api/v1/bank/wallet/charge/capture/

Captures a previously authorized card (confirmed).

POST/api/v1/bank/wallet/charge/<charge_uuid>/refund/<wallet_uuid>/

Refunds a charge fully or partially.

GET/api/v1/bank/public/charge/<charge_uuid>/

Public charge lookup (shows payment data).

Checkout & recurring

POST/api/v1/bank/wallet/payment-link/

Creates a payment link with a hosted payment page.

GET/api/v1/bank/wallet/payment-link/

Lists the wallet payment links.

POST/api/v1/bank/wallet/subscription/

Creates a recurring subscription.

POST/api/v1/bank/wallet/subscription/<subscription_uuid>/cancel/<wallet_uuid>/

Cancels a subscription.

Card services

POST/api/v1/bank/wallet/tokenization/

Tokenizes a card.

POST/api/v1/bank/wallet/zeroauth/

Validates a card with a zero-amount authorization.

GET/api/v1/bank/wallet/bin/<card_bin>/

Returns the card BIN data.

GET/api/v1/bank/wallet/fx/rate/

Returns the exchange rate between two currencies.

Payouts

POST/api/v1/bank/payout/

Creates a payout to an external or internal destination.

GET/api/v1/bank/payout/<payout_uuid>/<wallet_uuid>/

Returns the status of a payout.

Merchant portal

GET/api/v1/bff/account/

Auth account data and enabled features.

GET/api/v1/bff/merchant/transactions/

Merchant transactions for the merchant portal.