PagSeguro / PagBank Charges API

The Charges API from PagSeguro / PagBank — 4 operation(s) for charges.

OpenAPI Specification

pagseguro-charges-api-openapi.yml Raw ↑
openapi: 3.1.0
info:
  title: PagBank / PagSeguro REST Accounts Charges API
  description: "PagBank (PagSeguro) REST API surface covering Orders, Charges, Public\nKeys, Checkout, Recurring (plans / subscribers / subscriptions / coupons\n/ invoices), and Connect / OAuth. All requests authenticate with a Bearer\naccess token over HTTPS; responses are JSON.\n\nBase URLs:\n  - Production: https://api.pagseguro.com\n  - Sandbox:    https://sandbox.api.pagseguro.com\n"
  version: v1
  contact:
    name: PagBank Developers
    url: https://developer.pagbank.com.br/
servers:
- url: https://api.pagseguro.com
  description: PagBank production API
- url: https://sandbox.api.pagseguro.com
  description: PagBank sandbox API
security:
- bearerAuth: []
tags:
- name: Charges
paths:
  /orders/{order_id}/charges:
    parameters:
    - name: order_id
      in: path
      required: true
      schema:
        type: string
    post:
      tags:
      - Charges
      summary: Charge an Order
      responses:
        '201':
          description: Charge created
  /orders/{order_id}/charges/{charge_id}/capture:
    parameters:
    - name: order_id
      in: path
      required: true
      schema:
        type: string
    - name: charge_id
      in: path
      required: true
      schema:
        type: string
    post:
      tags:
      - Charges
      summary: Capture a Charge
      responses:
        '200':
          description: Charge captured
  /orders/{order_id}/charges/{charge_id}/cancel:
    parameters:
    - name: order_id
      in: path
      required: true
      schema:
        type: string
    - name: charge_id
      in: path
      required: true
      schema:
        type: string
    post:
      tags:
      - Charges
      summary: Cancel a Charge
      responses:
        '200':
          description: Charge cancelled
  /charges/{charge_id}/fees:
    parameters:
    - name: charge_id
      in: path
      required: true
      schema:
        type: string
    get:
      tags:
      - Charges
      summary: Get Charge Fees
      responses:
        '200':
          description: Fees
components:
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: access_token
      description: 'PagBank access token issued via the developer portal (or via the

        Connect flow). Send as "Authorization: Bearer {ACCESS_TOKEN}". All

        requests must be HTTPS.

        '