Test Payment Simulations

Endpointhttps://api.kontier.eu/v1

Simulate payment outcomes in a sandbox without a real payment processor — success, failure, pending and dispute — to test how your integration handles each. Combine with test clocks to run a whole billing cycle.

Sandbox only: a live workspace answers 403.

List test payment simulations

GET

https://api.kontier.eu/v1

/test-payment-simulations

Returns all payment simulations for the current sandbox.

List test payment simulations › Headers

X-Workspace-Id

string

Selects the workspace this request operates in, by workspace UUID or slug (e.g. a sandbox workspace for test integrations). Omitted: the organization's default live workspace. Unknown workspace: 404; workspace outside your organization: 403. Discover workspaces via GET /workspaces.

Workspace UUID or slug.

List test payment simulations › Responses

object · required

Create a test payment simulation

POST

https://api.kontier.eu/v1

/test-payment-simulations

Creates a new payment simulation for testing payment flows in sandbox mode.

Create a test payment simulation › Headers

Idempotency-Key

string · required

Unique key that makes this POST safe to retry: repeats with the same key replay the first response instead of re-executing. Replays are scoped to the retrying principal (same API key / user) and kept for 24 hours. Required on every POST.

Client-generated idempotency key (e.g. a UUID).

X-Workspace-Id

string

Workspace UUID or slug.

Create a test payment simulation › Request Body

outcome

string · enum · required

Enum values:

success

decline

insufficient_funds

expired_card

fraud

processing_error

network_error

requires_action

payment_method_id

string · uuid · required

Create a test payment simulation › Responses

Created

object · required

POST/test-payment-simulations

curl --request POST \
  --url https://api.kontier.eu/v1/test-payment-simulations \
  --header 'Content-Type: application/json' \
  --header 'Idempotency-Key: <string>' \
  --data '
{
  "outcome": "success",
  "payment_method_id": "0f8fad5b-d9cb-469f-a165-70867728950e"
}
'

shell

Example Request Body

{
  "outcome": "success",
  "payment_method_id": "0f8fad5b-d9cb-469f-a165-70867728950e"
}

json

Example Responses

{
  "data": {
    "created_at": "2024-08-25T15:00:00Z",
    "id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "last_used_at": "2024-08-25T15:00:00Z",
    "outcome": "success",
    "payment_method_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "workspace_id": "0f8fad5b-d9cb-469f-a165-70867728950e"
  }
}

json

application/json

Delete a test payment simulation

DELETE

https://api.kontier.eu/v1

/test-payment-simulations/{id}

Permanently deletes a payment simulation.

Delete a test payment simulation › path Parameters

id

string · uuid · required

Simulation UUID

Delete a test payment simulation › Headers

X-Workspace-Id

string

Workspace UUID or slug.

Delete a test payment simulation › Responses

No Content

No data returned

Test Clocks Search

List test payment simulations

GET

https://api.kontier.eu/v1

/test-payment-simulations

Returns all payment simulations for the current sandbox.

List test payment simulations › Headers

X-Workspace-Id

string

Workspace UUID or slug.

List test payment simulations › Responses

object · required

Create a test payment simulation

POST

https://api.kontier.eu/v1

/test-payment-simulations

Creates a new payment simulation for testing payment flows in sandbox mode.

Create a test payment simulation › Headers

Idempotency-Key

string · required

Client-generated idempotency key (e.g. a UUID).

X-Workspace-Id

string

Workspace UUID or slug.

Create a test payment simulation › Request Body

outcome

string · enum · required

Enum values:

success

decline

insufficient_funds

expired_card

fraud

processing_error

network_error

requires_action

payment_method_id

string · uuid · required

Create a test payment simulation › Responses

Created

object · required

Delete a test payment simulation

DELETE

https://api.kontier.eu/v1

/test-payment-simulations/{id}

Permanently deletes a payment simulation.

Delete a test payment simulation › path Parameters

id

string · uuid · required

Simulation UUID

Delete a test payment simulation › Headers

X-Workspace-Id

string

Workspace UUID or slug.

Delete a test payment simulation › Responses

No Content

No data returned