1. Pay-out Transactions
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
        GET
      • Create a pay-out transaction.
        POST
      • Retrieve a pay-out transaction.
        GET
    • 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. Pay-out Transactions

Search pay-out transactions

Production
https://api.paypaga.com
Production
https://api.paypaga.com
GET
/v2/transactions/pay-out
Returns a paginated list of pay-out transactions matching the provided query parameters sorted by creation date in descending order.
Use this endpoint to query pay-out transactions data for custom reports or reconciliation purposes.
⚠️ When using date criteria, the maximum allowable duration is 2 months.

Transaction statuses#

Initiated - The transaction has been initiated
Created - The transaction has been created and is ready to send to partner
Pending - The transaction has been sent to a partner, and is awaiting confirmation of payment
Approved - The transaction has been confirmed by the partner
Failed - An error occurred while sending the transaction to a partner
Rejected - the transaction has been rejected by a partner

Error codes for Query Pay-out Transactions#

HTTP statusError codeDescription
400VALIDATION_ERRORRequest validation failed
401UNAUTHORIZEDMissing or invalid authorization token
403FORBIDDENYou do not have permission to access this resource
500INTERNAL_ERRORUnexpected server error

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
Query Params

Responses

🟢200
application/json
Paginated pay-out list.
Bodyapplication/json

🟠400ValidationError
🟠401Unauthorized
🟠403Forbidden
🔴500InternalError
Request Request Example
Shell
JavaScript
Java
Swift
curl --location 'https://api.paypaga.com/v2/transactions/pay-out?lookup=undefined&country=undefined&currency=undefined&payment_method=undefined&status=undefined&date_from=undefined&date_to=undefined&page=undefined&page_size=undefined'
Response Response Example
200 - Example 1
{
    "items": [
        {
            "transaction_id": "20240806-2010-4086-8342-c28f4979f834",
            "merchant_order_reference": "ORDER-2026-0001",
            "merchant_transaction_reference": "TRX-2026-0001",
            "initiated_on": "2024-08-06T20:05:40Z",
            "created_on": "2024-08-06T18:02:41Z",
            "approved_on": "2024-08-06T18:07:41Z",
            "failed_on": "2024-08-06T19:15:00Z",
            "fail_reason": "Bank account closed",
            "country": "BR",
            "currency": "BRL",
            "payment_method": "top_up",
            "fields": {
                "name": "Maria Alves",
                "document": 12345678909,
                "bank_code": 1,
                "account_number": "12345-6"
            },
            "transaction_amount": 500,
            "fee": 3,
            "tax": 0,
            "status": "initiated",
            "meta": {
                "settlement_id": "SETTLEMENT-2024-06-15",
                "requested_by": "automation"
            }
        }
    ],
    "meta": {
        "page": 1,
        "page_size": 25,
        "total_items": 200
    }
}
Modified at 2026-06-09 15:16:31
Previous
Override a pay-out transaction status
Next
Create a pay-out transaction.
Built with