PagSeguro / PagBank website screenshot

PagSeguro / PagBank

PagSeguro (operating consumer-facing under the PagBank brand) is one of Brazil's largest payment processors and digital-banking platforms. Originally spun out of UOL (Universo Online) and listed on the NYSE under PAGS, the company offers an end-to-end financial stack covering online payments, in-person card acceptance via the Moderninha and Minizinha terminal families, Pix instant payments, boleto, credit and debit cards, recurring subscriptions, marketplace split, payouts, account-as-a-service, and a digital bank with cards, credit, and investments. Its developer portal at developer.pagbank.com.br exposes a REST API surface (Orders, Charges, Public Keys, Checkout, Recurring, Connect/OAuth, Account Registration, EDI, Webhooks) backed by official SDKs in PHP, Java, Ruby, and .NET, plus WooCommerce, Magento/Adobe Commerce, and PrestaShop plugins.

21 APIs 0 Features
PaymentsCheckoutPixBoletoCardsSubscriptionsRecurringPOSCard ReaderMarketplaceSplitPayoutsDigital BankBrazilLatin AmericaFintech

APIs

PagBank Orders API

Core REST surface for creating and managing orders and their associated charges across credit card, debit card with 3DS, boleto, and Pix. Covers capture, cancel, refund, fees re...

PagBank Checkout & Payment Link API

Hosted checkout and shareable payment-link generation. Merchants create, activate, deactivate, and retrieve checkouts; PagBank renders the UI, handles payment-method selection a...

PagBank Public Keys API

Issues the public keys used for client-side card encryption in PagBank's transparent checkout. Lets merchants tokenise card data in the browser so raw PAN never reaches their se...

PagBank Recurring / Subscriptions API

Recurring-billing surface with plans, subscribers, subscriptions, invoices, coupons, refunds, and retry management. Supports activate, suspend, cancel, and per-subscriber paymen...

PagBank Pix API

Pix (Brazilian Central Bank instant-payment rail) charge creation and collection. Supports QR-code generation, due-date Pix (Pix Cobrança), and payment status retrieval, integra...

PagBank Boleto API

Boleto Bancário issuance and collection. Generates a printable / scannable boleto tied to an Order, with status callbacks once the buyer pays at a bank, lottery house, or via in...

PagBank Marketplace / Split API

Payment-division (split) settlement for marketplaces and platforms. Splits a single charge across multiple receivers (with optional custody / release control) so each seller is ...

PagBank Connect / OAuth API

OAuth-style authorisation surface that lets a third-party application act on behalf of a PagBank account holder. Includes SMS and challenge verification, access-token issuance, ...

PagBank Account Registration API

Lets PagBank partners create and query merchant accounts on behalf of third parties — the on-ramp for platforms that want to onboard sub-merchants into the PagBank ecosystem.

PagBank EDI API

Electronic Data Interchange surface for downloading transaction and settlement statements for reconciliation — a structured replacement for manual CSV/PDF statement processing.

PagBank Digital Certificate (mTLS) API

Issues digital certificates for mTLS authentication, layered on top of bearer-token auth for higher-trust integrations and sensitive payouts / Pix Bacen flows.

PagBank Webhooks / Notifications

Event-driven notifications for order, charge, subscription, refund, and checkout state changes. Webhooks are signed so receivers can verify authenticity end-to-end.

PagSeguro PHP SDK

Official PHP integration library for PagSeguro / PagBank.

PagSeguro Java SDK

Official Java integration library for PagSeguro / PagBank.

PagSeguro Ruby SDK

Official Ruby integration library for PagSeguro / PagBank.

PagSeguro .NET SDK

Official .NET / C# integration library for PagSeguro / PagBank.

PagBank PlugPag (Terminal Integration)

Bluetooth / Android terminal integration for PagBank's Moderninha and Minizinha card readers, enabling third-party apps to drive in-person card and Pix payments on PagBank hardw...

