# PayPaga V2 API ## Docs - [Root](https://docsv2.paypaga.com/root-8025801f0.md): - Root [Introduction](https://docsv2.paypaga.com/introduction-2113598m0.md): - Root [API Reference](https://docsv2.paypaga.com/api-reference-2113599m0.md): - Root [Environments](https://docsv2.paypaga.com/environments-2113600m0.md): - Root [Payment methods](https://docsv2.paypaga.com/payment-methods-2113601m0.md): - Root [Errors](https://docsv2.paypaga.com/errors-2113602m0.md): - Root [Standard Codes and Values](https://docsv2.paypaga.com/standard-codes-and-values-2113603m0.md): - Root [Transaction Status Definitions and Lifecycle](https://docsv2.paypaga.com/transaction-status-definitions-and-lifecycle-2113636m0.md): - Root > Changelog [Format](https://docsv2.paypaga.com/format-2113626m0.md): - [Root](https://docsv2.paypaga.com/root-8051122f0.md): - [Root](https://docsv2.paypaga.com/root-8968875f0.md): - [Root](https://docsv2.paypaga.com/root-8897304f0.md): ## API Docs - Root [authenticate](https://docsv2.paypaga.com/authenticate-33841254e0.md): - Root > Transactions Configuration [List available pay-in configurations.](https://docsv2.paypaga.com/list-available-pay-in-configurations-37568270e0.md): Can be used to dynamically populate checkout options. Configuration contains payment methods supported for the merchant along with fees, limits, and required fields. - Root > Transactions Configuration [List available pay-out configurations.](https://docsv2.paypaga.com/list-available-pay-out-configurations-37568271e0.md): Can be used to dynamically populate checkout options. Configuration contains payment methods supported for the merchant along with fees, limits, and required fields. - Root > Pay-in Transactions [Search pay-in transactions](https://docsv2.paypaga.com/search-pay-in-transactions-37568272e0.md): Returns a paginated list of pay-in transactions matching the provided query parameters sorted by creation date in descending order. - Root > Pay-in Transactions [Create a pay-in transaction.](https://docsv2.paypaga.com/create-a-pay-in-transaction-37568273e0.md): Method initiates a new pay-in transaction for the merchant and returns its details. - Root > Pay-in Transactions [Retrieve a pay-in transaction.](https://docsv2.paypaga.com/retrieve-a-pay-in-transaction-37568274e0.md): Can be used to get the status and details of a specific pay-in by its transaction ID or merchant transaction reference. - Root > Development Utilities [Override a pay-in transaction status](https://docsv2.paypaga.com/override-a-pay-in-transaction-status-37568275e0.md): Available only in the sandbox environment, this endpoint allows overriding the status of a pay-in transaction for testing purposes. - Root > Development Utilities [Override a pay-out transaction status](https://docsv2.paypaga.com/override-a-pay-out-transaction-status-37568276e0.md): Available only in the sandbox environment, this endpoint allows overriding the status of a pay-out transaction for testing purposes. - Root > Pay-out Transactions [Search pay-out transactions](https://docsv2.paypaga.com/search-pay-out-transactions-37568277e0.md): Returns a paginated list of pay-out transactions matching the provided query parameters sorted by creation date in descending order. - Root > Pay-out Transactions [Create a pay-out transaction.](https://docsv2.paypaga.com/create-a-pay-out-transaction-37568278e0.md): Execute individual Pay Out transactions. The merchant_transaction_reference field per individual Pay Out transaction enables individual status notifications and therefore should be unique per individual Pay Out transaction. - Root > Pay-out Transactions [Retrieve a pay-out transaction.](https://docsv2.paypaga.com/retrieve-a-pay-out-transaction-37568279e0.md): Can be used to get the status and details of a specific pay-out by its transaction ID or merchant transaction reference. Can be used for tracking status. - Root > Pay URLs [Create a hosted PayURL checkout](https://docsv2.paypaga.com/create-a-hosted-payurl-checkout-37568280e0.md): The PayPaga PayURL is a customized checkout webpage to allow the selection of a payment method, entering any required information and submitting the payment. - Root > Balances [Retrieve merchant balance summary.](https://docsv2.paypaga.com/retrieve-merchant-balance-summary-37568281e0.md): Real-time access to the financial balances of a merchant's account. This can be used for reporting and as a precursor to [Pay Out - Payment Processing](#operation/createPayOutTransaction) to determine if there is sufficient balance. - Root > Catalog [List supported countries](https://docsv2.paypaga.com/list-supported-countries-37568282e0.md): Can be used to retrieve the list of countries supported by the merchant along with their default and additional currencies and available payment methods. - Root > Catalog [List supported payment methods](https://docsv2.paypaga.com/list-supported-payment-methods-37568283e0.md): Can be used to dynamically determine available payment methods for the merchant along with their supported countries, currencies, fees, and features. - Root > Settlements [Search settlements](https://docsv2.paypaga.com/search-settlements-37568284e0.md): Retrieve a paginated list of settlements processed for the merchant in descending order. Filters can be applied to narrow down the results by settlement ID and date range. - Root > Settlements [Retrieve settlement options](https://docsv2.paypaga.com/retrieve-settlement-options-37568285e0.md): Can be used to get the settlement configuration for the merchant. - Root > Settlements [Retrieve settlement transactions](https://docsv2.paypaga.com/retrieve-settlement-transactions-37568286e0.md): Retrieve a paginated list of transactions included in a specific settlement in descending order. - Root > Reference Data [Retrieve exchange rates](https://docsv2.paypaga.com/retrieve-exchange-rates-37568287e0.md): Retrieve foreign exchange rates for informational purposes only. Rates are updated at minute 55 of every hour. - Root > Reference Data [Retrieve tax rates](https://docsv2.paypaga.com/retrieve-tax-rates-37568288e0.md): Retrieve the catalogue of tax rates applicable to various countries, products, and payment methods. - Root > Notifications [Create a notification subscription](https://docsv2.paypaga.com/create-a-notification-subscription-37568289e0.md): Create a subscription to receive notifications for specific events related to transactions with callbacks or email. - Root > Notifications [List notification subscriptions](https://docsv2.paypaga.com/list-notification-subscriptions-37568290e0.md): Retrieve a list of existing notification subscriptions for the account. - Root > Notifications [Retrieve a notification subscription](https://docsv2.paypaga.com/retrieve-a-notification-subscription-37568291e0.md): Retrieve details of a specific notification subscription by its ID. - Root > Notifications [Delete a notification subscription](https://docsv2.paypaga.com/delete-a-notification-subscription-37568292e0.md): Delete an existing notification subscription by its ID. - Root > Pay In Examples > Argentina [Argentina CVU](https://docsv2.paypaga.com/argentina-cvu-37551952e0.md): # Important Considerations - Root > Pay In Examples > Brazil [Brazil PIX](https://docsv2.paypaga.com/brazil-pix-37550736e0.md): ### Required Fields - Root > Pay In Examples > Chile [Chile Bank Transfer](https://docsv2.paypaga.com/chile-bank-transfer-37551027e0.md): ### Required Fields - Root > Pay In Examples > Chile [Chile Khipu](https://docsv2.paypaga.com/chile-khipu-38066755e0.md): ### Required Fields - Root > Pay In Examples > Colombia [Colombia Dale](https://docsv2.paypaga.com/colombia-dale-37551955e0.md): ### Channel - Root > Pay In Examples > Colombia [Colombia Daviplata](https://docsv2.paypaga.com/colombia-daviplata-37551987e0.md): ### Channel - Root > Pay In Examples > Colombia [Colombia Efecty](https://docsv2.paypaga.com/colombia-efecty-37551997e0.md): ### Channel - Root > Pay In Examples > Colombia [Colombia Gana](https://docsv2.paypaga.com/colombia-gana-37552004e0.md): ### Channel - Root > Pay In Examples > Colombia [Colombia Movii](https://docsv2.paypaga.com/colombia-movii-37552012e0.md): ### Channel - Root > Pay In Examples > Colombia [Colombia Nequi](https://docsv2.paypaga.com/colombia-nequi-37552045e0.md): ### Channel - Root > Pay In Examples > Colombia [Colombia PSE](https://docsv2.paypaga.com/colombia-pse-37552193e0.md): ### Channel - Root > Pay In Examples > Colombia [Colombia RappiPay](https://docsv2.paypaga.com/colombia-rappipay-37550705e0.md): ### Channel - Root > Pay In Examples > Colombia [Colombia ReFacil](https://docsv2.paypaga.com/colombia-refacil-37552346e0.md): ### Channel - Root > Pay In Examples > Colombia [Colombia Susuerte](https://docsv2.paypaga.com/colombia-susuerte-37552551e0.md): ### Channel - Root > Pay In Examples > Colombia [Colombia Western Union](https://docsv2.paypaga.com/colombia-western-union-37552767e0.md): ### Channel - Root > Pay In Examples > Ecuador [Ecuador Bank Transfer](https://docsv2.paypaga.com/ecuador-bank-transfer-37562504e0.md): ### Channel - Root > Pay In Examples > Ecuador [Ecuador Banco Guayaquil](https://docsv2.paypaga.com/ecuador-banco-guayaquil-37562487e0.md):
- Root > Pay In Examples > Ecuador [Ecuador Bemovil](https://docsv2.paypaga.com/ecuador-bemovil-37562638e0.md): Example of a pay-in transaction creation request for the Ecuador Bemovil payment method. - Root > Pay In Examples > Ecuador [Ecuador Deuna](https://docsv2.paypaga.com/ecuador-deuna-37562666e0.md):
- Root > Pay In Examples > Ecuador [Ecuador Mi Negocio Efectivo](https://docsv2.paypaga.com/ecuador-mi-negocio-efectivo-37562671e0.md): Example of a pay-in transaction creation request for the Ecuador Mi Negocio Efectivo payment method. - Root > Pay In Examples > Ecuador [Ecuador Omniswitch](https://docsv2.paypaga.com/ecuador-omniswitch-37562673e0.md): Example of a pay-in transaction creation request for the Ecuador Omniswitch payment method. - Root > Pay In Examples > Ecuador [Ecuador RapiActivo](https://docsv2.paypaga.com/ecuador-rapiactivo-37562679e0.md): Example of a pay-in transaction creation request for the Ecuador RapiActivo payment method. - Root > Pay In Examples > Ecuador [Ecuador Western Union](https://docsv2.paypaga.com/ecuador-western-union-37562785e0.md): Example of a pay-in transaction creation request for the Ecuador Western Union payment method. - Root > Pay In Examples > Guatemala [Guatemala BAM Efectivo](https://docsv2.paypaga.com/guatemala-bam-efectivo-37562923e0.md): ### Expiry - Root > Pay In Examples > Guatemala [Guatemala BAM Transferencia](https://docsv2.paypaga.com/guatemala-bam-transferencia-37562934e0.md): ### Expiry - Root > Pay In Examples > Guatemala [Guatemala Banco Industrial](https://docsv2.paypaga.com/guatemala-banco-industrial-37562936e0.md): ### Expiry - Root > Pay In Examples > Guatemala [Guatemala Akisi Pronet](https://docsv2.paypaga.com/guatemala-akisi-pronet-37562920e0.md): ### Expiry - Root > Pay In Examples > Mexico [Mexico Pay With Cash](https://docsv2.paypaga.com/mexico-pay-with-cash-37562942e0.md): ### Expiry - Root > Pay In Examples > Mexico [Mexico SPEI](https://docsv2.paypaga.com/mexico-spei-37563023e0.md): ### Optional Fields - Root > Pay In Examples > Peru [Peru BBVA](https://docsv2.paypaga.com/peru-bbva-37563080e0.md): ### QR Code - Root > Pay In Examples > Peru [Peru BCP](https://docsv2.paypaga.com/peru-bcp-37563239e0.md): ### Channel - Root > Pay In Examples > Peru [Peru BCP Efectivo](https://docsv2.paypaga.com/peru-bcp-efectivo-37563233e0.md): Example of a pay-in transaction creation request for the Peru BCP Efectivo payment method. - Root > Pay In Examples > Peru [Peru Cell Power](https://docsv2.paypaga.com/peru-cell-power-37563249e0.md): Example of a pay-in transaction creation request for the Peru Cell Power payment method. - Root > Pay In Examples > Peru [Peru KasNet](https://docsv2.paypaga.com/peru-kasnet-37563279e0.md): Example of a pay-in transaction creation request for the Peru KasNet payment method. - Root > Pay In Examples > Peru [Peru QR Interoperable](https://docsv2.paypaga.com/peru-qr-interoperable-37563288e0.md): ### QR Code - Root > Pay In Examples > Peru [Peru Plin](https://docsv2.paypaga.com/peru-plin-37563283e0.md): ### QR Code - Root > Pay In Examples > Peru [Peru Yape](https://docsv2.paypaga.com/peru-yape-37563321e0.md): ### Optional Fields - Root > Pay Out Examples > Argentina [Argentina CVU](https://docsv2.paypaga.com/argentina-cvu-37563433e0.md): ### Required Fields - Root > Pay Out Examples > Brazil [Brazil PIX](https://docsv2.paypaga.com/brazil-pix-37563947e0.md): ### Required Fields - Root > Pay Out Examples > Chile [Chile Bank Transfer](https://docsv2.paypaga.com/chile-bank-transfer-37564121e0.md): ### Required Fields - Root > Pay Out Examples > Colombia [Colombia Bank Transfer](https://docsv2.paypaga.com/colombia-bank-transfer-37564128e0.md): ### Required Fields - Root > Pay Out Examples > Ecuador [Ecuador Bank Transfer](https://docsv2.paypaga.com/ecuador-bank-transfer-37564340e0.md): ### Required Fields - Root > Pay Out Examples > Guatemala [Guatemala Bank Transfer](https://docsv2.paypaga.com/guatemala-bank-transfer-37564795e0.md): ### Required Fields - Root > Pay Out Examples > Mexico [Mexico SPEI](https://docsv2.paypaga.com/mexico-spei-37566951e0.md): ### Required Fields - Root > Pay Out Examples > Peru [Peru Bank Transfer](https://docsv2.paypaga.com/peru-bank-transfer-37566954e0.md): ### Required Fields ## Schemas - Root [AuthRequest](https://docsv2.paypaga.com/authrequest-14434196d0.md): - Root [AuthResponse](https://docsv2.paypaga.com/authresponse-14434197d0.md): - Root [AuthFailed](https://docsv2.paypaga.com/authfailed-14434198d0.md): - Root [MoneyAmount](https://docsv2.paypaga.com/moneyamount-15651734d0.md): - Root [Currency](https://docsv2.paypaga.com/currency-15651735d0.md): - Root [Country](https://docsv2.paypaga.com/country-15651736d0.md): - Root [PaymentMethod](https://docsv2.paypaga.com/paymentmethod-15651737d0.md): - Root [Product](https://docsv2.paypaga.com/product-15651738d0.md): - Root [OptionField](https://docsv2.paypaga.com/optionfield-15651739d0.md): - Root [PayInTransactionStatus](https://docsv2.paypaga.com/payintransactionstatus-15651740d0.md): - Root [PayOutTransactionStatus](https://docsv2.paypaga.com/payouttransactionstatus-15651741d0.md): - Root [NotificationType](https://docsv2.paypaga.com/notificationtype-15651742d0.md): - Root [PaginationMeta](https://docsv2.paypaga.com/paginationmeta-15651743d0.md): - Root [MerchantOrderReference](https://docsv2.paypaga.com/merchantorderreference-15651744d0.md): - Root [MerchantTransactionReference](https://docsv2.paypaga.com/merchanttransactionreference-15651745d0.md): - Root [FeeMode](https://docsv2.paypaga.com/feemode-15651746d0.md): - Root [PaymentOption](https://docsv2.paypaga.com/paymentoption-15651747d0.md): - Root [Code](https://docsv2.paypaga.com/code-15651748d0.md): - Root [Message](https://docsv2.paypaga.com/message-15651749d0.md): - Root [ValidationErrorItem](https://docsv2.paypaga.com/validationerroritem-15651750d0.md): - Root [ValidationErrorDetail](https://docsv2.paypaga.com/validationerrordetail-15651751d0.md): - Root [ErrorDetail](https://docsv2.paypaga.com/errordetail-15651752d0.md): - Root [PayInTransaction](https://docsv2.paypaga.com/payintransaction-15651753d0.md): - Root [PayInTransactionListResponse](https://docsv2.paypaga.com/payintransactionlistresponse-15651754d0.md): - Root [ReturnUrls](https://docsv2.paypaga.com/returnurls-15651755d0.md): - Root [CreatePayInRequest](https://docsv2.paypaga.com/createpayinrequest-15651756d0.md): - Root [PaymentInstructions](https://docsv2.paypaga.com/paymentinstructions-15651757d0.md): - Root [CreatePayInResponse](https://docsv2.paypaga.com/createpayinresponse-15651758d0.md): - Root [PayInTransactionStatusOverrideRequest](https://docsv2.paypaga.com/payintransactionstatusoverriderequest-15651759d0.md): - Root [PayOutTransaction](https://docsv2.paypaga.com/payouttransaction-15651760d0.md): - Root [PayOutTransactionListResponse](https://docsv2.paypaga.com/payouttransactionlistresponse-15651761d0.md): - Root [CreatePayOutRequest](https://docsv2.paypaga.com/createpayoutrequest-15651762d0.md): - Root [CreatePayOutResponse](https://docsv2.paypaga.com/createpayoutresponse-15651763d0.md): - Root [PayOutTransactionStatusOverrideRequest](https://docsv2.paypaga.com/payouttransactionstatusoverriderequest-15651764d0.md): - Root [PredefinedFields](https://docsv2.paypaga.com/predefinedfields-15651765d0.md): - Root [CreatePayURLRequest](https://docsv2.paypaga.com/createpayurlrequest-15651766d0.md): - Root [CreatePayURLResponse](https://docsv2.paypaga.com/createpayurlresponse-15651767d0.md): - Root [BalanceTotal](https://docsv2.paypaga.com/balancetotal-15651768d0.md): - Root [BalanceCountry](https://docsv2.paypaga.com/balancecountry-15651769d0.md): - Root [BalanceSummaryResponse](https://docsv2.paypaga.com/balancesummaryresponse-15651770d0.md): - Root [CountryCatalogEntry](https://docsv2.paypaga.com/countrycatalogentry-15651771d0.md): - Root [PaymentMethodCatalogEntry](https://docsv2.paypaga.com/paymentmethodcatalogentry-15651772d0.md): - Root [Settlement](https://docsv2.paypaga.com/settlement-15651773d0.md): - Root [SettlementsResponse](https://docsv2.paypaga.com/settlementsresponse-15651774d0.md): - Root [SettlementWindow](https://docsv2.paypaga.com/settlementwindow-15651775d0.md): - Root [SettlementOptionsResponse](https://docsv2.paypaga.com/settlementoptionsresponse-15651776d0.md): - Root [SettlementTransaction](https://docsv2.paypaga.com/settlementtransaction-15651777d0.md): - Root [SettlementTransactionsResponse](https://docsv2.paypaga.com/settlementtransactionsresponse-15651778d0.md): - Root [ExchangeRateQuote](https://docsv2.paypaga.com/exchangeratequote-15651779d0.md): - Root [ExchangeRatesResponse](https://docsv2.paypaga.com/exchangeratesresponse-15651780d0.md): - Root [TaxRate](https://docsv2.paypaga.com/taxrate-15651781d0.md): - Root [ChannelType](https://docsv2.paypaga.com/channeltype-15651782d0.md): - Root [NotificationSubscriptionResponse](https://docsv2.paypaga.com/notificationsubscriptionresponse-15651783d0.md): - Root [ListNotificationSubscriptionsResponse](https://docsv2.paypaga.com/listnotificationsubscriptionsresponse-15651784d0.md): - Root [NotificationSubscriptionRequest](https://docsv2.paypaga.com/notificationsubscriptionrequest-15651785d0.md): - Root [TransactionCallbackPayload](https://docsv2.paypaga.com/transactioncallbackpayload-15651786d0.md): - Root [Country](https://docsv2.paypaga.com/country-15575404d0.md): - Root [Currency](https://docsv2.paypaga.com/currency-15575405d0.md): - Root [PaymentMethod](https://docsv2.paypaga.com/paymentmethod-15575406d0.md): - Root [MerchantOrderReference](https://docsv2.paypaga.com/merchantorderreference-15575407d0.md): - Root [MerchantTransactionReference](https://docsv2.paypaga.com/merchanttransactionreference-15575408d0.md): - Root [CreatePayOutRequest](https://docsv2.paypaga.com/createpayoutrequest-15650772d0.md): - Root [ReturnUrls](https://docsv2.paypaga.com/returnurls-15575409d0.md): - Root [CreatePayInRequest](https://docsv2.paypaga.com/createpayinrequest-15575410d0.md): - Root [CreatePayOutResponse](https://docsv2.paypaga.com/createpayoutresponse-15650773d0.md): - Root [PaymentInstructions](https://docsv2.paypaga.com/paymentinstructions-15575411d0.md): - Root [CreatePayInResponse](https://docsv2.paypaga.com/createpayinresponse-15575412d0.md):