Update Payout Status

Utils API for Sandbox testing

Sandbox Update a Payout status

This API is used in the Sandbox environment to manually update the status of a payout or batch for testing. Before using it, ensure that payouts with a new receiver account have completed the account confirmation process. Otherwise, status updates will fail with a "Batch payout not found" error.

POST /api/test-helpers/status

Headers

Name	Value
x-api-key	<token>
signature	<token>

Body

Name	Type	Description
id*	string	Payout ID or Batch ID to update status.
type*	string	Type to update. payout to make update a payout or batch to make update all payout in batch.
status*	string	Status of payout to update. success or fail

* is mandatory parameter

Example body request

{
    "id": "c111f9ee-5a42-496c-94ad-9645ebd2004b", // payout_id or batch_id
    "type": "payout", // payout or batch
    "status": "success" // success or fail
}

Response

200

{
    "statusCode": 200,
    "message": "Test helper: Update payout status is successful"
}