// SCAN REPORT

Mcp Ap2

1300 tools. 632 can modify or destroy data without limits.

350 destructive tools with no built-in limits. Policy required.

Last updated:

632 can modify or destroy data
668 read-only
1300 tools total

Community server · catalogue entry verified 12/06/2026

How to control Mcp Ap2 ↓

TOOL MAP

What Mcp Ap2 exposes to your agents

Read (668) Write / Execute (281) Destructive / Financial (350)

Running more than one server? Check your whole stack →

MOST DANGEROUS TOOLS
Critical Risk

The most dangerous Mcp Ap2 tools

Financial · Critical arrecadacao_pay This tool commits financial obligations by processing payments for utilities, taxes, and other bills. Financial · Critical authorize_recurring_charge This tool directly commits financial obligations by setting up recurring charges—a binding financial transaction. Financial · High cancel_charge This tool directly manipulates financial charges and payment commitments. Financial · Critical cancel_transfer This tool manipulates pending financial transactions in a payment protocol system (AP2).

632 of Mcp Ap2's 1300 tools can modify, destroy, or commit something on every call — and an agent calls them with no built-in limits.

POLICY

How to control Mcp Ap2

PolicyLayer is an MCP gateway — it sits between your AI agents and Mcp Ap2, and nothing reaches the server without passing your rules. These are the rules we recommend:

Block financial tools by default
{
  "authorize_transaction": {
    "deny_if": [
      {
        "conditions": [],
        "on_deny": "Requires human approval."
      }
    ]
  }
}

Financial tools should be explicitly enabled per use case, not open by default.

Deny destructive operations
{
  "cancel_all_orders": {
    "deny_if": [
      {
        "conditions": [],
        "on_deny": "Blocked by default. Requires approval."
      }
    ]
  }
}

Destructive tools should never be available to autonomous agents without human approval.

Rate limit write operations
{
  "remove_from_cart": {
    "limits": [
      {
        "counter": "remove_from_cart_per_hour",
        "window": "hour",
        "max": 30,
        "scope": "grant"
      }
    ]
  }
}

Prevents bulk unintended modifications from agents caught in loops.

Cap read operations
{
  "antifraud_score": {
    "limits": [
      {
        "counter": "antifraud_score_per_minute",
        "window": "minute",
        "max": 60,
        "scope": "grant"
      }
    ]
  }
}

Controls API costs and prevents retry loops from exhausting upstream rate limits.

  1. Create a free account and register Mcp Ap2 — nothing to install.
  2. Add these rules — paste them, or build them visually. Tune the limits to your setup.
  3. Point your MCP client (Claude, Cursor, anything) at your gateway URL.
ENFORCE POLICY ON MCP AP2 →

Free to start. No card required.

FULL CATALOGUE

All 1300 Mcp Ap2 tools

