Retrieve a pay-out transaction.
Production
https://api.paypaga.com
Production
https://api.paypaga.com
GET
/v2/transactions/pay-out/{lookup}
Transaction statuses
| Status | Description | Final |
|---|---|---|
| initiated | The transaction has been initiated | No |
| created | The transaction has been created and is ready to send to partner | No |
| pending | The transaction has been sent to a partner, and is awaiting confirmation of payment | No |
| approved | The transaction has been confirmed by the partner | Yes |
| failed | An error occurred while sending the transaction to a partner | Yes via the public API — see note below |
| rejected | The transaction has been rejected by a partner | Yes |
Error codes for Payout Transaction Retrieval
| HTTP status | Error code | Description |
|---|---|---|
| 400 | VALIDATION_ERROR | Request validation failed |
| 401 | UNAUTHORIZED | Missing or invalid authorization token |
| 403 | FORBIDDEN | You do not have permission to access this resource |
| 404 | NOT_FOUND | Pay-out transaction not found |
| 500 | INTERNAL_ERROR | Unexpected server error |
Request
Path Params
Responses
Request Request Example
Shell
JavaScript
Java
Swift
curl --location 'https://api.paypaga.com/v2/transactions/pay-out/'Response Response Example
200 - Example 1
{
"approved_on": "2024-08-06T18:07:41Z",
"beneficiary_amount": 497,
"country": "BR",
"created_on": "2024-08-06T18:02:41Z",
"currency": "BRL",
"fail_reason": "Bank account closed",
"failed_on": "2024-08-06T19:15:00Z",
"fee": 3,
"fields": {
"account_number": "12345-6",
"bank_code": "001",
"document": "12345678909",
"name": "Maria Alves"
},
"initiated_on": "2024-08-06T20:05:40Z",
"merchant_order_reference": "ORDER-2026-0001",
"merchant_transaction_reference": "TRX-2026-0001",
"meta": {
"requested_by": "automation",
"settlement_id": "SETTLEMENT-2024-06-15"
},
"payment_method": "top_up",
"status": "initiated",
"tax": 0,
"transaction_amount": 500,
"transaction_id": "20240806-2010-4086-8342-c28f4979f834"
}Modified at 2026-09-07 13:19:25