PagBank PlugPagServiceWrapper

Android service wrapper for integrating with the Moderninha / Minizinha terminal family — the official higher-level SDK on top of PlugPag.

PagBank for WooCommerce

Official WooCommerce plugin embedding PagBank checkout, Pix, boleto, and card payments in WordPress storefronts.

PagBank Payment for Magento / Adobe Commerce

Official Magento 2 / Adobe Commerce payment module for PagBank.

PagSeguro PrestaShop Module

Official PrestaShop transparent-checkout integration module for PagSeguro / PagBank.

Collections

PagBank / PagSeguro REST API

OPEN

Pricing Plans

Pagseguro Plans Pricing

2 plans

PLANS

Rate Limits

Pagseguro Rate Limits

3 limits

RATE LIMITS

FinOps

Pagseguro Finops

FINOPS

Resources

🔗
Website
Website
🔗
ConsumerWebsite
ConsumerWebsite
🔗
Developers
Developers
🔗
Documentation
Documentation
🔗
APIReference
APIReference
🚀
GettingStarted
GettingStarted
🔑
Authentication
Authentication
🔗
Environments
Environments
🔗
Webhooks
Webhooks
📄
ChangeLog
ChangeLog
👥
GitHub
GitHub
🔗
Postman
Postman
🔗
InvestorRelations
InvestorRelations

Sources

apis.yml Raw ↑ 
opencollection: 1.0.0
info:
  name: PagBank / PagSeguro REST API
  version: v1
request:
  auth:
    type: bearer
    token: '{{bearerToken}}'
items:
- info:
    name: Orders
    type: folder
  items:
  - info:
      name: List Orders
      type: http
    http:
      method: GET
      url: https://api.pagseguro.com/orders
    docs: List Orders
  - info:
      name: Create an Order
      type: http
    http:
      method: POST
      url: https://api.pagseguro.com/orders
    docs: Create an Order
  - info:
      name: Get an Order
      type: http
    http:
      method: GET
      url: https://api.pagseguro.com/orders/:order_id
      params:
      - name: order_id
        value: ''
        type: path
    docs: Get an Order
- info:
    name: Charges
    type: folder
  items:
  - info:
      name: Charge an Order
      type: http
    http:
      method: POST
      url: https://api.pagseguro.com/orders/:order_id/charges
      params:
      - name: order_id
        value: ''
        type: path
    docs: Charge an Order
  - info:
      name: Capture a Charge
      type: http
    http:
      method: POST
      url: https://api.pagseguro.com/orders/:order_id/charges/:charge_id/capture
      params:
      - name: order_id
        value: ''
        type: path
      - name: charge_id
        value: ''
        type: path
    docs: Capture a Charge
  - info:
      name: Cancel a Charge
      type: http
    http:
      method: POST
      url: https://api.pagseguro.com/orders/:order_id/charges/:charge_id/cancel
      params:
      - name: order_id
        value: ''
        type: path
      - name: charge_id
        value: ''
        type: path
    docs: Cancel a Charge
  - info:
      name: Get Charge Fees
      type: http
    http:
      method: GET
      url: https://api.pagseguro.com/charges/:charge_id/fees
      params:
      - name: charge_id
        value: ''
        type: path
    docs: Get Charge Fees
- info:
    name: PublicKeys
    type: folder
  items:
  - info:
      name: Create a Public Key
      type: http
    http:
      method: POST
      url: https://api.pagseguro.com/public-keys
    docs: Create a Public Key
  - info:
      name: Get a Public Key
      type: http
    http:
      method: GET
      url: https://api.pagseguro.com/public-keys/:id
      params:
      - name: id
        value: ''
        type: path
    docs: Get a Public Key
