Endpoints for driving entity state in sandbox environments. These endpoints are sandbox-only and return 404 in production. Use them to simulate status transitions and requirements-due scenarios when testing your integration.
Every API here is available over the APIs.io API and to AI agents over MCP.
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
find_apisBrowse and filter every API in the catalog.get_api_artifactsOne API's artifacts, grouped by type.get_openapiThe primary OpenAPI for this API.find_similar_apisAPIs that look like this one.apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.resolveTurn a domain, URL or GitHub org into the provider it belongs to.find_cohortsEvery scored population of providers in the catalog.curl "https://apis.io/api/v1/apis/checkout-com:checkout-com-onboarding-simulator-api"curl "https://apis.io/api/v1/apis?limit=25"Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.
Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.
A second provider on the same verified email joins the account you already have.
openapi: 3.2.0
info:
title: Checkout.com API Reference Onboarding Simulator API
description: '## Get started
Checkout.com provides a collection of APIs that enable you to integrate with our various products and services.
Our APIs accept and return JSON in the HTTP body, and return standard HTTP response codes. You can consume the APIs directly using any HTTP or REST library.
Sign up for a test account to gain access to the sandbox environment, where you can test API calls without affecting live data.
For more information, see:
- API endpoints
- API rate limits
- API changes
- Idempotency
- Private connections
## Base URLs
The base URLs you must use for your API calls to the sandbox and production environments are unique to you.
- `https://{prefix}.api.sandbox.checkout.com/{path}`
- `https://{prefix}.api.checkout.com/{path}`
- `https://{prefix}.access.sandbox.checkout.com/{path}`
- `https://{prefix}.access.checkout.com/{path}`
The unique API endpoint host names resolve to Checkout.com''s IP addresses. Do not allowlist these IP addresses.
The `{prefix}` value in each base URL is a string containing the first eight characters of each of your environments'' unique `client_id`, excluding the `cli_` prefix.
To find your unique base URL:
1. Sign in to the Dashboard environment you want to retrieve the base URL for:
- Sandbox
- Production
2. Go to _Developers_ > _Overview_.
Your unique base URL is displayed on the _Developer overview_ page. For example, `https://vkuhvk4v.api.checkout.com`.
3. Alternatively, go to _Settings_ > _Account details_.
Your unique base URL is displayed under _Connection settings_.
If you are unsure of your client ID or base URL for either environment, contact your account manager or request support.
For more information, see API endpoints.
## Authentication
When you sign up for an account, you can authenticate with either Access keys (OAuth 2.0), or Secret API keys.
Unless explicitly stated, all endpoints require authentication using either your Access or Secret API Keys. Public keys should only be used in JavaScript or native applications.
- **Client-side authentication**. Use your public key for client-side authentication. It only has access to a limited set of our APIs – mostly those called as part of your payment environment.
- **Server-to-server authentication**. Use your secret key or OAuth for server-to-server communication. Support for API keys depends on the endpoint.
Never share your OAuth credentials, API keys, or access tokens. Keep them guarded and secure.'
termsOfService: https://www.checkout.com/legal/terms-and-policies
contact:
name: Checkout.com Support
url: https://dashboard.checkout.com/support
version: v1.0.0
servers:
- url: https://{prefix}.api.sandbox.checkout.com
description: Sandbox environment
variables:
prefix:
default: '{prefix}'
description: Your unique <a href="https://www.checkout.com/docs/developer-resources/api/api-endpoints" target="_blank">base URL</a>. There is no default value.
- url: https://{prefix}.api.checkout.com
description: Production environment
variables:
prefix:
default: '{prefix}'
description: Your unique <a href="https://www.checkout.com/docs/developer-resources/api/api-endpoints" target="_blank">base URL</a>. There is no default value.
tags:
- name: Onboarding Simulator
description: Endpoints for driving entity state in sandbox environments. These endpoints are sandbox-only and return 404 in production. Use them to simulate status transitions and requirements-due scenarios when testing your integration.
paths:
/simulate/entities/{entityId}/requirements-due:
parameters:
- name: entityId
in: path
description: The ID of the entity.
required: true
style: simple
schema:
type: string
example: ent_w4jelhppmfiufdnatam37wrfc4
post:
tags:
- Onboarding Simulator
summary: Set requirements due
description: '**Sandbox only** — not available in Production.
Marks the specified requirement fields as due on an entity. Use this to test how your integration handles the requirements-due state.'
requestBody:
description: The requirement fields to mark as due.
content:
application/json:
schema:
$ref: '#/components/schemas/SimulatorSetRequirementsDueRequest'
required: true
responses:
'200':
description: Requirements due set successfully
content:
application/json:
schema:
$ref: '#/components/schemas/SimulatorSetRequirementsDueResponse'
'400':
description: Unknown or missing fields
content:
application/json:
schema:
$ref: '#/components/schemas/SimulatorErrorResponse'
'401':
description: Unauthorized
'404':
description: Entity not found
'502':
description: Dependency error
content:
application/json:
schema:
$ref: '#/components/schemas/SimulatorErrorResponse'
security:
- OAuth:
- accounts
operationId: postSimulateEntitiesByEntityIdRequirementsDue
x-operation-id-source: derived
/simulate/entities/{entityId}/scenarios/{scenarioId}:
parameters:
- name: entityId
in: path
description: The ID of the entity.
required: true
style: simple
schema:
type: string
example: ent_w4jelhppmfiufdnatam37wrfc4
- name: scenarioId
in: path
description: The ID of the scenario to run.
required: true
style: simple
schema:
type: string
example: go_active
post:
tags:
- Onboarding Simulator
summary: Run scenario
description: '**Sandbox only** — not available in Production.
Executes a pre-defined scenario against an entity, triggering the associated state transition or capability change. Use GET /simulate/scenarios to list available scenario IDs.'
responses:
'200':
description: Scenario executed successfully
content:
application/json:
schema:
$ref: '#/components/schemas/SimulatorRunScenarioResponse'
'202':
description: Scenario execution accepted and in progress
content:
application/json:
schema:
$ref: '#/components/schemas/SimulatorRunScenarioResponse'
'401':
description: Unauthorized
'404':
description: Entity or scenario not found
content:
application/json:
schema:
$ref: '#/components/schemas/SimulatorErrorResponse'
'502':
description: Dependency error
content:
application/json:
schema:
$ref: '#/components/schemas/SimulatorErrorResponse'
security:
- OAuth:
- accounts
operationId: postSimulateEntitiesByEntityIdScenariosByScenarioId
x-operation-id-source: derived
/simulate/entities/{entityId}/status:
parameters:
- name: entityId
in: path
description: The ID of the entity.
required: true
style: simple
schema:
type: string
example: ent_w4jelhppmfiufdnatam37wrfc4
post:
tags:
- Onboarding Simulator
summary: Set entity status
description: '**Sandbox only** — not available in Production.
Forces the entity to the specified status, bypassing normal onboarding flow. Use this to test how your integration handles different entity states.'
requestBody:
description: The status to apply to the entity.
content:
application/json:
schema:
$ref: '#/components/schemas/SimulatorSetStatusRequest'
required: true
responses:
'200':
description: Status updated successfully
content:
application/json:
schema:
$ref: '#/components/schemas/SimulatorSetStatusResponse'
'202':
description: Status transition accepted and in progress
content:
application/json:
schema:
$ref: '#/components/schemas/SimulatorSetStatusResponse'
'400':
description: Invalid status value or transition not allowed
content:
application/json:
schema:
$ref: '#/components/schemas/SimulatorErrorResponse'
'401':
description: Unauthorized
'404':
description: Entity not found
'502':
description: Dependency error
content:
application/json:
schema:
$ref: '#/components/schemas/SimulatorErrorResponse'
security:
- OAuth:
- accounts
operationId: postSimulateEntitiesByEntityIdStatus
x-operation-id-source: derived
/simulate/requirements-due:
get:
tags:
- Onboarding Simulator
summary: List available requirements
description: '**Sandbox only** — not available in Production.
Returns all requirement fields that can be set as due on an entity. Use the field values when calling the Set requirements due endpoint.'
responses:
'200':
description: Requirements listed successfully
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/SimulatorAvailableRequirement'
'401':
description: Unauthorized
'404':
description: Simulator not available in this environment. These endpoints are not registered in production.
security:
- OAuth:
- accounts
operationId: getSimulateRequirementsDue
x-operation-id-source: derived
/simulate/scenarios:
get:
tags:
- Onboarding Simulator
summary: List scenarios
description: '**Sandbox only** — not available in Production.
Returns all pre-defined scenarios available. Use the scenario IDs when calling the run scenario endpoint.'
responses:
'200':
description: Scenarios listed successfully
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/SimulatorScenario'
'401':
description: Unauthorized
'404':
description: Simulator not available in this environment. These endpoints are not registered in production.
security:
- OAuth:
- accounts
operationId: getSimulateScenarios
x-operation-id-source: derived
components:
schemas:
SimulatorSetStatusRequest:
required:
- status
type: object
properties:
status:
enum:
- draft
- requirements_due
- pending
- active
- restricted
- rejected
- inactive
type: string
description: The status to set on the entity.
example: active
SimulatorRunScenarioResponse:
type: object
properties:
entity_id:
type: string
description: The ID of the entity.
example: ent_w4jelhppmfiufdnatam37wrfc4
scenario_id:
type: string
description: The ID of the scenario that was run.
example: go_active
scenario_name:
type: string
description: The name of the scenario that was run.
example: Go Active
previous_status:
type: string
description: The entity status before the scenario ran.
example: RequirementsDue
current_status:
type: string
description: The entity status after the scenario ran.
example: Active
requirements_due:
type: array
items:
type: string
example: individual.identification.document
description: Requirement fields applied by the scenario, if any.
SimulatorSetRequirementsDueResponse:
type: object
properties:
entity_id:
type: string
description: The ID of the entity.
example: ent_w4jelhppmfiufdnatam37wrfc4
previous_status:
type: string
description: The status before the update.
example: Active
current_status:
type: string
description: The status after the update.
example: requirements_due
requirements_due:
type: array
items:
type: string
example: individual.identification.document
description: The requirement fields that are now marked as due.
SimulatorScenario:
type: object
properties:
id:
type: string
description: The unique identifier of the scenario.
example: go_active
name:
type: string
description: Human-readable name of the scenario.
example: Go Active
description:
type: string
description: Description of what the scenario does.
example: Transitions the entity to active status.
action:
type: string
description: The action type performed by this scenario.
example: set_status
status:
type: string
description: The resulting entity status after the scenario runs. Empty string for non-status actions.
example: active
requirements_due:
type: array
items:
type: string
example: individual.identification.document
description: Requirement fields applied when the scenario runs, if any.
SimulatorSetStatusResponse:
type: object
properties:
entity_id:
type: string
description: The ID of the entity.
example: ent_w4jelhppmfiufdnatam37wrfc4
previous_status:
type: string
description: The status before the update.
example: Pending
current_status:
type: string
description: The status after the update.
example: Active
SimulatorErrorResponse:
type: object
properties:
error_codes:
type: array
items:
type: string
example: invalid_status
description: Error codes describing what went wrong.
SimulatorSetRequirementsDueRequest:
required:
- fields
type: object
properties:
fields:
type: array
items:
type: string
example: individual.identification.document
description: 'The requirement fields to mark as due. <br/>
Call the [List available requirements](/#tag/Onboarding-Simulator/paths/~1simulate~1requirements-due/get) endpoint for a list of valid values.
'
SimulatorAvailableRequirement:
type: object
properties:
field:
type: string
description: The public path of the requirement field.
example: individual.identification.document
type:
type: string
description: The data type of the field.
example: string
securitySchemes:
ApiPublicKey:
type: apiKey
description: "Public keys are for client-side authentication and supported only in JavaScript or native applications.\n \n#### Format\n\n- Sandbox – `pk_sbox_xxxxxxxxxxxxxxxxxxxxxxxxxx`\n\n- Production – `pk_xxxxxxxxxxxxxxxxxxxxxxxxxx`\n\nWhen specifying your public key, use the format `Bearer {{PublicApiKey}}`.\n"
name: Authorization
in: header
x-cko-type: publicKey
ApiSecretKey:
type: apiKey
description: 'You can pass your secret API key in the `Authorization` header of your requests for supported endpoints.
#### Format
- Sandbox – `sk_sbox_xxxxxxxxxxxxxxxxxxxxxxxxxx`
- Production – `sk_xxxxxxxxxxxxxxxxxxxxxxxxxx`
When specifying your secret key, use the format `Bearer {{SecretApiKey}}`.
```
curl --location --request POST ''https://{prefix}.api.checkout.com/{{path}}'' \
--header ''Content-Type: application/json'' \
--header ''Accept: application/json'' \
--header ''Authorization: Bearer {{SecretApiKey}}'' \
--data-raw ''{
"amount": 10000,
"currency": "USD",
"reference": "Visa-USD-Test",
...
}''
```
'
name: Authorization
in: header
x-cko-type: secretKey
OAuth:
type: oauth2
description: "Your OAuth credentials include an access key ID and an access key secret. They correspond to an OAuth 2.0 client ID and a client secret respectively. \n\nTo exchange these credentials for an access token, call the [Request an access token](/tag/access/POST/connect/token) endpoint. Authenticate using basic authentication, with your access key ID as the username and your access key secret as the password.\n\n| Environment | Authorization server |\n|---------------|------------------------------------------------------|\n| Sandbox | https://{prefix}.access.sandbox.checkout.com/connect/token |\n| Production | https://{prefix}.access.checkout.com/connect/token |\n\n```\ncurl --location 'https://{prefix}.access.checkout.com/connect/token' \\\n--header 'Content-Type: application/x-www-form-urlencoded' \\\n--data-urlencode 'grant_type=client_credentials' \\\n--data-urlencode 'client_id=ack_...' \\\n--data-urlencode 'client_secret=...' \n```\n\nThe token server returns a Bearer `access_token` in JSON Web Token (JWT) format. Use this token in the `Authorization` header of your API requests.\n\n```\ncurl --location --request POST 'https://{prefix}.api.checkout.com/{{path}}' \\\n--header 'Content-Type: application/json' \\\n--header 'Accept: application/json' \\\n--header 'Authorization: Bearer {{AccessToken}}' \\\n--data-raw '{\n \"amount\": 10000,\n \"currency\": \"USD\",\n \"reference\": \"Visa-USD-Test\",\n ...\n}'\n```\n\nThe `expires_in` field in the response indicates the validity period of your access token in seconds. When your token expires, you must request a new one.\n\nDepending on the Environment against which you're making your requests against you'll need to request the token from a different Authorization Server.\n\n| Environment | Authorization Server |\n|---------------|------------------------------------------------------|\n| Sandbox | https://{prefix}.access.sandbox.checkout.com/connect/token |\n| Production | https://{prefix}.access.checkout.com/connect/token |\n\nYour base URL `{prefix}` is unique. To learn how to retrieve your unique base URLs for the sandbox and production environments, see [API endpoints](https://www.checkout.com/docs/developer-resources/api/api-endpoints).\n"
flows:
clientCredentials:
tokenUrl: string
scopes:
vault: Access to all Vault resources
vault:apme-enrollment: Manage Apple Pay Domain Enrollment
vault:customers: Manage customers
vault:card-metadata: Read card metadata
vault:instruments: Create instruments
vault:network-tokens: Manage network tokens
vault:tokenization: Tokenize payment instruments
vault:real-time-account-updater: Access to real-time account updater
gateway: Access to all Gateway resources
gateway:payment: Request payments
gateway:payment-details: Get payment details
gateway:payment-authorizations: Increment authorizations
gateway:payment-voids: Void payments
gateway:payment-captures: Capture payments
gateway:payment-contexts: Manage payment contexts
gateway:payment-cancellations: Manage payment cancellations
gateway:payment-refunds: Refund payments
fx: Foreign exchange services
payouts:bank-details: Get bank details
sessions:app: App-based authentication
sessions:browser: Browser-based authentication
disputes: Access to all Disputes resources
disputes:view: View disputes
disputes:provide-evidence: Provide dispute evidence
disputes:accept: Accept disputes
disputes:scheme-files: Read dispute scheme files
accounts: Manage sub-entities
flow: Access to all Flow resources
flow:workflows: Manage workflows
flow:events: Retrieve events
flow:reflow: Manage workflows
files: Access to all Files resources
files:retrieve: Retrieve files
files:upload: Upload files
files:download: Download files
forward: Access to Forward api
forward:secrets: Manage secrets in Forward api
balances: Access to all Balances resources
balances:view: View balances
balances:top-up-instructions: Get top-up instructions
transfers: Access to all Transfers resources
transfers:view: View transfers
transfers:create: Create transfers
middleware: Access to all Middleware resources
middleware:merchants-secret: Allows merchant identity and Middleware token exchange from a secure execution environment
middleware:merchants-public: Allows merchant identity and Middleware token exchange from an insecure execution environment
payment-sessions: Access to all Payment Sessions resources
payments:search: Search payments
reports: Access to all Reports resources
reports:view: View reports
financial-actions: Access to all Financial actions resources
financial-actions:view: View financial actions
card-management: Access to all Card management resources
issuing:card-management-read: Gives access to card management endpoints with GET operations
issuing:card-management-write: Gives access to card management endpoints with POST/ PUT / DELETE operations
issuing:controls-read: Gives access to card control endpoints with GET operations
issuing:controls-write: Gives access to card control endpoints with POST/ PUT / DELETE operations
transactions: Access to all transactions resources
issuing:transactions-read: Gives access to get and search transactions
issuing:transactions-write: Gives access to simulate transactions for testing purposes
issuing-disputes: Access to Issuing disputes resources
issuing:disputes-read: Gives access to get disputes
issuing:disputes-write: Gives access to create and submit Issuing disputes
identity-verification: Access to all Identities endpoints
Payment Context: Read payment context
agentic:inventory: Manage agentic commerce inventory and reservations
SessionSecret:
type: apiKey
description: 'A base64 encoded value prefixed with `sek_` that gives access to client-side operations for a single authentication within the Sessions API. This value is returned as the `session_secret` when requesting a session.
'
name: Authorization
in: header
x-tagGroups:
- name: Set up
tags:
- Access
- name: Handle payments and payouts
tags:
- Payments
- Flow
- Payment Setups
- Payment Links
- Hosted Payments Page
- Forex
- Apple Pay
- Bacs Direct Debit
- Google Pay
- Transfers
- Balances
- name: Payment Context
tags:
- Payment Context
- name: Payment Methods
tags:
- Payment Methods
- name: Store and forward payment credentials
tags:
- Tokens
- Instruments
- Customers
- Forward
- name: Authentication
tags:
- Standalone
- name: Risk management
tags:
- Disputes
- name: Notifications
tags:
- Workflows
- name: Platforms
tags:
- Platforms
- Business details
- Payment instruments
- Payout schedules
- Reserve rules
- Onboarding Simulator
- name: Card issuing
tags:
- Cardholders
- Cards
- Controls
- Control profiles
- Control groups
- Cardholder access tokens
- Transactions
- Issuing disputes
- Card testing
- name: Identities
tags:
- Applicants
- Identity Verification
- AML Screening
- Face Authentication
- ID Document Verification
- Address Document Verification
- name: Reporting
tags:
- Reports
- Financial actions
- name: Metadata
tags:
- Card metadata
- name: Network Tokens
tags:
- Network Tokens
- name: Standalone Account Updater
tags:
- Standalone Account Updater
- name: Compliance requests
tags:
- Compliance requests
- name: Agentic Commerce
tags:
- Agentic Commerce Protocol
- Inventory