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

Errors

Errors Handling#

The PayPaga API uses conventional HTTP response codes to indicate the success or failure of an API request.
Some 4xx errors that could be handled programmatically (e.g., Request validation failed) include additional information such as an error code to enable more nuanced error handling..
HTTP StatusDescription
200Request processed normally.
400Problem consuming the request due to not adhering to the API specification.
401Authorization required due to invalid, expired or missing authorization token.
402Request processing failure.
403The authorization token does not have permissions to perform the request.
404The requested resource does not exist.
500 502 503 504Server could not process the request due to an unexpected condition. We work hard to make them as rare as possible.

Error Response Format#

All error responses follow this structure:
"error": {
  {
    "code": "ERROR_CODE",
    "message": "Human-readable error description",
    "details": {} // Optional additional context
  }
}
Error codes are uppercase strings with underscores, designed to be machine-readable for programmatic error handling, for example: VALIDATION_ERROR, UNAUTHORIZED, INTERNAL_ERROR.

Common Error Codes#

HTTP statusError codeDescriptionAdditional details
400BAD_REQUESTFailed to parse the request bodyReturned when the request body is malformed or cannot be parsed as valid JSON. Applicable to POST and PUT endpoints.
400VALIDATION_ERRORRequest validation failedReturned when validation of the request body or query parameters fails. The response may include details about which fields failed validation and why.
401UNAUTHORIZEDMissing or invalid authorization tokenReturned when the authorization token is missing, invalid, or expired.
403FORBIDDENYou do not have permission to access this resourceReturned when the authorization token does not have the necessary permissions to perform the requested operation.
404NOT_FOUNDRequested resource not foundReturned when the requested resource does not exist.
409MERCHANT_REFERENCE_ALREADY_EXISTSMerchant transaction reference already existsReturned when a transaction with the same merchant reference already exists.
500INTERNAL_ERRORUnexpected server errorReturned when an unexpected error occurs on the server.
Particular list of possible errors can be found in the documentation of each endpoint.
Modified at 2026-04-28 08:43:36
Previous
Payment methods
Next
Standard Codes and Values
Built with