Get bulk payout status

GET

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

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

Retrieves processing progress, totals, and success rates for a bulk payout batch.

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//status' \
--header 'Authorization: Bearer <token>'

Response Example

200 - example1

{
    "batch_id": "batch_01HZY6ZQ4J8ZKFE20QG93DYD3A",
    "status": "PROCESSING",
    "summary": {
        "total_transactions": 100,
        "processed": 50,
        "successful": 48,
        "failed": 2
    }
}

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

Create bulk payout

Get bulk payout status