FINANCIAL 288 tools
Financial authorize_transaction Authorize a transaction (reserve funds without capturing) via Braintree GraphQL authorizePaymentMethod. Pass a Financial block_card Block a card temporarily (reversible). Use for lost-card or fraud-suspected flows. Card status goes to BLOCKED Financial cancel_bill Cancel a pending bill Financial cancel_collection Cancel a scheduled collection request Financial cancel_credit Cancel an authorized-but-uncaptured credit payment. Financial cancel_debit Cancel a debit-card payment by Getnet payment_id. Financial cancel_invoice Cancel/void an authorized invoice (FECancel — limited to certain types/conditions) Financial cancel_order Cancel an order, optionally restocking and refunding Financial cancel_payment Attempt to cancel a payment that has not yet settled. Iniciador endpoint: POST /payments/{id}/cancel. Financial cancel_payment_intent Cancel a payment intent that has not yet been captured. Fails on already-captured intents; use create_refund i Financial cancel_payout Cancel a payout that is still in Financial cancel_pix_automatico Cancel an active Pix Automático recurrence. Future charges stop after BCB confirms the cancellation. Past char Financial cancel_recurrence Cancel an active recurrence. Future charges will stop; already-charged cycles are untouched. Financial cancel_scheduled_pix Cancel a previously scheduled PIX transfer Financial cancel_scheduled_send Cancel or pause a scheduled send by batch_id via POST /user/scheduled_sends. A send_mail call with Financial cancel_subscription Cancel a subscription by ID Financial cancel_swap Cancel a pending swap before it lands onchain. Endpoint set provisional, expand once docs stabilize. Financial cancel_transaction Cancel a transaction. Only valid while status is Financial unsubscribe Cancel a subscription Financial vault_payment_method Permanently store a tokenized payment method in the Braintree vault via vaultPaymentMethod. The input paymentM Financial void_sale Void / cancel a sale (PUT /sales/{paymentId}/void). Supports full void (omit amount) or partial void. Financial authorize_payment Request payment authorization with scoped limits. Returns an authorization token that can be used to execute t Financial execute_payment Execute an authorized payment. Requires a valid authorization token. Financial initiate_transaction Start a new KYC workflow execution on an existing account. Returns a Financial sign_buy_url Build and HMAC-SHA256 sign a MoonPay buy widget URL (buy.moonpay.com). Returns a ready-to-redirect URL with th Financial sign_sell_url Build and HMAC-SHA256 sign a MoonPay sell widget URL (sell.moonpay.com). Returns a ready-to-redirect URL with Financial arrecadacao_pay Pay a utility, tax, or concessionária bill via Bradesco Arrecadação. Works with barcode (código de barras) or Financial authorize_recurring_charge Authorize a recurring charge agreement against a Nequi user Financial cancel_charge Cancel a charge that has not yet been paid. Only charges in NEW status can be cancelled; once pending or compl Financial cancel_transfer Cancel a pending SPEI orden by clave_rastreo (only works while orden is pending) Financial capture_charge Capture a pre-authorized order (pre_authorized → paid) Financial charge_bill Retry charging a pending bill (runs the billing workflow) Financial charge_transaction Authorize and capture a transaction atomically via Braintree GraphQL chargePaymentMethod. Use for one-step sal Financial create_b2p_transfer Create a Business-to-Person (B2P) transfer: push funds from the merchant wallet to a PicPay user identified by Financial create_boleto_issue Issue a boleto receivable (generates barcode/digitable line to collect payment) Financial create_card_charge Charge a credit or debit card (Stone acquiring) Financial create_charge Create a crypto charge — a one-time merchant invoice priced in local fiat that a buyer can settle in BTC, ETH, Financial create_chargeback_notification Report a confirmed chargeback back to ClearSale. Critical for model tuning: unreported chargebacks degrade fut Financial create_payment Record a payment against an invoice Financial create_payment_consent Create payment-initiation consent (e.g., PIX) via Open Finance Financial create_payment_intent Create a payment intent for Pluggy Payments (PISP). Pluggy endpoint: POST /payments/intents. Financial create_payment_link Create a payment link Financial create_payment_mandate Create an AP2 payment mandate — the final Verifiable Credential authorizing settlement against a cart mandate. Financial create_payment_method Attach a payment method (credit card token) to a customer. Endpoint: POST /customers/:customer_id/payment_meth Financial create_payment_profile Create a payment profile (tokenized card / saved payment method) for a customer Financial create_payment_request Create a payment request for approval workflow Financial create_payment_source Create a reusable payment source (CARD/NEQUI/PSE) linked to a customer email Financial create_payment_source_using_token Attach a payment source to a customer using a gateway token (e.g. from Chargebee JS / Stripe.js / Adyen tokeni Financial create_payment_token Tokenize a credit card server-side. Endpoint: POST /payment_token. WARNING: using this from your server subjec Financial create_pix_charge Create a Pix charge (QR Code / cob) to receive a payment Financial create_pix_charge_due Create a due-dated Pix charge (BCB /cobv — Pix com Vencimento). Boleto-style charge with due date, late fee (m Financial create_pix_charge_dynamic Create a dynamic Pix charge (single-use QR with expiration). Returns txid, EMV copy-paste, and QR image. Prefe Financial create_pix_charge_static Create a static Pix charge (reusable QR code tied to a merchant Pix key). Returns EMV copy-paste payload and Q Financial create_pix_deposit Create a Pix instant deposit (BRL). Returns Pix QR code / copy-paste payload. Financial create_pix_due_charge Create a Pix charge with a due date (cobv) — commonly used for installments and scheduled invoices. Returns tx Financial create_refund Create a refund for a transaction Financial create_transfer Create a bank transfer (Pix or TED) Financial finalize_dispute Finalize a dispute via finalizeDispute — submits previously added evidence to the card network for review. Aft Financial finalize_invoice Finalize a draft Invoice. Moves status draft → open and makes it payable. Required before send/pay when auto_a Financial fund_transfer Fund a Wise transfer from a multi-currency balance. Equivalent to clicking Financial internal_transfer Book a transfer between two accounts both held on Matera (TED-interno / transferência interna). Settles instan Financial oneclick_refund Refund a OneClick Mall charge. Parent buy_order identifies the mall transaction; detail_buy_order + commerce_c Financial partial_refund Refund a portion of a charge (explicit partial refund; returns amount in cents). Financial pay_account_payable Settle / record payment (baixa) for an AP title in Omie ERP Financial pay_bill Pay a bill (boleto bancário or concessionária) by barcode / digitable line Financial pay_boleto Pay a boleto from a linked account Financial pay_credit_card_bill Pay a credit card bill from a linked account Financial pay_invoice Attempt to collect payment on an open Invoice. Charges the customer Financial pay_order Pay an existing order (attach a charge/payment to an order in CREATED state) Financial pay_plin Initiate a Plin direct payment. Plin is the inter-bank wallet (Interbank, BBVA, Scotiabank, BanBif). The payer Financial pay_request Pay for a 402-protected resource. Sends USDC payment via x402 protocol and returns the resource content. The a Financial pay_tax_darf Pay a federal tax (DARF) or union fee (GRU) via Bradesco Arrecadação. Distinct product surface from utility ar Financial pay_tribute Pay a federal tribute (DARF, GPS, GRU) or other guia de arrecadação via Caixa. Input is the full 44/47-digit b Financial pay_yape Initiate a Yape direct payment. Yape is BCP Financial refund Refund a payment (full or partial) Financial refund_capture Refund a captured payment via POST /v2/payments/captures/{id}/refund. Pass an amount object for partial refund Financial refund_charge Refund a charge Financial refund_credit Refund a captured credit payment. Pass amount for a partial refund; omit for full. Financial refund_invoice Refund a paid invoice (full or partial). Endpoint: POST /invoices/:id/refund Financial refund_payment Refund a captured payment (full or partial). Financial refund_pix Refund (devolução) a previously received Pix. Must reference the original endToEndId and a merchant-side refun Financial refund_pix_payment Refund (devolução) a Pix payment. Supports full or partial amount. Use reason codes per BCB MED catalog. Financial refund_sell_transaction Request a refund on an off-ramp (sell) transaction. Used when the destination bank rejects payout or the user Financial refund_transaction Refund a settled transaction via refundTransaction. Amount defaults to the full settled amount when omitted. F Financial request_withdraw Request a bank withdrawal (saque) from a sub-account. Endpoint: POST /accounts/:id/request_withdraw Financial resolve_charge Manually resolve a charge as paid. Used for out-of-band settlement (e.g. underpayment you accept, delayed conf Financial transfer Send a transfer from a wallet to a destination address. Returns the tx hash + initial status. Endpoint set pro Financial transfer_between_accounts TAA — transfer between two Itaú accounts (owned by the merchant or a counterparty). Instant settlement, no BCB Financial transfer_between_wallets Move funds between two Rapyd ewallets (source_ewallet → destination_ewallet). Used for marketplace settlement Financial transfer_internal Transfer between two Santander accounts (TEF / mesma instituição). Settles instantly and is fee-free for most Financial transfer_ted Execute a TED (or TEF when intra-Bradesco) transfer from the merchant Financial update_pix_charge Update (PATCH) a Pix immediate charge (cob) — e.g. change amount before payment, adjust expiration, or mark as Financial update_pix_due_charge Patch a Pix due charge (cobv) — revise amount, due date, discount, or debtor before payment. Financial webpay_mall_refund_transaction Refund one child seller of a Webpay Mall transaction. Must specify which child (commerce_code + buy_order) to Financial webpay_refund_transaction Refund a committed Webpay Plus transaction. Full refund if amount equals original; partial otherwise. Financial withdraw Create a withdrawal request Financial accept_dispute Accept a dispute — forfeit the funds and close the case (Dispute Service v30). Financial accept_dispute_claim Accept liability for a dispute claim via POST /v1/customer/disputes/{id}/accept-claim. The disputed amount is Financial accept_return_offer Accept the buyer Financial authenticate_3ds Complete a 3-D Secure challenge. Call after the payer finishes the issuer challenge (redirected back to return Financial authorize_debit Authorize a debit card transaction on Rede. Requires a prior 3DS authentication — pass threeDSecure.embedded=t Financial authorize_order Authorize payment for an approved order via POST /v2/checkout/orders/{id}/authorize. Use after the buyer appro Financial authorize_with_3ds Authorize a transaction after a successful 3DS authentication, attaching the 3DS reference for liability shift Financial buy_label_range Request a range of SIGEP tracking labels (etiquetas) for a service Financial buy_phone_number Provision a new phone number. Supply either a specific Financial capture_credit Capture a previously authorized credit payment (when delayed=true was used). Financial capture_order Capture payment for an approved order via POST /v2/checkout/orders/{id}/capture. Use after the buyer approves Financial capture_payment Capture an authorized payment (for delayed-capture flows). Financial capture_payment_intent Capture a previously-authorized payment intent (two-step auth + capture flow). Use this after confirm_payment_ Financial capture_sale Capture a pre-authorized sale (PUT /sales/{paymentId}/capture). Supports partial capture via amount, and optio Financial capture_transaction Capture a previously authorized transaction via captureTransaction. Amount defaults to full authorized amount Financial confirm_order Confirm an unpaid order (POST /orders/{id}/confirm). Moves the order to a confirmed state ready to be paid by Financial confirm_payment Manually confirm a Khipu payment. Use when the merchant has opted into manual confirmation and the backend has Financial confirm_payment_intent Confirm a previously-created payment intent with a payment method. For card intents this triggers authorizatio Financial confirm_payout Second step of Rapyd Financial confirm_return Confirm (accept) a buyer-initiated return request by return_sn. Financial deactivate_recurrent Deactivate (pause) a recurrent payment so it stops charging Financial defend_dispute Defend a dispute using one of the applicable defense reason codes (Dispute Service v30). Financial email_invoice Email an AUTHORISED invoice to the contact Financial freeze_account Freeze (block) a Dock account. Pix outflows and card spend are halted but balance is preserved. Used for fraud Financial get_pix_qrcode Get Pix QR code for a payment (returns payload and image) Financial initiate_pix Initiate a PIX transfer Financial invoice_order Issue a fiscal invoice (nota fiscal) for an order Financial invoice_sales_order Generate an invoice (NF) from an existing sales order in Omie ERP Financial notify_unregistered_payment Notify a non-Nequi recipient with instructions to claim a payment Financial oneclick_authorize Charge a stored OneClick Mall card across one or more mall merchant codes. Each details entry is a separate ch Financial oneclick_capture Capture a previously authorized OneClick Mall charge (deferred-capture flow). One capture per child detail. Financial payment_details Submit additional details for a payment (3DS challenge response, redirect returnUrl payload, etc). Financial reactivate_recurrent Reactivate a previously deactivated recurrent payment (PUT /recurrentPayments/{recurrentPaymentId}/Reactivate) Financial reactivate_subscription Reactivate a cancelled or paused subscription Financial redeem_from_fund Redeem (resgatar) from a fund. Total or partial. Settlement follows the fund Financial report_chargeback Report a confirmed chargeback for an order. Convenience wrapper around update_order_status with status= Financial request_return Request a return or refund for a delivered order Financial retry_transaction Retry a failed, expired, or rejected workflow execution. Creates a new workflow execution on the same account, Financial reverse_payment Reverse a completed payment Financial reverse_transaction Reverse any Nequi transaction by transaction ID (refund flow) Financial simulate_payment Simulate the response of a payment in sandbox without persisting it (useful for integration testing). Financial subscribe_to_fund Subscribe (aplicar) to a fund on BTG Financial tokenize_card Tokenize a card into the Braspag vault / Cartão Protegido (POST /card). Returns a reusable token that can subs Financial track_payment Notify Legiti of a payment-method-level event (authorization attempt, capture, refund, void). Distinct from tr Financial verify_payment_method Run a credit-card verification (zero-auth or $1 auth) on a tokenized payment method via verifyPaymentMethod. R Financial void_authorization Void (release) an unsettled authorization via POST /v2/payments/authorizations/{id}/void. Use when funds were Financial void_payment Void/annul a payment Financial void_transaction Void a transaction Financial webpay_capture_transaction Deferred-capture for a previously authorized Webpay Plus transaction. Uses the official PUT /capture endpoint Financial webpay_increase_amount Capture a previously authorized Webpay Plus transaction (partial-capture / deferred-capture flow). Financial webpay_mall_capture_transaction Deferred-capture for one child seller inside a Webpay Mall transaction. Financial zero_auth Zero-dollar authorization to validate a card without charging (card or CardToken) Financial activate_subscription Reactivate a suspended subscription. Endpoint: POST /subscriptions/:id/activate Financial apply_payment Apply a payment method to the checkout session. Supports card, AP2 token, or x402. Financial authorize_credit Authorize a credit-card payment on Getnet. Set delayed=false to authorize+capture atomically; delayed=true to Financial capture_authorization Capture a previously authorized payment via POST /v2/payments/authorizations/{id}/capture. Pass an amount obje Financial checkout_cart Checkout all items in the cart and pay Financial complete_checkout Complete an ACP checkout by submitting a payment token. Finalizes the order with the seller. The checkout must Financial complete_draft_order Convert a draft order into a real order. Optionally mark as paid or send invoice. Financial create_account Create a digital account for an end user (CPF holder) on Dock. Returns the account id, agency, and account num Financial create_account_payable Create an account payable (conta a pagar) Financial create_account_receivable Create an account receivable (conta a receber) Financial create_advanced_payment Create a marketplace split payment with per-recipient disbursements (application_fee, money_release_days, coll Financial create_anticipation Request anticipation of receivables for a recipient (antecipação) Financial create_automatic_payment Create a Khipu automatic payment (recurring / subscription charge against a previously enrolled subscription_i Financial create_balance_account Open a new currency balance account on a profile (e.g. open a EUR balance to hold euros). Financial create_bank_account Store a customer bank account (POST /customers/{customer_id}/bankaccounts). Required before you can run destin Financial create_bank_transaction Create a bank transaction (SPEND = money out, RECEIVE = money in) directly on a bank account — for transaction Financial create_batch_payment Submit a batch of B2P transfers in a single request. Each item is an independent transfer to a PicPay user; Pi Financial create_batch_payout Create a batch payout via POST /v1/payments/payouts. sender_batch_header carries metadata; items is an array o Financial create_beneficiary Create a transfer beneficiary (recipient) with bank details. Required before sending cross-border payouts via Financial create_bill Create a bill (AP / money owed to a vendor). VendorRef and at least one Line (AccountBasedExpenseLineDetail or Financial create_boleto Issue a boleto via Bradesco Cobrança. Returns nosso_numero, linha_digitável, barcode, and PDF URL. Financial create_boleto_sale Convenience wrapper to create a Boleto sale (POST /sales with Payment.Type=Boleto). Returns BarCodeNumber, Dig Financial create_brcode_payment Pay a BR Code (Pix QR code / copia-e-cola) Financial create_buy_transaction Create a buy transaction (fiat -> crypto). The returned object contains status plus — depending on method — re Financial create_card Register card data for on-ramp payments Financial create_card_token Tokenize a card for use in DIRECT-flow create_payment. Use the returned token in the card.token field instead Financial create_cart_mandate Create an AP2 cart mandate — a signed, locked-cart commitment from a merchant binding line items, totals, and Financial create_cash_entry Create a bank account ledger entry (lançamento de conta corrente) in Omie ERP Financial create_checkout Create a reusable hosted checkout — think product-page-style link that can be paid multiple times. Good for ev Financial create_checkout_page Create a Rapyd hosted checkout page. Returns a redirect_url the payer opens in a browser. Rapyd renders the ap Financial create_checkout_session Create a hosted Checkout Session. Returns a url the customer completes payment on. Use mode= Financial create_cob Create an immediate Pix charge (cobranca imediata) Financial create_cobv Create a Pix due charge (cobranca com vencimento). If txid omitted, server-generated. Financial create_consent Create a payment consent that the payer will authorize at their bank. Iniciador endpoint: POST /consents. Financial create_conversion Execute an FX conversion between wallet currencies (e.g. swap USD received into BRL before settling locally). Financial create_credit_note Issue a credit note (Nota de Crédito A/B/C: types 3, 8, 13) referencing an original invoice Financial create_crypto_withdrawal Create a crypto withdrawal to an external wallet address Financial create_debit Create a debit card sale in Cielo (requires 3DS authentication) Financial create_debit_note Issue a debit note (Nota de Débito A/B/C: types 2, 7, 12) referencing an original invoice Financial create_devolucao Request a Pix devolution (refund) on a received Pix transaction Financial create_donation Create a round-up donation linked to an original payment (Adyen Giving). Financial create_estimate Create an estimate (quote). CustomerRef and Line items required. Estimates can later be converted to invoices. Financial create_ewallet Create a digital wallet payment (Google Pay, Samsung Pay, Apple Pay) Financial create_external_account Register a fiat receiver account (BRL Pix, USD wire, EUR SEPA, MXN SPEI). Skippable for BRL Pix payouts — pass Financial create_giftcard Create a gift card for a customer (GiftCard Hub) Financial create_installment_plan Create a Peruvian cuotas (installment) plan on a charge. Enables splitting a card payment into N monthly insta Financial create_intent_mandate Create an AP2 intent mandate — a Verifiable Credential expressing the user Financial create_invoice Create an electronic invoice (Factura Electrónica) via AFIP Financial create_invoice_batch Create a batch of invoices in a single CAE request (FECAESolicitar, up to 250) Financial create_link Create a link to a financial institution Financial create_mass_payout Create a mass payout — multiple payouts in a single batch request. Financial create_nfce Create and emit an NFCe (nota fiscal do consumidor eletronica) Financial create_nfe Create and emit an NFe (nota fiscal eletronica) Financial create_nfse Create and emit an NFSe (nota fiscal de servico) Financial create_numtoken Create a numtoken (Getnet card-on-file PAN-level token). Use for recurring or one-click-checkout flows where t Financial create_openfinance_consent Create an Open Finance consent (BACEN-regulated) for data access or payment initiation against a third-party Financial create_order Create a buy or sell order Financial create_payout Create a payout from Circle (USDC to fiat) Financial create_paywall Create a x402 paywall configuration for an endpoint. When requests hit this endpoint, they receive HTTP 402 wi Financial create_pix Create a Pix payment in Cielo (generates QR code) Financial create_pix_automatico Register a Pix Automático recurrence (BCB 2025 recurring Pix product, /rec). The payer authorizes the merchant Financial create_pix_cob Create an immediate Pix charge (cob) with QR code. Returns txid, EMV copy-paste payload, and location URL. BAC Financial create_pix_cobv Create a Pix charge with due date (cobv) — used for boleto-like Pix where the payer can pay at or after a due Financial create_pix_devolucao Refund (devolução) a previously received Pix. Must reference the original endToEndId and a merchant-side refun Financial create_pix_devolution Create a Pix devolução (refund) — refund a received Pix transaction Financial create_pix_evp Create a random Pix key (EVP/alias) Financial create_pix_key Register a Pix key (CPF/CNPJ, email, phone, or EVP/random) Financial create_pix_payment Initiate an outbound Pix transfer (ordem de pagamento). Moves money from a debtor account held on Matera to an Financial create_pix_qr Create a dynamic Pix charge with QR code (cob). Returns the txid, copy-paste EMV payload, and location URL. Financial create_pix_qr_dynamic Create a dynamic Pix QR (single-use, expiring). Returns txid, EMV payload, and QR image. Preferred for e-comme Financial create_pix_qr_static Create a static Pix QR (reusable, tied to a merchant Pix key). Returns EMV copy-paste payload and QR image. Us Financial create_pix_qrcode Generate a static PIX QR code for receiving payments Financial create_pix_request Create a Pix payment request Financial create_pix_sale Convenience wrapper to create a Pix sale (POST /sales with Payment.Type=Pix). Returns a QrCodeBase64Image and Financial create_pix_withdrawal Create a Pix withdrawal (BRL) to a Pix key Financial create_preauth_payment Create a NuPay payment using a pre-authorized Bearer access_token (pre-auth / recurrence flow). Same body as c Financial create_preference Create a checkout preference for Checkout Pro Financial create_purchase Create a purchase document Financial create_purchase_order Create a purchase order (pedido de compra) in Bling Financial create_push_payment Send a push payment notification to a Nequi user Financial create_qr_payment Generate a QR code for payment Financial create_quote Lock an FX + fee quote for a 5-minute TTL. Same endpoint for both on_ramp (fiat → stablecoin) and off_ramp (st Financial create_recurrence Create a native Rede recurrence (subscription). Rede handles retries and cardholder updates automatically. Financial create_recurrent Create a recurrent payment schedule (POST /recurrentPayments). Used for subscriptions and any schedule where B Financial create_sale Create a sale in Conta Azul Financial create_sale_3ds Create a 3DS-authenticated credit sale (POST /sales). Same endpoint as create_sale but the CreditCard object c Financial create_sale_with_3ds Create a credit card sale using 3DS 2.0 authentication data (from 3DS flow) Financial create_sale_with_token Create a credit card sale using a previously stored CardToken (avoids re-entering card data) Financial create_sales_receipt Create a sales receipt (paid-on-the-spot sale — combines invoice + payment). CustomerRef and Line items requir Financial create_sell_transaction Create a sell transaction (crypto -> fiat). Used for agents that need to pay out in local fiat after receiving Financial create_settlement_report Manually generate a settlement (account money) report for a date range. Returns 202; poll the report list endp Financial create_split Configure a marketplace split rule that routes part of a payment to a subseller. Values are cents; percentages Financial create_split_capture Capture a previously authorized split sale with overridden per-sub-merchant amounts (PUT /sales/{paymentId}/ca Financial create_split_rule Configure split distribution for an existing charge. Each rule routes a portion of the charge to a receiver (o Financial create_split_sale Create a sale with marketplace split rules (POST /sales with Payment.SplitPayments). Same endpoint as create_s Financial create_static_qr Generate a static (reusable) Nequi QR code for a merchant Financial create_subaccount Create a subaccount for payment splitting Financial create_swap Create an onchain swap between two assets. Endpoint set provisional, expand once docs stabilize. Financial create_tax_payment Pay a tax (DARF, GPS, GRU, etc.) by barcode / digitable line Financial create_terminal_session Create a Khipu terminal session for in-person / POS bank-transfer checkout. Returns a QR/URL the payer scans a Financial create_token Tokenize a card (POST /tokens). Returns a token id like tkn_xxx. Tokenization is typically done client-side vi Financial create_token_card Tokenize a credit card for secure payments Financial create_tokenized_card Tokenize a credit/debit card Financial create_tokenized_nequi Tokenize a Nequi wallet (start async tokenization by phone number) Financial create_topup Create a mobile/service top-up (recarga) via Celcoin Financial create_transaction Create a payment transaction Financial create_utility_payment Pay a utility bill (e.g. water, electricity) by barcode / digitable line Financial create_wallet Create a new Circle business-account wallet Financial create_withdrawal Create a withdrawal request (crypto or fiat) Financial create_zero_auth Zero-dollar authorization / card validation (POST /zeroauth). Braspag routes a $0 (or minimum-amount) authoriz Financial disable_recurrence Disable (cancel) an active recurrence. Stops all future billings. Financial disable_recurrent Deactivate a recurrent payment (PUT /recurrentPayments/{recurrentPaymentId}/Deactivate). Stops future charges; Financial generate_dynamic_qrcode Generate a dynamic PicPay Pay QR code with a fixed amount and optional expiration. Each QR is single-purpose. Financial initiate_checkout Start the checkout process for a cart. Returns a checkout session with payment options. Financial issue_card Issue a card (debit / credit / prepaid / virtual) against a Dock account. Card issuing is Dock Financial mark_order_fraudulent Report a confirmed chargeback / fraud outcome back to Legiti. This is Legiti Financial oneclick_create_inscription Start a OneClick Mall card-enrollment flow. Returns { token, url_webpay } — redirect the user to complete enro Financial register_beneficiary Register a beneficiary account Financial register_boleto Issue a boleto via BB Cobranças. Returns nosso_numero, linha digitável, barcode, and PDF URL. Financial resolve_key_claim Resolve a pending DICT key claim (confirm or cancel) — POST /dict/keys/claims/{id}/resolve Financial schedule_payment Schedule a future-dated payment (Pix, boleto, arrecadação, or TED). Itaú executes the debit on the scheduled d Financial schedule_pix Schedule a future-dated PIX transfer Financial send_chargeback Send a $chargeback event to Sift Financial send_pix Initiate an outbound Pix payment from the merchant Financial send_ted Send a TED transfer to an account at another bank. Same-day settlement within banking hours; otherwise queued. Financial submit_for_settlement Submit a previously authorized transaction for settlement via submitTransactionForSettlement. Unlike capture_t Financial suspend_subscription Suspend a subscription. Endpoint: POST /subscriptions/:id/suspend Financial update_amount Update the authorized amount of an unsettled payment (common in tips / hotel incidentals). Financial update_payment_link Update a payment link Financial update_quote Update a Wise quote (e.g. attach a recipient via targetAccount, or change payOut). Returns the updated quote w Financial update_recurrence Update an existing recurrence — change amount, card (storageCard), end date, or pause/resume. Pass only the fi Financial update_recurrent_amount Update the charged amount on a recurrent payment (PUT /recurrentPayments/{recurrentPaymentId}/Amount). Body ca Financial update_recurrent_next_date Update the next charge date of an existing recurrent payment Financial update_recurrent_next_payment Update the NextPaymentDate on a recurrent payment (PUT /recurrentPayments/{recurrentPaymentId}/NextPaymentDate Financial update_recurrent_payment Update the Payment (CreditCard + Customer) on a recurrent schedule (PUT /recurrentPayments/{recurrentPaymentId Financial update_subscription Update a subscription. Accepts any Chargebee subscription fields (plan_id, plan_quantity, coupon_ids, addons, Financial webpay_commit_transaction Commit a Webpay Plus transaction after the user has returned from the Webpay flow. Must be called to actually Financial webpay_create_transaction Create a Webpay Plus transaction. Returns { token, url } — redirect the user to url?token_ws=<token> to comple Financial webpay_mall_commit_transaction Commit a Webpay Mall transaction after the user has returned. Charges all child commerce codes at once. Financial webpay_mall_create_transaction Create a Webpay Mall transaction — one parent buy_order split across several seller commerce codes. Returns {
DESTRUCTIVE 62 tools
Destructive cancel_all_orders Cancel all open orders for the authenticated user Destructive cancel_boleto Cancel (baixa) an outstanding boleto before payment. Destructive cancel_checkout Cancel an ACP checkout session. Releases any held inventory. Destructive cancel_cte Cancel an authorized CTe Destructive cancel_mdfe Cancel a MDF-e (manifesto) Destructive cancel_nfce Cancel an authorized NFCe Destructive cancel_nfe Cancel an authorized NFe (within 24h of emission) Destructive cancel_nfse Cancel an authorized NFSe Destructive cancel_pickup Cancel a pickup/collection request Destructive cancel_prepost Cancel a pre-posting order Destructive cancel_report Cancel a report that is IN_QUEUE and has not yet started processing. Reports that are IN_PROGRESS or DONE cann Destructive cancel_sale Cancel a sale in Conta Azul Destructive cancel_shipment Cancel a shipment Destructive clear_cart Remove all items from the cart Destructive delete_account Delete a Jumio end-user account and every workflow execution under it (GDPR right-to-erasure). Irreversible. F Destructive delete_applicant Soft-delete an applicant. Onfido retains the record for 30 days before permanent deletion; during that window Destructive delete_bank_account Delete a stored customer bank account (DELETE /customers/{customer_id}/bankaccounts/{id}). Destructive delete_boleto Cancel an issued boleto (only allowed while unpaid / in Destructive delete_bounce Remove a bounced address from the bounce suppression list via DELETE /suppression/bounces/{email}. Call this a Destructive delete_card Detach a saved card from its customer (DELETE /cards/{id}). The card id becomes unusable as source_id afterwar Destructive delete_card_token Delete a Cartão Protegido vault token (DELETE /card/{token}). After deletion the token can no longer be used t Destructive delete_category Delete a product category by ID Destructive delete_checkout Delete a reusable checkout. The hosted URL stops accepting new payments. Existing charges spawned by the check Destructive delete_contact Delete a contact Destructive delete_customer Delete a customer Destructive delete_dict_key Delete a DICT key owned by the merchant. Irreversible — key becomes available for re-registration after BCB lo Destructive delete_instance Delete an instance permanently Destructive delete_invoice Delete an invoice. Permanently removes the invoice. Requires Id and SyncToken. Destructive delete_item Delete a bank connection (revokes credentials, removes accounts/transactions). Pluggy endpoint: DELETE /items/ Destructive delete_link Delete a link (and all its associated data) by ID Destructive delete_list Delete a Marketing Campaigns contact list via DELETE /marketing/lists/{id}. Contacts are NOT deleted by defaul Destructive delete_listings_item Delete a listing item for the seller by SKU. Destructive delete_media Delete an uploaded media asset by id. Destructive delete_message Delete a message for me or for everyone in a chat Destructive delete_payment Delete a payment by ID Destructive delete_payment_method Delete a vaulted payment method via deletePaymentMethodFromVault. Irreversible — the token cannot be used for Destructive delete_payment_source Delete a payment source from a customer Destructive delete_paywall Remove a x402 paywall from an endpoint Destructive delete_pix_key Delete a DICT key owned by the merchant. Irreversible — the key becomes available for re-registration by any P Destructive delete_plan Delete a subscription plan. Fails if the plan has active subscriptions. Destructive delete_product Delete a product by ID Destructive delete_recipient Remove a registered recipient. Will fail if the recipient is currently attached to in-flight payments. Destructive delete_service Delete a service in Conta Azul Destructive delete_subscription Delete a webhook subscription by ID Destructive delete_template Delete a message template from the WABA by name. Optionally scope by hsm_id when two templates share a name ac Destructive delete_token Delete a stored card token. Destructive delete_transaction Delete a workflow execution (GDPR right-to-erasure). Removes captured images, extracted data, and decision aud Destructive delete_webhook Delete a webhook by ID Destructive oneclick_delete_inscription Delete (revoke) a stored OneClick Mall card for a user. Destructive remove_from_allowlist Remove a value from the Konduto allowlist. Future orders matching the value will once again undergo full ML sc Destructive remove_from_blocklist Remove a value from the Konduto blocklist. Destructive remove_from_reviewlist Remove a value from the Konduto reviewlist. Future orders matching the value will be scored normally instead o Destructive remove_group_participant Remove a participant from a WhatsApp group Destructive revoke_agent Revoke an agent Destructive revoke_consent Revoke a payment consent before it is exercised. Iniciador endpoint: DELETE /consents/{id}. Destructive revoke_token Revoke an issued access_token or refresh_token at POST /v1/token/revoke. Use to terminate a recurrence mandate Destructive unlabel_user Remove any existing label on a user (DELETE /v205/users/{user_id}/labels). Optionally scope by abuse_type. Destructive unsubscribe_webhook Remove a previously registered webhook Destructive void_invoice Void/cancel an invoice Destructive redact_inquiry Redact an inquiry (GDPR right-to-erasure). Scrubs PII, captured images, and verification detail for this inqui Destructive add_to_blocklist Add a value to the Konduto blocklist. Any future order matching the value is auto-declined. Useful for known-b Destructive disable_stored_payment_method Delete a stored payment method (shopper opt-out).
EXECUTE 37 tools
Execute ship_order Arrange shipment for an order — either request pickup, drop off, or pass a tracking number depending on the lo Execute backchannel_start Start a CIBA / OTP pre-authorization for a shopper. Sends a push to Nubank app (CIBA) or triggers an OTP SMS. Execute execute_studio_flow Trigger a Studio Flow Execution for a contact. Studio flows are visual IVR / workflow builders — this kicks on Execute fraud_screen Run a standalone FraudSight assessment on a payment method (no authorization). Returns a score and recommendat Execute restart_instance Restart an instance Execute run_report Create and run a standalone Persona report — not tied to an inquiry flow. Use for ad-hoc watchlist screening, Execute start_verification Start a Verify (2FA) challenge. Sends a one-time code to Execute trust_platform_start Start a Trust Platform onboarding flow — orchestrated pipeline chaining person/company checks + biometrics + d Execute address_validation Address normalization + validation against CORREIOS + IBGE — canonical address, CEP, neighborhood, city, state Execute backchannel_resend_otp Resend the OTP to the shopper for an in-flight authorization ticket. Execute challenge_3ds Step 3 of 3DS2 — post the CReq back after the issuer challenge window closes, to retrieve the final authentica Execute evaluate_order Submit an order to Legiti for real-time fraud evaluation via the v2 order endpoint. Returns a decision (approv Execute exchange_token Exchange an authorization_code or refresh_token at POST /v1/token. Expects an already-signed JWT client_assert Execute logout_instance Logout an instance (disconnects the WhatsApp session without deleting the instance) Execute lookup_3ds Step 1 of 3DS2 — submit device-data-collection (DDC) output to Worldpay to determine whether a challenge is re Execute make_call Place an outbound voice call. Twilio fetches TwiML from Execute oauth_token_exchange Exchange an authorization code for a seller access token (marketplace onboarding). Also supports refresh_token Execute apply_decision_to_order Apply a workflow Decision to a specific order (POST /v3/accounts/{account_id}/users/{user_id}/orders/{order_id Execute apply_decision_to_session Apply a workflow Decision to a session (POST /v3/accounts/{account_id}/users/{user_id}/sessions/{session_id}/d Execute backchannel_complete Complete a CIBA/OTP flow by submitting the OTP the shopper received. Returns the access_token once validated. Execute create_antifraud_analysis Submit a standalone Antifraud analysis (POST /fraudanalysis) through Braspag Execute create_check Run a verification check on an applicant. A check is a bundle of one or more reports (document, facial_similar Execute create_client_token Mint a Braintree client token via createClientToken for client-side tokenization (Drop-in, Hosted Fields, mobi Execute create_device_fingerprint_session Start a device fingerprint session. Returns a session_token the client embeds via ClearSale Execute create_workflow_run Start an Onfido Studio workflow run. Studio is Onfido Execute issue_challenge Issue an authentication challenge (OTP via SMS/email or KBA question) to a buyer. Use as a step-up after EM_AN Execute onboarding_process_create Kick off an orchestrated onboarding pipeline that chains KYC + biometrics + signature in one call. Returns pro Execute resolve_manual_review Manually resolve an order currently in EM_ANALISE by approving or declining it. Use when an analyst overrides Execute resume_inquiry Resume a paused inquiry — returns a fresh one-time session token / link so the end user can continue a flow th Execute send_button_actions Send interactive action buttons (CALL, URL, REPLY). Do not mix REPLY with CALL/URL in the same message. Execute send_button_list Send a button list message via WhatsApp Execute send_custom_event Send a custom (merchant-defined) event to Sift Execute send_login Send a $login event to Sift Execute send_logout Send a $logout event to Sift Execute send_order_for_analysis Submit an order to ClearSale for fraud analysis. Returns a score (0-100) and a decision (APROVADO / REPROVADO Execute send_rcs Send an RCS (Rich Communication Services) message Execute send_sms Send an SMS message
WRITE 244 tools
Write remove_from_cart Remove an item from the shopping cart Write track_auth Notify Legiti of an authentication or password event (login attempt, logout, password recovery request, passwo Write unblock_card Unblock a card that was previously blocked (reversible). Restores card to ACTIVE status. Cannot be used on per Write send_invoice Email an invoice to one or more recipients Write send_invoice_email Email an issued invoice to a recipient Write adjust_inventory Adjust the available inventory for a specific inventory_item at a specific location by a delta (positive to in Write answer_question Answer a question on a product listing Write change_card_status Change a card Write confirm_shipment Confirm shipment of an order Write correct_nfe Issue a Carta de Correção (CC-e) for an authorized NF-e. Use for minor fixes that don Write decline_inquiry Mark an inquiry as declined. Records your final reject decision on the Persona inquiry for reporting and feedb Write duplicate_invoice Duplicate an existing invoice with a new due date. Endpoint: POST /invoices/:id/duplicate Write email_nfse Email the PDF of an already-issued NFS-e to a recipient. Write label_user Label a user as fraud or not-fraud via the legacy Labels API (POST /v205/users/{user_id}/labels). Labels are t Write leave_group Leave a WhatsApp group Write link_identity Link buyer identity for personalization and order history across merchants Write oneclick_finish_inscription Finalize a OneClick Mall enrollment after the user has returned. Returns the tbk_user token to store and reuse Write read_message Mark messages as read Write report_order_approved Report that an order was ultimately approved by the merchant. Convenience wrapper around update_order_status w Write report_order_declined Report that an order was ultimately declined by the merchant. Convenience wrapper around update_order_status w Write request_key_portability Request portability of a Pix key from another PSP into this PSP (DICT portability flow) Write subscribe_webhook Register a webhook (notificação) to receive Bling events Write track_account Notify Legiti of an account lifecycle event (created / updated / deleted). Legiti Write track_behavior_event Log a behavior signal (page view, login, signup, custom event) tied to a fingerprint session. Behavior data sh Write track_event Track a custom analytics event in the bot event tracker Write track_event_view Notify Legiti that a user viewed an event/show page. Browse signal — feeds Legiti Write track_logout Notify Legiti of a logout event. Convenience wrapper over track_auth with action= Write track_password_recovery Notify Legiti of a password recovery request (the Write track_signup Notify Legiti of a new account creation. Convenience wrapper over track_account with action= Write unfreeze_account Unfreeze a previously frozen Dock account, restoring Pix and card operations. Write verify_code Submit the verification code received via SMS/voice after request_verification_code. Completes registration. Write wallet_contact_verify Submit a verification token (usually received via SMS/email) to verify a wallet contact Write add_bundle_deal Create a bundle-deal promotion (e.g. buy-N-for-X, buy-N-get-Y%-off, fixed-price bundle). Items are attached vi Write add_cart Add shipment orders to cart for batch checkout Write add_case_tag Add a tag to a case. Tags are operator-facing labels useful for grouping / filtering investigations (e.g. Write add_contact Upsert contacts in Marketing Campaigns via PUT /marketing/contacts. Matches on email. Returns a job_id — inges Write add_contacts Add one or more contacts to the WhatsApp address book. Accepts an array of contacts. Write add_conversation_participant Add a participant to a Conversation. For SMS / WhatsApp, pass MessagingBinding.Address (+E164 or whatsapp:+E16 Write add_discount Create a new shop-level discount (promotion) with a time window. Add items/variations to it afterwards via the Write add_group_participant Add a participant to a WhatsApp group Write add_item Create a new product (item) in the shop. Expects full item payload per Shopee /product/add_item spec (category Write add_label Assign a label/tag to a chat Write add_opt_out Add a phone number to the opt-out list (suppresses future messages) Write add_suppression Add recipients to a suppression group via POST /asm/groups/{group_id}/suppressions. Future mail in this group Write add_to_allowlist Add a value to the Konduto allowlist (trusted). Future orders matching the value are auto-approved without ful Write add_to_cart Add an item to the shopping cart Write add_to_reviewlist Add a value to the Konduto reviewlist. Future orders matching the value are forced into manual review regardle Write apply_decision_to_content Apply a workflow Decision to a content item (POST /v3/accounts/{account_id}/users/{user_id}/content/{content_i Write apply_decision_to_user Apply a workflow Decision to a user (POST /v3/accounts/{account_id}/users/{user_id}/decisions). Decisions are Write approve_inquiry Mark an inquiry as approved. This records your final decision on the Persona inquiry — useful for dashboard re Write archive_chat Archive or unarchive a chat Write archive_contact Archive a Xero contact by setting ContactStatus=ARCHIVED. Archived contacts are hidden from default lists but Write close_mdfe Close/finalize an MDFe (encerramento) after trip completion Write close_order Close an order (mark as fulfilled/closed) Write close_ticket Close an open support ticket Write create_address Create a stored address for sender/recipient Write create_applicant Create an Onfido applicant — the person record that documents, live photos, and checks attach to. Required bef Write create_broadcast Create a broadcast distribution list and send messages Write create_bulk_guias Create multiple guías in a single batch operation Write create_buyer Create a buyer in the marketplace Write create_carnet Create a carnet (payment booklet with multiple parcels) Write create_cart Create a new shopping cart for a merchant Write create_case Open a fraud investigation case (e.g. for a suspicious cluster of orders or a confirmed fraud ring). Cases gro Write create_category Create a product category Write create_collection Schedule a package collection (pickup) from an address Write create_company Provision a new company on NFe.io. Requires federalTaxNumber (CNPJ), name, address, and fiscal certificates/co Write create_connect_token Mint a connect token for embedding the Pluggy Connect widget on the client. Pluggy endpoint: POST /connect_tok Write create_contact Create a contact (customer or supplier) Write create_conversation Create a Twilio Conversation. Conversations host multi-channel (SMS / WhatsApp / chat) threads with server-sid Write create_coupon Create a promotion coupon code Write create_cte Create and emit a CTe (conhecimento de transporte eletronico) for cargo transport Write create_custom_collection Create a custom collection — a manually curated collection. Products are attached separately via collects. Write create_customer Create a customer Write create_discount_code Create a discount code tied to an existing price rule (the customer-facing string like Write create_discount_coupon Create a discount coupon Write create_draft_order Create a draft order (invoice-style quote). Can be completed later into a real order via complete_draft_order. Write create_event Create a conversion event for a contact Write create_feed Submit a feed to SP-API (e.g. POST_PRODUCT_DATA, POST_INVENTORY_AVAILABILITY_DATA, JSON_LISTINGS_FEED). Feed c Write create_fulfillment Create a fulfillment for an order (mark line items as shipped, attach tracking number and carrier). Write create_group Create a WhatsApp group Write create_inquiry Create a Persona inquiry — a verification session bound to an inquiry template you configured in the Persona d Write create_instance Create a new WhatsApp instance Write create_invoice_item Add a line item to an upcoming or specific invoice Write create_item Create a new bank connection (item) for a connector. Pluggy endpoint: POST /items. Write create_label Generate a shipping label for a shipment Write create_list Create a Marketing Campaigns contact list via POST /marketing/lists. Returns the new list UUID. Use the id wit Write create_mdfe Create and emit an MDFe (manifesto eletronico de documentos fiscais) for cargo transport manifest Write create_metafield Attach a metafield (custom typed field) to a resource (shop, product, variant, customer, order, collection, dr Write create_notification Create a webhook notification configuration Write create_opportunity Create a sales opportunity in a funnel Write create_pickup Create a pickup/collection request (retiro) Write create_plan Create a subscription plan (POST /plans). Plans are reusable templates — attach customer cards via create_subs Write create_pos Create a point of sale (POS) linked to a store Write create_prepost Create a pre-posting order for shipping Write create_presentation Create a Verifiable Presentation bundling one or more credentials (e.g. intent + cart + payment mandates) for Write create_price Create a Price attached to a Product. Set recurring for subscription prices; omit for one-time. Amount is in s Write create_price_rule Create a price rule (the policy that governs discounts — percentage/fixed amount, prerequisites, entitlements, Write create_product Create a new product Write create_promotion Create a promotion/discount in VTEX Write create_receipt Create a receipt (recibo) — record cash/transfer received against one or more invoices Write create_receiver Create (onboard) a new receiver under an integrator account. The receiver can then collect Khipu payments. Onl Write create_recipient Register a final beneficiary (required for regulatory split payments). Up to 10 recipients can later be attach Write create_report Request an SP-API report. Report is generated asynchronously — poll with get_report until processingStatus is Write create_return Create a reverse logistics shipment (logística inversa / devolución) Write create_reverse Create a reverse logistics (return) order Write create_seller Onboard a marketplace seller via Getnet Marketplace Management. Required before routing split payments to a se Write create_service Create a service in Conta Azul Write create_service_invoice Create a service invoice (NFS-e) in Bling Write create_service_order Create a service order (OS) in Omie ERP Write create_session Create a Checkout session (used by Drop-in and Web Components to load methods + handle the full flow client-si Write create_shipment Create a new shipment Write create_sku Create a new SKU for a product Write create_smart_collection Create a smart collection — an automated collection populated by rules (e.g. vendor, tag, product_type, price Write create_stock_adjustment Create an inventory adjustment (entry/exit/balance) in Omie ERP Write create_stock_movement Register a stock-in or stock-out movement for a product (alias of update_stock with explicit direction) Write create_store Create a store (physical location or POS group) Write create_subscription Create a webhook subscription for message events Write create_supplier Create a supplier (proveedor) Write create_taskrouter_task Create a TaskRouter Task on a Workspace. TaskRouter routes work (calls, chats, tickets) to eligible Workers ba Write create_template Create a transactional template via POST /templates. Returns a template_id. Add versions separately via /templ Write create_ticket Open a support ticket / human handoff for a contact Write create_variant Add a new variant to an existing product (size/color/SKU permutation with its own price and inventory). Write create_vendor Create a vendor (supplier). DisplayName is required and must be unique. Write create_verify_service Create a Verify Service (VA...). A service groups verification attempts and holds per-service config (code len Write create_warehouse Register a new warehouse (fulfillment center) Write create_webhook Subscribe to a webhook event Write create_widget_token Create a short-lived access token for the Belvo Connect Widget Write generate_label Generate shipping label for an order Write generate_sdk_token Mint a short-lived SDK token for embedding the Onfido Web / iOS / Android SDKs in your frontend. The token is Write generate_static_qrcode Generate a static PicPay Pay QR code for in-store / reusable use. The buyer opens PicPay, scans the QR and typ Write initiate_account Create a persistent Jumio end-user account. An account groups all workflow executions (KYC transactions) for t Write link_session_to_user Send a $link_session_to_user event to Sift Write mark_chat_as_read Mark an entire chat as read or unread Write mark_dispute_resolution Report the outcome of a chargeback dispute back to Legiti — i.e. whether the merchant won or lost the chargeba Write mark_message_as_read Mark one or more messages in a chat as read Write patch_link Update a link Write patch_listings_item Partially update a listing item for the seller by SKU using a JSON Patch list of operations. Use this to chang Write post_objects Close and post a list of pre-posted objects (fechar postagem SIGEP) — creates a PLP Write put_listings_item Create or fully replace a listing item for the seller by SKU. Body must be a Listings Items submission (produc Write register_agent Register an AI agent as a trusted payer in the AP2 network. Defines the agent Write register_callback_url Set or update the account-level webhook (callback) URL where Jumio POSTs workflow result notifications. Per-tr Write register_company Register a company in Nuvem Fiscal Write register_dict_key Register a DICT key on a BB account owned by the merchant. Some key types (email/phone) require BCB confirmati Write register_pix_key Register a DICT key (CPF, CNPJ, email, phone, or EVP) on a C6 account owned by the merchant. Subject to BCB va Write register_webhook Register a webhook subscription for a Shopify event topic (orders/create, orders/paid, products/update, app/un Write request_verification_code Request Meta to send a verification code to the configured phone number via SMS or voice. Use before verify_co Write resume_check Resume a check that was paused (typically awaiting_applicant or paused states). No-op on checks that are alrea Write send_audio Send an audio message via WhatsApp Write send_chat_message Send a text or sticker message to a buyer in Shopee Write send_contact Send a contact card via WhatsApp Write send_contacts_message Send one or more contact cards (vCard-like). Each contact includes name and at least one of phones, emails, ad Write send_content_status Send a $content_status event to Sift Write send_conversation_message Post a message into a Conversation. Fanned out to all participants via their channel (SMS / WhatsApp / chat). Write send_correction_letter Send a correction letter (Carta de Correcao / CCe) for an authorized NFe Write send_correction_letter_cte Send a carta de correção for a CT-e. Used to correct minor errors without cancelling. Write send_correction_letter_nfe Send a carta de correção eletrônica (CCe) for a NF-e. Used to correct minor errors without cancelling. Write send_document Send a document via WhatsApp Write send_email Send a transactional email Write send_event Send a fraud signal to Sift Write send_facebook_message Send a Facebook Messenger message Write send_image Send an image message via WhatsApp Write send_interactive_cta_url Send an interactive message with a single CTA URL button. Opens the URL when the recipient taps it. Available Write send_interactive_flow Send a WhatsApp Flow message. Flows are Meta Write send_interactive_message Send an interactive message (reply buttons or list). Supply a fully-formed Write send_location Send a location message via WhatsApp Write send_location_message Send a location pin with latitude/longitude and optional name/address. Write send_mail Send an email via POST /mail/send. Supply at least one Write send_media_message Send an image, video, document, or audio. Supply either Write send_message Send a message to a contact via Take Blip Write send_notification Send a notification message to a contact Write send_option_list Send an interactive option list (WhatsApp native list). Does NOT work in groups. Write send_poll Send a poll message via WhatsApp Write send_reaction_message Send an emoji reaction on a previously received/sent message. Pass empty string for Write send_template Convenience wrapper for POST /mail/send with a dynamic template. Equivalent to send_mail with Write send_template_message Send an approved message template. Required for business-initiated conversations. Templates must be pre-approv Write send_text Send a text message via WhatsApp Write send_text_message Send a plain text message. For business-initiated conversations outside the 24h customer-service window, use s Write send_typing_indicator Show a typing indicator on a received message. Also marks the message as read. Indicator auto-clears after ~25 Write send_voice Send a voice message via TTS or pre-recorded audio URL Write send_whatsapp Send a WhatsApp message Write set_bot_resource Set a bot resource value (used as bot variables / state via /resources bucket) Write set_presence Set online/offline presence for an instance Write set_webhook Configure a webhook URL for a given Pix key (PUT /webhook/{chave}). PSP will POST notifications when Pix payme Write signature_electronic_create Create a GoCertta electronic signature envelope (e-signature without ICP-Brasil cert — lower legal weight, fas Write signature_icp_create Create an ICP-Brasil digital signature envelope for one or more documents. Returns envelope_id + signers Write submit_dispute_evidence Submit evidence to defend a dispute. Pass the evidence payload (document references, rebuttal text, etc.) in t Write supply_defense_document Upload a supporting document for an ongoing dispute defense (Dispute Service v30). Write track_account_update Notify Legiti of an account profile change (email, phone, CPF, address). Convenience wrapper over track_accoun Write track_login Notify Legiti of a login attempt (successful or failed). Convenience wrapper over track_auth that hard-codes a Write track_order_invoice Update tracking info for a previously issued invoice Write track_sale Notify Legiti of a Sale state change (created / updated). For initial sale creation without asking for a decis Write update_account Patch attributes on an existing Persona account (e.g. update address, phone, tags). Use this to keep a persist Write update_allowlist_entry Update an existing allowlist entry — typically to extend or shorten the expiration window. Konduto Write update_applicant Update fields on an existing applicant. Send only the fields you want to change. Write update_blocklist_entry Update an existing blocklist entry — typically used to extend or shorten the expiration window (expires_at) wi Write update_business_profile Update the business profile on the configured phone number. Supply only the fields you want to change. Write update_call Modify an in-progress call. Set Status= Write update_case Update an existing fraud investigation case — change status, add notes, reassign, or attach more orders. Write update_category Update a product category Write update_checkout Update an existing reusable checkout. Supply only the fields you want to change (Coinbase replaces the supplie Write update_cob Revise an existing immediate charge (PATCH /cob/{txid}). Common updates: status REMOVIDA_PELO_USUARIO_RECEBEDO Write update_cobv Update an existing Pix due charge (cobv) by txid Write update_contact Update an existing contact Write update_customer Update an existing customer Write update_deal Update a deal/opportunity by ID Write update_decision_status Manually override Legiti Write update_dispute Submit evidence on a Dispute. Pass an Write update_fulfillment_tracking Update the tracking number, tracking company, or tracking URL on an existing fulfillment (post-ship tracking c Write update_group_participants Add, remove, promote, or demote participants in a WhatsApp group Write update_inventory Update inventory quantity for a SKU at a specific warehouse Write update_invoice Update an invoice. QBO uses sparse update: pass Id, SyncToken, sparse=true, plus any fields to change. Write update_item Refresh / update credentials for an existing bank connection. Pluggy endpoint: PATCH /items/{id}. Write update_lead_scoring Mark a contact as lead, qualified lead, or opportunity (lead scoring) Write update_order Update a Transak order after creation. Used for partner-side post-creation actions such as marking a SELL cryp Write update_order_status Update order fulfillment/shipping status Write update_payment Update a pending payment Write update_payment_method Update metadata on a vaulted payment method via updatePaymentMethod. Use to change billing address, cardholder Write update_pix_cob Update (PATCH) an existing Pix immediate charge. Typical uses: change status to REMOVIDA_PELO_USUARIO_RECEBEDO Write update_plan Update an existing plan. Endpoint: PUT /plans/:id Write update_product Update an existing product Write update_product_price Update prices for an item (or its models/variants). Pass price_list entries with model_id 0 for single-SKU ite Write update_product_stock Update stock levels for an item (or its models/variants). Pass stock_list entries with model_id 0 for single-S Write update_product_variant Update a product variant (price, stock, sku, weight) Write update_profile Update instance profile (name, status text, or picture) Write update_recipient Update a registered final beneficiary (name, document, country, type). referenceId is the path key and cannot Write update_reviewlist_entry Update an existing reviewlist entry — typically to extend or shorten the expiration window without removing an Write update_sales_order Alter an existing sales order in Omie ERP Write update_seller Update seller information Write update_service Update a service in Conta Azul Write update_shipment_status Update the shipment status of an order (Orders API v0). Used to mark MFN orders as ReadyForPickup, PickedUp, o Write update_sku_price Update base/list/cost price for an SKU Write update_stock Update stock for a product at a warehouse Write update_token Update metadata on a stored card token (e.g. expiryDate after an account-updater refresh, cardHolderName, desc Write update_transaction_status Update the merchant-side status of a workflow execution (PATCH). Use to record your final accept/reject decisi Write update_variant Update an existing product variant Write update_wallet Update profile fields on a Rapyd ewallet (user). Pass the ewallet id plus only the fields you want to change. Write update_webhook Update a webhook endpoint Write upload_certificate Upload or update an A1 digital certificate (.pfx, base64) for an empresa. Required to emit fiscal documents. Write upload_chargeback_evidence Upload documentation/evidence for a chargeback dispute. Accepts one or more files as base64 content. Write upload_document Upload an identity document image for an applicant. Sent as multipart/form-data. Pass file as base64-encoded b Write upload_live_photo Upload a live photo (selfie) for an applicant, used by facial_similarity_photo reports. Sent as multipart/form Write upload_media Upload a media file and get back a media_id reusable in send_media_message. Multipart POST to /{phone_number_i Write upload_process_document IDCheck: upload a captured image to a running verification process. Use the appropriate document_side (FRONT, Write upsert_contact Upsert (create or update) a contact identified by email (Marketing API)
READ 668 tools
Read antifraud_score Composite fraud risk score (0-1000) for a transaction context (CPF + email + phone + IP + device). Returns sco Read batch_get_process_status IDCheck: batch status lookup. Send up to 100 process_ids per call and receive the same status payload as get_p Read biometrics_face_match Compare a selfie against a document photo (RG / CNH front). Returns match_score (0..1) and liveness verdict. P Read biometrics_liveness Passive liveness check on a selfie (no document). Returns liveness_score (0..1) + spoofing_indicators. POST /v Read calculate_shipping Calculate shipping rates between two CEPs Read check_availability Check product stock and delivery availability for a specific location Read check_number Check if a phone number is registered on WhatsApp Read check_pep IDCheck: Politically Exposed Person screening. Pass cpf (preferred) or name; returns matches with role, jurisd Read check_verification Check a Verify (2FA) code against a Service SID. Returns status=approved when the code matches. Read check_watchlists IDCheck: global sanctions / adverse-media screening. Covers OFAC (US Treasury), UN, EU, HMT (UK), Interpol Red Read companies_lookup CNPJ lookup — razão social, fantasia, founding date, paid-in capital, partners, address, CNAE. POST /v1/datase Read company_check KYB — validate a CNPJ, return corporate profile, QSA, regularity, sanctions. POST /v1/checks/company. Read conciliation_report Get transactions reconciliation report by date (all received + sent ordenes) Read connection_state Get the connection state of an instance (open, connecting, close) Read consult_cep Resolve a Brazilian postal code (CEP) to a full address. Read consult_cnpj Look up Brazilian company data (razão social, status, address) by CNPJ. Read consult_fgts Query FGTS balance / extrato. Caixa is the sole operator of FGTS (Fundo de Garantia do Tempo de Serviço) and e Read court_records_search IDCheck: Brazilian judicial-records search. Covers federal and state courts (TRFs, TJs), labor courts (TRTs), Read document_check Document validation — OCR + authenticity check on RG / CNH / passport / proof of residence. Returns structured Read documents_ocr OCR a Brazilian ID document (RG / CNH / CRLV / proof of residence / passport). Returns extracted structured fi Read download_boleto_pdf Fetch the rendered boleto PDF for an issued boleto. Returns the PDF URL (or base64 bytes) so it can be attache Read download_document Download the raw binary of an uploaded document. Returns the bytes as base64 plus content_type. Useful for re- Read download_invoice_pdf Download invoice as PDF (returns download URL) Read download_invoice_xml Download invoice as XML (returns download URL) Read download_shipping_document Request the shipping label / air waybill PDF for one or more orders. Returns a download URL or base64 document Read employment_data Employment profile for a CPF — current employer, history, monthly income, professional category. POST /v1/data Read exchange_rate Get current exchange rate for a currency pair Read expenses_report Expenses/purchases report by date range Read extract_document IDCloud: OCR + structured field extraction from a Brazilian ID document image. Returns typed fields (name, doc Read face_authentication Face authentication against a base image (typically the document photo). Returns match_score + liveness verdic Read face_match IDPay: biometric 1:1 comparison between a live selfie and a document photo. Returns a similarity score (0-1) a Read fetch_group_invite_code Fetch the invite code/link for a WhatsApp group Read financial_data Credit + financial profile for a CPF/CNPJ — income, score, declared assets, banking, default history. POST /v1 Read find_cep Look up address by CEP via Correios Read find_cep_bulk Batch address lookup for up to 20 CEPs in a single call Read find_customer Search for customers via the GraphQL search.customers query. Pass one of email / firstName / lastName / compan Read find_dispute Fetch a dispute by id via the GraphQL node(id:) query. Returns id, status, reason, amountDisputed, receivedDat Read find_merchant_account Fetch a merchant account by id via the GraphQL node(id:) query. Returns id, status, currencyCode, and default Read get_3ds_status Check the current status of a 3DS authentication by its reference id. Returns whether the cardholder completed Read get_acceptance_token Get merchant acceptance token (required for transactions) Read get_account Retrieve a Dock account by id. Returns balance, status, holder info, and account coordinates (agency / account Read get_account_balance Retrieve the current balance of a BB conta-corrente (checking) account. Read get_account_balances Get account balances for all currencies Read get_account_detail Retrieve a stored account by account ID Read get_account_info Get account information, configuration, and balance Read get_account_overdraft_limits Get account overdraft (limites) via Open Finance Read get_account_receivable Get a single accounts-receivable record by ID Read get_account_statement Retrieve account statement transactions for a given period. Paginated. Read get_account_status Retrieve account KYC and verification status (tier, limits, required docs) Read get_accounts Get accounts for a link Read get_address Get address by ID Read get_advanced_payment Get an advanced (split) payment by ID Read get_agent Get agent registration details, trust status, and current spend usage Read get_analytics Get chatbot analytics and metrics Read get_anticipation Get anticipation details by ID Read get_anticipation_limits Get anticipation limits available for a recipient Read get_antifraud Get anti-fraud analysis details for a payment Read get_audit_trail Get the complete audit trail for a transaction — every authorization, approval, execution, and settlement even Read get_authorization Get authorization details including status, limits, and expiry Read get_authorization_url Build the URL where the payer authorizes a consent at their bank. This is a helper — it does not call Iniciado Read get_authorized_points_of_sale List authorized puntos de venta for the CUIT Read get_b2p_transfer Get the status of a B2P transfer by referenceId. Typical statuses: created, processing, completed, failed. Read get_badlar_rate Get BADLAR rate (tasa de plazos fijos >1M ARS, bancos privados) — used as benchmark for many financial product Read get_balance Get account balance summary Read get_balance_account Fetch a single balance account by id (Balance Platform BCL v2). Read get_balance_sheet Retrieve the Balance Sheet report for the tenant. Returns assets, liabilities, and equity grouped by account a Read get_balances Get account balances for all assets Read get_bank_accounts List registered bank accounts in Omie ERP Read get_bank_statement Retrieve bank account statement (extrato) for a period from Omie ERP Read get_banks List all Brazilian banks with codes and names Read get_bill Get bill details by ID Read get_boleto Retrieve a boleto by nosso_numero. Read get_boleto_pdf Download the boleto PDF as base64. Useful for attaching to emails or portal downloads. Read get_bot_resource Get a bot resource value by name (variable / state) Read get_bounces Retrieve bounced recipients via GET /suppression/bounces. Returns [{email, created, reason, status}]. Filter b Read get_business_profile Read the WhatsApp business profile (about, description, email, websites, vertical, address) for the configured Read get_business_qualifications Get business customer qualifications via Open Finance Read get_buy_quote Preview a fiat -> crypto buy quote in real time. Use this before create_buy_transaction to show the end user t Read get_buy_transaction Retrieve a buy transaction (fiat -> crypto) by its MoonPay id. Returns current status and settlement detail. Read get_cae_status Check CAE authorization status for an invoice Read get_call Retrieve a call resource by SID (CA...). Read get_candles Get OHLC candlestick data for a market Read get_card Retrieve a card by id. Returns card status (ACTIVE / BLOCKED / CANCELED), masked PAN, expiry, and limits. Read get_card_details Get details for a single debit or credit card Read get_card_token Retrieve the stored card data associated with a Cartão Protegido token (GET /card/{token}). Returns masked car Read get_cart Get cart contents, item totals, taxes, and shipping estimates Read get_catalog Get the catalog category tree Read get_category Get category details and children Read get_cep Look up address by CEP (Brazilian postal code) Read get_cep_v1 Look up address by CEP using BrasilAPI v1 (single-provider, often faster than v2) Read get_charge Retrieve a charge by Culqi id. Read get_charge_by_order Retrieve a charge by the merchant-side orderNumber (order_id passed to create_charge). Use when you have the m Read get_chargeback Get chargeback details by ID Read get_chat_history Get full chat history with pagination support Read get_chatbot_flow Get chatbot flow/builder configuration Read get_check_result Retrieve a previously-run check by ID (person, company, or document). Useful for replay + auditing without re- Read get_checkout Retrieve the current state of an ACP checkout session, including status, pricing, and available payment method Read get_cnpj Look up company information by CNPJ Read get_cob Get Pix charge details by txid Read get_cobv Get Pix due charge (cobv) details by txid Read get_collection Get collection request details by ID Read get_company Get company profile and settings Read get_company_info List companies registered in Omie ERP Read get_connector Get a single connector definition by id. Pluggy endpoint: GET /connectors/{id}. Read get_consent Fetch a payment consent and its current authorization status. Iniciador endpoint: GET /consents/{id}. Read get_contact Get contact details by UUID or email Read get_contact_metadata Get metadata (name, WhatsApp display name, profile picture, status) for a single contact Read get_contacts Get contacts from an instance Read get_content_decisions Fetch the decisions currently applied to a content item (GET /v3/accounts/{account_id}/users/{user_id}/content Read get_corretora Look up a single CVM-registered brokerage by CNPJ Read get_corretoras List all CVM-registered Brazilian brokerages (corretoras) Read get_coverage Check if a location is within coverage area Read get_cptec_airport_weather Get current airport weather (METAR) by ICAO code from CPTEC/INPE Read get_cptec_capitals_weather Get current weather conditions for all Brazilian state capitals Read get_cptec_cities Search CPTEC/INPE cities by name for weather forecasts Read get_cptec_ocean_forecast Get ocean/wave forecast for a coastal city (CPTEC/INPE) Read get_cptec_weather Get weather forecast for a city (CPTEC/INPE) Read get_credit_card_bill Get credit card bill details Read get_credit_card_bills Get credit card bills (faturas) via Open Finance Read get_credit_card_transactions Get credit card transactions via Open Finance Read get_credit_note Get a credit note by ID Read get_cte Get CTe details and status by reference Read get_currency Get details of a specific currency (precision, min/max amounts, type) Read get_currency_history Get historical quotes for a currency over a date range Read get_currency_rate Get FX rate (cotización) for a currency vs ARS (FEParamGetCotizacion) Read get_customer Get customer details by ID Read get_customer_balance Get the current account balance (cuenta corriente) for a customer Read get_customer_kyc_status Fetch KYC verification status (and any pending document requirements) for a MoonPay customer. Use to gate flow Read get_ddd Get state and cities for a DDD (area code) Read get_deal Get a deal/opportunity by ID Read get_decision Fetch the latest Legiti decision for an order. Returns the decision (approve / reject / manual), score, and th Read get_delivery_modality Get delivery modality (forma de entrega) for a CEP and service — whether delivery is domicile, agency pickup, Read get_delivery_options Get available shipping and delivery options for a cart Read get_delivery_time Get estimated delivery time between two CEPs Read get_deposit Get deposit details by ID (incoming Pix or TED) Read get_device_fingerprint Retrieve captured device characteristics for a fingerprint session (OS, browser, timezone, canvas/WebGL hash, Read get_devolucao Get details of a Pix devolution by e2eId and devolution id Read get_dispute Get dispute/chargeback details by ID Read get_domain_info Look up .br domain registration info Read get_employment_records Get employment records for a link (employment institutions) Read get_event Retrieve a single webhook event by id (GET /events/{id}). Useful for auditing a webhook delivery against Culqi Read get_event_webhook_settings Retrieve the Event Webhook configuration via GET /user/webhooks/event/settings. Returns {url, enabled, deliver Read get_exchange_rate Query the dLocal FX rate for a destination country/currency pair. Used to preview converted amounts before a p Read get_exchange_rates Get official exchange rates snapshot for a date (USD, EUR, BRL, etc.) Read get_extracted_data IDCheck: fetch the structured OCR result for a finished process — typed fields (name, document number, issuer, Read get_feed Get a feed Read get_fees Query trading fees (maker/taker) for a symbol Read get_financial List accounts receivable from Omie ERP Read get_financial_summary Get financial summary from Conta Azul Read get_fipe_brands List vehicle brands by type from FIPE table Read get_fipe_price Get vehicle price from FIPE table by code Read get_fipe_tables List FIPE reference tables (months/years available for FIPE queries) Read get_fipe_vehicles List vehicle models for a given FIPE brand code and vehicle type Read get_funnel Get funnel details with stages Read get_giftcard Get gift card details by ID Read get_group_info Get group metadata, participants, and settings Read get_group_metadata Get group metadata and participants Read get_guia_pdf Download a guía label as PDF (returns base64 or URL) Read get_holidays List national holidays for a given year Read get_ibge_municipalities List all municipalities for a Brazilian state (IBGE data) Read get_ibge_states List all Brazilian states/UFs with IBGE codes and metadata Read get_identification_types Get document/identification types available per country (CPF, CNPJ, DNI, RUT, etc.). Use the seller Read get_incomes Get income data for a link Read get_inflation Get inflation data (IPC nivel general — variación mensual) Read get_installments Get installment details. Pass Read get_instances List all WhatsApp instances Read get_interest_rates Get reference interest rates (tasas de interés de referencia) Read get_inventory Get inventory/stock for a SKU across warehouses Read get_inventory_summary Get FBA inventory summaries (fulfillable, inbound, reserved, researching, unfulfillable quantities) for the se Read get_investments Get investment portfolios for a link Read get_invoice Get invoice details by type, point of sale, and number Read get_invoice_link Get the DANFE PDF/link for an issued invoice Read get_invoice_pdf Get the PDF representation of an invoice (returns URL or base64) Read get_invoice_total_x_request Max number of records allowed per FECAESolicitar request (FECompTotXRequest) Read get_invoice_xml Get the XML payload of an issued invoice (NF-e) Read get_invoices Get invoices for a link (BR/MX fiscal institutions) Read get_isbn Look up book information by ISBN Read get_item Fetch a single bank connection by id. Pluggy endpoint: GET /items/{id}. Read get_kyc_status Get the KYC status of a buyer the partner has previously sent through Transak. Look up by partnerCustomerId (p Read get_label Get a label by ID Read get_label_pdf Download a shipping label as PDF (base64-encoded) Read get_labels List all available labels/tags Read get_last_invoice_number Get last authorized invoice number for a point of sale and type Read get_leliq_rate Get monetary policy rate (ex-LELIQ / tasa de política monetaria) Read get_link Retrieve details of a specific link by ID Read get_listings_item Get a single listing item for the seller by SKU. Read get_loan_payments Get loan payment schedule via Open Finance Read get_market_trades Get recent public trades for a market (trade history / tape) Read get_marketplace Get marketplace information and settings Read get_marketplace_participations List all marketplaces the seller is registered to sell in (Sellers API). Returns marketplace ids, names, defau Read get_masterdata_document Get a document (customer profile, custom entity) from VTEX Master Data v2 Read get_mdfe Get MDF-e details by ID Read get_merchant Get merchant information Read get_merchant_info Retrieve registered merchant business profile Read get_merchant_order Get merchant order by ID Read get_merchants List the merchant receiver accounts accessible with the current API key. Useful to confirm auth + discover rec Read get_message Retrieve a message resource by SID (SM... or MM...). Read get_message_status Get message delivery status by ID Read get_messages Get messages from a chat Read get_monetary_base Get monetary base data (base monetaria) Read get_my_fees_estimate_for_asin Estimate referral fee + FBA fees for selling an ASIN at a given price. Useful before creating a listing or whe Read get_ncm Look up NCM tax classification code Read get_nfce Get NFCe details and status by reference Read get_nfe Get NFe details and status by reference Read get_nfe_batch Get NF-e batch (lote) status by batch ID. Use for batch emissions. Read get_nfe_events Get events for a NF-e (cancellations, corrections, etc.) Read get_nfe_pdf Get NFe PDF (DANFE) download URL Read get_nfe_xml Return the authorized XML URL for an NF-e. Requires the invoice to be in status Authorized. Read get_nfse Get NFSe details and status by reference Read get_nfse_pdf Return the PDF URL for an issued NFS-e. Read get_nfse_xml Return the XML URL for an issued NFS-e. Read get_notifications Get payment notification details by notification code Read get_oauth_token Mint or return a cached OAuth2 client_credentials bearer token for the Bradesco Developer Portal. Exposed so a Read get_official_rate Get the official BCRA quote for a single currency on a specific date Read get_order Get order details by ID Read get_order_analysis Retrieve the current analysis state of an order previously sent to ClearSale. Useful when the initial response Read get_order_decisions Fetch the decisions currently applied to an order (GET /v3/accounts/{account_id}/orders/{order_id}/decisions). Read get_order_detail Get full detail for one or more orders by order_sn (comma-separated, up to 50). Read get_order_items Get the line items for an order by AmazonOrderId. Returns ASIN, SellerSKU, quantity, item price, taxes, promot Read get_order_limits Get the min and max trade amount for a fiat+crypto+country combination — what Read get_order_score Fetch only the fraud score (numeric 0-100) for an order. Lighter than get_order_analysis when the full decisio Read get_order_shipment_status Get shipment status for a shipment id via the Shipping API (Amazon Shipping / Buy Shipping labels). Read get_orderbook Get order book (bids and asks) for a market Read get_owners Get owner information for a link Read get_partner_account Get the authenticated partner Read get_partner_balance Get the partner Read get_payment Fetch a payment by id (status, E2E id, error reason if rejected). Iniciador endpoint: GET /payments/{id}. Read get_payment_by_order Retrieve a payment using the merchant-side order_id (handy when you Read get_payment_by_order_id Get a payment by the merchant-side order_id supplied at creation time. Useful when the agent only kept its own Read get_payment_details Fetch a payment object by id via GET /v2/payments/{type}/{id}. type is one of Read get_payment_intent Fetch the current status of a payment intent. Pluggy endpoint: GET /payments/intents/{id}. Read get_payment_link Get payment link details Read get_payment_method_details Get details of a specific payment method by ID Read get_payment_methods Dynamically list available payment methods for a country/currency/amount combination. Critical for multi-count Read get_payment_methods_by_site List available payment methods for a specific Mercado Pago site (MLB=Brazil, MLA=Argentina, MLM=Mexico, MLC=Ch Read get_payment_request Get payment request details by ID Read get_payment_status Check the status of a payment Read get_payout Get payout details by ID Read get_payout_by_external_id Get a payout by the merchant external_id / order_id supplied at creation time. Mirror of get_payment_by_order_ Read get_payout_item Fetch a single payout item by id via GET /v1/payments/payouts-item/{item_id}. Use to inspect the status of one Read get_paywall Get paywall configuration for a specific URL Read get_personal_qualifications Get personal customer qualifications (income, occupation) via Open Finance Read get_pickup Get pickup (recolección) details by id Read get_pix Retrieve a Pix transaction by its BCB endToEndId (E<ispb><yyyymmddhhmm><sequence>). Read get_pix_automatico Retrieve a Pix Automático recurrence by idRec. Returns current status (CRIADA, APROVADA, REJEITADA, CANCELADA) Read get_pix_charge Retrieve a Pix immediate charge (cob) by its BCB txid. Returns status, QR payload, and associated received Pix Read get_pix_charge_due Retrieve a due-dated Pix charge (BCB GET /cobv/{txid}). Read get_pix_cob Retrieve an immediate Pix charge by its txid. Read get_pix_cobv Retrieve a Pix due-date charge (cobv) by its txid. Read get_pix_devolucao Retrieve a Pix devolução by its endToEndId + refund id. Read get_pix_due_charge Retrieve a Pix due charge (cobv) by txid. Read get_pix_key Get Pix key details by ID Read get_pix_keys List registered PIX keys Read get_pix_participants List Pix participant institutions (PSPs/banks enrolled in Pix) Read get_pix_payment Retrieve an outbound Pix payment by endToEndId. Read get_pix_transfer Get status and details of a specific PIX transfer Read get_portfolio_summary Consolidated portfolio summary across all asset classes held at BTG (fixed income, funds, equities, treasury, Read get_preference Get checkout preference by ID Read get_prepost Get a pre-posting order by ID Read get_process_status IDCheck: poll the status of a verification process previously created via the Unico Web/Mobile SDK or API. Ret Read get_product Get product details by ID Read get_product_description Get product description text by item ID Read get_product_detail Get detailed base info for up to 50 items by item_id. Read get_profile Get authenticated user profile information Read get_profile_picture Get profile picture URL for a phone number Read get_profit_and_loss_report Run a Profit and Loss report for a date range. Read get_public_keys Get PagSeguro public key for card data encryption (type: card) Read get_qrcode Get QR code for instance pairing Read get_quote Get a fiat↔crypto price quote (public, no auth). Returns the rate, fees, min/max, delivery network, and the ex Read get_rates Get shipping rates/quotes Read get_receivables Get receivables for a transaction Read get_receivables_transactions Get receivables transactions for a link (payment rails / acquirer data) Read get_recipient Retrieve a registered recipient by referenceId. Read get_reconciliation_batch Retrieve a reconciliation batch (daily settlement file equivalent) — lists all settled transactions, fees, and Read get_recurrence Retrieve a recurrence by Rede recurrence id. Read get_recurrence_transactions List transactions generated by a recurrence (one row per billing cycle executed). Read get_recurrent Get recurrent payment details Read get_refund Get refund details by ID Read get_registration_certificate Get constancia de inscripción (registration certificate) for a CUIT Read get_report Get a report Read get_report_entries Get message report entries within a date range Read get_reserves Get international reserves data (reservas internacionales) Read get_return_list List return/refund requests on the shop, optionally filtered by status and time window. Read get_reverse Get reverse logistics order details by ID Read get_sale Get a sale by id in Conta Azul Read get_sale_by_order_id Look up sale(s) by MerchantOrderId (GET /sales?merchantOrderId=X — Query API). Returns an array of PaymentIds Read get_sales_order Consult a specific sales order by ID or integration code in Omie ERP Read get_score_by_contact Look up the risk score for a contact identifier (email or phone). Use for account-takeover screening at login Read get_score_by_document Look up the risk score and historical signals associated with a Brazilian document (CPF or CNPJ). Use for pre- Read get_segmentation_contacts List contacts inside a given segmentation Read get_sell_quote Preview a crypto -> fiat sell quote in real time. Use this before create_sell_transaction to show the end user Read get_sell_transaction Retrieve a sell transaction (crypto -> fiat) by its MoonPay id. Read get_seller Retrieve a seller by Getnet seller_id. Read get_seller_balance Get detailed balance for a specific seller Read get_server_status Check AFIP web-service availability (WSFE status) Read get_session Retrieve the status/result of a Checkout session (poll after the shopper finishes Drop-in). Read get_session_decisions Fetch the decisions currently applied to a session (GET /v3/accounts/{account_id}/users/{user_id}/sessions/{se Read get_settlement Query settlement (liquidation) for a given date Read get_settlement_report Retrieve a settlement (liquidacao) report from the reconciliation host. Groups captured charges by settlement Read get_shipment Get shipment details by ID Read get_shipment_history Get tracking history (status changes) for a shipment Read get_shipment_list List orders currently in shipment (status SHIPPED or in-transit). Useful for reconciling tracking and delivery Read get_shipping_label Get shipping labels (PDF or ZPL) for one or more shipments. Returns the raw response URL; caller is expected t Read get_shipping_parameter Fetch the required shipping parameters for an order before calling ship_order. Returns which of pickup / dropo Read get_shipping_rates Simulate shipping rates for items to a postal code Read get_shop_info Get basic information about the authorized Shopee shop (shop_name, region, status, auth expiry). Read get_sku_price Get pricing details for an SKU (base price, list price, markup, cost, fixed prices per trade policy) Read get_statement Retrieve account statement transactions for a BB conta-corrente over a date range. Paginated. Read get_statement_enriched Get enriched statement with detailed transaction info (counterparty, category, Pix details) Read get_statement_pdf Download account statement as PDF (base64 payload) for a date range Read get_stats Global email stats via GET /stats. Returns sent/delivered/opens/clicks/bounces/spam_reports aggregated between Read get_status Get WhatsApp instance connection status Read get_stock Get current stock for a product across warehouses Read get_stock_position Get current stock position / balance in Omie ERP Read get_store Get store/company information Read get_subscription Get subscription details for a phone number Read get_supported_networks List supported blockchain networks, tokens, and facilitators for x402 payments Read get_swap Get a single swap by id — full status, executed amounts, gas, and tx hash. Endpoint set provisional, expand on Read get_tariffs Query the tariff schedule applicable to the merchant Read get_tax_rates Get current Brazilian tax/economic rates (Selic, CDI, IPCA) Read get_tax_returns Get tax returns for a link (fiscal institutions) Read get_terminal_session Retrieve the current status of a terminal (POS) session — whether the payer has scanned, paid, or the session Read get_terminal_status Get current status of a specific POS terminal (online / offline / last seen) Read get_thread Get the message thread between the bot and a specific identity Read get_threads Get message threads (recent conversations) Read get_ticker Get ticker data for a trading pair (price, volume, VWAP, etc.) Read get_tm20_rate Get TM20 rate (tasa de plazos fijos >20M ARS, bancos privados) Read get_token Retrieve metadata for a previously stored card token (brand, last 4, expiration). Does not return the PAN. Read get_tokenization_status Query async tokenization status (Nequi etc.) by tokenization id Read get_tracker Get tracker (events) by tracker ID Read get_tracking_history Get full tracking history for a shipment Read get_tracking_number Get the tracking number (and courier info when available) for a shipped order. Read get_trading_fees Get current trading fees and limits (maker/taker per pair, withdrawal limits) Read get_transaction Retrieve a single transaction by id. Returns full detail including counterparty, fees, and originating event ( Read get_transaction_detail Retrieve a stored transaction by transaction ID Read get_transaction_details Retrieve the full result payload for a workflow execution — all capability outputs (extraction, liveness, simi Read get_transaction_receipt Fetch a tax-/audit-grade receipt for a completed buy or sell transaction. Useful for end-user reporting or acc Read get_transactions Get transactions for a link Read get_transfer Get transfer details by ID Read get_trends Get trending searches in the marketplace Read get_user Get authenticated user information Read get_user_country Resolve the caller Read get_user_decisions Fetch the decisions currently applied to a user (GET /v3/accounts/{account_id}/users/{user_id}/decisions). Ret Read get_user_limits Get the current per-user transaction limits granted by Transak based on the user Read get_user_score Fetch the latest Sift score(s) for a user (GET /v205/users/{user_id}/score). Does NOT trigger a rescore — it r Read get_uva_value Get UVA (Unidad de Valor Adquisitivo) — used for inflation-adjusted mortgage calculations Read get_variable_history Get the historical series for any monetary variable by id, with optional date range. Use list_variables to dis Read get_wallet Get wallet details by ID Read get_wallet_balance Retrieve the merchant Read get_webhook Get configured webhooks Read get_webhook_event Retrieve a single webhook event by ID Read get_webhook_events Get webhook events (payment confirmations, transfers, etc.) Read get_withdrawal Retrieve a specific withdrawal by its ID Read get_workflow_run Fetch the status of a Sift Workflow run (GET /v3/accounts/{account_id}/workflows/runs/{run_id}). The run_id is Read kyb_lookup_cnpj Validate a CNPJ and return company profile — corporate name, fantasia, address, partners (QSA), CNAE, share ca Read kyc_lookup_cpf Validate a CPF against Receita Federal + SPC / Serasa. Returns name, DOB, regularity status, restrictions, ris Read list_abandoned_carts List abandoned checkouts Read list_abandoned_checkouts List abandoned checkouts (carts where the customer entered contact info but did not complete checkout). Useful Read list_account_balances List balances for all company accounts Read list_account_trades List authenticated account fills/trades for a symbol Read list_accounts List chart of accounts (plan de cuentas) Read list_accounts_payable List accounts payable (contas a pagar) Read list_accounts_receivable List accounts receivable (contas a receber) Read list_addresses List saved addresses Read list_agencies List carrier pickup agencies near a location Read list_agents List registered agents with optional filters Read list_assets List supported assets/coins on the exchange Read list_audit_events List audit events across all transactions with filters Read list_authorizations List payment authorizations with optional filters Read list_balance_accounts List the balance accounts owned by an account holder (Balance Platform BCL v2). Read list_balances List the asset balances for a wallet across all addresses + networks. Endpoint set provisional. Read list_bank_accounts List bank accounts Read list_bank_transactions List bank transactions (spend/receive entries on bank accounts). Supports where-clause filtering by BankAccoun Read list_banks List participating SPEI banks Read list_beneficiaries List beneficiaries. Supports pagination and filters by entity_type, nickname and bank_country_code. Read list_bills Query bills using QBO Read list_boletos List boletos issued by the merchant filtered by status and issue/due period. Paginated. Read list_branches List Andreani branches/sucursales Read list_buy_transactions List buy transactions with optional filters. Used for reconciliation and agent-driven monitoring. Read list_cards List registered cards Read list_carriers List available carriers Read list_cases List investigation cases, filterable by status, assignee, or priority. Useful for operator dashboards or batch Read list_categories List product categories Read list_cep_ranges List CEP ranges (faixas de CEP) served by a given shipping service Read list_channels List available messaging channels Read list_chargebacks List chargebacks Read list_charges List charges, newest first. Supports cursor pagination via starting_after / ending_before. Read list_chats List all WhatsApp chats with pagination Read list_checkouts List reusable hosted checkouts, newest first. Cursor pagination via starting_after / ending_before. Read list_checks List all checks for a given applicant. Read list_cheque_entities List the catalog of financial entities with their cheque codes — use the código to validate cheques Read list_cities List available cities for shipping Read list_cobs List Pix charges by date range Read list_cobv List due-date charges (cobv) within a date range Read list_companies List companies (empresas) accessible to the current API user Read list_concept_types List available concept types (FEParamGetTiposConcepto: 1=Products, 2=Services, 3=Both) Read list_conciliations List settlement / conciliation records for a date range. Each record groups settled payments into a single ban Read list_connectors Lists supported Brazilian banks (connectors). Pluggy endpoint: GET /connectors. Optional filters: name, types Read list_contacts List contacts Read list_conversations List Conversations. Returns a paginated list; pass PageSize to cap. Read list_countries List countries supported by MoonPay along with which flows (buy / sell / NFT) are allowed per geography. Use t Read list_coupons List all promotion coupons Read list_credit_cards List credit card accounts via Open Finance Read list_credit_notes List credit notes Read list_crypto_currencies List all crypto assets Transak supports, including network, decimals, pay-in/pay-out eligibility, and jurisdic Read list_currencies List the master catalog of currencies (divisas) tracked by BCRA Read list_currency_types List supported currencies (FEParamGetTiposMonedas) Read list_customer_orders List order history for a customer (filtered by email) Read list_customer_transactions List all transactions (buy + sell) tied to a single MoonPay customer. Convenience wrapper for unified history Read list_customers List customers Read list_datasources List the datasources available to your Caf account (varies per subscription tier). GET /v1/datasources. Read list_dda_bills List bills registered for the merchant under the DDA (Débito Direto Autorizado) enrolment. Returns pending bol Read list_deal_stages List deal stages of a pipeline (funnel) Read list_deals List deals with optional filters and pagination Read list_departments List departments (cost centers) in Omie ERP Read list_deposits List deposits (incoming Pix or TED) with optional filters Read list_deposits_withdrawals List deposits and withdrawals (transactions) for a currency Read list_dict_keys List DICT keys registered to the merchant Read list_discount_coupons List discount coupons Read list_disputes List disputes via GET /v1/customer/disputes. Filter by disputed_transaction_id, dispute_state, update_time_bef Read list_doc_types List document/identifier types (FEParamGetTiposDoc: 80=CUIT, 86=CUIL, 96=DNI, 99=Consumer Final) Read list_document_types List document types (e.g., FV for invoice, NC for credit note, FC for purchase) Read list_documents List all documents uploaded for a given applicant. Read list_dre List DRE (income statement) chart of accounts in Omie ERP Read list_empresas List all companies (empresas) registered in the account. Read list_events List events — the lifecycle signals (charge:created, charge:confirmed, charge:failed, charge:delayed, charge:p Read list_exchange_rates Fetch current Coinbase exchange rates for a base asset (e.g. BTC, ETH, USDC) against every supported fiat and Read list_external_accounts List external accounts under the operator Read list_fees List applicable fees for the authenticated user across trading pairs Read list_fiat_currencies List all fiat currencies Transak supports, with per-currency payment methods, limits, and country restrictions Read list_financial_events List financial events (shipment, refund, service fee, adjustment, etc.) for reconciliation. Filter by posted-t Read list_financial_events_by_order List financial events scoped to a single order (shipment, refund, service fee, adjustment). Cleaner than list_ Read list_financial_institutions List PSE banks (financial institutions) Read list_financial_movements List unified financial movements (AP + AR + CC) in Omie ERP Read list_financings List financing contracts (financiamentos) via Open Finance Read list_funding_destinations Get funding destination details (address/CLABE) for a given currency Read list_funding_sources List available funding sources (bank accounts, etc.) Read list_fundings List account fundings (deposits) Read list_funds_available List funds available for distribution on BTG Read list_funnels List all sales funnels Read list_groups List all WhatsApp groups with pagination Read list_identities Fetch identity data (legal name, document, address) for an item. Pluggy endpoint: GET /identity?itemId=... Read list_incomes List stored incomes (GET /api/incomes/) Read list_incoming_numbers List Twilio-provisioned phone numbers on this account. Filter by PhoneNumber (partial), FriendlyName, or Beta. Read list_inquiries List inquiries, filterable by reference-id (your internal user id) or status. Useful for reconciling state or Read list_installment_options Query available cuota programs for a given card BIN and amount. Returns the list of issuer-offered installment Read list_institutions List Brazilian banks supported for Pix payment initiation. Iniciador endpoint: GET /institutions. Read list_investment_positions List the counterparty Read list_investments List investment products via Open Finance Read list_invoice_types List available invoice types (Factura A, B, C, etc.) Read list_invoices List invoices Read list_items List bank connections (items) owned by the application. Pluggy endpoint: GET /items. Read list_iva_types List IVA tax aliquots (FEParamGetTiposIva: 21%, 10.5%, 27%, 0%, etc.) Read list_labels List labels Read list_ledger List account ledger entries (trades, fees, fundings, withdrawals) Read list_links List existing links Read list_listings List seller Read list_lists List all Marketing Campaigns contact lists via GET /marketing/lists. Returns list UUIDs, names, and contact_co Read list_live_photos List all live photos (selfies) uploaded for a given applicant. Read list_loans List loan contracts (empréstimos) via Open Finance Read list_locations List all fulfillment locations (physical stores, warehouses, 3PLs). Use the returned IDs with adjust_inventory Read list_markets List all available trading pairs / markets on Foxbit Read list_merchant_accounts List the bank accounts registered for a merchant to collect into. Use with refund_payment / conciliation flows Read list_merchants List merchant accounts visible to the API credential (Management API v3). Read list_messages List messages with optional filters. Returns Twilio Read list_messaging_services List Messaging Services (MG...). A Messaging Service bundles sender pools, templates, and routing rules. Read list_network_fees List the network/gas fees Transak charges (or estimates) per crypto+network combination. Useful for showing bu Read list_networks List supported blockchain networks for a given asset Read list_nfe List NF-e with pagination + optional status filter. Read list_nfse List NFS-e with pagination + optional flowStatus filter. Read list_notifications List webhook notification configurations Read list_offices List Coordinadora branch offices (oficinas) Read list_open_orders List currently open orders for the authenticated user Read list_orderbook Get order book (bids and asks) for a trading pair Read list_orders List orders Read list_organisations Retrieve the Xero organisation(s) the access token has access to — returns name, base currency, country, fisca Read list_owners List stored owners (GET /api/owners/) Read list_parcels List saved parcel presets Read list_payment_events List recent payment events for the configured merchant entity. Useful for transaction reports and reconciliati Read list_payment_intents List payment intents with optional filters (status, merchant_order_id, date range). Supports pagination via pa Read list_payment_links List payment links Read list_payment_methods List available payment methods Read list_payment_methods_by_country List all inbound (collect) payment methods Rapyd supports for a given country + currency. Use to dynamically d Read list_payment_profiles List payment profiles, optionally filtered by customer Read list_payment_requests List payment requests with optional filters Read list_payment_sources List payment sources for a customer Read list_payments List payments in a date range with optional filters. Iniciador endpoint: GET /payments. Read list_payments_by_date List payments created within a date range. Supports cursor pagination via limit + offset. Useful for reconcili Read list_payout_methods_by_country List all outbound (disburse) payout method types Rapyd supports for a given beneficiary country. Returns the p Read list_payouts List payouts with optional filters Read list_paywalls List all configured x402 paywalls Read list_phone_numbers List all phone numbers registered under the WhatsApp Business Account, including display name, quality rating, Read list_pickups List pickup/collection requests Read list_pix List PIX transactions Read list_pix_charges List Pix immediate charges (cob) filtered by date range and optional status / CPF / CNPJ. Paginated per BACEN Read list_pix_cob List immediate Pix charges (cob) by date range. Paginated per BACEN Pix v2. Read list_pix_deposits List Pix deposit history (BRL instant deposits) Read list_pix_keys List DICT keys currently registered to the merchant Read list_pix_payments List outbound Pix payments with optional filters. Useful for reconciliation and agent-driven audit. Read list_pix_received List Pix transactions received by the merchant during a period. Uses BACEN Pix v2 /pix collection with ISO-860 Read list_pix_withdrawals List Pix withdrawal history (BRL fiat withdrawals) Read list_plans List subscription plans. Endpoint: GET /plans Read list_positions List open margin/futures positions (if applicable to the account) Read list_postal_codes Search addresses by street name or location (returns matching CEPs) Read list_preposts List pre-posting orders with optional filters (date range, status) Read list_price_lists List price lists (listas de preços) configured in Tiny ERP Read list_price_tables List all configured price tables (trade policies) Read list_prices List Prices. Filter by product, active flag, type (one_time/recurring), or currency. Read list_product_variants List variants of a product Read list_products List contracted products/services available on the account Read list_profiles List Wise profiles (personal + business) accessible to this API token. Most other endpoints are scoped to a pr Read list_projects List projects in Omie ERP Read list_purchase_orders List purchase orders (pedidos de compras) in Bling Read list_purchases List purchase documents Read list_questions List questions on a product listing Read list_quotes List recent swap quotes minted under the authenticated CDP account. Endpoint set provisional, expand once docs Read list_receipts List receipts (recibos) Read list_receivables Search receivables (future credits from card transactions) Read list_receivers List receivers onboarded under the current integrator account. Read list_recipient_account_requirements Discover required Read list_recipients List registered recipients (final beneficiaries) for the merchant. Supports pagination. Read list_recordings List call recordings on this account. Optionally filter by CallSid, or by DateCreated range. Returns Twilio Read list_refunds List devoluciones (refunds) by date range Read list_reports List reports the seller has requested. Filter by reportTypes, processingStatuses, and created-time window. Read list_returns List reverse logistics shipments (returns) Read list_reviews List payer reviews / opinions left after a Khipu payment. Useful for NPS dashboards and detecting UX problems Read list_sales List sales in Conta Azul Read list_segmentations List contact segmentations Read list_sellers List marketplace sellers with optional filters. Read list_service_orders List service orders (OS) from Omie ERP Read list_services List available service types for a given origin/destination Read list_services_available List available shipping services for a route Read list_settlements List settlements (card payment batches) Read list_shipments List all shipment orders with filters Read list_shipments_by_date List guías created within a date range Read list_skus List SKUs for a product Read list_stored_payment_methods List a shopper Read list_stores List stores Read list_subscriptions List all webhook subscriptions Read list_suppliers List suppliers (proveedores) Read list_suppressions List all suppressed recipients for an unsubscribe group via GET /asm/groups/{group_id}/suppressions. Returns a Read list_symbols List available trading symbols (pairs) on the exchange Read list_taskrouter_workers List Workers on a TaskRouter Workspace. Optionally filter by ActivityName, Available, or TargetWorkersExpressi Read list_tax_rates List tax rates configured in the Xero tenant. Use the returned TaxType codes on invoice/bill line items. Suppo Read list_tax_types List available tax types (IVA, percepciones, retenciones, etc.) Read list_taxes List available tax types Read list_templates List transactional templates via GET /templates. By default returns dynamic templates (recommended); set gener Read list_terminals List physical Stone / TON terminals for a merchant Read list_tickets List tickets, optionally filtering by status Read list_topup_providers List telecom top-up providers (operadoras) available for recargas Read list_trackers List trackers Read list_tracking_by_date List tracking events for a contract within a date range Read list_trades List executed trades for an order book Read list_transactions List transactions on a Dock account (Pix in/out, card auths, fees, transfers). Supports date range and paginat Read list_transfers List transfers with optional filters Read list_unsubscribe_groups List all unsubscribe groups on the account via GET /asm/groups. Returns [{id, name, description, is_default, u Read list_users List Siigo users (sellers) Read list_variables List the catalog of monetary variables (id, descripción, categoría) — use this to discover variable ids for ge Read list_vendors Query vendors using QBO Read list_wallets List all Circle wallets Read list_warehouses List warehouses (depósitos) Read list_webhooks List configured webhooks Read list_withdrawals List account withdrawals Read list_workspaces List workspaces the organization has access to (multi-tenant subaccounts) Read liveness_check Passive liveness on a selfie (no comparison image). Returns liveness_score + spoofing signals. POST /v1/biomet Read lookup_bank_by_code Look up a participating bank by its ABM/SPEI code (first 3 digits of CLABE) Read lookup_dict_key Resolve a DICT key (CPF, CNPJ, email, phone, EVP) to the owner Read lookup_order Look up one or more orders by origin_id (client_id) Read lookup_phone Validate and normalize a phone number via Lookups v2. Optional Read lookup_pix_dict Lookup a Pix DICT key — resolves a Pix key to account holder + bank info Read lookup_taxpayer Padrón lookup by CUIT (WS_SR_PADRON A4/A5/A13 — fiscal status, name, address) Read onboarding_process_get Get status + results of an onboarding process. Each step (KYC, biometrics, signature) reports its own verdict. Read oneclick_get_transaction_by_buy_order Look up a OneClick Mall transaction by parent buy_order. Functionally identical to oneclick_status — provided Read oneclick_status Get the status of a OneClick Mall transaction by parent buy_order. Read person_check KYC — validate a CPF, return name + DOB + restrictions + risk indicators. POST /v1/checks/person. Read persons_lookup CPF lookup — name, DOB, mother Read predict_category Predict the best category for a product title (domain_discovery) Read predict_payment Predict whether a payment is likely to succeed for a given payer+amount+bank, and recommend the best bank/rail Read preview_label Preview a shipping label before generating Read print_label Print/download label PDF Read properties_lookup Real-estate lookup by address or registration — property type, area, owner history, market value estimate. POS Read query_allowlist Check whether a value is currently on the Konduto allowlist. Konduto Read query_blocklist Check whether a value is currently on the Konduto blocklist. Read query_boleto Retrieve a boleto by Getnet payment_id. Returns current status, bank slip URL and barcode. Read query_chargeback Retrieve chargeback (contestacao) detail for a charge: reason code, acquirer deadline, dispute amount, evidenc Read query_installments Query the installment plans Getnet offers for a given amount + card brand (with/without interest, max installm Read query_payment Look up a payment by the merchant-side transactionReference you assigned on authorize_payment. Returns the mat Read query_payment_by_merchant_code Get payment details by merchant_payment_code (alternative to hash) Read query_payment_conditions Query available installment/payment conditions for a given amount and (optionally) shopper CPF. Use before ren Read query_pix Retrieve a Pix charge by Getnet payment_id. Returns current status (PENDING, APPROVED, CANCELED) and, when pai Read query_reviewlist Check whether a value is currently on the Konduto reviewlist. Konduto Read read_barcode Read a boleto / concessionária barcode (digitable line) — returns due date, amount, beneficiary Read retrieve_account Retrieve a Persona account by id, including summary PII and linked inquiries / verifications. Read retrieve_applicable_defense_reasons List the defense reason codes Adyen will accept for a given dispute (Dispute Service v30). Read retrieve_applicant Retrieve an applicant by id. Read retrieve_balance Retrieve the current wallet balance for every currency the account holds. Read retrieve_beneficiary Retrieve a beneficiary by id. Returns bank details, entity_type, and allowed payment_methods. Read retrieve_case Retrieve a case by id — full detail including status, assignee, linked objects, attached fields, and tags. Read retrieve_charge Retrieve a charge by its Coinbase Commerce id OR its short code (the 8-character code embedded in the hosted U Read retrieve_check Retrieve a check by id. Returns the overall status ( Read retrieve_checkout Retrieve a checkout by id. Read retrieve_credentials List the credentials (captured artefacts: ID front/back, selfie, proof-of-address, etc) for a workflow executi Read retrieve_customer Retrieve a customer by id. Returns the customer profile plus metadata. Read retrieve_data_export Retrieve a full GDPR-compliant data export for an account — every workflow execution, captured image URL, extr Read retrieve_document Retrieve document metadata by id. Read retrieve_document_data Retrieve extracted fields from the ID document (name, DOB, document number, expiry, issuing country, MRZ, etc) Read retrieve_event Retrieve a single event by id. Useful when auditing a webhook delivery or replaying state — fetch the event Co Read retrieve_extraction_data Retrieve raw OCR / extraction capability output for a completed workflow — every extracted field with its sour Read retrieve_facemap Retrieve the biometric facemap (face template) generated during a workflow. Used for downstream face-search / Read retrieve_inquiry Retrieve an inquiry by id. Response includes overall status ( Read retrieve_invoice Retrieve an invoice by code. Returns recipient details, status (DRAFT, OPEN, VIEWED, PAID, VOID), and the link Read retrieve_live_photo Retrieve a live photo record by id. Read retrieve_liveness_result Retrieve the liveness capability result — passive/active liveness decision plus per-frame anti-spoofing scores Read retrieve_media_url Resolve a media_id to a short-lived downloadable URL. The URL itself still requires the Bearer token to fetch. Read retrieve_payment_intent Retrieve a payment intent by id. Returns current status, payment_attempts, and latest payment_method. Read retrieve_refund Retrieve a refund by id. Returns current status (RECEIVED, ACCEPTED, PROCESSING, SUCCEEDED, FAILED). Read retrieve_report Retrieve an individual report by id. A report is one verification component of a check (e.g. the document repo Read retrieve_screening_result Retrieve AML / watchlist screening output for a workflow — sanctions hits, PEP hits, adverse-media hits with s Read retrieve_similarity_score Retrieve the facial similarity result (selfie vs document photo). Returns match decision plus confidence score Read retrieve_subscription Retrieve a subscription by ID Read retrieve_transfer Retrieve a transfer by id. Returns current status (APPROVED, IN_PROGRESS, DELIVERED, CANCELLED, etc). Read retrieve_workflow_run Retrieve a workflow run by id. Returns status ( Read sales_report Sales report by date range Read sanctions_check Sanctions + PEP screening (OFAC / UN / EU / BR PEP / CNJ / INSS / IBAMA) for a CPF or CNPJ. POST /v1/datasets/ Read search_agencies Search pickup agencies by service and location Read search_by_merchant_order Look up charges by the merchant-side order identifier (the order_id supplied at creation). Useful when the Saf Read search_catalog_items Search the Amazon catalog for reference product data (ASIN, title, brand, images) by identifiers or keywords. Read search_contacts Search contacts with an SGQL query via POST /marketing/contacts/search. Example: Read search_masterdata Search documents in a Master Data entity Read search_merchant_orders Search merchant orders with filters (last 90 days). Useful for reconciliation of Checkout Pro / Bricks flows. Read search_payments Search payments with filters Read search_products Search products in Mercado Libre marketplace Read search_transaction_by_reference Find transaction(s) by merchant reference Read search_transactions Search transactions via the GraphQL search.transactions query. Filter by status / customerId / orderId / creat Read signature_get_envelope Get status + signer responses for a signature envelope. GET /v1/signature/envelopes/{envelope_id}. Read social_signals Social-presence enrichment for a CPF (Instagram / LinkedIn / Twitter / Facebook handles + follower counts). PO Read track_bulk Track multiple Correios packages in a single call (up to 50 codes) Read track_package Track a package by Correios tracking code Read track_shipment Track a shipment by tracking number Read trust_platform_get Get the status + step-by-step verdicts of a Trust Platform flow. GET /v1/trust/flows/{flow_id}. Read validate_account Validate a CLABE account number against the receiving bank (online check) Read validate_address KYC: validate a Brazilian postal address against the Correios database. Confirms zip_code → street/neighborhoo Read validate_challenge_response Verify a buyer Read validate_cheque Check whether a cheque has been reported as stolen/lost (denunciado) by entity code and cheque number Read validate_clabe Validate CLABE structure and checksum locally (no API call). Returns bank code, plaza, account, and check digi Read validate_cnpj IDCloud: validate a Brazilian CNPJ with Receita Federal. Returns company status (ATIVA, BAIXADA, SUSPENSA, INA Read validate_coverage Validate that a city + postal code combination is covered Read validate_cpf IDCloud: validate a Brazilian CPF with Receita Federal. Returns { valid, status (REGULAR | SUSPENSA | TITULAR Read validate_document KYC: validate a CPF or CNPJ against Receita Federal. Returns registration status (REGULAR / SUSPENSA / CANCELA Read validate_notification Verify that an incoming webhook callback came from PicPay by comparing the x-seller-token header against PICPA Read validate_phone Check whether a phone number is enrolled in Nequi Read validate_postal_code Validate CP coverage and list available services for a postal code Read validate_webhook_signature Validate a Wompi event signature. Accepts either the properties-based checksum (SHA-256 of ordered props + tim Read vehicles_lookup Vehicle lookup by plate / chassis / RENAVAM — make, model, year, color, fuel, FIPE price, ownership history, r Read verify_account Run an AVS/CVC account verification on a card without charging it. Returns the verification outcome and a card Read verify_credential Verify a Verifiable Credential (intent, cart, or payment mandate). Checks signature, issuer trust, expiry, and Read verify_customer Trigger the KYC verification check for a customer. Sandbox auto-progresses business customers through the host Read verify_document_authenticity IDCloud: tamper / forgery detection on a document image. Returns an authenticity score (0-1), a categorical ve Read verify_notification Verify an EBANX webhook notification HMAC signature against the integration key. Local verification, no API ca Read verify_payment Verify if a x402 payment was received and settled on-chain Read verify_presentation Verify a Verifiable Presentation and all embedded credentials, including holder binding and challenge nonce. Read verify_receipt Verify a receipt Read verify_webhook_signature Local helper — verify a Coinbase Commerce webhook payload using HMAC-SHA256. Pass the EXACT raw request body s Read webpay_get_transaction_status Get the current status of a Webpay Plus transaction by token. Read webpay_mall_get_transaction_status Get the status of a Webpay Mall transaction by token (includes per-child details). Read resolve_dict_key Resolve a DICT key (CPF, CNPJ, email, phone, EVP) to the owner Read resolve_did Resolve a Decentralized Identifier (DID) to its DID document via the AP2 universal resolver. Read resolve_pix_key Resolve a Pix DICT key to the account holder
OTHER 1 tools
Other refresh_access_token Mint a fresh short-lived access-token from the partner api-secret. Some Partner API tiers require this token (
EXPLORE

Related servers

Other MCP servers with similar tools — same risk classification, starter policies for each.

Sperax Ecosystem Crypto & DeFI MCP Server 1318 tools
paymentsadminautomation
Mcp Afip 1300 tools
paymentsadminautomation
BNB Chain MCP 1240 tools
paymentsadminautomation
Binance MCP Server 734 tools
paymentsadminautomation
GoHighLevel MCP Server 566 tools
paymentsadminautomation
0nmcp 407 tools
paymentsadminautomation
GoHighLevel MCP Server 406 tools
paymentsadminautomation
TheProtocol — Sovereign AI Agent Platform 380 tools
paymentsadminautomation
FAQ

Questions about Mcp Ap2

Can an AI agent move money through the Mcp Ap2 MCP server? +

Yes. The Mcp Ap2 server exposes 288 financial tools including authorize_transaction, block_card, cancel_bill. Without a policy, an autonomous agent can call these with no spend caps, no rate limits, and no approval flow. PolicyLayer lets you block financial tools by default, require human approval, or set per-tool rate limits — enforced on every call.

Can an AI agent delete data through the Mcp Ap2 MCP server? +

Yes. The Mcp Ap2 server exposes 62 destructive tools including cancel_all_orders, cancel_boleto, cancel_checkout. These permanently remove resources with no undo. PolicyLayer blocks destructive tools by default so they never reach the upstream server.

How do I prevent bulk modifications through Mcp Ap2? +

The Mcp Ap2 server has 244 write tools including remove_from_cart, track_auth, unblock_card. Set a rate limit in your policy -- for example, 10 calls per hour prevents an agent from making more than 10 modifications per hour. PolicyLayer enforces this at the gateway, before calls reach Mcp Ap2.

How many tools does the Mcp Ap2 MCP server expose? +

1300 tools across 5 categories: Destructive, Execute, Financial, Read, Write. 668 are read-only. 632 can modify, create, or delete data.

How do I enforce a policy on Mcp Ap2? +

Register the Mcp Ap2 MCP server in PolicyLayer, apply the suggested rules above (adjust the limits to your use case), and point your AI client at the PolicyLayer proxy URL instead of the server directly. Your agents keep the same tools; PolicyLayer evaluates every call against policy before it executes. Nothing to install, live in minutes.

Enforce policy on every Mcp Ap2 tool call.

Deterministic rules across all 1300 Mcp Ap2 tools. Per-identity grants. Full audit log. Live in minutes. Nothing to install.

ENFORCE POLICY ON MCP AP2 →

Free to start. No card required.

1300 Mcp Ap2 tools catalogued and risk-classified — across an index of 43,000+ MCP servers.

// GET IN TOUCH

Have a question or want to learn more? Send us a message.

Message sent.

We'll get back to you soon.