{"templateId":"markdown","sharedDataIds":{"sidebar":"sidebar-guides/sidebars.yaml"},"props":{"metadata":{"markdoc":{"tagList":[]},"type":"markdown"},"seo":{"title":"API coverage map","description":"Start today using our public API to power your next project."},"dynamicMarkdocComponents":[],"compilationErrors":[],"ast":{"$$mdtype":"Tag","name":"article","attributes":{},"children":[{"$$mdtype":"Tag","name":"Heading","attributes":{"level":1,"id":"api-coverage-map"},"children":["API coverage map"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Every operation in the Jeeves Public API, and where to learn it. Each endpoint appears in at least one recipe of the ",{"$$mdtype":"Tag","name":"a","attributes":{"href":"/flow-builder"},"children":["flow builder"]}," and links to its entry in the ",{"$$mdtype":"Tag","name":"a","attributes":{"href":"/apis"},"children":["API reference"]},"."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"cards"},"children":["Cards"]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"align":"left","data-label":"Method"},"children":["Method"]},{"$$mdtype":"Tag","name":"th","attributes":{"align":"left","data-label":"Endpoint"},"children":["Endpoint"]},{"$$mdtype":"Tag","name":"th","attributes":{"align":"left","data-label":"Summary"},"children":["Summary"]},{"$$mdtype":"Tag","name":"th","attributes":{"align":"left","data-label":"Scope"},"children":["Scope"]},{"$$mdtype":"Tag","name":"th","attributes":{"align":"left","data-label":"Flow-builder block"},"children":["Flow-builder block"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["GET"]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Tag","name":"a","attributes":{"href":"/apis#tag/Cards/operation/CardsController.getCards"},"children":["/v1/cards"]}]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["List all cards"]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["cards:read"]}]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["List & retire cards"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["POST"]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Tag","name":"a","attributes":{"href":"/apis#tag/Cards/operation/CardsController.createCard"},"children":["/v1/cards"]}]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["Create a card"]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["cards:write"]}]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["Issue virtual cards"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["GET"]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Tag","name":"a","attributes":{"href":"/apis#tag/Cards/operation/CardsController.getCard"},"children":["/v1/cards/{id}"]}]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["Retrieve a card"]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["cards:read"]}]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["Issue virtual cards"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["PATCH"]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Tag","name":"a","attributes":{"href":"/apis#tag/Cards/operation/CardsController.updateCard"},"children":["/v1/cards/{id}"]}]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["Update a card"]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["cards:write"]}]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["Spend controls & MCC"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["DELETE"]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Tag","name":"a","attributes":{"href":"/apis#tag/Cards/operation/CardsController.deleteCard"},"children":["/v1/cards/{id}"]}]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["Delete a card"]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["cards:write"]}]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["List & retire cards"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["POST"]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Tag","name":"a","attributes":{"href":"/apis#tag/Cards/operation/CardsController.postCardTransactions"},"children":["/v1/cards/transactions"]}]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["Retrieve card or travel transactions"]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["transactions:read"]}]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["Reconcile card & travel transactions"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["GET"]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Tag","name":"a","attributes":{"href":"/apis#tag/Cards/operation/CardsController.getMccCategories"},"children":["/v1/cards/mcc/categories"]}]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["List all MCC categories"]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["cards:read"]}]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["Spend controls & MCC"]}]}]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"travel"},"children":["Travel"]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"align":"left","data-label":"Method"},"children":["Method"]},{"$$mdtype":"Tag","name":"th","attributes":{"align":"left","data-label":"Endpoint"},"children":["Endpoint"]},{"$$mdtype":"Tag","name":"th","attributes":{"align":"left","data-label":"Summary"},"children":["Summary"]},{"$$mdtype":"Tag","name":"th","attributes":{"align":"left","data-label":"Scope"},"children":["Scope"]},{"$$mdtype":"Tag","name":"th","attributes":{"align":"left","data-label":"Flow-builder block"},"children":["Flow-builder block"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["GET"]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Tag","name":"a","attributes":{"href":"/apis#tag/Travel/operation/TravelController.getTransactions"},"children":["/v1/travel/transactions"]}]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["Get transactions — ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["deprecated"]},", use ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["POST /v1/cards/transactions"]}," with ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["source: travel"]}]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["transactions:read"]}]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["Reconcile card & travel transactions (migration step)"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["PATCH"]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Tag","name":"a","attributes":{"href":"/apis#tag/Travel/operation/TravelController.updateBookingDetails"},"children":["/v1/travel/cards/{id}/booking"]}]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["Update booking details"]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["cards:write"]}]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["Attach booking details"]}]}]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"transactions"},"children":["Transactions"]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"align":"left","data-label":"Method"},"children":["Method"]},{"$$mdtype":"Tag","name":"th","attributes":{"align":"left","data-label":"Endpoint"},"children":["Endpoint"]},{"$$mdtype":"Tag","name":"th","attributes":{"align":"left","data-label":"Summary"},"children":["Summary"]},{"$$mdtype":"Tag","name":"th","attributes":{"align":"left","data-label":"Scope"},"children":["Scope"]},{"$$mdtype":"Tag","name":"th","attributes":{"align":"left","data-label":"Flow-builder block"},"children":["Flow-builder block"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["GET"]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Tag","name":"a","attributes":{"href":"/apis#tag/Transactions/operation/TransactionsController.getTransactions"},"children":["/v1/transactions"]}]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["Get a list of card transactions — ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["deprecated"]},", use ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["POST /v1/cards/transactions"]}," with ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["source: cards"]}]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["transactions:read"]}]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["Reconcile card & travel transactions (migration step)"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["GET"]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Tag","name":"a","attributes":{"href":"/apis#tag/Transactions/operation/PaymentsController.getTransactions"},"children":["/v1/payments/transactions"]}]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["Get a list of payment transactions"]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["transactions:read"]}]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["Export payment transactions"]}]}]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"boletos--receivables-brazil"},"children":["Boletos — receivables (Brazil)"]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"align":"left","data-label":"Method"},"children":["Method"]},{"$$mdtype":"Tag","name":"th","attributes":{"align":"left","data-label":"Endpoint"},"children":["Endpoint"]},{"$$mdtype":"Tag","name":"th","attributes":{"align":"left","data-label":"Summary"},"children":["Summary"]},{"$$mdtype":"Tag","name":"th","attributes":{"align":"left","data-label":"Scope"},"children":["Scope"]},{"$$mdtype":"Tag","name":"th","attributes":{"align":"left","data-label":"Flow-builder block"},"children":["Flow-builder block"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["GET"]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Tag","name":"a","attributes":{"href":"/apis#tag/Boletos/operation/BoletosController.getBoletos"},"children":["/v1/boletos"]}]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["List Boletos"]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["boletos:read"]}]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["Collect via boleto (Brazil)"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["POST"]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Tag","name":"a","attributes":{"href":"/apis#tag/Boletos/operation/BoletosController.createBoleto"},"children":["/v1/boletos"]}]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["Create Boleto"]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["boletos:write"]}]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["Collect via boleto (Brazil)"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["GET"]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Tag","name":"a","attributes":{"href":"/apis#tag/Boletos/operation/BoletosController.getBoleto"},"children":["/v1/boletos/{id}"]}]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["Get Boleto by ID"]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["boletos:read"]}]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["Collect via boleto (Brazil)"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["POST"]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Tag","name":"a","attributes":{"href":"/apis#tag/Boletos/operation/BoletosController.cancelBoleto"},"children":["/v1/boletos/{id}/cancel"]}]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["Cancel Boleto"]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["boletos:write"]}]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["Collect via boleto (Brazil)"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["POST"]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Tag","name":"a","attributes":{"href":"/apis#tag/Boletos/operation/BoletosController.extendBoleto"},"children":["/v1/boletos/{id}/extend"]}]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["Extend Boleto"]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["boletos:write"]}]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["Collect via boleto (Brazil)"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["POST"]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Tag","name":"a","attributes":{"href":"/apis#tag/Boletos/operation/BoletosController.configureDiscount"},"children":["/v1/boletos/{id}/discount"]}]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["Configure Boleto Discount"]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["boletos:write"]}]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["Collect via boleto (Brazil)"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["POST"]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Tag","name":"a","attributes":{"href":"/apis#tag/Boletos/operation/BoletosController.removeDiscount"},"children":["/v1/boletos/{id}/discount/remove"]}]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["Remove Boleto Discount"]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["boletos:write"]}]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["Collect via boleto (Brazil)"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["POST"]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Tag","name":"a","attributes":{"href":"/apis#tag/Boletos/operation/BoletosController.createRebate"},"children":["/v1/boletos/{id}/rebate"]}]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["Reduce Boleto Amount"]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["boletos:write"]}]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["Collect via boleto (Brazil)"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["POST"]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Tag","name":"a","attributes":{"href":"/apis#tag/Boletos/operation/BoletosController.cancelRebate"},"children":["/v1/boletos/{id}/rebate/cancel"]}]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["Restore Boleto Original Amount"]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["boletos:write"]}]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["Collect via boleto (Brazil)"]}]}]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"pix-charges--receivables-brazil"},"children":["Pix Charges — receivables (Brazil)"]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"align":"left","data-label":"Method"},"children":["Method"]},{"$$mdtype":"Tag","name":"th","attributes":{"align":"left","data-label":"Endpoint"},"children":["Endpoint"]},{"$$mdtype":"Tag","name":"th","attributes":{"align":"left","data-label":"Summary"},"children":["Summary"]},{"$$mdtype":"Tag","name":"th","attributes":{"align":"left","data-label":"Scope"},"children":["Scope"]},{"$$mdtype":"Tag","name":"th","attributes":{"align":"left","data-label":"Flow-builder block"},"children":["Flow-builder block"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["GET"]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Tag","name":"a","attributes":{"href":"/apis#tag/Pix-Charges/operation/PixChargesController.getPixCharges"},"children":["/v1/pix-charges"]}]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["List Pix Charges"]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["pix_charges:read"]}]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["Collect via Pix (Brazil)"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["POST"]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Tag","name":"a","attributes":{"href":"/apis#tag/Pix-Charges/operation/PixChargesController.createPixCharge"},"children":["/v1/pix-charges"]}]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["Create Pix Charge"]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["pix_charges:write"]}]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["Collect via Pix (Brazil)"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["GET"]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Tag","name":"a","attributes":{"href":"/apis#tag/Pix-Charges/operation/PixChargesController.getPixCharge"},"children":["/v1/pix-charges/{id}"]}]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["Get Pix Charge by ID"]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["pix_charges:read"]}]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["Collect via Pix (Brazil)"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["POST"]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Tag","name":"a","attributes":{"href":"/apis#tag/Pix-Charges/operation/PixChargesController.cancelPixCharge"},"children":["/v1/pix-charges/{id}/cancel"]}]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["Cancel Pix Charge"]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["pix_charges:write"]}]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["Collect via Pix (Brazil)"]}]}]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"webhooks"},"children":["Webhooks"]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"align":"left","data-label":"Method"},"children":["Method"]},{"$$mdtype":"Tag","name":"th","attributes":{"align":"left","data-label":"Endpoint"},"children":["Endpoint"]},{"$$mdtype":"Tag","name":"th","attributes":{"align":"left","data-label":"Summary"},"children":["Summary"]},{"$$mdtype":"Tag","name":"th","attributes":{"align":"left","data-label":"Scope"},"children":["Scope"]},{"$$mdtype":"Tag","name":"th","attributes":{"align":"left","data-label":"Flow-builder block"},"children":["Flow-builder block"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["POST"]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Tag","name":"a","attributes":{"href":"/apis#tag/Webhooks/operation/WebhooksController.createSubscription"},"children":["/v1/webhooks/subscriptions"]}]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["Create subscription"]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["webhooks:write"]}]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["Receive real-time card events"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["GET"]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Tag","name":"a","attributes":{"href":"/apis#tag/Webhooks/operation/WebhooksController.listSubscriptions"},"children":["/v1/webhooks/subscriptions"]}]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["List subscriptions"]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["webhooks:read"]}]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["Operate & monitor webhooks"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["GET"]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Tag","name":"a","attributes":{"href":"/apis#tag/Webhooks/operation/WebhooksController.getSubscription"},"children":["/v1/webhooks/subscriptions/{id}"]}]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["Get subscription"]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["webhooks:read"]}]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["Operate & monitor webhooks"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["PATCH"]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Tag","name":"a","attributes":{"href":"/apis#tag/Webhooks/operation/WebhooksController.updateSubscription"},"children":["/v1/webhooks/subscriptions/{id}"]}]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["Update subscription"]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["webhooks:write"]}]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["Operate & monitor webhooks"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["DELETE"]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Tag","name":"a","attributes":{"href":"/apis#tag/Webhooks/operation/WebhooksController.deleteSubscription"},"children":["/v1/webhooks/subscriptions/{id}"]}]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["Delete subscription"]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["webhooks:write"]}]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["Operate & monitor webhooks"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["POST"]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Tag","name":"a","attributes":{"href":"/apis#tag/Webhooks/operation/WebhooksController.rotateSecret"},"children":["/v1/webhooks/subscriptions/{id}/rotate-secret"]}]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["Rotate secret"]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["webhooks:write"]}]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["Operate & monitor webhooks"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["POST"]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Tag","name":"a","attributes":{"href":"/apis#tag/Webhooks/operation/WebhooksController.testSubscription"},"children":["/v1/webhooks/subscriptions/{id}/test"]}]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["Send test delivery"]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["webhooks:write"]}]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["Receive real-time card events"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["GET"]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Tag","name":"a","attributes":{"href":"/apis#tag/Webhooks/operation/WebhooksController.listEvents"},"children":["/v1/webhooks/events"]}]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["List events"]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["webhooks:read"]}]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["Operate & monitor webhooks"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["GET"]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Tag","name":"a","attributes":{"href":"/apis#tag/Webhooks/operation/WebhooksController.getEvent"},"children":["/v1/webhooks/events/{id}"]}]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["Get event"]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["webhooks:read"]}]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["Operate & monitor webhooks"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["GET"]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Tag","name":"a","attributes":{"href":"/apis#tag/Webhooks/operation/WebhooksController.listDeliveries"},"children":["/v1/webhooks/events/{id}/deliveries"]}]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["List deliveries"]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["webhooks:read"]}]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["Operate & monitor webhooks"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["POST"]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Tag","name":"a","attributes":{"href":"/apis#tag/Webhooks/operation/WebhooksController.retryEvent"},"children":["/v1/webhooks/events/{id}/retry"]}]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["Retry event"]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["webhooks:write"]}]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["Operate & monitor webhooks"]}]}]}]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Total: 35 operations"]}," — 7 Cards, 2 Travel, 2 Transactions, 9 Boletos, 4 Pix Charges, 11 Webhooks. Deep-dive material for webhooks lives in the ",{"$$mdtype":"Tag","name":"a","attributes":{"href":"/guides/integration-guides/webhooks/"},"children":["Webhooks integration guide"]},"."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"payment-api"},"children":["Payment API"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["A separate spec (",{"$$mdtype":"Tag","name":"a","attributes":{"href":"/apis/payments"},"children":["reference"]},") covering money movement: quotes, idempotent payments, and signed status webhooks. Interactive version: ",{"$$mdtype":"Tag","name":"a","attributes":{"href":"/payments/demo"},"children":["Build your payment flow"]},"."]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"align":"left","data-label":"Method"},"children":["Method"]},{"$$mdtype":"Tag","name":"th","attributes":{"align":"left","data-label":"Endpoint"},"children":["Endpoint"]},{"$$mdtype":"Tag","name":"th","attributes":{"align":"left","data-label":"Summary"},"children":["Summary"]},{"$$mdtype":"Tag","name":"th","attributes":{"align":"left","data-label":"Scope"},"children":["Scope"]},{"$$mdtype":"Tag","name":"th","attributes":{"align":"left","data-label":"Where documented"},"children":["Where documented"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["POST"]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["/oauth/token"]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["Get an access token"]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["— (Basic auth)"]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Tag","name":"a","attributes":{"href":"/payments/payment-flow/send-payment"},"children":["Send a payment"]}]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["GET"]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["/v1/product-accounts"]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["List funding (product) accounts"]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["accounts:read"]}]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Tag","name":"a","attributes":{"href":"/payments/funding/product-accounts"},"children":["Funding accounts"]}]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["GET"]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["/v1/beneficiaries"]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["List beneficiaries"]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["beneficiaries:read"]}]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Tag","name":"a","attributes":{"href":"/payments/funding/beneficiaries"},"children":["Beneficiaries"]}]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["POST"]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["/v1/quotes"]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["Create a quote"]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["quotes:write"]}]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Tag","name":"a","attributes":{"href":"/payments/payment-flow/quotes-and-fx"},"children":["Quotes & FX"]}]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["POST"]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["/v1/payments"]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["Create a payment"]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["payments:write"]}]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Tag","name":"a","attributes":{"href":"/payments/payment-flow/send-payment"},"children":["Send a payment"]}," · ",{"$$mdtype":"Tag","name":"a","attributes":{"href":"/payments/payment-flow/scheduled-payments"},"children":["Scheduled payments"]}]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["GET"]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["/v1/payments/{paymentId}"]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["Get a payment"]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["payments:read"]}]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Tag","name":"a","attributes":{"href":"/payments/payment-flow/tracking-payments"},"children":["Tracking & webhooks"]}]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["WEBHOOK"]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["payment.status.updated"]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["Payment status updated"]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["—"]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Tag","name":"a","attributes":{"href":"/payments/payment-flow/tracking-payments"},"children":["Tracking & webhooks"]}]}]}]}]}]}]},"headings":[{"value":"API coverage map","id":"api-coverage-map","depth":1},{"value":"Cards","id":"cards","depth":2},{"value":"Travel","id":"travel","depth":2},{"value":"Transactions","id":"transactions","depth":2},{"value":"Boletos — receivables (Brazil)","id":"boletos--receivables-brazil","depth":2},{"value":"Pix Charges — receivables (Brazil)","id":"pix-charges--receivables-brazil","depth":2},{"value":"Webhooks","id":"webhooks","depth":2},{"value":"Payment API","id":"payment-api","depth":2}],"frontmatter":{"seo":{"title":"API coverage map"}},"lastModified":"2026-11-02T14:48:40.000Z","pagePropGetterError":{"message":"","name":""}},"slug":"/guides/api-coverage","userData":{"isAuthenticated":false,"teams":["anonymous"]}}