1. API Overview
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
      • 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. API Overview

API Reference

The PayPaga API is organized around REST. The API has predictable resource-oriented URLs, accepts JSON-encoded request bodies, returns JSON-encoded responses and uses standard HTTP response codes, authentication, and verbs.
PayPaga considers the following changes to be backwards-compatible:
Adding new API resources
Adding new optional request parameters to existing API methods
Adding new properties to existing API responses
Changing the order of properties in existing API responses
When making requests to the PayPaga API we recommend using a timeout of 30 seconds as some requests can take longer than expected since they rely on communicating with a payment processor.
Modified at 2026-04-28 07:55:31
Previous
Introduction
Next
Environments
Built with