Critical-risk tools in Mcp Ap2

Authorize a transaction (reserve funds without capturing) via Braintree GraphQL authorizePaymentMethod. Pass a paymentMethodId obtained from client-side tokenization (Drop-in / ...

Block a card temporarily (reversible). Use for lost-card or fraud-suspected flows. Card status goes to BLOCKED — declines all authorizations until unblocked. Different from chan...

Cancel all open orders for the authenticated user

Cancel a pending bill

Cancel (baixa) an outstanding boleto before payment.

Cancel an ACP checkout session. Releases any held inventory.

Cancel a scheduled collection request

Cancel an authorized-but-uncaptured credit payment.

Cancel an authorized CTe

Cancel a debit-card payment by Getnet payment_id.

Cancel/void an authorized invoice (FECancel — limited to certain types/conditions)

Cancel a MDF-e (manifesto)

Cancel an authorized NFCe

Cancel an authorized NFe (within 24h of emission)

Cancel an authorized NFSe

Cancel an order, optionally restocking and refunding

Attempt to cancel a payment that has not yet settled. Iniciador endpoint: POST /payments/{id}/cancel.

Cancel a payment intent that has not yet been captured. Fails on already-captured intents; use create_refund instead.

Cancel a payout that is still in

Cancel a pickup/collection request

Cancel an active Pix Automático recurrence. Future charges stop after BCB confirms the cancellation. Past charges are unaffected.

Cancel a pre-posting order

Cancel an active recurrence. Future charges will stop; already-charged cycles are untouched.

Cancel a report that is IN_QUEUE and has not yet started processing. Reports that are IN_PROGRESS or DONE cannot be cancelled.

Cancel a sale in Conta Azul

Cancel a previously scheduled PIX transfer

Cancel or pause a scheduled send by batch_id via POST /user/scheduled_sends. A send_mail call with

Cancel a shipment

Cancel a subscription by ID

Cancel a pending swap before it lands onchain. Endpoint set provisional, expand once docs stabilize.

Cancel a transaction. Only valid while status is

Remove all items from the cart

Delete a Jumio end-user account and every workflow execution under it (GDPR right-to-erasure). Irreversible. For deleting only a single transaction, use delete_transaction instead.

Soft-delete an applicant. Onfido retains the record for 30 days before permanent deletion; during that window it can be restored via the dashboard.

Delete a stored customer bank account (DELETE /customers/{customer_id}/bankaccounts/{id}).

Cancel an issued boleto (only allowed while unpaid / in

Remove a bounced address from the bounce suppression list via DELETE /suppression/bounces/{email}. Call this after the recipient confirms the underlying issue (e.g. mailbox full...

Detach a saved card from its customer (DELETE /cards/{id}). The card id becomes unusable as source_id afterwards.

Delete a Cartão Protegido vault token (DELETE /card/{token}). After deletion the token can no longer be used to create sales. Use when the cardholder requests removal or the car...

Delete a product category by ID

Delete a reusable checkout. The hosted URL stops accepting new payments. Existing charges spawned by the checkout are unaffected.

Delete a contact

Delete a customer

Delete a DICT key owned by the merchant. Irreversible — key becomes available for re-registration after BCB lockout window.

Delete an instance permanently

Delete an invoice. Permanently removes the invoice. Requires Id and SyncToken.

Delete a bank connection (revokes credentials, removes accounts/transactions). Pluggy endpoint: DELETE /items/{id}.

Delete a link (and all its associated data) by ID

Delete a Marketing Campaigns contact list via DELETE /marketing/lists/{id}. Contacts are NOT deleted by default — set delete_contacts=true to also remove contacts that belong ON...

Delete a listing item for the seller by SKU.

Delete an uploaded media asset by id.

Delete a message for me or for everyone in a chat

Delete a payment by ID

Delete a vaulted payment method via deletePaymentMethodFromVault. Irreversible — the token cannot be used for future charges after deletion.

Delete a payment source from a customer

Remove a x402 paywall from an endpoint

Delete a DICT key owned by the merchant. Irreversible — the key becomes available for re-registration by any PSP after the BCB lockout window.

Delete a subscription plan. Fails if the plan has active subscriptions.

Delete a product by ID

Remove a registered recipient. Will fail if the recipient is currently attached to in-flight payments.

Delete a service in Conta Azul

Delete a webhook subscription by ID

Delete a message template from the WABA by name. Optionally scope by hsm_id when two templates share a name across languages.

Delete a stored card token.

Delete a workflow execution (GDPR right-to-erasure). Removes captured images, extracted data, and decision audit trail for this transaction on Jumio

Delete a webhook by ID

Delete (revoke) a stored OneClick Mall card for a user.

Remove a value from the Konduto allowlist. Future orders matching the value will once again undergo full ML scoring.

Remove a value from the Konduto blocklist.

Remove a value from the Konduto reviewlist. Future orders matching the value will be scored normally instead of being forced into review.

Remove a participant from a WhatsApp group

Revoke an agent

Revoke a payment consent before it is exercised. Iniciador endpoint: DELETE /consents/{id}.

Revoke an issued access_token or refresh_token at POST /v1/token/revoke. Use to terminate a recurrence mandate or after card-token deletion. Form-encoded; expects a signed JWT c...

Remove any existing label on a user (DELETE /v205/users/{user_id}/labels). Optionally scope by abuse_type.

Cancel a subscription

Remove a previously registered webhook

Permanently store a tokenized payment method in the Braintree vault via vaultPaymentMethod. The input paymentMethodId must be a single-use nonce; the mutation returns a permanen...

Void/cancel an invoice

Void / cancel a sale (PUT /sales/{paymentId}/void). Supports full void (omit amount) or partial void.

Request payment authorization with scoped limits. Returns an authorization token that can be used to execute the payment.

Execute an authorized payment. Requires a valid authorization token.

Start a new KYC workflow execution on an existing account. Returns a

Build and HMAC-SHA256 sign a MoonPay buy widget URL (buy.moonpay.com). Returns a ready-to-redirect URL with the merchant

Build and HMAC-SHA256 sign a MoonPay sell widget URL (sell.moonpay.com). Returns a ready-to-redirect URL with apiKey + signature appended. Requires MOONPAY_PUBLISHABLE_KEY and M...

Pay a utility, tax, or concessionária bill via Bradesco Arrecadação. Works with barcode (código de barras) or linha digitável.

Authorize a recurring charge agreement against a Nequi user

Cancel a charge that has not yet been paid. Only charges in NEW status can be cancelled; once pending or completed the call will fail.

Cancel a pending SPEI orden by clave_rastreo (only works while orden is pending)

Capture a pre-authorized order (pre_authorized → paid)

Retry charging a pending bill (runs the billing workflow)

Authorize and capture a transaction atomically via Braintree GraphQL chargePaymentMethod. Use for one-step sales. For auth-now-capture-later split, use authorize_transaction + c...

Create a Business-to-Person (B2P) transfer: push funds from the merchant wallet to a PicPay user identified by CPF/CNPJ. Useful for payouts, cashbacks, rewards and marketplace s...

Issue a boleto receivable (generates barcode/digitable line to collect payment)

Charge a credit or debit card (Stone acquiring)

Create a crypto charge — a one-time merchant invoice priced in local fiat that a buyer can settle in BTC, ETH, USDC, and other supported assets. Returns a hosted_url the buyer c...

Report a confirmed chargeback back to ClearSale. Critical for model tuning: unreported chargebacks degrade future decision quality for similar buyers.

Record a payment against an invoice

Create payment-initiation consent (e.g., PIX) via Open Finance

Create a payment intent for Pluggy Payments (PISP). Pluggy endpoint: POST /payments/intents.

Create a payment link

Create an AP2 payment mandate — the final Verifiable Credential authorizing settlement against a cart mandate.

Attach a payment method (credit card token) to a customer. Endpoint: POST /customers/:customer_id/payment_methods

Create a payment profile (tokenized card / saved payment method) for a customer

Create a payment request for approval workflow

Create a reusable payment source (CARD/NEQUI/PSE) linked to a customer email

Attach a payment source to a customer using a gateway token (e.g. from Chargebee JS / Stripe.js / Adyen tokenization)

Tokenize a credit card server-side. Endpoint: POST /payment_token. WARNING: using this from your server subjects you to PCI audits — prefer iugu.js client-side tokenization in p...

Create a Pix charge (QR Code / cob) to receive a payment

Create a due-dated Pix charge (BCB /cobv — Pix com Vencimento). Boleto-style charge with due date, late fee (multa), interest (juros), and discount fields. Returns txid + QR pay...

Create a dynamic Pix charge (single-use QR with expiration). Returns txid, EMV copy-paste, and QR image. Preferred for e-commerce checkouts and invoices.

Create a static Pix charge (reusable QR code tied to a merchant Pix key). Returns EMV copy-paste payload and QR code image. Use for points-of-sale or donations where the same QR...

Create a Pix instant deposit (BRL). Returns Pix QR code / copy-paste payload.

Create a Pix charge with a due date (cobv) — commonly used for installments and scheduled invoices. Returns txid, location URL, and EMV payload.

Create a refund for a transaction

Create a bank transfer (Pix or TED)

Finalize a dispute via finalizeDispute — submits previously added evidence to the card network for review. After finalization, no further evidence can be added.

Finalize a draft Invoice. Moves status draft → open and makes it payable. Required before send/pay when auto_advance=false.

Fund a Wise transfer from a multi-currency balance. Equivalent to clicking

Book a transfer between two accounts both held on Matera (TED-interno / transferência interna). Settles instantly without touching SPI/Pix rails — no endToEndId, no DICT lookup....

Refund a OneClick Mall charge. Parent buy_order identifies the mall transaction; detail_buy_order + commerce_code pinpoint the child to refund.

Refund a portion of a charge (explicit partial refund; returns amount in cents).

Settle / record payment (baixa) for an AP title in Omie ERP

Pay a bill (boleto bancário or concessionária) by barcode / digitable line

Pay a boleto from a linked account

Pay a credit card bill from a linked account

Attempt to collect payment on an open Invoice. Charges the customer

Pay an existing order (attach a charge/payment to an order in CREATED state)

Initiate a Plin direct payment. Plin is the inter-bank wallet (Interbank, BBVA, Scotiabank, BanBif). The payer authorizes in-app; this call sends the payment request to their ph...

Pay for a 402-protected resource. Sends USDC payment via x402 protocol and returns the resource content. The agent automatically handles the 402 handshake.

Pay a federal tax (DARF) or union fee (GRU) via Bradesco Arrecadação. Distinct product surface from utility arrecadação because DARF/GRU require tax-code fields (código de recei...

Pay a federal tribute (DARF, GPS, GRU) or other guia de arrecadação via Caixa. Input is the full 44/47-digit barcode or linha digitável plus debit account. Requires arrecadação ...

Initiate a Yape direct payment. Yape is BCP

Refund a payment (full or partial)

Refund a captured payment via POST /v2/payments/captures/{id}/refund. Pass an amount object for partial refunds, or omit for a full refund. Idempotent via PayPal-Request-Id.

Refund a charge

Refund a captured credit payment. Pass amount for a partial refund; omit for full.

Refund a paid invoice (full or partial). Endpoint: POST /invoices/:id/refund

Refund a captured payment (full or partial).

Refund (devolução) a previously received Pix. Must reference the original endToEndId and a merchant-side refund id.

Refund (devolução) a Pix payment. Supports full or partial amount. Use reason codes per BCB MED catalog.

Request a refund on an off-ramp (sell) transaction. Used when the destination bank rejects payout or the user disputes the trade. Reason codes are MoonPay-defined.

Refund a settled transaction via refundTransaction. Amount defaults to the full settled amount when omitted. For partial refunds, pass a smaller amount.

Request a bank withdrawal (saque) from a sub-account. Endpoint: POST /accounts/:id/request_withdraw

Manually resolve a charge as paid. Used for out-of-band settlement (e.g. underpayment you accept, delayed confirmation you want to honour).

Send a transfer from a wallet to a destination address. Returns the tx hash + initial status. Endpoint set provisional.

TAA — transfer between two Itaú accounts (owned by the merchant or a counterparty). Instant settlement, no BCB fee.

Move funds between two Rapyd ewallets (source_ewallet → destination_ewallet). Used for marketplace settlement (buyer wallet → seller wallet), creator payouts, internal rebalanci...

Transfer between two Santander accounts (TEF / mesma instituição). Settles instantly and is fee-free for most covenants.

Execute a TED (or TEF when intra-Bradesco) transfer from the merchant

Update (PATCH) a Pix immediate charge (cob) — e.g. change amount before payment, adjust expiration, or mark as REMOVIDA_PELO_USUARIO_RECEBEDOR.

Patch a Pix due charge (cobv) — revise amount, due date, discount, or debtor before payment.

Refund one child seller of a Webpay Mall transaction. Must specify which child (commerce_code + buy_order) to refund.

Refund a committed Webpay Plus transaction. Full refund if amount equals original; partial otherwise.

Create a withdrawal request

Accept a dispute — forfeit the funds and close the case (Dispute Service v30).

Accept liability for a dispute claim via POST /v1/customer/disputes/{id}/accept-claim. The disputed amount is refunded to the buyer. Terminal action.

Accept the buyer

Complete a 3-D Secure challenge. Call after the payer finishes the issuer challenge (redirected back to return_url) with the authenticator response (cres / PaRes). Returns the a...

Authorize a debit card transaction on Rede. Requires a prior 3DS authentication — pass threeDSecure.embedded=true and a valid threeDSecure reference, or use authorize_with_3ds a...

Authorize payment for an approved order via POST /v2/checkout/orders/{id}/authorize. Use after the buyer approves an order with intent=AUTHORIZE. Returns the created authorizati...

Authorize a transaction after a successful 3DS authentication, attaching the 3DS reference for liability shift. Works for both credit and debit.

Request a range of SIGEP tracking labels (etiquetas) for a service

Provision a new phone number. Supply either a specific

Capture a previously authorized credit payment (when delayed=true was used).

Capture payment for an approved order via POST /v2/checkout/orders/{id}/capture. Use after the buyer approves an order with intent=CAPTURE. Returns the captured payment details.

Capture an authorized payment (for delayed-capture flows).

Capture a previously-authorized payment intent (two-step auth + capture flow). Use this after confirm_payment_intent on intents created with capture_method=manual. Amount may be...

Capture a pre-authorized sale (PUT /sales/{paymentId}/capture). Supports partial capture via amount, and optional serviceTaxAmount (airline / travel merchants).

Capture a previously authorized transaction via captureTransaction. Amount defaults to full authorized amount when omitted (partial captures allowed up to the authorized total).

Confirm an unpaid order (POST /orders/{id}/confirm). Moves the order to a confirmed state ready to be paid by the customer via Yape / PagoEfectivo.

Manually confirm a Khipu payment. Use when the merchant has opted into manual confirmation and the backend has validated the underlying transfer.

Confirm a previously-created payment intent with a payment method. For card intents this triggers authorization; for APM intents this returns a next_action (redirect, QR, etc).

Second step of Rapyd

Confirm (accept) a buyer-initiated return request by return_sn.

Deactivate (pause) a recurrent payment so it stops charging

Defend a dispute using one of the applicable defense reason codes (Dispute Service v30).

Email an AUTHORISED invoice to the contact

Freeze (block) a Dock account. Pix outflows and card spend are halted but balance is preserved. Used for fraud holds, KYC re-verification, or judicial blocks.

Get Pix QR code for a payment (returns payload and image)

Initiate a PIX transfer

Issue a fiscal invoice (nota fiscal) for an order

Generate an invoice (NF) from an existing sales order in Omie ERP

Notify a non-Nequi recipient with instructions to claim a payment

Charge a stored OneClick Mall card across one or more mall merchant codes. Each details entry is a separate child charge with its own commerce_code, buy_order, amount, and insta...

Capture a previously authorized OneClick Mall charge (deferred-capture flow). One capture per child detail.

Submit additional details for a payment (3DS challenge response, redirect returnUrl payload, etc).

Reactivate a previously deactivated recurrent payment (PUT /recurrentPayments/{recurrentPaymentId}/Reactivate). Resumes future scheduled charges from the next configured date.

Reactivate a cancelled or paused subscription

Redact an inquiry (GDPR right-to-erasure). Scrubs PII, captured images, and verification detail for this inquiry on Persona

Redeem (resgatar) from a fund. Total or partial. Settlement follows the fund

Report a confirmed chargeback for an order. Convenience wrapper around update_order_status with status=

Request a return or refund for a delivered order

Retry a failed, expired, or rejected workflow execution. Creates a new workflow execution on the same account, optionally re-using the original workflow definition and customer ...

Reverse a completed payment

Reverse any Nequi transaction by transaction ID (refund flow)

Simulate the response of a payment in sandbox without persisting it (useful for integration testing).

Subscribe (aplicar) to a fund on BTG

Tokenize a card into the Braspag vault / Cartão Protegido (POST /card). Returns a reusable token that can substitute CardNumber on future sales — reduces PCI scope and enables c...

Notify Legiti of a payment-method-level event (authorization attempt, capture, refund, void). Distinct from track_sale, which is order-level. Use this when you process payments ...

Run a credit-card verification (zero-auth or $1 auth) on a tokenized payment method via verifyPaymentMethod. Returns a CreditCardVerification with status and processor response....

Void (release) an unsettled authorization via POST /v2/payments/authorizations/{id}/void. Use when funds were authorized but will not be captured. Returns 204 No Content on succ...

Void/annul a payment

Void a transaction

Deferred-capture for a previously authorized Webpay Plus transaction. Uses the official PUT /capture endpoint — prefer this over webpay_increase_amount for standard deferred-cap...

Capture a previously authorized Webpay Plus transaction (partial-capture / deferred-capture flow).

Deferred-capture for one child seller inside a Webpay Mall transaction.

Zero-dollar authorization to validate a card without charging (card or CardToken)

Reactivate a suspended subscription. Endpoint: POST /subscriptions/:id/activate

Add a value to the Konduto blocklist. Any future order matching the value is auto-declined. Useful for known-bad emails, IPs, tax IDs, or card BIN+last4 pairs observed in confir...

Apply a payment method to the checkout session. Supports card, AP2 token, or x402.

Authorize a credit-card payment on Getnet. Set delayed=false to authorize+capture atomically; delayed=true to authorize only (use capture_credit later).

Capture a previously authorized payment via POST /v2/payments/authorizations/{id}/capture. Pass an amount object for partial captures, or omit to capture the full authorized amo...

Checkout all items in the cart and pay

Complete an ACP checkout by submitting a payment token. Finalizes the order with the seller. The checkout must be in

Convert a draft order into a real order. Optionally mark as paid or send invoice.

Create a digital account for an end user (CPF holder) on Dock. Returns the account id, agency, and account number. Account holds funds that can be moved via Pix or spent via iss...

Create an account payable (conta a pagar)

Create an account receivable (conta a receber)

Create a marketplace split payment with per-recipient disbursements (application_fee, money_release_days, collector_id per seller)

Request anticipation of receivables for a recipient (antecipação)

Create a Khipu automatic payment (recurring / subscription charge against a previously enrolled subscription_id). The payer must have completed the subscription enrollment at th...

Open a new currency balance account on a profile (e.g. open a EUR balance to hold euros).

Store a customer bank account (POST /customers/{customer_id}/bankaccounts). Required before you can run destination_id-based payouts to that customer

Create a bank transaction (SPEND = money out, RECEIVE = money in) directly on a bank account — for transactions without a matching invoice/bill (fees, transfers, one-off expenses).

Submit a batch of B2P transfers in a single request. Each item is an independent transfer to a PicPay user; PicPay processes them asynchronously and notifies per-item via callback.

Create a batch payout via POST /v1/payments/payouts. sender_batch_header carries metadata; items is an array of payout_item objects each with recipient_type, amount { currency, ...

Create a transfer beneficiary (recipient) with bank details. Required before sending cross-border payouts via create_transfer. Entity type, bank details fields, and required IDs...

Create a bill (AP / money owed to a vendor). VendorRef and at least one Line (AccountBasedExpenseLineDetail or ItemBasedExpenseLineDetail) are required.

Issue a boleto via Bradesco Cobrança. Returns nosso_numero, linha_digitável, barcode, and PDF URL.

Convenience wrapper to create a Boleto sale (POST /sales with Payment.Type=Boleto). Returns BarCodeNumber, DigitableLine, ExpirationDate, and Url for the rendered boleto. Provid...

Pay a BR Code (Pix QR code / copia-e-cola)

Create a buy transaction (fiat -> crypto). The returned object contains status plus — depending on method — redirect URL for hosted checkout, Pix QR data, or card auth next steps.

Register card data for on-ramp payments

Tokenize a card for use in DIRECT-flow create_payment. Use the returned token in the card.token field instead of raw PAN. Required for PCI scope reduction.

Create an AP2 cart mandate — a signed, locked-cart commitment from a merchant binding line items, totals, and merchant attestation.

Create a bank account ledger entry (lançamento de conta corrente) in Omie ERP

Create a reusable hosted checkout — think product-page-style link that can be paid multiple times. Good for evergreen SKUs and donation pages.

Create a Rapyd hosted checkout page. Returns a redirect_url the payer opens in a browser. Rapyd renders the appropriate local methods (cards, cash pickup, bank transfer, wallets...

Create a hosted Checkout Session. Returns a url the customer completes payment on. Use mode=

Create an immediate Pix charge (cobranca imediata)

Create a Pix due charge (cobranca com vencimento). If txid omitted, server-generated.

Create a payment consent that the payer will authorize at their bank. Iniciador endpoint: POST /consents.

Execute an FX conversion between wallet currencies (e.g. swap USD received into BRL before settling locally). Pass quote_id for a locked quoted rate, or omit for a market rate.

Issue a credit note (Nota de Crédito A/B/C: types 3, 8, 13) referencing an original invoice

Create a crypto withdrawal to an external wallet address

Create a debit card sale in Cielo (requires 3DS authentication)

Issue a debit note (Nota de Débito A/B/C: types 2, 7, 12) referencing an original invoice

Request a Pix devolution (refund) on a received Pix transaction

Create a round-up donation linked to an original payment (Adyen Giving).

Create an estimate (quote). CustomerRef and Line items required. Estimates can later be converted to invoices.

Create a digital wallet payment (Google Pay, Samsung Pay, Apple Pay)

Register a fiat receiver account (BRL Pix, USD wire, EUR SEPA, MXN SPEI). Skippable for BRL Pix payouts — pass pix_key + document directly on /payout instead.

Create a gift card for a customer (GiftCard Hub)

Create a Peruvian cuotas (installment) plan on a charge. Enables splitting a card payment into N monthly installments, with or without interest, per the issuer

Create an AP2 intent mandate — a Verifiable Credential expressing the user

Create an electronic invoice (Factura Electrónica) via AFIP

Create a batch of invoices in a single CAE request (FECAESolicitar, up to 250)

Create a link to a financial institution

Create a mass payout — multiple payouts in a single batch request.

Create and emit an NFCe (nota fiscal do consumidor eletronica)

Create and emit an NFe (nota fiscal eletronica)

Create and emit an NFSe (nota fiscal de servico)

Create a numtoken (Getnet card-on-file PAN-level token). Use for recurring or one-click-checkout flows where the merchant stores the numtoken and later hydrates it via tokenize_...

Create an Open Finance consent (BACEN-regulated) for data access or payment initiation against a third-party

Create a buy or sell order

Create a payout from Circle (USDC to fiat)

Create a x402 paywall configuration for an endpoint. When requests hit this endpoint, they receive HTTP 402 with payment instructions.

Create a Pix payment in Cielo (generates QR code)

Register a Pix Automático recurrence (BCB 2025 recurring Pix product, /rec). The payer authorizes the merchant to pull recurring amounts on a schedule. Matera is one of the few ...

Create an immediate Pix charge (cob) with QR code. Returns txid, EMV copy-paste payload, and location URL. BACEN Pix v2 standard.

Create a Pix charge with due date (cobv) — used for boleto-like Pix where the payer can pay at or after a due date with optional fine/interest. Returns txid, copy-paste EMV payl...

Refund (devolução) a previously received Pix. Must reference the original endToEndId and a merchant-side refund id.

Create a Pix devolução (refund) — refund a received Pix transaction

Create a random Pix key (EVP/alias)

Register a Pix key (CPF/CNPJ, email, phone, or EVP/random)

Initiate an outbound Pix transfer (ordem de pagamento). Moves money from a debtor account held on Matera to any Pix key in BR. Returns endToEndId once the BCB SPI confirms.

Create a dynamic Pix charge with QR code (cob). Returns the txid, copy-paste EMV payload, and location URL.

Create a dynamic Pix QR (single-use, expiring). Returns txid, EMV payload, and QR image. Preferred for e-commerce checkouts and invoices.

Create a static Pix QR (reusable, tied to a merchant Pix key). Returns EMV copy-paste payload and QR image. Use for points-of-sale or donations where the same QR is shown to man...

Generate a static PIX QR code for receiving payments

Create a Pix payment request

Convenience wrapper to create a Pix sale (POST /sales with Payment.Type=Pix). Returns a QrCodeBase64Image and QrCodeString (Pix copia e cola) that the merchant can display. Bras...

Create a Pix withdrawal (BRL) to a Pix key

Create a NuPay payment using a pre-authorized Bearer access_token (pre-auth / recurrence flow). Same body as create_payment, but auth is Bearer instead of merchant-key. Use afte...

Create a checkout preference for Checkout Pro

Create a purchase document

Create a purchase order (pedido de compra) in Bling

Send a push payment notification to a Nequi user

Generate a QR code for payment

Lock an FX + fee quote for a 5-minute TTL. Same endpoint for both on_ramp (fiat → stablecoin) and off_ramp (stablecoin → fiat). Pass amount on EITHER sender or receiver, not bot...

Create a native Rede recurrence (subscription). Rede handles retries and cardholder updates automatically.

Create a recurrent payment schedule (POST /recurrentPayments). Used for subscriptions and any schedule where Braspag (not the merchant) drives the recurrence.

Create a sale in Conta Azul

Create a 3DS-authenticated credit sale (POST /sales). Same endpoint as create_sale but the CreditCard object carries ExternalAuthentication (Cavv, Xid/Eci, Version, ReferenceId)...

Create a credit card sale using 3DS 2.0 authentication data (from 3DS flow)

Create a credit card sale using a previously stored CardToken (avoids re-entering card data)

Create a sales receipt (paid-on-the-spot sale — combines invoice + payment). CustomerRef and Line items required.

Create a sell transaction (crypto -> fiat). Used for agents that need to pay out in local fiat after receiving crypto.

Manually generate a settlement (account money) report for a date range. Returns 202; poll the report list endpoint to download when ready.

Configure a marketplace split rule that routes part of a payment to a subseller. Values are cents; percentages are integers 0-100.

Capture a previously authorized split sale with overridden per-sub-merchant amounts (PUT /sales/{paymentId}/capture with a SplitPayments body). Use when the original split mix n...

Configure split distribution for an existing charge. Each rule routes a portion of the charge to a receiver (onboard receivers via the Portal first).

Create a sale with marketplace split rules (POST /sales with Payment.SplitPayments). Same endpoint as create_sale, but exposes the split array shape explicitly: each element has...

Generate a static (reusable) Nequi QR code for a merchant

Create a subaccount for payment splitting

Create an onchain swap between two assets. Endpoint set provisional, expand once docs stabilize.

Pay a tax (DARF, GPS, GRU, etc.) by barcode / digitable line

Create a Khipu terminal session for in-person / POS bank-transfer checkout. Returns a QR/URL the payer scans at the point of sale to pay from their bank app.

Tokenize a card (POST /tokens). Returns a token id like tkn_xxx. Tokenization is typically done client-side via culqi.js or mobile SDKs; this tool is primarily for test scripts ...

Tokenize a credit card for secure payments

Tokenize a credit/debit card

Tokenize a Nequi wallet (start async tokenization by phone number)

Create a mobile/service top-up (recarga) via Celcoin

Create a payment transaction

Pay a utility bill (e.g. water, electricity) by barcode / digitable line

Create a new Circle business-account wallet

Create a withdrawal request (crypto or fiat)

Zero-dollar authorization / card validation (POST /zeroauth). Braspag routes a $0 (or minimum-amount) authorization through the acquirer to confirm the card is live and not bloc...

Disable (cancel) an active recurrence. Stops all future billings.

Deactivate a recurrent payment (PUT /recurrentPayments/{recurrentPaymentId}/Deactivate). Stops future charges; does not refund historical ones.

Delete a stored payment method (shopper opt-out).

Generate a dynamic PicPay Pay QR code with a fixed amount and optional expiration. Each QR is single-purpose. Returns qrcode content + base64 image and a paymentUrl.

Start the checkout process for a cart. Returns a checkout session with payment options.

Issue a card (debit / credit / prepaid / virtual) against a Dock account. Card issuing is Dock

Report a confirmed chargeback / fraud outcome back to Legiti. This is Legiti

Start a OneClick Mall card-enrollment flow. Returns { token, url_webpay } — redirect the user to complete enrollment. After return to response_url, call oneclick_finish_inscript...

Register a beneficiary account

Issue a boleto via BB Cobranças. Returns nosso_numero, linha digitável, barcode, and PDF URL.

Resolve a pending DICT key claim (confirm or cancel) — POST /dict/keys/claims/{id}/resolve

Schedule a future-dated payment (Pix, boleto, arrecadação, or TED). Itaú executes the debit on the scheduled date at D+0 cut-off.

Schedule a future-dated PIX transfer

Send a $chargeback event to Sift

Initiate an outbound Pix payment from the merchant

Send a TED transfer to an account at another bank. Same-day settlement within banking hours; otherwise queued.

Submit a previously authorized transaction for settlement via submitTransactionForSettlement. Unlike capture_transaction (captureTransaction), this marks the transaction for the...

Suspend a subscription. Endpoint: POST /subscriptions/:id/suspend

Update the authorized amount of an unsettled payment (common in tips / hotel incidentals).

Update a payment link

Update a Wise quote (e.g. attach a recipient via targetAccount, or change payOut). Returns the updated quote with refreshed paymentOptions.

Update an existing recurrence — change amount, card (storageCard), end date, or pause/resume. Pass only the fields you want to change.

Update the charged amount on a recurrent payment (PUT /recurrentPayments/{recurrentPaymentId}/Amount). Body carries the new amount in cents.

Update the next charge date of an existing recurrent payment

Update the NextPaymentDate on a recurrent payment (PUT /recurrentPayments/{recurrentPaymentId}/NextPaymentDate). Useful to skip a cycle or realign billing dates. Body carries th...

Update the Payment (CreditCard + Customer) on a recurrent schedule (PUT /recurrentPayments/{recurrentPaymentId}/Payment). Used when the card on file expires or the customer upda...

Update a subscription. Accepts any Chargebee subscription fields (plan_id, plan_quantity, coupon_ids, addons, billing_cycles, etc.)

Commit a Webpay Plus transaction after the user has returned from the Webpay flow. Must be called to actually charge the card.

Create a Webpay Plus transaction. Returns { token, url } — redirect the user to url?token_ws=<token> to complete payment. After the user returns to return_url, call webpay_commi...

Commit a Webpay Mall transaction after the user has returned. Charges all child commerce codes at once.

Create a Webpay Mall transaction — one parent buy_order split across several seller commerce codes. Returns { token, url } exactly like Webpay Plus. Each details entry is a chil...