How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Pagar.me Orders API

Top-level checkout objects bundling customer, items, and payments.

Pagar.me Orders API is one of 10 APIs that Pagar.me publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Order. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and an API reference.

This API exposes 4 operations across 3 paths, and defines 17 schemas. It is described by OpenAPI 3.0.1, at version 5.

Requests are made against a single base URL, https://api.pagar.me/core/v5.

4 operations 3 paths 17 schemas 2 GET1 PATCH1 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.1
API Version
5
Base URL
https://api.pagar.me/core/v5
Authentication
HTTP Basic
Terms of Service
Resource Areas
1

Authentication & Security 1

Pagar.me Orders API declares 1 security scheme for authenticating requests. It accepts HTTP basic authentication (basicAuth). By default, every request must be authenticated.

  • basicAuth — HTTP Basic auth with the account secret key as the username and an empty password.

Paths & Operations 4

Across 3 paths, the API surfaces 4 operations — 2 GET, 1 PATCH, 1 POST. Each is listed below with its method, path, parameters, and response codes.

Orders 4

Top-level checkout objects bundling customer, items, and payments.

POST
/orders
Create order
createOrder body → 200
GET
/orders
List orders
listOrders 2 params → 200
GET
/orders/{order_id}
Get order
getOrder 1 param → 200
PATCH
/orders/{order_id}/closed
Close or reopen an order
closeOrder 1 param body → 200

Schemas 17

The contract defines 17 schemas that model the data the API accepts and returns. The most detailed are Charge (11 properties), Order (9 properties), CreateOrderRequest (8 properties), CreateCustomerRequest (7 properties). Each schema is shown below with its type and property counts.

Address
object
6 properties
OrderItem
object
4 properties
Customer
BoletoPayment
object
2 properties
Payment
object
6 properties
Split
object
4 properties
CardInput
object
6 properties
CreateOrderRequest
object
8 properties 2 required
Shipping
object
4 properties
CreditCardPayment
object
5 properties
PixPayment
object
2 properties
OrderList
object
2 properties
Charge
object
11 properties
CreateCustomerRequest
object
7 properties
Order
object
9 properties
Phone
object
3 properties
Paging
object
3 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

pagarme-orders-api-openapi.yml Raw ↑

Other APIs Pagar.me publishes across the network.

Pagar.me Anticipations API
Pagar.me Cards API
Pagar.me Charges API
Pagar.me Customers API
Pagar.me Invoices API
Pagar.me Plans API
Pagar.me Recipients API
Pagar.me Subscriptions API
Pagar.me Transfers API
Where this information came from

This is an independent, third-party profile of Pagar.me Orders API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.