Override a pay-out transaction status
Production
https://api.paypaga.com
Production
https://api.paypaga.com
POST
/v2/test/transactions/pay-out/{lookup}/status
Error codes for Payout Transaction Status Override
| HTTP status | Error code | Description |
|---|---|---|
| 400 | VALIDATION_ERROR | Request validation failed |
| 400 | BAD_REQUEST | Failed to parse the request body |
| 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 |
| 409 | INVALID_STATUS_TRANSITION | Unsupported pay-out transaction status transition |
| 500 | INTERNAL_ERROR | Unexpected server error |
Request
Path Params
Body Params application/jsonRequired
Responses
Request Request Example
Shell
JavaScript
Java
Swift
curl --location 'https://api.paypaga.com/v2/test/transactions/pay-out//status' \
--header 'Content-Type: application/json' \
--data '{
"status": "approved",
"reason": "Simulate approved state for integration test",
"with_notifications": false
}'Response Response Example
200 - Example 1
{
"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"
}
}Modified at 2026-06-09 15:16:31