Simulate Payout
POST/api/v1/test/payouts/{id}/simulate
- operationId
- testkit.SimulatePayout
- Permission
- simulate
- Idempotency
- required
An Idempotency-Key header is required.
Parameters
| Field | in | Type | Required | Description |
|---|---|---|---|---|
| id | path | string | Yes | |
| Idempotency-Key | header | string | Yes | |
| PG-Version | header | string |
Request body
application/json
| Field | Type | Required | Description |
|---|---|---|---|
| outcome | enum | Values: `paid`, `returned`, `failed` | |
| payout_id | string | ||
| return_reason | string |
Example
Generated from the schema — a shape, not a sample.
{
"outcome": "paid",
"payout_id": "string",
"return_reason": "string"
}Responses
200 OK
Response headers: `X-Request-Id`
| Field | Type | Required | Description |
|---|---|---|---|
| action_id | string | ||
| outcome | string | ||
| payment_id | string | ||
| payout_id | string | ||
| provider_event_id | string | ||
| refund_id | string | ||
| replayed | boolean |
{
"action_id": "string",
"outcome": "string",
"payment_id": "string",
"payout_id": "string",
"provider_event_id": "string",
"refund_id": "string",
"replayed": false
}default Error
| Field | Type | Required | Description |
|---|---|---|---|
| code | string | Yes | |
| detail | string | ||
| details | object | ||
| errors | object[] | ||
| errors.code | string | ||
| errors.field | string | ||
| errors.message | string | ||
| instance | string | ||
| status | integer | Yes | |
| title | string | Yes | |
| type | string |
{
"code": "string",
"detail": "string",
"details": {},
"errors": [
{
"code": "string",
"field": "string",
"message": "string"
}
],
"instance": "string",
"status": 0,
"title": "string",
"type": "string"
}Errors
Derived from the modules this operation touches, because the snapshot carries no x-errors list yet — it may list codes this operation cannot return.
Try it
POST/test/payouts/%7Bid%7D/simulateMakes a real call in test mode with your own key. The key stays in this tab and is never sent anywhere but the API.
No API base URL is configured for this environment, so try-it is unavailable.
Starts with pg_test_. A live key is refused before any request is made.
curl -X POST '<API_BASE_URL>/api/v1/test/payouts/%7Bid%7D/simulate' \
-H 'Authorization: Bearer pg_test_…' \
-H 'PG-Version: 2026-09-01' \
-H 'Content-Type: application/json' \
-H 'Idempotency-Key: <uuid v7>' \
-d '{
"outcome": "paid",
"payout_id": "string",
"return_reason": "string"
}'