1. Brazil
PayPaga V2 API
  • API Overview
    • Introduction
    • API Reference
    • Environments
    • Payment methods
    • Errors
    • Standard Codes and Values
    • Transaction Status Definitions and Lifecycle
    • Assets
    • Authorization
    • Changelog
      • Format
    • Transactions Status Notification
      • Transactions Status Notification
      • How to verify callback signature
      • Signing public keys
  • OAuth2 Service
    • authenticate
    • Schemas
      • AuthRequest
      • AuthResponse
      • AuthFailed
  • PayPaga Integration API
    • Transactions Configuration
      • List available pay-in configurations.
      • List available pay-out configurations.
    • Pay-in Transactions
      • Search pay-in transactions
      • Create a pay-in transaction.
      • Retrieve a pay-in transaction.
    • Development Utilities
      • Override a pay-in transaction status
      • Override a pay-out transaction status
    • Pay-out Transactions
      • Search pay-out transactions
      • Create a pay-out transaction.
      • Retrieve a pay-out transaction.
    • Pay URLs
      • Create a hosted PayURL checkout
    • Balances
      • Retrieve merchant balance summary.
    • Catalog
      • List supported countries
      • List supported payment methods
    • Settlements
      • Search settlements
      • Retrieve settlement transactions
      • Retrieve settlement options
    • Reference Data
      • Retrieve exchange rates
      • Retrieve tax rates
    • Notifications
      • List notification subscriptions
      • Create a notification subscription
      • Retrieve a notification subscription
      • Delete a notification subscription
    • Schemas
      • MoneyAmount
      • Currency
      • Country
      • PayOutTransaction
      • CreatePayURLRequest
      • PredefinedFields
      • PayOutTransactionStatusOverrideRequest
      • CreatePayOutResponse
      • ReturnUrls
      • CreatePayOutRequest
      • TaxRate
      • PaymentInstructions
      • PayInTransactionStatusOverrideRequest
      • CreatePayInRequest
      • CreatePayInResponse
      • CreatePayURLResponse
      • BalanceTotal
      • BalanceCountry
      • BalanceSummaryResponse
      • TransactionCallbackPayload
      • PaymentMethodCatalogEntry
      • Settlement
      • NotificationSubscriptionRequest
      • SettlementWindow
      • SettlementOptionsResponse
      • SettlementTransaction
      • ListNotificationSubscriptionsResponse
      • NotificationSubscriptionResponse
      • ExchangeRatesResponse
      • PayInTransaction
      • ValidationErrorDetail
      • ValidationErrorItem
      • PaymentOption
      • PaymentMethod
      • OptionField
      • Product
      • PayInTransactionStatus
      • PayOutTransactionStatus
      • NotificationType
      • PaginationMeta
      • MerchantOrderReference
      • MerchantTransactionReference
      • FeeMode
      • Code
      • Message
      • ErrorDetail
      • PayInTransactionListResponse
      • Money
      • PayOutTransactionListResponse
      • CountryCatalogEntry
      • SettlementsResponse
      • SettlementTransactionsResponse
      • ExchangeRateQuote
      • ChannelType
  • Examples
    • Pay In Examples
      • Argentina
        • Argentina Instant Transfer
      • Bolivia
        • Bolivia Qr Interoperable
      • Brazil
        • Brazil PIX
          POST
      • Chile
        • Chile Bank Transfer
        • Chile Khipu
      • Colombia
        • Colombia Dale
        • Colombia Daviplata
        • Colombia Efecty
        • Colombia Gana
        • Colombia Movii
        • Colombia Nequi
        • Colombia PSE
        • Colombia RappiPay
        • Colombia ReFacil
        • Colombia Susuerte
        • Colombia Western Union
      • Ecuador
        • Ecuador Banco Guayaquil
        • Ecuador Bank Transfer
        • Ecuador Bemovil
        • Ecuador Deuna
        • Ecuador Mi Negocio Efectivo
        • Ecuador Omniswitch
        • Ecuador RapiActivo
        • Ecuador Western Union
      • Guatemala
        • Guatemala Akisi Pronet
        • Guatemala BAM Efectivo
        • Guatemala BAM Transferencia
        • Guatemala Banco Industrial
      • Honduras
        • Honduras Cash Voucher
        • Honduras Digital Voucher
      • Mexico
        • Mexico Pay With Cash
        • Mexico SPEI
      • Peru
        • Peru BBVA
        • Peru BCP
        • Peru BCP Efectivo
        • Peru Cell Power
        • Peru KasNet
        • Peru Plin
        • Peru QR Interoperable
        • Peru Yape
    • Pay Out Examples
      • Argentina
        • Argentina Instant Transfer
      • Bolivia
        • Bolivia Bank Transfer
      • Brazil
        • Brazil PIX
      • Chile
        • Chile Bank Transfer
      • Colombia
        • Colombia Bank Transfer
      • Ecuador
        • Ecuador Bank Transfer
      • Guatemala
        • Guatemala Bank Transfer
      • Mexico
        • Mexico SPEI
      • Peru
        • Peru Bank Transfer
    • Schemas
      • Pay In
        • Country
        • Currency
        • PaymentMethod
        • MerchantOrderReference
        • MerchantTransactionReference
        • ReturnUrls
        • CreatePayInRequest
        • PaymentInstructions
        • CreatePayInResponse
      • Country
      • Code
      • CreatePayInRequest
      • Currency
      • CreatePayInResponse
      • CreatePayOutRequest
      • CreatePayOutResponse
      • MerchantTransactionReference
      • MerchantOrderReference
      • ErrorDetail
      • PaymentInstructions
      • PaymentMethod
      • ReturnUrls
      • Message
      • ValidationErrorDetail
      • ValidationErrorItem
  1. Brazil