- info:
    name: Checkout
    type: folder
  items:
  - info:
      name: Create a Checkout
      type: http
    http:
      method: POST
      url: https://api.pagseguro.com/checkouts
    docs: Create a Checkout
  - info:
      name: Get a Checkout
      type: http
    http:
      method: GET
      url: https://api.pagseguro.com/checkouts/:id
      params:
      - name: id
        value: ''
        type: path
    docs: Get a Checkout
  - info:
      name: Activate a Checkout
      type: http
    http:
      method: POST
      url: https://api.pagseguro.com/checkouts/:id/activate
      params:
      - name: id
        value: ''
        type: path
    docs: Activate a Checkout
  - info:
      name: Deactivate a Checkout
      type: http
    http:
      method: POST
      url: https://api.pagseguro.com/checkouts/:id/deactivate
      params:
      - name: id
        value: ''
        type: path
    docs: Deactivate a Checkout
- info:
    name: Plans
    type: folder
  items:
  - info:
      name: List Plans
      type: http
    http:
      method: GET
      url: https://api.pagseguro.com/plans
    docs: List Plans
  - info:
      name: Create a Recurring Plan
      type: http
    http:
      method: POST
      url: https://api.pagseguro.com/plans
    docs: Create a Recurring Plan
  - info:
      name: Get a Plan
      type: http
    http:
      method: GET
      url: https://api.pagseguro.com/plans/:id
      params:
      - name: id
        value: ''
        type: path
    docs: Get a Plan
  - info:
      name: Update a Plan
      type: http
    http:
      method: PUT
      url: https://api.pagseguro.com/plans/:id
      params:
      - name: id
        value: ''
        type: path
    docs: Update a Plan
  - info:
      name: Activate a Plan
      type: http
    http:
      method: PUT
      url: https://api.pagseguro.com/plans/:id/activate
      params:
      - name: id
        value: ''
        type: path
    docs: Activate a Plan
  - info:
      name: Deactivate a Plan
      type: http
    http:
      method: PUT
      url: https://api.pagseguro.com/plans/:id/deactivate
      params:
      - name: id
        value: ''
        type: path
    docs: Deactivate a Plan
- info:
    name: Subscribers
    type: folder
  items:
  - info:
      name: List Subscribers
      type: http
    http:
      method: GET
      url: https://api.pagseguro.com/subscribers
    docs: List Subscribers
  - info:
      name: Create a Subscriber
      type: http
    http:
      method: POST
      url: https://api.pagseguro.com/subscribers
    docs: Create a Subscriber
  - info:
      name: Get a Subscriber
      type: http
    http:
      method: GET
      url: https://api.pagseguro.com/subscribers/:id
      params:
      - name: id
        value: ''
        type: path
    docs: Get a Subscriber
  - info:
      name: Update a Subscriber
      type: http
    http:
      method: PUT
      url: https://api.pagseguro.com/subscribers/:id
      params:
      - name: id
        value: ''
        type: path
    docs: Update a Subscriber
  - info:
      name: Update Subscriber Payment Method
      type: http
    http:
      method: PUT
      url: https://api.pagseguro.com/subscribers/:id/payment-method
      params:
      - name: id
        value: ''
        type: path
    docs: Update Subscriber Payment Method
- info:
    name: Subscriptions
    type: folder
  items:
  - info:
      name: List Subscriptions
      type: http
    http:
      method: GET
      url: https://api.pagseguro.com/subscriptions
    docs: List Subscriptions
  - info:
      name: Create a Subscription
      type: http
    http:
      method: POST
      url: https://api.pagseguro.com/subscriptions
    docs: Create a Subscription
  - info:
      name: Get a Subscription
      type: http
    http:
      method: GET
      url: https://api.pagseguro.com/subscriptions/:id
      params:
      - name: id
        value: ''
        type: path
    docs: Get a Subscription
  - info:
      name: Update a Subscription
      type: http
    http:
      method: PUT
      url: https://api.pagseguro.com/subscriptions/:id
      params:
      - name: id
        value: ''
        type: path
    docs: Update a Subscription
  - info:
      name: Cancel a Subscription
      type: http
    http:
      method: PUT
      url: https://api.pagseguro.com/subscriptions/:id/cancel
      params:
      - name: id
        value: ''
        type: path
    docs: Cancel a Subscription
  - info:
      name: Suspend a Subscription
      type: http
    http:
      method: PUT
      url: https://api.pagseguro.com/subscriptions/:id/suspend
      params:
      - name: id
        value: ''
        type: path
    docs: Suspend a Subscription
  - info:
      name: Activate a Subscription
      type: http
    http:
      method: PUT
      url: https://api.pagseguro.com/subscriptions/:id/activate
      params:
      - name: id
        value: ''
        type: path
    docs: Activate a Subscription
