Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

AbacatePay Pix QR Code API

Create, check, and simulate dynamic Pix QR Code payments.

AbacatePay Pix QR Code API is one of 6 APIs that AbacatePay publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

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

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

Requests are made against a single base URL, https://api.abacatepay.com/v1.

3 operations 3 paths 7 schemas 1 GET2 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.1
API Version
v1
Base URL
https://api.abacatepay.com/v1
Authentication
HTTP Bearer
Terms of Service
Resource Areas
1

Authentication & Security 1

AbacatePay Pix QR Code API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (API Key) (bearerAuth). By default, every request must be authenticated.

  • bearerAuth — Authenticate with your AbacatePay API key as a Bearer token: Authorization: Bearer .

Paths & Operations 3

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

Pix QR Code 3

Create, check, and simulate dynamic Pix QR Code payments.

POST
/pixQrCode/create
Create a Pix QR Code
createPixQrCode body → 200401
GET
/pixQrCode/check
Check Pix QR Code status
checkPixQrCode 1 param → 200401
POST
/pixQrCode/simulate-payment
Simulate a Pix payment
simulatePixPayment 1 param body → 200401

Schemas 7

The contract defines 7 schemas that model the data the API accepts and returns. The most detailed are PixQrCode (7 properties), CreatePixQrCodeRequest (5 properties), CustomerData (4 properties), Error (2 properties). Each schema is shown below with its type and property counts.

PixQrCodeResponse
object
2 properties
PixQrCode
object
7 properties
Error
object
2 properties
CustomerData
object
4 properties
PixStatus
string
Metadata
object
Arbitrary key/value metadata attached to a resource.
CreatePixQrCodeRequest
object
5 properties 1 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

abacatepay-pix-qr-code-api-openapi.yml Raw ↑

Other APIs AbacatePay publishes across the network.

AbacatePay Webhooks
AbacatePay Billing API
AbacatePay Coupon API
AbacatePay Customer API
AbacatePay Withdraw API