---
title: "Compile a stateful synthetic payment scenario"
method: POST
path: "/payment-scenarios/compile"
---

# Compile a stateful synthetic payment scenario

`POST /payment-scenarios/compile`

## Request

- Base URL: `https://ibangen.com/api/v1`
- URL: `https://ibangen.com/api/v1/payment-scenarios/compile`
- Auth: API key in header `X-API-Key`

## Request body

- PaymentScenarioRequest
  - `scenario` string
  - `country` string
  - `bank_target` string
  - `amount` string
  - `currency` string
  - `payment_path` string
  - `vop_outcome` 'MATCH' | 'CLOSE_MATCH' | 'NO_MATCH' | 'NOAP' | 'REJECTED'
  - `seed` string

## Response `200`

Structured scenario artifact

- PaymentScenarioResponse
  - `success` boolean, required
  - `scenario` object, required

## Other responses

- `400`: Invalid scenario
- `401`: Invalid API key
- `402`: Business access required
- `429`: API credits exhausted

---

[API](https://skmtc.dev/ibangen/apis/ibangen-api.md) · [All operations](https://skmtc.dev/ibangen/apis/ibangen-api/llms.txt) · [OpenAPI document](https://skmtc.dev/ibangen/apis/ibangen-api/revisions/50b475482b4d?raw)