- info:
    name: Invoices
    type: folder
  items:
  - info:
      name: List Invoices for a Subscription
      type: http
    http:
      method: GET
      url: https://api.pagseguro.com/subscriptions/:id/invoices
      params:
      - name: id
        value: ''
        type: path
    docs: List Invoices for a Subscription
  - info:
      name: Get an Invoice
      type: http
    http:
      method: GET
      url: https://api.pagseguro.com/invoices/:id
      params:
      - name: id
        value: ''
        type: path
    docs: Get an Invoice
- info:
    name: Coupons
    type: folder
  items:
  - info:
      name: List Coupons
      type: http
    http:
      method: GET
      url: https://api.pagseguro.com/coupons
    docs: List Coupons
  - info:
      name: Create a Coupon
      type: http
    http:
      method: POST
      url: https://api.pagseguro.com/coupons
    docs: Create a Coupon
  - info:
      name: Get a Coupon
      type: http
    http:
      method: GET
      url: https://api.pagseguro.com/coupons/:id
      params:
      - name: id
        value: ''
        type: path
    docs: Get a Coupon
- info:
    name: Refunds
    type: folder
  items:
  - info:
      name: List Refunds
      type: http
    http:
      method: GET
      url: https://api.pagseguro.com/refunds
    docs: List Refunds
  - info:
      name: Create a Refund
      type: http
    http:
      method: POST
      url: https://api.pagseguro.com/refunds
    docs: Create a Refund
  - info:
      name: Get a Refund
      type: http
    http:
      method: GET
      url: https://api.pagseguro.com/refunds/:id
      params:
      - name: id
        value: ''
        type: path
    docs: Get a Refund
- info:
    name: Connect
    type: folder
  items:
  - info:
      name: Create a Connect Application
      type: http
    http:
      method: POST
      url: https://api.pagseguro.com/applications
    docs: Create a Connect Application
  - info:
      name: Get a Connect Application
      type: http
    http:
      method: GET
      url: https://api.pagseguro.com/applications/:id
      params:
      - name: id
        value: ''
        type: path
    docs: Get a Connect Application
  - info:
      name: Request Authorization (Connect)
      type: http
    http:
      method: GET
      url: https://api.pagseguro.com/authorization
    docs: Request Authorization (Connect)
  - info:
      name: Issue an Access Token
      type: http
    http:
      method: POST
      url: https://api.pagseguro.com/tokens
    docs: Issue an Access Token
  - info:
      name: Refresh an Access Token
      type: http
    http:
      method: POST
      url: https://api.pagseguro.com/tokens/refresh
    docs: Refresh an Access Token
  - info:
      name: Revoke an Access Token
      type: http
    http:
      method: POST
      url: https://api.pagseguro.com/tokens/revoke
    docs: Revoke an Access Token
- info:
    name: Accounts
    type: folder
  items:
  - info:
      name: Create a Sub-Merchant Account
      type: http
    http:
      method: POST
      url: https://api.pagseguro.com/accounts
    docs: Create a Sub-Merchant Account
  - info:
      name: Get a Sub-Merchant Account
      type: http
    http:
      method: GET
      url: https://api.pagseguro.com/accounts/:id
      params:
      - name: id
        value: ''
        type: path
    docs: Get a Sub-Merchant Account
bundled: true