Brazil PIX

Production
https://api.paypaga.com
Production
https://api.paypaga.com
POST
/v2/transactions/pay-in

Required Fields#

FieldDescriptionValidation
first_nameFirst nameLength >= 2 <= 50, RegEx ^\p{L}(?:[ '-]\p{L}+)$
last_nameLast nameLength >= 2 <= 50, RegEx ^\p{L}(?:[ '-]\p{L}+)$
document_numberCPF (Cadastro de Pessoa Física)RegEx ^(\d{3}.?\d{3}.?\d{3}-?\d{2}|\d{11})$ Must be valid CPF

Expiry#

Initiated transactions that are not completed transition to an Expired state after 20 minutes.

Response Fields#

FieldDescription
qr_code_contentBase64-encoded PIX QR code image (BR Code) the customer scans with their banking app to complete the payment.
referenceThe PIX "Copia e Cola" code: the same BR Code payload as plain text, which the customer can paste directly into their bank app's PIX screen instead of scanning the QR code.

QR Code#

The value encoded in the QR Code image (type/key: qr_link/qr_content) (Base64 encoded PNG) is replicated in the value (type/key: copy_link/text_sequence)

Payment Instructions#

Scan the QR code or copy the PIX Copy and Paste code to proceed with the payment. You have 3 days to complete your payment.
Important
Payments must be made exclusively by the account holder or an authorized user.
Third-party payments are not allowed and may result in account cancellation or suspension.
Spanish:
Importante
Los pagos deben ser realizados exclusivamente por el titular de la cuenta o un usuario autorizado.
No se permiten pagos de terceros y pueden resultar en la cancelación o suspensión de la cuenta.

Request

Authorization
or
Body Params application/jsonRequired

Examples

Responses

🟢201
application/json
Pay-in accepted.
Headers

Bodyapplication/json

🟠400ValidationAndBadRequestError
🔴500InternalError
Request Request Example
Shell
JavaScript
Java
Swift
curl --location 'https://api.paypaga.com/v2/transactions/pay-in' \
--header 'Content-Type: application/json' \
--data-raw '{
    "amount": 1000,
    "country": "BR",
    "currency": "BRL",
    "customer_ip": "120.29.48.92",
    "fields": {
        "document_number": "241.390.720-32",
        "first_name": "João",
        "last_name": "Silva"
    },
    "merchant_customer_id": "customer@email.com",
    "merchant_order_reference": "ORDER-2026-0002",
    "merchant_transaction_reference": "TRX-2026-0002",
    "payment_method": "pix",
    "return_urls": {
        "failure_url": "https://merchant.com/payment-failure",
        "success_url": "https://merchant.com/payment-success"
    }
}'
Response Response Example
201 - Brazil PIX
{
    "expires_at": "2026-06-09T14:13:05.143073869Z",
    "instructions": {
        "qr_code_content": "iVBORw0KGgoAAAANSUhE...giuGGL4IYtghu2/gXRjZ6j+5wP3QAAAABJRU5ErkJggg==",
        "reference": "00020101021226880014br.gov.bcb.pix2566qrcode-h.fitbank.com.br/QR/cob/9BA5CDA69AB1CBAA0EE61D1F2910AB030FD5204000053039865802BR5925ORKESTRA TECNOLOGIA EM PA6014Belo Horizonte61083031002062070503***63043A5B"
    },
    "payment_method_reference": "129930",
    "transaction_id": "20260205-1127-4678-8883-5e4868d33e4e"
}
Modified at 2026-09-15 13:41:08
Previous
Bolivia Qr Interoperable
Next
Chile Bank Transfer
Built with