1. Brazil
PayPaga V2 API
  • API Overview
    • Introduction
    • API Reference
    • Environments
    • Payment methods
    • Errors
    • Standard Codes and Values
    • Transaction Status Definitions and Lifecycle
    • Changelog
      • Format
  • OAuth2 Service
    • authenticate
      POST
    • 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 options
      • Retrieve settlement transactions
    • Reference Data
      • Retrieve exchange rates
      • Retrieve tax rates
    • Notifications
      • Create a notification subscription
      • List notification subscriptions
      • Retrieve a notification subscription
      • Delete a notification subscription
    • Schemas
      • MoneyAmount
      • Currency
      • Country
      • PaymentMethod
      • Product
      • OptionField
      • PayInTransactionStatus
      • PayOutTransactionStatus
      • NotificationType
      • PaginationMeta
      • MerchantOrderReference
      • MerchantTransactionReference
      • FeeMode
      • PaymentOption
      • Code
      • Message
      • ValidationErrorItem
      • ValidationErrorDetail
      • ErrorDetail
      • PayInTransaction
      • PayInTransactionListResponse
      • ReturnUrls
      • CreatePayInRequest
      • PaymentInstructions
      • CreatePayInResponse
      • PayInTransactionStatusOverrideRequest
      • PayOutTransaction
      • PayOutTransactionListResponse
      • CreatePayOutRequest
      • CreatePayOutResponse
      • PayOutTransactionStatusOverrideRequest
      • PredefinedFields
      • CreatePayURLRequest
      • CreatePayURLResponse
      • BalanceTotal
      • BalanceCountry
      • BalanceSummaryResponse
      • CountryCatalogEntry
      • PaymentMethodCatalogEntry
      • Settlement
      • SettlementsResponse
      • SettlementWindow
      • SettlementOptionsResponse
      • SettlementTransaction
      • SettlementTransactionsResponse
      • ExchangeRateQuote
      • ExchangeRatesResponse
      • TaxRate
      • ChannelType
      • NotificationSubscriptionResponse
      • ListNotificationSubscriptionsResponse
      • NotificationSubscriptionRequest
      • TransactionCallbackPayload
  • Examples
    • Pay In Examples
      • Argentina
        • Argentina CVU
      • Brazil
        • Brazil PIX
      • 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 Bank Transfer
        • Ecuador Banco Guayaquil
        • Ecuador Bemovil
        • Ecuador Deuna
        • Ecuador Mi Negocio Efectivo
        • Ecuador Omniswitch
        • Ecuador RapiActivo
        • Ecuador Western Union
      • Guatemala
        • Guatemala BAM Efectivo
        • Guatemala BAM Transferencia
        • Guatemala Banco Industrial
        • Guatemala Akisi Pronet
      • Mexico
        • Mexico Pay With Cash
        • Mexico SPEI
      • Peru
        • Peru BBVA
        • Peru BCP
        • Peru BCP Efectivo
        • Peru Cell Power
        • Peru KasNet
        • Peru QR Interoperable
        • Peru Plin
        • Peru Yape
    • Pay Out Examples
      • Argentina
        • Argentina CVU
      • Brazil
        • Brazil PIX
          POST
      • 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
      • CreatePayOutRequest
      • ReturnUrls
      • CreatePayInRequest
      • CreatePayOutResponse
      • PaymentInstructions
      • CreatePayInResponse
  1. Brazil

Brazil PIX

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

Required Fields

FieldDescriptionValidation
nameFull name
person_typePerson typeFrom options: individual or company
document_numberCPF numberRegEx ^(\d{3}\.?\d{3}\.?\d{3}-?\d{2}
document_typeIdentification typeFrom options: CPF
account_numberPIX keyMust be valid PIX key

Request

Authorization
OAuth 2.0
Client Credentials
Add the parameter
Authorization
to Headers
,whose value is to concatenate the Token after the Bearer.
Example:
Authorization: Bearer ********************
Token URL: https://api.paypaga.com/oauth2/token
or
Body Params application/jsonRequired

Examples

Responses

🟢202
application/json
Pay-out accepted for processing.
Headers

Bodyapplication/json

Request Request Example
Shell
JavaScript
Java
Swift
curl --location 'https://api.paypaga.com/v2/transactions/pay-out' \
--header 'Content-Type: application/json' \
--data-raw '{
    "country": "BR",
    "currency": "BRL",
    "payment_method": "pix",
    "merchant_transaction_reference": "TRX-2026-0026",
    "merchant_order_reference": "ORDER-2026-0001",
    "merchant_customer_id": "customer@mail.com",
    "customer_ip": "120.29.48.92",
    "amount": 125.5,
    "fields": {
        "name": "Rafael Beaty",
        "person_type": "individual",
        "document_number": "123.456.789-09",
        "document_type": "CPF",
        "account_number": "43000000000"
    }
}'
Response Response Example
{
    "transaction_id": "20240806-2010-4086-8342-c28f4979f834",
    "merchant_transaction_reference": "TRX-2026-0026",
    "merchant_order_reference": "ORDER-2026-0001"
}
Modified at 2026-06-09 14:05:00
Previous
Argentina CVU
Next
Chile Bank Transfer
Built with