Version: 2.4.0

Instant Payments API (PIX sample)

Sample API for issuing and reconciling instant payments on Brazil's PIX rail. The endpoints, payloads, and error codes mirror the publicly-documented PIX PSP standard published by Banco Central do Brasil. Customer identifiers, ISPBs, and webhook URLs are illustrative.

This API is anonymized and synthetic. It is published as a portfolio sample to demonstrate OpenAPI authoring conventions, Diátaxis-aligned reference structure, and the contract-first workflow used at scale on real PIX integrations.

Authentication

OAuth 2.0: OAuth2

Security Scheme Type:	oauth2
OAuth Flow (clientCredentials):	Token URL: https://sandbox.instant-payments.example/oauth/token Scopes: cob.write: Create and update charges cob.read: Read charges pix.read: Read received payments webhook.write: Register and remove webhooks webhook.read: Read webhook registrations

Contact

Leandro Gabriel:

URL: https://www.linkedin.com/in/leandro-gabriel-8aab31167/

License

MIT