Retrieves a detailed report for a bulk payout batch, including payouts and summary.
Request
Path Params
Request Code Samples
Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
Request Request Example
Shell
JavaScript
Java
Swift
curl--location--request GET 'https://api.staging.vrtx.sa/payouts/bulk//report'
Responses
🟢200OK
application/json
Default Response
Body
Example
{"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":"INSUFFICIENT_FUNDS","error_message":"Insufficient funds in the payout account."},{"row_number":"3","external_reference":"PAY-2024-003","payout_amount":"75.25","status":"COMPLETED"}]}
