GOgocardless
Scenario Simulator

Simulate a scenario

Runs the specific scenario simulator against the specific resource

post/scenario_simulators/{scenario_simulator_id}/actions/run

Request

  • Base URL
    https://api.gocardless.com
  • Auth
    HTTP bearer

Path parameters

scenario_simulator_idstring required

The scenario simulator id

Headers

GoCardless-Versionstring required

Request body

Example request

{
  "scenario_simulators": {
    "links": {
      "resource": "CR123"
    }
  }
}

Response

Action completed successfully

Example response

{
  "scenario_simulators": {
    "id": "payment_failed"
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.