Get batch report

GET

https://api.staging.vrtx.sa/payouts/bulk/{batch_id}/report

Last modified:2026-04-16 11:21:19

Retrieves a detailed report for a bulk payout batch, including payouts and summary.

Request

Authorization

JWT Bearer

Add the parameter

Authorization

to Headers

Example:

Authorization: ********************

Path Params

Responses

🟢200OK

application/json

Default Response

Body

🟠400Bad Request

🟠401Unauthorized

🟠403Forbidden

🟠404Not Found

🟠405Method Not Allowed

🟠409Conflict

🟠410Gone

🟠422Unprocessable Entity

🟠429Too Many Requests

🔴500Internal Server Error

🔴501Not Implemented

🔴503Service Unavailable

🔴504Gateway Timeout

🔴505HTTP Version Not Supported

Request Example

Shell

JavaScript

Java

Swift

curl --location --request GET 'https://api.staging.vrtx.sa/payouts/bulk//report' \
--header 'Authorization: Bearer <token>'

Response Example

200 - Success

{
    "batch_id": "batch_01HZY6ZQ4J8ZKFE20QG93DYD3A",
    "report_status": "READY",
    "summary": {
        "total_transactions": 3,
        "processed": 3,
        "successful": 2,
        "failed": 1
    },
    "rows": [
        {
            "row_number": "1",
            "external_reference": "PAY-2024-001",
            "payout_amount": "250.00",
            "status": "COMPLETED"
        },
        {
            "row_number": "2",
            "external_reference": "PAY-2024-002",
            "payout_amount": "1500.50",
            "status": "FAILED",
            "error_code": "PAYOUT_AMOUNT_EXCEEDS_MAX",
            "error_message": "Payout amount exceeds the configured maximum."
        },
        {
            "row_number": "3",
            "external_reference": "PAY-2024-003",
            "payout_amount": "75.25",
            "status": "COMPLETED"
        }
    ]
}

Modified at 2026-04-16 11:21:19

Get bulk payout status

Get batch report