Can I use Checkout.com as a CLI?

Yes. KosmoKrator exposes a Checkout.com CLI through kosmo integrations:call and the provider shortcut command. Commands can return JSON for scripts, CI, and coding agents.

Can I expose Checkout.com through MCP?

Yes. The KosmoKrator MCP gateway can expose selected Checkout.com tools to clients such as Claude Code, Cursor, Codex, and other MCP-compatible tools.

Where are Checkout.com credentials stored?

Checkout.com credentials are configured in KosmoKrator's local integration settings and reused by CLI, Lua, and MCP gateway surfaces.

Can I deny write access for Checkout.com MCP tools?

Yes. Start the gateway with --write=deny for read-only clients, or use ask/allow only for trusted workspaces.

data

Checkout.com CLI for AI Agents

Use the Checkout.com CLI from KosmoKrator to call Checkout.com tools headlessly, return JSON, inspect schemas, and automate workflows from coding agents, scripts, and CI.

Checkout.com CLI Setup

Checkout.com can be configured headlessly with `kosmokrator integrations:configure checkout-com`.

Install, configure, and verify

# Install KosmoKrator first if it is not available on PATH.
curl -fsSL https://raw.githubusercontent.com/OpenCompanyApp/kosmokrator/main/install.sh | bash

# Configure and verify this integration.
kosmokrator integrations:configure checkout-com --set api_key="$CHECKOUT_COM_API_KEY" --enable --read allow --write ask --json
kosmokrator integrations:doctor checkout-com --json
kosmokrator integrations:status --json

Credentials

Authentication type: Bearer token bearer_token. Configure credentials once, then reuse the same stored profile from scripts, coding CLIs, Lua, and MCP.

Key	Env var	Type	Required	Label
`api_key`	`CHECKOUT_COM_API_KEY`	Secret `secret`	yes	API Key or Access Token

Command Patterns

The generic command is stable across every integration. The provider shortcut is shorter for humans.

Generic CLI call

kosmo integrations:call checkout-com.checkout_com_retrieve_updated_card_details '{"body":"example_body"}' --json

Provider shortcut

kosmo integrations:checkout-com checkout_com_retrieve_updated_card_details '{"body":"example_body"}' --json

Discovery

These commands return structured output for coding agents that need to inspect capabilities before choosing a function.

Discovery commands

kosmo integrations:docs checkout-com --json
kosmo integrations:docs checkout-com.checkout_com_retrieve_updated_card_details --json
kosmo integrations:schema checkout-com.checkout_com_retrieve_updated_card_details --json
kosmo integrations:search "Checkout.com" --json
kosmo integrations:list --json

Automation Contexts

The same configured command surface works in these environments. The command does not change unless the host wrapper, credentials, or permissions change.

CI Run integration calls from CI jobs with JSON output, explicit credentials, and predictable exit status. Cron Jobs Schedule repeatable integration workflows from cron while keeping credentials in KosmoKrator config. Shell Scripts Call integration functions from shell scripts with stable JSON input and output. Headless Automation Use KosmoKrator as a non-interactive integration runtime for local automations and wrappers. Coding Agents Let coding agents discover schemas and execute integration functions through CLI commands or MCP.

CLI Functions

Every function below can be called headlessly. Commands are highlighted, copyable, and scroll horizontally when payloads are long.

`checkout-com.checkout_com_retrieve_updated_card_details`

Retrieve updated card credentials. The following card schemes are supported: - Mastercard - Visa - American Express Official Checkout.com endpoint: POST /account-updater/cards.

Read read

Parameters: body

Generic call

kosmo integrations:call checkout-com.checkout_com_retrieve_updated_card_details '{"body":"example_body"}' --json

Shortcut

kosmo integrations:checkout-com checkout_com_retrieve_updated_card_details '{"body":"example_body"}' --json

`checkout-com.checkout_com_onboard_entity`

Onboard an entity so they can start using Checkout services. Official Checkout.com endpoint: POST /accounts/entities.

Read read

Parameters: accept, body

Generic call

kosmo integrations:call checkout-com.checkout_com_onboard_entity '{"accept":"example_accept","body":"example_body"}' --json

Shortcut

kosmo integrations:checkout-com checkout_com_onboard_entity '{"accept":"example_accept","body":"example_body"}' --json

`checkout-com.checkout_com_get_sub_entity_members`

Beta Retrieve information on all users of a sub-entity that has been invited through Hosted Onboarding. Only one user can be invited to onboard the sub-entity through Hosted Onboarding. To enable the Hosted Onboarding feature, contact your Account Manager. Official Checkout.com endpoint: GET /accounts/entities/{entityId}/members.

Read read

Parameters: entity_id

Generic call

kosmo integrations:call checkout-com.checkout_com_get_sub_entity_members '{"entity_id":"example_entity_id"}' --json

Shortcut

kosmo integrations:checkout-com checkout_com_get_sub_entity_members '{"entity_id":"example_entity_id"}' --json

`checkout-com.checkout_com_reinvite_sub_entity_members`

Beta Resend an invitation to the user of a sub-entity. The user will receive another email to continue their Hosted Onboarding application. An invitation can only be resent to the user originally registered to the sub-entity. To enable the Hosted Onboarding feature, contact your Account Manager. Official Checkout.com endpoint: PUT /accounts/entities/{entityId}/members/{userId}.

Read read

Parameters: entity_id, user_id, body

Generic call

kosmo integrations:call checkout-com.checkout_com_reinvite_sub_entity_members '{"entity_id":"example_entity_id","user_id":"example_user_id","body":"example_body"}' --json

Shortcut

kosmo integrations:checkout-com checkout_com_reinvite_sub_entity_members '{"entity_id":"example_entity_id","user_id":"example_user_id","body":"example_body"}' --json

`checkout-com.checkout_com_get_platforms_payment_instrument`

Retrieve the details of a specific payment instrument used for sub-entity payouts. Official Checkout.com endpoint: GET /accounts/entities/{entityId}/payment-instruments/{id}.

Read read

Parameters: entity_id, id

Generic call

kosmo integrations:call checkout-com.checkout_com_get_platforms_payment_instrument '{"entity_id":"example_entity_id","id":"example_id"}' --json

Shortcut

kosmo integrations:checkout-com checkout_com_get_platforms_payment_instrument '{"entity_id":"example_entity_id","id":"example_id"}' --json

`checkout-com.checkout_com_update_platforms_payment_instrument`

Set an existing payment instrument as default. This will make it the destination instrument when a scheduled payout is made. You can also update the label of a payment instrument. Official Checkout.com endpoint: PATCH /accounts/entities/{entityId}/payment-instruments/{id}.

Write write

Parameters: entity_id, id, body

Generic call

kosmo integrations:call checkout-com.checkout_com_update_platforms_payment_instrument '{"entity_id":"example_entity_id","id":"example_id","body":"example_body"}' --json

Shortcut

kosmo integrations:checkout-com checkout_com_update_platforms_payment_instrument '{"entity_id":"example_entity_id","id":"example_id","body":"example_body"}' --json

`checkout-com.checkout_com_get_reserve_rule`

Retrieve the details of a specific reserve rule. Official Checkout.com endpoint: GET /accounts/entities/{entityId}/reserve-rules/{id}.

Read read

Parameters: entity_id, id

Generic call

kosmo integrations:call checkout-com.checkout_com_get_reserve_rule '{"entity_id":"example_entity_id","id":"example_id"}' --json

Shortcut

kosmo integrations:checkout-com checkout_com_get_reserve_rule '{"entity_id":"example_entity_id","id":"example_id"}' --json

`checkout-com.checkout_com_update_reserve_rule`

Update an upcoming reserve rule. Only reserve rules that have never been active can be updated. Official Checkout.com endpoint: PUT /accounts/entities/{entityId}/reserve-rules/{id}.

Write write

Parameters: entity_id, id, if_match, body

Generic call

kosmo integrations:call checkout-com.checkout_com_update_reserve_rule '{"entity_id":"example_entity_id","id":"example_id","if_match":"example_if_match","body":"example_body"}' --json

Shortcut

kosmo integrations:checkout-com checkout_com_update_reserve_rule '{"entity_id":"example_entity_id","id":"example_id","if_match":"example_if_match","body":"example_body"}' --json

`checkout-com.checkout_com_get_entity_details`

Use this endpoint to retrieve an entity and its full details. Official Checkout.com endpoint: GET /accounts/entities/{id}.

Read read

Parameters: accept, id

Generic call

kosmo integrations:call checkout-com.checkout_com_get_entity_details '{"accept":"example_accept","id":"example_id"}' --json

Shortcut

kosmo integrations:checkout-com checkout_com_get_entity_details '{"accept":"example_accept","id":"example_id"}' --json

`checkout-com.checkout_com_update_entity_details`

Update an entity. **Note:** when you update a entity we may conduct further due diligence checks when necessary. During these checks, your payment capabilities will remain the same. Official Checkout.com endpoint: PUT /accounts/entities/{id}.

Write write

Parameters: accept, id, body

Generic call

kosmo integrations:call checkout-com.checkout_com_update_entity_details '{"accept":"example_accept","id":"example_id","body":"example_body"}' --json

Shortcut

kosmo integrations:checkout-com checkout_com_update_entity_details '{"accept":"example_accept","id":"example_id","body":"example_body"}' --json

`checkout-com.checkout_com_add_platforms_payment_instrument`

Create a bank account payment instrument for your sub-entity. You can use this payment instrument as a payout destination. Official Checkout.com endpoint: POST /accounts/entities/{id}/payment-instruments.

Write write

Parameters: id, body

Generic call

kosmo integrations:call checkout-com.checkout_com_add_platforms_payment_instrument '{"id":"example_id","body":"example_body"}' --json

Shortcut

kosmo integrations:checkout-com checkout_com_add_platforms_payment_instrument '{"id":"example_id","body":"example_body"}' --json

`checkout-com.checkout_com_query_platforms_payment_instruments`

Fetch all of the payment instruments for a sub-entity. You can filter by `status` to identify `verified` instruments that are ready to be used for Payouts. Official Checkout.com endpoint: GET /accounts/entities/{id}/payment-instruments.

Read read

Parameters: id, status

Generic call

kosmo integrations:call checkout-com.checkout_com_query_platforms_payment_instruments '{"id":"example_id","status":"example_status"}' --json

Shortcut

kosmo integrations:checkout-com checkout_com_query_platforms_payment_instruments '{"id":"example_id","status":"example_status"}' --json

`checkout-com.checkout_com_get_sub_entitys_payout_schedule`

You can schedule when your sub-entities receive their funds using our Platforms solution. Use this endpoint to retrieve information about a sub-entity's schedule. Official Checkout.com endpoint: GET /accounts/entities/{id}/payout-schedules.

Read read

Parameters: id

Generic call

kosmo integrations:call checkout-com.checkout_com_get_sub_entitys_payout_schedule '{"id":"example_id"}' --json

Shortcut

kosmo integrations:checkout-com checkout_com_get_sub_entitys_payout_schedule '{"id":"example_id"}' --json

`checkout-com.checkout_com_put_sub_entitys_payout_schedule`

You can schedule when your sub-entities receive their funds using our Platforms solution. Use this endpoint to update a sub-entity's schedule. Official Checkout.com endpoint: PUT /accounts/entities/{id}/payout-schedules.

Read read

Parameters: id, body

Generic call

kosmo integrations:call checkout-com.checkout_com_put_sub_entitys_payout_schedule '{"id":"example_id","body":"example_body"}' --json

Shortcut

kosmo integrations:checkout-com checkout_com_put_sub_entitys_payout_schedule '{"id":"example_id","body":"example_body"}' --json

`checkout-com.checkout_com_add_reserve_rule`

Create a sub-entity reserve rule. Official Checkout.com endpoint: POST /accounts/entities/{id}/reserve-rules.

Write write

Parameters: id, body

Generic call

kosmo integrations:call checkout-com.checkout_com_add_reserve_rule '{"id":"example_id","body":"example_body"}' --json

Shortcut

kosmo integrations:checkout-com checkout_com_add_reserve_rule '{"id":"example_id","body":"example_body"}' --json

`checkout-com.checkout_com_query_reserve_rules`

Fetch all of the reserve rules for a sub-entity. Official Checkout.com endpoint: GET /accounts/entities/{id}/reserve-rules.

Read read

Parameters: id

Generic call

kosmo integrations:call checkout-com.checkout_com_query_reserve_rules '{"id":"example_id"}' --json

Shortcut

kosmo integrations:checkout-com checkout_com_query_reserve_rules '{"id":"example_id"}' --json

`checkout-com.checkout_com_delegate_payment`

Create a delegated payment token Official Checkout.com endpoint: POST /agentic_commerce/delegate_payment.

Read read

Parameters: signature, timestamp, cko_idempotency_key, api_version, body

Generic call

kosmo integrations:call checkout-com.checkout_com_delegate_payment '{"signature":"example_signature","timestamp":"example_timestamp","cko_idempotency_key":"example_cko_idempotency_key","api_version":"example_api_version","body":"example_body"}' --json

Shortcut

kosmo integrations:checkout-com checkout_com_delegate_payment '{"signature":"example_signature","timestamp":"example_timestamp","cko_idempotency_key":"example_cko_idempotency_key","api_version":"example_api_version","body":"example_body"}' --json

`checkout-com.checkout_com_create_aml_verification`

Beta Create an [AML screening](https://www.checkout.com/docs/business-operations/manage-identities/screen-aml-databases). If the request is successful, you receive a `201 Created` response with the AML screening resource. Official Checkout.com endpoint: POST /aml-verifications.

Write write

Parameters: body

Generic call

kosmo integrations:call checkout-com.checkout_com_create_aml_verification '{"body":"example_body"}' --json

Shortcut

kosmo integrations:checkout-com checkout_com_create_aml_verification '{"body":"example_body"}' --json

`checkout-com.checkout_com_retrieve_aml_screening`

Get the detailed result of an [AML screening](https://www.checkout.com/docs/business-operations/manage-identities/screen-aml-databases). Official Checkout.com endpoint: GET /aml-verifications/{aml_verification_id}.

Read read

Parameters: aml_verification_id

Generic call

kosmo integrations:call checkout-com.checkout_com_retrieve_aml_screening '{"aml_verification_id":"example_aml_verification_id"}' --json

Shortcut

kosmo integrations:checkout-com checkout_com_retrieve_aml_screening '{"aml_verification_id":"example_aml_verification_id"}' --json

`checkout-com.checkout_com_upload_apple_pay_certificate`

Upload a payment processing certificate. This will allow you to start processing payments via Apple Pay. Official Checkout.com endpoint: POST /applepay/certificates.

Read read

Parameters: body

Generic call

kosmo integrations:call checkout-com.checkout_com_upload_apple_pay_certificate '{"body":"example_body"}' --json

Shortcut

kosmo integrations:checkout-com checkout_com_upload_apple_pay_certificate '{"body":"example_body"}' --json

`checkout-com.checkout_com_apple_pay_enroll_merchant`

Enroll a domain to the Apple Pay Service Official Checkout.com endpoint: POST /applepay/enrollments.

Read read

Parameters: body

Generic call

kosmo integrations:call checkout-com.checkout_com_apple_pay_enroll_merchant '{"body":"example_body"}' --json

Shortcut

kosmo integrations:checkout-com checkout_com_apple_pay_enroll_merchant '{"body":"example_body"}' --json

`checkout-com.checkout_com_generate_apple_pay_signing_request`

Generate a certificate signing request. You'll need to upload this to your Apple Developer account to download a payment processing certificate. Official Checkout.com endpoint: POST /applepay/signing-requests.

Read read

Parameters: body

Generic call

kosmo integrations:call checkout-com.checkout_com_generate_apple_pay_signing_request '{"body":"example_body"}' --json

Shortcut

kosmo integrations:checkout-com checkout_com_generate_apple_pay_signing_request '{"body":"example_body"}' --json

`checkout-com.checkout_com_get_entity_balances`

Use this endpoint to retrieve balances for each sub-account in an entity. *Note:* The sub-account is referred to as _currency account_ in the API. Official Checkout.com endpoint: GET /balances/{id}.

Read read

Parameters: id, query, with_currency_account_id

Generic call

kosmo integrations:call checkout-com.checkout_com_get_entity_balances '{"id":"example_id","query":"example_query","with_currency_account_id":true}' --json

Shortcut

kosmo integrations:checkout-com checkout_com_get_entity_balances '{"id":"example_id","query":"example_query","with_currency_account_id":true}' --json

`checkout-com.checkout_com_compliance_requests_get_compliance_request`

Retrieve an existing compliance request by payment ID. Official Checkout.com endpoint: GET /compliance-requests/{payment_id}.

Read read

Parameters: payment_id

Generic call

kosmo integrations:call checkout-com.checkout_com_compliance_requests_get_compliance_request '{"payment_id":"example_payment_id"}' --json

Shortcut

kosmo integrations:checkout-com checkout_com_compliance_requests_get_compliance_request '{"payment_id":"example_payment_id"}' --json

`checkout-com.checkout_com_compliance_requests_submit_compliance_request_response`

Submit a response to a compliance request. Official Checkout.com endpoint: POST /compliance-requests/{payment_id}.

Write write

Parameters: payment_id, body

Generic call

kosmo integrations:call checkout-com.checkout_com_compliance_requests_submit_compliance_request_response '{"payment_id":"example_payment_id","body":"example_body"}' --json

Shortcut

kosmo integrations:checkout-com checkout_com_compliance_requests_submit_compliance_request_response '{"payment_id":"example_payment_id","body":"example_body"}' --json

`checkout-com.checkout_com_request_an_access_token`

OAuth endpoint to exchange your access key ID and access key secret for an access token. Official Checkout.com endpoint: POST /connect/token.

Read read

Parameters: body

Generic call

kosmo integrations:call checkout-com.checkout_com_request_an_access_token '{"body":"example_body"}' --json

Shortcut

kosmo integrations:checkout-com checkout_com_request_an_access_token '{"body":"example_body"}' --json

`checkout-com.checkout_com_create_customer`

Store a customer's details in a customer object to reuse in future payments. When creating a customer, you can link payment instruments – the customer `id` returned can be passed as a source when making a payment. **NOTE:** Specify a `default` instrument, otherwise the `instruments` array will not be saved on creation. Official Checkout.com endpoint: POST /customers.

Write write

Parameters: body

Generic call

kosmo integrations:call checkout-com.checkout_com_create_customer '{"body":"example_body"}' --json

Shortcut

kosmo integrations:checkout-com checkout_com_create_customer '{"body":"example_body"}' --json

`checkout-com.checkout_com_get_customer_details`

Returns the details of a customer and their payment instruments. Official Checkout.com endpoint: GET /customers/{identifier}.

Read read

Parameters: identifier

Generic call

kosmo integrations:call checkout-com.checkout_com_get_customer_details '{"identifier":"example_identifier"}' --json

Shortcut

kosmo integrations:checkout-com checkout_com_get_customer_details '{"identifier":"example_identifier"}' --json

`checkout-com.checkout_com_update_customer_details`

Update the details of a customer and link payment instruments to them. Official Checkout.com endpoint: PATCH /customers/{identifier}.

Write write

Parameters: identifier, body

Generic call

kosmo integrations:call checkout-com.checkout_com_update_customer_details '{"identifier":"example_identifier","body":"example_body"}' --json

Shortcut

kosmo integrations:checkout-com checkout_com_update_customer_details '{"identifier":"example_identifier","body":"example_body"}' --json

`checkout-com.checkout_com_delete_customer`

Delete a customer and all of their linked payment instruments. Official Checkout.com endpoint: DELETE /customers/{identifier}.

Write write

Parameters: identifier

Generic call

kosmo integrations:call checkout-com.checkout_com_delete_customer '{"identifier":"example_identifier"}' --json

Shortcut

kosmo integrations:checkout-com checkout_com_delete_customer '{"identifier":"example_identifier"}' --json

`checkout-com.checkout_com_get_disputes`

Returns a list of all disputes against your business. The results will be returned in reverse chronological order, showing the last modified dispute (for example, where you've recently added a piece of evidence) first. You can use the optional parameters below to skip or limit results. Official Checkout.com endpoint: GET /disputes.

Read read

Parameters: limit, skip, from, to, id, entity_ids, sub_entity_ids, processing_channel_ids, segment_ids, statuses, payment_id, payment_reference, payment_arn, payment_mcc, this_channel_only

Generic call

kosmo integrations:call checkout-com.checkout_com_get_disputes '{"limit":1,"skip":1,"from":"example_from","to":"example_to","id":"example_id","entity_ids":"example_entity_ids","sub_entity_ids":"example_sub_entity_ids","processing_channel_ids":"example_processing_channel_ids"}' --json

Shortcut

kosmo integrations:checkout-com checkout_com_get_disputes '{"limit":1,"skip":1,"from":"example_from","to":"example_to","id":"example_id","entity_ids":"example_entity_ids","sub_entity_ids":"example_sub_entity_ids","processing_channel_ids":"example_processing_channel_ids"}' --json

`checkout-com.checkout_com_get_dispute_details`

Returns all the details of a dispute using the dispute identifier. Official Checkout.com endpoint: GET /disputes/{dispute_id}.

Read read

Parameters: dispute_id

Generic call

kosmo integrations:call checkout-com.checkout_com_get_dispute_details '{"dispute_id":"example_dispute_id"}' --json

Shortcut

kosmo integrations:checkout-com checkout_com_get_dispute_details '{"dispute_id":"example_dispute_id"}' --json

`checkout-com.checkout_com_accept_dispute`

If a dispute is legitimate, you can choose to accept it. This will close it for you and remove it from your list of open disputes. There are no further financial implications. Official Checkout.com endpoint: POST /disputes/{dispute_id}/accept.

Read read

Parameters: dispute_id, body

Generic call

kosmo integrations:call checkout-com.checkout_com_accept_dispute '{"dispute_id":"example_dispute_id","body":"example_body"}' --json

Shortcut

kosmo integrations:checkout-com checkout_com_accept_dispute '{"dispute_id":"example_dispute_id","body":"example_body"}' --json

`checkout-com.checkout_com_provide_dispute_evidence`

Provide dispute evidence Official Checkout.com endpoint: PUT /disputes/{dispute_id}/evidence.

Read read

Parameters: dispute_id, body

Generic call

kosmo integrations:call checkout-com.checkout_com_provide_dispute_evidence '{"dispute_id":"example_dispute_id","body":"example_body"}' --json

Shortcut

kosmo integrations:checkout-com checkout_com_provide_dispute_evidence '{"dispute_id":"example_dispute_id","body":"example_body"}' --json

`checkout-com.checkout_com_get_dispute_evidence`

Retrieves a list of the evidence submitted in response to a specific dispute. Official Checkout.com endpoint: GET /disputes/{dispute_id}/evidence.

Read read

Parameters: dispute_id

Generic call

kosmo integrations:call checkout-com.checkout_com_get_dispute_evidence '{"dispute_id":"example_dispute_id"}' --json

Shortcut

kosmo integrations:checkout-com checkout_com_get_dispute_evidence '{"dispute_id":"example_dispute_id"}' --json

`checkout-com.checkout_com_submit_dispute_evidence`

With this final request, you can submit the evidence that you have previously provided. Make sure you have provided all the relevant information before using this request. You will not be able to amend your evidence once you have submitted it. Official Checkout.com endpoint: POST /disputes/{dispute_id}/evidence.

Write write

Parameters: dispute_id, body

Generic call

kosmo integrations:call checkout-com.checkout_com_submit_dispute_evidence '{"dispute_id":"example_dispute_id","body":"example_body"}' --json

Shortcut

kosmo integrations:checkout-com checkout_com_submit_dispute_evidence '{"dispute_id":"example_dispute_id","body":"example_body"}' --json

`checkout-com.checkout_com_submit_dispute_arbitration_evidence`

Submits the previously provided arbitration evidence to the scheme. You cannot amend evidence after you submit with this endpoint. Ensure you have provided all of the required information. Official Checkout.com endpoint: POST /disputes/{dispute_id}/evidence/arbitration.

Write write

Parameters: dispute_id, body

Generic call

kosmo integrations:call checkout-com.checkout_com_submit_dispute_arbitration_evidence '{"dispute_id":"example_dispute_id","body":"example_body"}' --json

Shortcut

kosmo integrations:checkout-com checkout_com_submit_dispute_arbitration_evidence '{"dispute_id":"example_dispute_id","body":"example_body"}' --json

`checkout-com.checkout_com_get_dispute_submitted_arbitration_evidence`

Retrieves the unique identifier of the PDF file containing all of the evidence submitted to escalate the dispute to arbitration. To retrieve the file's download link, call the `GET /files/{file_id}` [endpoint](https://api-reference.checkout.com/#operation/getFileInformation) with the returned file ID. Official Checkout.com endpoint: GET /disputes/{dispute_id}/evidence/arbitration/submitted.

Read read

Parameters: dispute_id

Generic call

kosmo integrations:call checkout-com.checkout_com_get_dispute_submitted_arbitration_evidence '{"dispute_id":"example_dispute_id"}' --json

Shortcut

kosmo integrations:checkout-com checkout_com_get_dispute_submitted_arbitration_evidence '{"dispute_id":"example_dispute_id"}' --json

`checkout-com.checkout_com_get_dispute_submitted_evidence`

Retrieves the unique identifier of the PDF file containing all the evidence submitted to represent the dispute case. To retrieve the file's download link, call the `GET /files/{file_id}` [endpoint](https://api-reference.checkout.com/#operation/getFileInformation) with the returned file ID. Evidence submitted before February 2024 cannot be retrieved using this endpoint. Official Checkout.com endpoint: GET /disputes/{dispute_id}/evidence/submitted.

Read read

Parameters: dispute_id

Generic call

kosmo integrations:call checkout-com.checkout_com_get_dispute_submitted_evidence '{"dispute_id":"example_dispute_id"}' --json

Shortcut

kosmo integrations:checkout-com checkout_com_get_dispute_submitted_evidence '{"dispute_id":"example_dispute_id"}' --json

`checkout-com.checkout_com_get_dispute_scheme_files`

Returns all of the scheme files of a dispute using the dispute identifier. Currently available only for VISA disputes. Official Checkout.com endpoint: GET /disputes/{dispute_id}/schemefiles.

Read read

Parameters: dispute_id

Generic call

kosmo integrations:call checkout-com.checkout_com_get_dispute_scheme_files '{"dispute_id":"example_dispute_id"}' --json

Shortcut

kosmo integrations:checkout-com checkout_com_get_dispute_scheme_files '{"dispute_id":"example_dispute_id"}' --json

`checkout-com.checkout_com_upload_a_file`

Upload a file Official Checkout.com endpoint: POST /entities/{entityId}/files.

Read read

Parameters: entity_id, body

Generic call

kosmo integrations:call checkout-com.checkout_com_upload_a_file '{"entity_id":"example_entity_id","body":"example_body"}' --json

Shortcut

kosmo integrations:checkout-com checkout_com_upload_a_file '{"entity_id":"example_entity_id","body":"example_body"}' --json

`checkout-com.checkout_com_retrieve_a_file`

Retrieve information about a previously uploaded file. Please note that the sub-domain – https://files.checkout.com – is slightly different to Checkout.com's other endpoints. See the documentation for more information. Official Checkout.com endpoint: GET /entities/{entityId}/files/{fileId}.

Read read

Parameters: entity_id, file_id

Generic call

kosmo integrations:call checkout-com.checkout_com_retrieve_a_file '{"entity_id":"example_entity_id","file_id":"example_file_id"}' --json

Shortcut

kosmo integrations:checkout-com checkout_com_retrieve_a_file '{"entity_id":"example_entity_id","file_id":"example_file_id"}' --json

`checkout-com.checkout_com_create_face_authentication`

Create a face authentication Official Checkout.com endpoint: POST /face-authentications.

Write write

Parameters: body

Generic call

kosmo integrations:call checkout-com.checkout_com_create_face_authentication '{"body":"example_body"}' --json

Shortcut

kosmo integrations:checkout-com checkout_com_create_face_authentication '{"body":"example_body"}' --json

`checkout-com.checkout_com_retrieve_face_authentication`

Beta Get the details of a [face authentication](https://www.checkout.com/docs/business-operations/manage-identities/authenticate-with-biometrics). Official Checkout.com endpoint: GET /face-authentications/{face_authentication_id}.

Read read

Parameters: face_authentication_id

Generic call

kosmo integrations:call checkout-com.checkout_com_retrieve_face_authentication '{"face_authentication_id":"example_face_authentication_id"}' --json

Shortcut

kosmo integrations:checkout-com checkout_com_retrieve_face_authentication '{"face_authentication_id":"example_face_authentication_id"}' --json

`checkout-com.checkout_com_anonymize_face_authentication`

Beta Remove the personal data in a [face authentication](https://www.checkout.com/docs/business-operations/manage-identities/authenticate-with-biometrics). Official Checkout.com endpoint: POST /face-authentications/{face_authentication_id}/anonymize.

Read read

Parameters: face_authentication_id, body

Generic call

kosmo integrations:call checkout-com.checkout_com_anonymize_face_authentication '{"face_authentication_id":"example_face_authentication_id","body":"example_body"}' --json

Shortcut

kosmo integrations:checkout-com checkout_com_anonymize_face_authentication '{"face_authentication_id":"example_face_authentication_id","body":"example_body"}' --json

`checkout-com.checkout_com_create_fav_attempt`

Create a face authentication attempt Official Checkout.com endpoint: POST /face-authentications/{face_authentication_id}/attempts.

Write write

Parameters: face_authentication_id, body

Generic call

kosmo integrations:call checkout-com.checkout_com_create_fav_attempt '{"face_authentication_id":"example_face_authentication_id","body":"example_body"}' --json

Shortcut

kosmo integrations:checkout-com checkout_com_create_fav_attempt '{"face_authentication_id":"example_face_authentication_id","body":"example_body"}' --json

`checkout-com.checkout_com_list_fav_attempts`

Beta Get the details of all attempts for a specific [face authentication](https://www.checkout.com/docs/business-operations/manage-identities/authenticate-with-biometrics). Official Checkout.com endpoint: GET /face-authentications/{face_authentication_id}/attempts.

Read read

Parameters: face_authentication_id

Generic call

kosmo integrations:call checkout-com.checkout_com_list_fav_attempts '{"face_authentication_id":"example_face_authentication_id"}' --json

Shortcut

kosmo integrations:checkout-com checkout_com_list_fav_attempts '{"face_authentication_id":"example_face_authentication_id"}' --json

`checkout-com.checkout_com_get_fav_attempt`

Beta Get the details of a specific attempt for a [face authentication](https://www.checkout.com/docs/business-operations/manage-identities/authenticate-with-biometrics). Official Checkout.com endpoint: GET /face-authentications/{face_authentication_id}/attempts/{attempt_id}.

Read read

Parameters: face_authentication_id, attempt_id

Generic call

kosmo integrations:call checkout-com.checkout_com_get_fav_attempt '{"face_authentication_id":"example_face_authentication_id","attempt_id":"example_attempt_id"}' --json

Shortcut

kosmo integrations:checkout-com checkout_com_get_fav_attempt '{"face_authentication_id":"example_face_authentication_id","attempt_id":"example_attempt_id"}' --json

`checkout-com.checkout_com_upload_file`

Upload a file to use as evidence in a dispute. Your file must be in either JPEG/JPG, PNG or PDF format, and be no larger than 4MB. Official Checkout.com endpoint: POST /files.

Read read

Parameters: body

Generic call

kosmo integrations:call checkout-com.checkout_com_upload_file '{"body":"example_body"}' --json

Shortcut

kosmo integrations:checkout-com checkout_com_upload_file '{"body":"example_body"}' --json

`checkout-com.checkout_com_get_file_information`

Retrieve information about a file that was previously uploaded. Official Checkout.com endpoint: GET /files/{file_id}.

Read read

Parameters: file_id

Generic call

kosmo integrations:call checkout-com.checkout_com_get_file_information '{"file_id":"example_file_id"}' --json

Shortcut

kosmo integrations:checkout-com checkout_com_get_file_information '{"file_id":"example_file_id"}' --json

`checkout-com.checkout_com_get_financial_actions`

Returns the list of financial actions and their details. Official Checkout.com endpoint: GET /financial-actions.

Read read

Parameters: payment_id, action_id, limit, pagination_token

Generic call

kosmo integrations:call checkout-com.checkout_com_get_financial_actions '{"payment_id":"example_payment_id","action_id":"example_action_id","limit":1,"pagination_token":"example_pagination_token"}' --json

Shortcut

kosmo integrations:checkout-com checkout_com_get_financial_actions '{"payment_id":"example_payment_id","action_id":"example_action_id","limit":1,"pagination_token":"example_pagination_token"}' --json

`checkout-com.checkout_com_get_all_workflows`

Get all workflows Official Checkout.com endpoint: GET /workflows.

Read read

Parameters: none

Generic call

kosmo integrations:call checkout-com.checkout_com_get_all_workflows '{}' --json

Shortcut

kosmo integrations:checkout-com checkout_com_get_all_workflows '{}' --json

`checkout-com.checkout_com_add_workflow`

Add a new workflow Official Checkout.com endpoint: POST /workflows.

Write write

Parameters: body

Generic call

kosmo integrations:call checkout-com.checkout_com_add_workflow '{"body":"example_body"}' --json

Shortcut

kosmo integrations:checkout-com checkout_com_add_workflow '{"body":"example_body"}' --json

`checkout-com.checkout_com_get_workflow`

Get the details of a workflow Official Checkout.com endpoint: GET /workflows/{workflowId}.

Read read

Parameters: workflow_id

Generic call

kosmo integrations:call checkout-com.checkout_com_get_workflow '{"workflow_id":"example_workflow_id"}' --json

Shortcut

kosmo integrations:checkout-com checkout_com_get_workflow '{"workflow_id":"example_workflow_id"}' --json

`checkout-com.checkout_com_remove_workflow`

Removes a workflow so it is no longer being executed. Actions of already executed workflows will be still processed. Official Checkout.com endpoint: DELETE /workflows/{workflowId}.

Write write

Parameters: workflow_id

Generic call

kosmo integrations:call checkout-com.checkout_com_remove_workflow '{"workflow_id":"example_workflow_id"}' --json

Shortcut

kosmo integrations:checkout-com checkout_com_remove_workflow '{"workflow_id":"example_workflow_id"}' --json

`checkout-com.checkout_com_patch_workflow`

Update a workflow. Official Checkout.com endpoint: PATCH /workflows/{workflowId}.

Read read

Parameters: workflow_id, body

Generic call

kosmo integrations:call checkout-com.checkout_com_patch_workflow '{"workflow_id":"example_workflow_id","body":"example_body"}' --json

Shortcut

kosmo integrations:checkout-com checkout_com_patch_workflow '{"workflow_id":"example_workflow_id","body":"example_body"}' --json

`checkout-com.checkout_com_add_workflow_action`

Adds a workflow action. Actions determine what the workflow will do when it is triggered. Official Checkout.com endpoint: POST /workflows/{workflowId}/actions.

Write write

Parameters: workflow_id, body

Generic call

kosmo integrations:call checkout-com.checkout_com_add_workflow_action '{"workflow_id":"example_workflow_id","body":"example_body"}' --json

Shortcut

kosmo integrations:checkout-com checkout_com_add_workflow_action '{"workflow_id":"example_workflow_id","body":"example_body"}' --json

`checkout-com.checkout_com_update_workflow_action`

Update a workflow action. Official Checkout.com endpoint: PUT /workflows/{workflowId}/actions/{workflowActionId}.

Write write

Parameters: workflow_id, workflow_action_id, body

Generic call

kosmo integrations:call checkout-com.checkout_com_update_workflow_action '{"workflow_id":"example_workflow_id","workflow_action_id":"example_workflow_action_id","body":"example_body"}' --json

Shortcut

kosmo integrations:checkout-com checkout_com_update_workflow_action '{"workflow_id":"example_workflow_id","workflow_action_id":"example_workflow_action_id","body":"example_body"}' --json

`checkout-com.checkout_com_remove_workflow_action`

Removes a workflow action. Actions determine what the workflow will do when it is triggered. Official Checkout.com endpoint: DELETE /workflows/{workflowId}/actions/{workflowActionId}.

Write write

Parameters: workflow_id, workflow_action_id

Generic call

kosmo integrations:call checkout-com.checkout_com_remove_workflow_action '{"workflow_id":"example_workflow_id","workflow_action_id":"example_workflow_action_id"}' --json

Shortcut

kosmo integrations:checkout-com checkout_com_remove_workflow_action '{"workflow_id":"example_workflow_id","workflow_action_id":"example_workflow_action_id"}' --json

`checkout-com.checkout_com_add_workflow_condition`

Adds a workflow condition. Conditions determine when the workflow will trigger. Official Checkout.com endpoint: POST /workflows/{workflowId}/conditions.

Write write

Parameters: workflow_id, body

Generic call

kosmo integrations:call checkout-com.checkout_com_add_workflow_condition '{"workflow_id":"example_workflow_id","body":"example_body"}' --json

Shortcut

kosmo integrations:checkout-com checkout_com_add_workflow_condition '{"workflow_id":"example_workflow_id","body":"example_body"}' --json

`checkout-com.checkout_com_update_workflow_condition`

Update a workflow condition. Official Checkout.com endpoint: PUT /workflows/{workflowId}/conditions/{workflowConditionId}.

Write write

Parameters: workflow_id, workflow_condition_id, body

Generic call

kosmo integrations:call checkout-com.checkout_com_update_workflow_condition '{"workflow_id":"example_workflow_id","workflow_condition_id":"example_workflow_condition_id","body":"example_body"}' --json

Shortcut

kosmo integrations:checkout-com checkout_com_update_workflow_condition '{"workflow_id":"example_workflow_id","workflow_condition_id":"example_workflow_condition_id","body":"example_body"}' --json

`checkout-com.checkout_com_remove_workflow_condition`

Removes a workflow condition. Conditions determine when the workflow will trigger. Official Checkout.com endpoint: DELETE /workflows/{workflowId}/conditions/{workflowConditionId}.

Write write

Parameters: workflow_id, workflow_condition_id

Generic call

kosmo integrations:call checkout-com.checkout_com_remove_workflow_condition '{"workflow_id":"example_workflow_id","workflow_condition_id":"example_workflow_condition_id"}' --json

Shortcut

kosmo integrations:checkout-com checkout_com_remove_workflow_condition '{"workflow_id":"example_workflow_id","workflow_condition_id":"example_workflow_condition_id"}' --json

`checkout-com.checkout_com_test_workflow`

Validate a workflow in our Sandbox environment. Official Checkout.com endpoint: POST /workflows/{workflowId}/test.

Write write

Parameters: workflow_id, body

Generic call

kosmo integrations:call checkout-com.checkout_com_test_workflow '{"workflow_id":"example_workflow_id","body":"example_body"}' --json

Shortcut

kosmo integrations:checkout-com checkout_com_test_workflow '{"workflow_id":"example_workflow_id","body":"example_body"}' --json

`checkout-com.checkout_com_get_event_types`

Get a list of sources and their events for building new workflows Official Checkout.com endpoint: GET /workflows/event-types.

Read read

Parameters: none

Generic call

kosmo integrations:call checkout-com.checkout_com_get_event_types '{}' --json

Shortcut

kosmo integrations:checkout-com checkout_com_get_event_types '{}' --json

`checkout-com.checkout_com_get_workflow_event`

Get the details of an event Official Checkout.com endpoint: GET /workflows/events/{eventId}.

Read read

Parameters: event_id

Generic call

kosmo integrations:call checkout-com.checkout_com_get_workflow_event '{"event_id":"example_event_id"}' --json

Shortcut

kosmo integrations:checkout-com checkout_com_get_workflow_event '{"event_id":"example_event_id"}' --json

`checkout-com.checkout_com_get_workflow_action_invocations`

Get the details of a workflow action executed for the specified event. Official Checkout.com endpoint: GET /workflows/events/{eventId}/actions/{workflowActionId}.

Read read

Parameters: event_id, workflow_action_id

Generic call

kosmo integrations:call checkout-com.checkout_com_get_workflow_action_invocations '{"event_id":"example_event_id","workflow_action_id":"example_workflow_action_id"}' --json

Shortcut

kosmo integrations:checkout-com checkout_com_get_workflow_action_invocations '{"event_id":"example_event_id","workflow_action_id":"example_workflow_action_id"}' --json

`checkout-com.checkout_com_reflow_by_event`

Reflows a past event denoted by the event ID and triggers the actions of any workflows with matching conditions. Official Checkout.com endpoint: POST /workflows/events/{eventId}/reflow.

Read read

Parameters: event_id, body

Generic call

kosmo integrations:call checkout-com.checkout_com_reflow_by_event '{"event_id":"example_event_id","body":"example_body"}' --json

Shortcut

kosmo integrations:checkout-com checkout_com_reflow_by_event '{"event_id":"example_event_id","body":"example_body"}' --json

`checkout-com.checkout_com_reflow_by_event_and_workflow`

Reflows a past event by event ID and workflow ID. Triggers all the actions of a specific event and workflow combination if the event denoted by the event ID matches the workflow conditions. Official Checkout.com endpoint: POST /workflows/events/{eventId}/workflow/{workflowId}/reflow.

Read read

Parameters: event_id, workflow_id, body

Generic call

kosmo integrations:call checkout-com.checkout_com_reflow_by_event_and_workflow '{"event_id":"example_event_id","workflow_id":"example_workflow_id","body":"example_body"}' --json

Shortcut

kosmo integrations:checkout-com checkout_com_reflow_by_event_and_workflow '{"event_id":"example_event_id","workflow_id":"example_workflow_id","body":"example_body"}' --json

`checkout-com.checkout_com_reflow_events`

Reflow past events attached to multiple event IDs and workflow IDs, or to multiple subject IDs and workflow IDs. If you don't specify any workflow IDs, all matching workflows will be retriggered. Official Checkout.com endpoint: POST /workflows/events/reflow.

Read read

Parameters: body

Generic call

kosmo integrations:call checkout-com.checkout_com_reflow_events '{"body":"example_body"}' --json

Shortcut

kosmo integrations:checkout-com checkout_com_reflow_events '{"body":"example_body"}' --json

`checkout-com.checkout_com_get_subject_events`

Get all events that relate to a specific subject Official Checkout.com endpoint: GET /workflows/events/subject/{subjectId}.

Read read

Parameters: subject_id

Generic call

kosmo integrations:call checkout-com.checkout_com_get_subject_events '{"subject_id":"example_subject_id"}' --json

Shortcut

kosmo integrations:checkout-com checkout_com_get_subject_events '{"subject_id":"example_subject_id"}' --json

`checkout-com.checkout_com_reflow_by_subject`

Reflows the events associated with a subject ID (for example, a payment ID or a dispute ID) and triggers the actions of any workflows with matching conditions. Official Checkout.com endpoint: POST /workflows/events/subject/{subjectId}/reflow.

Read read

Parameters: subject_id, body

Generic call

kosmo integrations:call checkout-com.checkout_com_reflow_by_subject '{"subject_id":"example_subject_id","body":"example_body"}' --json

Shortcut

kosmo integrations:checkout-com checkout_com_reflow_by_subject '{"subject_id":"example_subject_id","body":"example_body"}' --json

`checkout-com.checkout_com_reflow_by_subject_and_workflow`

Reflows the events associated with a subject ID (for example, a payment ID or a dispute ID) and triggers the actions of the specified workflow if the conditions match. Official Checkout.com endpoint: POST /workflows/events/subject/{subjectId}/workflow/{workflowId}/reflow.

Read read

Parameters: subject_id, workflow_id, body

Generic call

kosmo integrations:call checkout-com.checkout_com_reflow_by_subject_and_workflow '{"subject_id":"example_subject_id","workflow_id":"example_workflow_id","body":"example_body"}' --json

Shortcut

kosmo integrations:checkout-com checkout_com_reflow_by_subject_and_workflow '{"subject_id":"example_subject_id","workflow_id":"example_workflow_id","body":"example_body"}' --json

`checkout-com.checkout_com_get_fx_rates`

Get the indicative foreign exchange (FX) rates that Checkout.com uses to process payments for the following products: - Card Payouts - Daily acquiring >Note: Ensure that you have the relevant product enabled for your account. Otherwise, you receive a `403 Forbidden` error response. Official Checkout.com endpoint: GET /forex/rates.

Read read

Parameters: product, source, currency_pairs, processing_channel_id

Generic call

kosmo integrations:call checkout-com.checkout_com_get_fx_rates '{"product":"example_product","source":"example_source","currency_pairs":"example_currency_pairs","processing_channel_id":"example_processing_channel_id"}' --json

Shortcut

kosmo integrations:checkout-com checkout_com_get_fx_rates '{"product":"example_product","source":"example_source","currency_pairs":"example_currency_pairs","processing_channel_id":"example_processing_channel_id"}' --json

`checkout-com.checkout_com_forward_request`

Beta Forwards an API request to a third-party endpoint. For example, you can forward payment credentials you've stored in our Vault to a third-party payment processor. Official Checkout.com endpoint: POST /forward.

Write write

Parameters: body

Generic call

kosmo integrations:call checkout-com.checkout_com_forward_request '{"body":"example_body"}' --json

Shortcut

kosmo integrations:checkout-com checkout_com_forward_request '{"body":"example_body"}' --json

`checkout-com.checkout_com_get_forward_request`

Retrieve the details of a successfully forwarded API request. The details can be retrieved for up to 14 days after the request was initiated. Official Checkout.com endpoint: GET /forward/{id}.

Write write

Parameters: id

Generic call

kosmo integrations:call checkout-com.checkout_com_get_forward_request '{"id":"example_id"}' --json

Shortcut

kosmo integrations:checkout-com checkout_com_get_forward_request '{"id":"example_id"}' --json

`checkout-com.checkout_com_create_secret`

Create a new secret with a plaintext value. **Validation Rules:** - `name`: 1-64 characters, alphanumeric + underscore - `value`: max 8KB - `entity_id` (optional): when provided, secret is scoped to this entity **Response:** Returns metadata. Official Checkout.com endpoint: POST /forward/secrets.

Write write

Parameters: body

Generic call

kosmo integrations:call checkout-com.checkout_com_create_secret '{"body":"example_body"}' --json

Shortcut

kosmo integrations:checkout-com checkout_com_create_secret '{"body":"example_body"}' --json

`checkout-com.checkout_com_list_secrets`

Returns metadata for secrets scoped for client_id. Official Checkout.com endpoint: GET /forward/secrets.

Read read

Parameters: none

Generic call

kosmo integrations:call checkout-com.checkout_com_list_secrets '{}' --json

Shortcut

kosmo integrations:checkout-com checkout_com_list_secrets '{}' --json

`checkout-com.checkout_com_update_secret`

Update an existing secret. After updating, the version is automatically incremented. **Validation Rules:** - Only `value` and `entity_id` can be updated - `value`: max 8KB **Response:** Returns updated metadata with incremented version. Official Checkout.com endpoint: PATCH /forward/secrets/{name}.

Write write

Parameters: name, body

Generic call

kosmo integrations:call checkout-com.checkout_com_update_secret '{"name":"example_name","body":"example_body"}' --json

Shortcut

kosmo integrations:checkout-com checkout_com_update_secret '{"name":"example_name","body":"example_body"}' --json

`checkout-com.checkout_com_delete_secret`

Permanently delete a secret by name. Official Checkout.com endpoint: DELETE /forward/secrets/{name}.

Write write

Parameters: name

Generic call

kosmo integrations:call checkout-com.checkout_com_delete_secret '{"name":"example_name"}' --json

Shortcut

kosmo integrations:checkout-com checkout_com_delete_secret '{"name":"example_name"}' --json

`checkout-com.checkout_com_google_pay_enroll_merchant`

Enroll an entity to the Google Pay Service. You must accept the Google terms of service to use this feature. Official Checkout.com endpoint: POST /googlepay/enrollments.

Read read

Parameters: body

Generic call

kosmo integrations:call checkout-com.checkout_com_google_pay_enroll_merchant '{"body":"example_body"}' --json

Shortcut

kosmo integrations:checkout-com checkout_com_google_pay_enroll_merchant '{"body":"example_body"}' --json

`checkout-com.checkout_com_google_pay_register_domain`

Associates a web domain with the specified enrolled entity. Official Checkout.com endpoint: POST /googlepay/enrollments/{entity_id}/domain.

Read read

Parameters: entity_id, body

Generic call

kosmo integrations:call checkout-com.checkout_com_google_pay_register_domain '{"entity_id":"example_entity_id","body":"example_body"}' --json

Shortcut

kosmo integrations:checkout-com checkout_com_google_pay_register_domain '{"entity_id":"example_entity_id","body":"example_body"}' --json

`checkout-com.checkout_com_google_pay_get_registered_domains`

Retrieves all web domains registered for the specified entity. Official Checkout.com endpoint: GET /googlepay/enrollments/{entity_id}/domains.

Read read

Parameters: entity_id

Generic call

kosmo integrations:call checkout-com.checkout_com_google_pay_get_registered_domains '{"entity_id":"example_entity_id"}' --json

Shortcut

kosmo integrations:checkout-com checkout_com_google_pay_get_registered_domains '{"entity_id":"example_entity_id"}' --json

`checkout-com.checkout_com_google_pay_get_enrollment_state`

Returns the current enrollment state of an entity. Official Checkout.com endpoint: GET /googlepay/enrollments/{entity_id}/state.

Read read

Parameters: entity_id

Generic call

kosmo integrations:call checkout-com.checkout_com_google_pay_get_enrollment_state '{"entity_id":"example_entity_id"}' --json

Shortcut

kosmo integrations:checkout-com checkout_com_google_pay_get_enrollment_state '{"entity_id":"example_entity_id"}' --json

`checkout-com.checkout_com_create_a_hosted_payments_session`

Create a Hosted Payments Page session and pass through all the payment information, like the amount, currency, country and reference. To get started with our Hosted Payments Page, contact your solutions engineer or request support. Official Checkout.com endpoint: POST /hosted-payments.

Write write

Parameters: body

Generic call

kosmo integrations:call checkout-com.checkout_com_create_a_hosted_payments_session '{"body":"example_body"}' --json

Shortcut

kosmo integrations:checkout-com checkout_com_create_a_hosted_payments_session '{"body":"example_body"}' --json

`checkout-com.checkout_com_get_hosted_payments_page_details`

Retrieve details about a specific Hosted Payments Page using the ID returned when it was created. In the response, you will see the status of the Hosted Payments Page. For more information, see the Hosted Payments Page documentation. Official Checkout.com endpoint: GET /hosted-payments/{id}.

Read read

Parameters: id

Generic call

kosmo integrations:call checkout-com.checkout_com_get_hosted_payments_page_details '{"id":"example_id"}' --json

Shortcut

kosmo integrations:checkout-com checkout_com_get_hosted_payments_page_details '{"id":"example_id"}' --json

`checkout-com.checkout_com_create_id_document_verification`

Beta Create an [ID document verification](https://www.checkout.com/docs/business-operations/manage-identities/verify-id-documents) for an applicant. Ensure you use your ID Document Verification [configuration ID](https://www.checkout.com/docs/business-operations/manage-identities/verify-id-documents#Configuration). Official Checkout.com endpoint: POST /id-document-verifications.

Write write

Parameters: body

Generic call

kosmo integrations:call checkout-com.checkout_com_create_id_document_verification '{"body":"example_body"}' --json

Shortcut

kosmo integrations:checkout-com checkout_com_create_id_document_verification '{"body":"example_body"}' --json

`checkout-com.checkout_com_retrieve_id_document_verification`

Beta Get the details of an existing [ID document verification](https://www.checkout.com/docs/business-operations/manage-identities/verify-id-documents). Official Checkout.com endpoint: GET /id-document-verifications/{id_document_verification_id}.

Read read

Parameters: id_document_verification_id

Generic call

kosmo integrations:call checkout-com.checkout_com_retrieve_id_document_verification '{"id_document_verification_id":"example_id_document_verification_id"}' --json

Shortcut

kosmo integrations:checkout-com checkout_com_retrieve_id_document_verification '{"id_document_verification_id":"example_id_document_verification_id"}' --json

`checkout-com.checkout_com_anonymize_id_document_verification`

Beta Remove the personal data from an [ID document verification](https://www.checkout.com/docs/business-operations/manage-identities/verify-id-documents). Official Checkout.com endpoint: POST /id-document-verifications/{id_document_verification_id}/anonymize.

Read read

Parameters: id_document_verification_id, body

Generic call

kosmo integrations:call checkout-com.checkout_com_anonymize_id_document_verification '{"id_document_verification_id":"example_id_document_verification_id","body":"example_body"}' --json

Shortcut

kosmo integrations:checkout-com checkout_com_anonymize_id_document_verification '{"id_document_verification_id":"example_id_document_verification_id","body":"example_body"}' --json

`checkout-com.checkout_com_create_id_document_verification_attempt`

Create an ID document verification attempt Official Checkout.com endpoint: POST /id-document-verifications/{id_document_verification_id}/attempts.

Write write

Parameters: id_document_verification_id, body

Generic call

kosmo integrations:call checkout-com.checkout_com_create_id_document_verification_attempt '{"id_document_verification_id":"example_id_document_verification_id","body":"example_body"}' --json

Shortcut

kosmo integrations:checkout-com checkout_com_create_id_document_verification_attempt '{"id_document_verification_id":"example_id_document_verification_id","body":"example_body"}' --json

`checkout-com.checkout_com_list_attempts_id_document_verification`

Beta Get the details of all attempts for a specific [ID document verification](https://www.checkout.com/docs/business-operations/manage-identities/verify-id-documents). Official Checkout.com endpoint: GET /id-document-verifications/{id_document_verification_id}/attempts.

Read read

Parameters: id_document_verification_id

Generic call

kosmo integrations:call checkout-com.checkout_com_list_attempts_id_document_verification '{"id_document_verification_id":"example_id_document_verification_id"}' --json

Shortcut

kosmo integrations:checkout-com checkout_com_list_attempts_id_document_verification '{"id_document_verification_id":"example_id_document_verification_id"}' --json

`checkout-com.checkout_com_get_id_document_verification_attempt`

Beta Get the details of a specific attempt for an [ID document verification](https://www.checkout.com/docs/business-operations/manage-identities/verify-id-documents). Official Checkout.com endpoint: GET /id-document-verifications/{id_document_verification_id}/attempts/{attempt_id}.

Read read

Parameters: id_document_verification_id, attempt_id

Generic call

kosmo integrations:call checkout-com.checkout_com_get_id_document_verification_attempt '{"id_document_verification_id":"example_id_document_verification_id","attempt_id":"example_attempt_id"}' --json

Shortcut

kosmo integrations:checkout-com checkout_com_get_id_document_verification_attempt '{"id_document_verification_id":"example_id_document_verification_id","attempt_id":"example_attempt_id"}' --json

`checkout-com.checkout_com_pdf_id_document_verification`

Get ID document verification report Official Checkout.com endpoint: GET /id-document-verifications/{id_document_verification_id}/pdf-report.

Read read

Parameters: id_document_verification_id

Generic call

kosmo integrations:call checkout-com.checkout_com_pdf_id_document_verification '{"id_document_verification_id":"example_id_document_verification_id"}' --json

Shortcut

kosmo integrations:checkout-com checkout_com_pdf_id_document_verification '{"id_document_verification_id":"example_id_document_verification_id"}' --json

`checkout-com.checkout_com_create_applicant`

Create a profile for an [Identities applicant](https://www.checkout.com/docs/business-operations/manage-identities/manage-applicants). Official Checkout.com endpoint: POST /applicants.

Write write

Parameters: body

Generic call

kosmo integrations:call checkout-com.checkout_com_create_applicant '{"body":"example_body"}' --json

Shortcut

kosmo integrations:checkout-com checkout_com_create_applicant '{"body":"example_body"}' --json

`checkout-com.checkout_com_retrieve_applicant`

Get the details of an [applicant profile](https://www.checkout.com/docs/business-operations/manage-identities/manage-applicants). Official Checkout.com endpoint: GET /applicants/{applicant_id}.

Read read

Parameters: applicant_id

Generic call

kosmo integrations:call checkout-com.checkout_com_retrieve_applicant '{"applicant_id":"example_applicant_id"}' --json

Shortcut

kosmo integrations:checkout-com checkout_com_retrieve_applicant '{"applicant_id":"example_applicant_id"}' --json

`checkout-com.checkout_com_update_applicant`

Update the details of an [applicant profile](https://www.checkout.com/docs/business-operations/manage-identities/manage-applicants). Official Checkout.com endpoint: PATCH /applicants/{applicant_id}.

Write write

Parameters: applicant_id, body

Generic call

kosmo integrations:call checkout-com.checkout_com_update_applicant '{"applicant_id":"example_applicant_id","body":"example_body"}' --json

Shortcut

kosmo integrations:checkout-com checkout_com_update_applicant '{"applicant_id":"example_applicant_id","body":"example_body"}' --json

`checkout-com.checkout_com_anonymize_applicant`

Remove the personal data in an [applicant profile](https://www.checkout.com/docs/business-operations/manage-identities/manage-applicants). Official Checkout.com endpoint: POST /applicants/{applicant_id}/anonymize.

Read read

Parameters: applicant_id, body

Generic call

kosmo integrations:call checkout-com.checkout_com_anonymize_applicant '{"applicant_id":"example_applicant_id","body":"example_body"}' --json

Shortcut

kosmo integrations:checkout-com checkout_com_anonymize_applicant '{"applicant_id":"example_applicant_id","body":"example_body"}' --json

`checkout-com.checkout_com_create_and_start_identity_verification`

Create an identity verification and attempt Official Checkout.com endpoint: POST /create-and-open-idv.

Write write

Parameters: body

Generic call

kosmo integrations:call checkout-com.checkout_com_create_and_start_identity_verification '{"body":"example_body"}' --json

Shortcut

kosmo integrations:checkout-com checkout_com_create_and_start_identity_verification '{"body":"example_body"}' --json

`checkout-com.checkout_com_create_identity_verification`

Beta Create an [identity verification](https://www.checkout.com/docs/business-operations/manage-identities/verify-identities) linked to an applicant. If successful, you receive a `201 Created` response with the identity verification resource. Ensure you use your identity verification [configuration ID](https://www.checkout.com/docs/business-operations/manage-identities/verify-identities#Configuration). Official Checkout.com endpoint: POST /identity-verifications.

Write write

Parameters: body

Generic call

kosmo integrations:call checkout-com.checkout_com_create_identity_verification '{"body":"example_body"}' --json

Shortcut

kosmo integrations:checkout-com checkout_com_create_identity_verification '{"body":"example_body"}' --json

`checkout-com.checkout_com_retrieve_identity_verification`

Beta Get the details of an existing [identity verification](https://www.checkout.com/docs/business-operations/manage-identities/verify-identities). Official Checkout.com endpoint: GET /identity-verifications/{identity_verification_id}.

Read read

Parameters: identity_verification_id

Generic call

kosmo integrations:call checkout-com.checkout_com_retrieve_identity_verification '{"identity_verification_id":"example_identity_verification_id"}' --json

Shortcut

kosmo integrations:checkout-com checkout_com_retrieve_identity_verification '{"identity_verification_id":"example_identity_verification_id"}' --json

`checkout-com.checkout_com_anonymize_identity_verification`

Beta Remove the personal data in an [identity verification](https://www.checkout.com/docs/business-operations/manage-identities/verify-identities). Official Checkout.com endpoint: POST /identity-verifications/{identity_verification_id}/anonymize.

Read read

Parameters: identity_verification_id, body

Generic call

kosmo integrations:call checkout-com.checkout_com_anonymize_identity_verification '{"identity_verification_id":"example_identity_verification_id","body":"example_body"}' --json

Shortcut

kosmo integrations:checkout-com checkout_com_anonymize_identity_verification '{"identity_verification_id":"example_identity_verification_id","body":"example_body"}' --json

`checkout-com.checkout_com_create_attempt`

Create an identity verification attempt Official Checkout.com endpoint: POST /identity-verifications/{identity_verification_id}/attempts.

Write write

Parameters: identity_verification_id, body

Generic call

kosmo integrations:call checkout-com.checkout_com_create_attempt '{"identity_verification_id":"example_identity_verification_id","body":"example_body"}' --json

Shortcut

kosmo integrations:checkout-com checkout_com_create_attempt '{"identity_verification_id":"example_identity_verification_id","body":"example_body"}' --json

`checkout-com.checkout_com_list_attempts`

Beta Get all the attempts for a specific [identity verification](https://www.checkout.com/docs/business-operations/manage-identities/verify-identities). Official Checkout.com endpoint: GET /identity-verifications/{identity_verification_id}/attempts.

Read read

Parameters: identity_verification_id

Generic call

kosmo integrations:call checkout-com.checkout_com_list_attempts '{"identity_verification_id":"example_identity_verification_id"}' --json

Shortcut

kosmo integrations:checkout-com checkout_com_list_attempts '{"identity_verification_id":"example_identity_verification_id"}' --json

`checkout-com.checkout_com_get_attempt`

Beta Get the details of a specific attempt for an [identity verification](https://www.checkout.com/docs/business-operations/manage-identities/verify-identities). Official Checkout.com endpoint: GET /identity-verifications/{identity_verification_id}/attempts/{attempt_id}.

Read read

Parameters: identity_verification_id, attempt_id

Generic call

kosmo integrations:call checkout-com.checkout_com_get_attempt '{"identity_verification_id":"example_identity_verification_id","attempt_id":"example_attempt_id"}' --json

Shortcut

kosmo integrations:checkout-com checkout_com_get_attempt '{"identity_verification_id":"example_identity_verification_id","attempt_id":"example_attempt_id"}' --json

`checkout-com.checkout_com_pdf_identity_verification`

Get identity verification report Official Checkout.com endpoint: GET /identity-verifications/{identity_verification_id}/pdf-report.

Read read

Parameters: identity_verification_id

Generic call

kosmo integrations:call checkout-com.checkout_com_pdf_identity_verification '{"identity_verification_id":"example_identity_verification_id"}' --json

Shortcut

kosmo integrations:checkout-com checkout_com_pdf_identity_verification '{"identity_verification_id":"example_identity_verification_id"}' --json

`checkout-com.checkout_com_create_an_instrument`

Create a payment instrument like card, bank, ach or sepa to use for future payments and payouts. The parameters you need to provide when creating a bank account payment instrument depend on the account's country and currency. See the payout formatting documentation, or use the `GET /validation/bank-accounts/{country}/{currency}` endpoint. Official Checkout.com endpoint: POST /instruments.

Write write

Parameters: body

Generic call

kosmo integrations:call checkout-com.checkout_com_create_an_instrument '{"body":"example_body"}' --json

Shortcut

kosmo integrations:checkout-com checkout_com_create_an_instrument '{"body":"example_body"}' --json

`checkout-com.checkout_com_get_instrument_details`

Retrieve the details of a payment instrument. Official Checkout.com endpoint: GET /instruments/{id}.

Read read

Parameters: id

Generic call

kosmo integrations:call checkout-com.checkout_com_get_instrument_details '{"id":"example_id"}' --json

Shortcut

kosmo integrations:checkout-com checkout_com_get_instrument_details '{"id":"example_id"}' --json

`checkout-com.checkout_com_update_instrument`

Update the details of a payment instrument. Official Checkout.com endpoint: PATCH /instruments/{id}.

Write write

Parameters: id, body

Generic call

kosmo integrations:call checkout-com.checkout_com_update_instrument '{"id":"example_id","body":"example_body"}' --json

Shortcut

kosmo integrations:checkout-com checkout_com_update_instrument '{"id":"example_id","body":"example_body"}' --json

`checkout-com.checkout_com_delete_instrument`

Delete a payment instrument. Official Checkout.com endpoint: DELETE /instruments/{id}.

Write write

Parameters: id

Generic call

kosmo integrations:call checkout-com.checkout_com_delete_instrument '{"id":"example_id"}' --json

Shortcut

kosmo integrations:checkout-com checkout_com_delete_instrument '{"id":"example_id"}' --json

`checkout-com.checkout_com_request_cardholder_access_token`

OAuth endpoint to exchange your access key ID and access key secret for an access token. Official Checkout.com endpoint: POST /issuing/access/connect/token.

Read read

Parameters: body

Generic call

kosmo integrations:call checkout-com.checkout_com_request_cardholder_access_token '{"body":"example_body"}' --json

Shortcut

kosmo integrations:checkout-com checkout_com_request_cardholder_access_token '{"body":"example_body"}' --json

`checkout-com.checkout_com_create_cardholder`

Create a new cardholder that you can issue a card to at a later point. Official Checkout.com endpoint: POST /issuing/cardholders.

Write write

Parameters: body

Generic call

kosmo integrations:call checkout-com.checkout_com_create_cardholder '{"body":"example_body"}' --json

Shortcut

kosmo integrations:checkout-com checkout_com_create_cardholder '{"body":"example_body"}' --json

`checkout-com.checkout_com_get_cardholder`

Retrieve the details for a cardholder you created previously. Official Checkout.com endpoint: GET /issuing/cardholders/{cardholderId}.

Read read

Parameters: cardholder_id

Generic call

kosmo integrations:call checkout-com.checkout_com_get_cardholder '{"cardholder_id":"example_cardholder_id"}' --json

Shortcut

kosmo integrations:checkout-com checkout_com_get_cardholder '{"cardholder_id":"example_cardholder_id"}' --json

`checkout-com.checkout_com_update_cardholder`

Updates the details of an existing cardholder. Official Checkout.com endpoint: PATCH /issuing/cardholders/{cardholderId}.

Write write

Parameters: cardholder_id, body

Generic call

kosmo integrations:call checkout-com.checkout_com_update_cardholder '{"cardholder_id":"example_cardholder_id","body":"example_body"}' --json

Shortcut

kosmo integrations:checkout-com checkout_com_update_cardholder '{"cardholder_id":"example_cardholder_id","body":"example_body"}' --json

`checkout-com.checkout_com_get_cardholder_cards`

Retrieves the cards issued to the specified cardholder. Card credentials are not returned in the response. The response is limited to a maximum of 150 cards. Official Checkout.com endpoint: GET /issuing/cardholders/{cardholderId}/cards.

Read read

Parameters: cardholder_id, statuses

Generic call

kosmo integrations:call checkout-com.checkout_com_get_cardholder_cards '{"cardholder_id":"example_cardholder_id","statuses":"example_statuses"}' --json

Shortcut

kosmo integrations:checkout-com checkout_com_get_cardholder_cards '{"cardholder_id":"example_cardholder_id","statuses":"example_statuses"}' --json

`checkout-com.checkout_com_create_card`

Creates a physical or virtual card and issues it to the specified cardholder. Official Checkout.com endpoint: POST /issuing/cards.

Write write

Parameters: cko_idempotency_key, body

Generic call

kosmo integrations:call checkout-com.checkout_com_create_card '{"cko_idempotency_key":"example_cko_idempotency_key","body":"example_body"}' --json

Shortcut

kosmo integrations:checkout-com checkout_com_create_card '{"cko_idempotency_key":"example_cko_idempotency_key","body":"example_body"}' --json

`checkout-com.checkout_com_get_card`

Retrieves the details for a card you issued previously. The card's credentials are not returned in the response. Official Checkout.com endpoint: GET /issuing/cards/{cardId}.

Read read

Parameters: card_id

Generic call

kosmo integrations:call checkout-com.checkout_com_get_card '{"card_id":"example_card_id"}' --json

Shortcut

kosmo integrations:checkout-com checkout_com_get_card '{"card_id":"example_card_id"}' --json

`checkout-com.checkout_com_update_card`

Update the details of an issued card. Only the fields for which you provide values will be updated. If you pass `null`, the existing value will be removed. Official Checkout.com endpoint: PATCH /issuing/cards/{cardId}.

Write write

Parameters: card_id, body

Generic call

kosmo integrations:call checkout-com.checkout_com_update_card '{"card_id":"example_card_id","body":"example_body"}' --json

Shortcut

kosmo integrations:checkout-com checkout_com_update_card '{"card_id":"example_card_id","body":"example_body"}' --json

`checkout-com.checkout_com_enroll_card`

Enrolls a card in 3D Secure (3DS). Additional information is requested from the cardholder through a 3DS challenge when performing a transaction. Two-factor authentication (2FA) is supported. For maximum security, we recommend using a combination of a one-time password (OTP) sent via SMS, along with a password or question and answer security pair. Official Checkout.com endpoint: POST /issuing/cards/{cardId}/3ds-enrollment.

Read read

Parameters: card_id, body

Generic call

kosmo integrations:call checkout-com.checkout_com_enroll_card '{"card_id":"example_card_id","body":"example_body"}' --json

Shortcut

kosmo integrations:checkout-com checkout_com_enroll_card '{"card_id":"example_card_id","body":"example_body"}' --json

`checkout-com.checkout_com_update_card_enrollment_details`

Updates a card's 3DS enrollment details. At least one of the fields is required. Official Checkout.com endpoint: PATCH /issuing/cards/{cardId}/3ds-enrollment.

Write write

Parameters: card_id, body

Generic call

kosmo integrations:call checkout-com.checkout_com_update_card_enrollment_details '{"card_id":"example_card_id","body":"example_body"}' --json

Shortcut

kosmo integrations:checkout-com checkout_com_update_card_enrollment_details '{"card_id":"example_card_id","body":"example_body"}' --json

`checkout-com.checkout_com_get_card_enrollment_details`

Retrieves a card's 3DS enrollment details. Official Checkout.com endpoint: GET /issuing/cards/{cardId}/3ds-enrollment.

Read read

Parameters: card_id

Generic call

kosmo integrations:call checkout-com.checkout_com_get_card_enrollment_details '{"card_id":"example_card_id"}' --json

Shortcut

kosmo integrations:checkout-com checkout_com_get_card_enrollment_details '{"card_id":"example_card_id"}' --json

`checkout-com.checkout_com_activate_card`

Activates an `inactive` or `suspended` card so that incoming authorizations can be approved. Activating a renewed card will schedule the parent card for revocation the following day, and transfer all configurations to the newly activated card. This includes 3DS enrollment, card controls, control profiles and tokenisation. Official Checkout.com endpoint: POST /issuing/cards/{cardId}/activate.

Write write

Parameters: card_id, body

Generic call

kosmo integrations:call checkout-com.checkout_com_activate_card '{"card_id":"example_card_id","body":"example_body"}' --json

Shortcut

kosmo integrations:checkout-com checkout_com_activate_card '{"card_id":"example_card_id","body":"example_body"}' --json

`checkout-com.checkout_com_get_card_credentials`

Retrieves the credentials for a card you issued previously. Official Checkout.com endpoint: GET /issuing/cards/{cardId}/credentials.

Read read

Parameters: card_id, credentials

Generic call

kosmo integrations:call checkout-com.checkout_com_get_card_credentials '{"card_id":"example_card_id","credentials":"example_credentials"}' --json

Shortcut

kosmo integrations:checkout-com checkout_com_get_card_credentials '{"card_id":"example_card_id","credentials":"example_credentials"}' --json

`checkout-com.checkout_com_renew_card`

Renew a card Official Checkout.com endpoint: POST /issuing/cards/{cardId}/renew.

Read read

Parameters: card_id, body

Generic call

kosmo integrations:call checkout-com.checkout_com_renew_card '{"card_id":"example_card_id","body":"example_body"}' --json

Shortcut

kosmo integrations:checkout-com checkout_com_renew_card '{"card_id":"example_card_id","body":"example_body"}' --json

`checkout-com.checkout_com_revoke_card`

Revokes an `inactive`, `active`, or `suspended` card to permanently decline all incoming authorizations. This is a permanent action. Revoked cards cannot be reactivated. Official Checkout.com endpoint: POST /issuing/cards/{cardId}/revoke.

Read read

Parameters: card_id, body

Generic call

kosmo integrations:call checkout-com.checkout_com_revoke_card '{"card_id":"example_card_id","body":"example_body"}' --json

Shortcut

kosmo integrations:checkout-com checkout_com_revoke_card '{"card_id":"example_card_id","body":"example_body"}' --json

`checkout-com.checkout_com_add_scheduled_revocation_date`

Schedules a card to be revoked at 00:00(UTC) on a specified date. Official Checkout.com endpoint: POST /issuing/cards/{cardId}/schedule-revocation.

Write write

Parameters: card_id, body

Generic call

kosmo integrations:call checkout-com.checkout_com_add_scheduled_revocation_date '{"card_id":"example_card_id","body":"example_body"}' --json

Shortcut

kosmo integrations:checkout-com checkout_com_add_scheduled_revocation_date '{"card_id":"example_card_id","body":"example_body"}' --json

`checkout-com.checkout_com_delete_scheduled_revocation_date`

Delete a card's scheduled revocation. Official Checkout.com endpoint: DELETE /issuing/cards/{cardId}/schedule-revocation.

Write write

Parameters: card_id

Generic call

kosmo integrations:call checkout-com.checkout_com_delete_scheduled_revocation_date '{"card_id":"example_card_id"}' --json

Shortcut

kosmo integrations:checkout-com checkout_com_delete_scheduled_revocation_date '{"card_id":"example_card_id"}' --json

`checkout-com.checkout_com_suspend_card`

Suspends an `active` or `inactive` card to temporarily decline all incoming authorizations. A `suspended` card can be reactivated. Official Checkout.com endpoint: POST /issuing/cards/{cardId}/suspend.

Read read

Parameters: card_id, body

Generic call

kosmo integrations:call checkout-com.checkout_com_suspend_card '{"card_id":"example_card_id","body":"example_body"}' --json

Shortcut

kosmo integrations:checkout-com checkout_com_suspend_card '{"card_id":"example_card_id","body":"example_body"}' --json

`checkout-com.checkout_com_create_control`

Creates a control and applies it to the specified target. Official Checkout.com endpoint: POST /issuing/controls.

Write write

Parameters: cko_idempotency_key, body

Generic call

kosmo integrations:call checkout-com.checkout_com_create_control '{"cko_idempotency_key":"example_cko_idempotency_key","body":"example_body"}' --json

Shortcut

kosmo integrations:checkout-com checkout_com_create_control '{"cko_idempotency_key":"example_cko_idempotency_key","body":"example_body"}' --json

`checkout-com.checkout_com_get_control_by_target`

Retrieves a list of spending controls applied to the specified target. Official Checkout.com endpoint: GET /issuing/controls.

Read read

Parameters: target_id

Generic call

kosmo integrations:call checkout-com.checkout_com_get_control_by_target '{"target_id":"example_target_id"}' --json

Shortcut

kosmo integrations:checkout-com checkout_com_get_control_by_target '{"target_id":"example_target_id"}' --json

`checkout-com.checkout_com_get_control`

Retrieves the details of an existing control. Official Checkout.com endpoint: GET /issuing/controls/{controlId}.

Read read

Parameters: control_id, card_id

Generic call

kosmo integrations:call checkout-com.checkout_com_get_control '{"control_id":"example_control_id","card_id":"example_card_id"}' --json

Shortcut

kosmo integrations:checkout-com checkout_com_get_control '{"control_id":"example_control_id","card_id":"example_card_id"}' --json

`checkout-com.checkout_com_update_control`

Updates an existing control. Official Checkout.com endpoint: PUT /issuing/controls/{controlId}.

Write write

Parameters: control_id, body

Generic call

kosmo integrations:call checkout-com.checkout_com_update_control '{"control_id":"example_control_id","body":"example_body"}' --json

Shortcut

kosmo integrations:checkout-com checkout_com_update_control '{"control_id":"example_control_id","body":"example_body"}' --json

`checkout-com.checkout_com_delete_control`

Removes an existing control from the target it was applied to. If you want to reapply an equivalent control to the target, you must create a new control. Official Checkout.com endpoint: DELETE /issuing/controls/{controlId}.

Write write

Parameters: control_id

Generic call

kosmo integrations:call checkout-com.checkout_com_delete_control '{"control_id":"example_control_id"}' --json

Shortcut

kosmo integrations:checkout-com checkout_com_delete_control '{"control_id":"example_control_id"}' --json

`checkout-com.checkout_com_create_control_group`

Creates a control group and applies it to the specified target. Official Checkout.com endpoint: POST /issuing/controls/control-groups.

Write write

Parameters: body

Generic call

kosmo integrations:call checkout-com.checkout_com_create_control_group '{"body":"example_body"}' --json

Shortcut

kosmo integrations:checkout-com checkout_com_create_control_group '{"body":"example_body"}' --json

`checkout-com.checkout_com_get_control_group_by_target`

Retrieves a list of control groups applied to the specified target. Official Checkout.com endpoint: GET /issuing/controls/control-groups.

Read read

Parameters: target_id

Generic call

kosmo integrations:call checkout-com.checkout_com_get_control_group_by_target '{"target_id":"example_target_id"}' --json

Shortcut

kosmo integrations:checkout-com checkout_com_get_control_group_by_target '{"target_id":"example_target_id"}' --json

`checkout-com.checkout_com_get_control_group`

Retrieves the details of a control group you created previously. Official Checkout.com endpoint: GET /issuing/controls/control-groups/{controlGroupId}.

Read read

Parameters: control_group_id

Generic call

kosmo integrations:call checkout-com.checkout_com_get_control_group '{"control_group_id":"example_control_group_id"}' --json

Shortcut

kosmo integrations:checkout-com checkout_com_get_control_group '{"control_group_id":"example_control_group_id"}' --json

`checkout-com.checkout_com_delete_control_group`

Removes the control group and all the controls it contains. If you want to reapply an equivalent control group to the card, you'll need to create a new control group. Official Checkout.com endpoint: DELETE /issuing/controls/control-groups/{controlGroupId}.

Write write

Parameters: control_group_id

Generic call

kosmo integrations:call checkout-com.checkout_com_delete_control_group '{"control_group_id":"example_control_group_id"}' --json

Shortcut

kosmo integrations:checkout-com checkout_com_delete_control_group '{"control_group_id":"example_control_group_id"}' --json

`checkout-com.checkout_com_create_control_profile`

Creates a control profile. Official Checkout.com endpoint: POST /issuing/controls/control-profiles.

Write write

Parameters: body

Generic call

kosmo integrations:call checkout-com.checkout_com_create_control_profile '{"body":"example_body"}' --json

Shortcut

kosmo integrations:checkout-com checkout_com_create_control_profile '{"body":"example_body"}' --json

`checkout-com.checkout_com_get_control_profiles_by_target`

Retrieves a list of control profiles for the currently authenticated client, or for a specific card if a card ID is provided. Official Checkout.com endpoint: GET /issuing/controls/control-profiles.

Read read

Parameters: target_id

Generic call

kosmo integrations:call checkout-com.checkout_com_get_control_profiles_by_target '{"target_id":"example_target_id"}' --json

Shortcut

kosmo integrations:checkout-com checkout_com_get_control_profiles_by_target '{"target_id":"example_target_id"}' --json

`checkout-com.checkout_com_get_control_profile`

Retrieves the details of an existing control profile. Official Checkout.com endpoint: GET /issuing/controls/control-profiles/{controlProfileId}.

Read read

Parameters: control_profile_id

Generic call

kosmo integrations:call checkout-com.checkout_com_get_control_profile '{"control_profile_id":"example_control_profile_id"}' --json

Shortcut

kosmo integrations:checkout-com checkout_com_get_control_profile '{"control_profile_id":"example_control_profile_id"}' --json

`checkout-com.checkout_com_update_control_profile`

Update the control profile Official Checkout.com endpoint: PATCH /issuing/controls/control-profiles/{controlProfileId}.

Write write

Parameters: control_profile_id, body

Generic call

kosmo integrations:call checkout-com.checkout_com_update_control_profile '{"control_profile_id":"example_control_profile_id","body":"example_body"}' --json

Shortcut

kosmo integrations:checkout-com checkout_com_update_control_profile '{"control_profile_id":"example_control_profile_id","body":"example_body"}' --json

`checkout-com.checkout_com_delete_control_profile`

Removes the control profile. A control profile cannot be removed if it is used by a control. Official Checkout.com endpoint: DELETE /issuing/controls/control-profiles/{controlProfileId}.

Write write

Parameters: control_profile_id

Generic call

kosmo integrations:call checkout-com.checkout_com_delete_control_profile '{"control_profile_id":"example_control_profile_id"}' --json

Shortcut

kosmo integrations:checkout-com checkout_com_delete_control_profile '{"control_profile_id":"example_control_profile_id"}' --json

`checkout-com.checkout_com_add_target_to_control_profile`

Adds a target to an existing control profile. Official Checkout.com endpoint: POST /issuing/controls/control-profiles/{controlProfileId}/add/{targetId}.

Write write

Parameters: control_profile_id, target_id, body

Generic call

kosmo integrations:call checkout-com.checkout_com_add_target_to_control_profile '{"control_profile_id":"example_control_profile_id","target_id":"example_target_id","body":"example_body"}' --json

Shortcut

kosmo integrations:checkout-com checkout_com_add_target_to_control_profile '{"control_profile_id":"example_control_profile_id","target_id":"example_target_id","body":"example_body"}' --json

`checkout-com.checkout_com_remove_target_from_control_profile`

Removes a target from an existing control profile. Official Checkout.com endpoint: POST /issuing/controls/control-profiles/{controlProfileId}/remove/{targetId}.

Write write

Parameters: control_profile_id, target_id, body

Generic call

kosmo integrations:call checkout-com.checkout_com_remove_target_from_control_profile '{"control_profile_id":"example_control_profile_id","target_id":"example_target_id","body":"example_body"}' --json

Shortcut

kosmo integrations:checkout-com checkout_com_remove_target_from_control_profile '{"control_profile_id":"example_control_profile_id","target_id":"example_target_id","body":"example_body"}' --json

`checkout-com.checkout_com_get_digital_card`

Retrieves the details for a digital card. Official Checkout.com endpoint: GET /issuing/digital-cards/{digitalCardId}.

Read read

Parameters: digital_card_id

Generic call

kosmo integrations:call checkout-com.checkout_com_get_digital_card '{"digital_card_id":"example_digital_card_id"}' --json

Shortcut

kosmo integrations:checkout-com checkout_com_get_digital_card '{"digital_card_id":"example_digital_card_id"}' --json

`checkout-com.checkout_com_create_dispute`

Beta Create a dispute for an Issuing transaction. For full guidance, see [Manage Issuing disputes](https://www.checkout.com/docs/card-issuing/manage-cardholder-transactions/manage-issuing-disputes). The transaction must already be cleared and not refunded. For the card scheme to process the chargeback, you must submit the dispute using this endpoint. Official Checkout.com endpoint: POST /issuing/disputes.

Write write

Parameters: cko_idempotency_key, body

Generic call

kosmo integrations:call checkout-com.checkout_com_create_dispute '{"cko_idempotency_key":"example_cko_idempotency_key","body":"example_body"}' --json

Shortcut

kosmo integrations:checkout-com checkout_com_create_dispute '{"cko_idempotency_key":"example_cko_idempotency_key","body":"example_body"}' --json

`checkout-com.checkout_com_get_dispute`

Beta Retrieve the details of an [Issuing dispute](https://www.checkout.com/docs/card-issuing/manage-cardholder-transactions/manage-issuing-disputes). Official Checkout.com endpoint: GET /issuing/disputes/{disputeId}.

Read read

Parameters: dispute_id

Generic call

kosmo integrations:call checkout-com.checkout_com_get_dispute '{"dispute_id":"example_dispute_id"}' --json

Shortcut

kosmo integrations:checkout-com checkout_com_get_dispute '{"dispute_id":"example_dispute_id"}' --json

`checkout-com.checkout_com_cancel_dispute`

Beta Cancel an [Issuing dispute](https://www.checkout.com/docs/card-issuing/manage-cardholder-transactions/manage-issuing-disputes). If you decide not to proceed with a dispute, you can cancel it either: * Before you submit it * While the dispute `status` is `processing` and `status_reason` is `chargeback_pending` or `chargeback_processed` For more information, see Cancel a dispute. Official Checkout.com endpoint: POST /issuing/disputes/{disputeId}/cancel.

Write write

Parameters: cko_idempotency_key, dispute_id, body

Generic call

kosmo integrations:call checkout-com.checkout_com_cancel_dispute '{"cko_idempotency_key":"example_cko_idempotency_key","dispute_id":"example_dispute_id","body":"example_body"}' --json

Shortcut

kosmo integrations:checkout-com checkout_com_cancel_dispute '{"cko_idempotency_key":"example_cko_idempotency_key","dispute_id":"example_dispute_id","body":"example_body"}' --json

`checkout-com.checkout_com_escalate_dispute`

Beta Escalate an [Issuing dispute](https://www.checkout.com/docs/card-issuing/manage-cardholder-transactions/manage-issuing-disputes) to pre-arbitration or arbitration. Official Checkout.com endpoint: POST /issuing/disputes/{disputeId}/escalate.

Read read

Parameters: cko_idempotency_key, dispute_id, body

Generic call

kosmo integrations:call checkout-com.checkout_com_escalate_dispute '{"cko_idempotency_key":"example_cko_idempotency_key","dispute_id":"example_dispute_id","body":"example_body"}' --json

Shortcut

kosmo integrations:checkout-com checkout_com_escalate_dispute '{"cko_idempotency_key":"example_cko_idempotency_key","dispute_id":"example_dispute_id","body":"example_body"}' --json

`checkout-com.checkout_com_simulate_authorization`

Simulate an authorization request with a card you issued previously. Official Checkout.com endpoint: POST /issuing/simulate/authorizations.

Read read

Parameters: body

Generic call

kosmo integrations:call checkout-com.checkout_com_simulate_authorization '{"body":"example_body"}' --json

Shortcut

kosmo integrations:checkout-com checkout_com_simulate_authorization '{"body":"example_body"}' --json

`checkout-com.checkout_com_simulate_incremental_authorization`

Simulate an incremental authorization request for an existing approved transaction. Incremental authorizations increase the total authorized amount of the transaction. For example, adding a restaurant bill to an existing hotel booking. Official Checkout.com endpoint: POST /issuing/simulate/authorizations/{id}/authorizations.

Read read

Parameters: id, body

Generic call

kosmo integrations:call checkout-com.checkout_com_simulate_incremental_authorization '{"id":"example_id","body":"example_body"}' --json

Shortcut

kosmo integrations:checkout-com checkout_com_simulate_incremental_authorization '{"id":"example_id","body":"example_body"}' --json

`checkout-com.checkout_com_simulate_presentment`

Simulate the clearing of an existing approved authorization. Official Checkout.com endpoint: POST /issuing/simulate/authorizations/{id}/presentments.

Read read

Parameters: id, body

Generic call

kosmo integrations:call checkout-com.checkout_com_simulate_presentment '{"id":"example_id","body":"example_body"}' --json

Shortcut

kosmo integrations:checkout-com checkout_com_simulate_presentment '{"id":"example_id","body":"example_body"}' --json

`checkout-com.checkout_com_simulate_refund`

Simulate the refund of an existing approved authorization, after it has been cleared. Official Checkout.com endpoint: POST /issuing/simulate/authorizations/{id}/refunds.

Read read

Parameters: id, body

Generic call

kosmo integrations:call checkout-com.checkout_com_simulate_refund '{"id":"example_id","body":"example_body"}' --json

Shortcut

kosmo integrations:checkout-com checkout_com_simulate_refund '{"id":"example_id","body":"example_body"}' --json

`checkout-com.checkout_com_simulate_reversal`

Simulate the reversal of an existing approved authorization. Official Checkout.com endpoint: POST /issuing/simulate/authorizations/{id}/reversals.

Read read

Parameters: id, body

Generic call

kosmo integrations:call checkout-com.checkout_com_simulate_reversal '{"id":"example_id","body":"example_body"}' --json

Shortcut

kosmo integrations:checkout-com checkout_com_simulate_reversal '{"id":"example_id","body":"example_body"}' --json

`checkout-com.checkout_com_simulate_oob_authentication`

Simulate a request to your back-end from an out-of-band (OOB) authentication provider. Official Checkout.com endpoint: POST /issuing/simulate/oob/authentication.

Read read

Parameters: body

Generic call

kosmo integrations:call checkout-com.checkout_com_simulate_oob_authentication '{"body":"example_body"}' --json

Shortcut

kosmo integrations:checkout-com checkout_com_simulate_oob_authentication '{"body":"example_body"}' --json

`checkout-com.checkout_com_get_transactions`

Beta Returns a list of transactions based on the matching input parameters in reverse chronological order, with the most recent transactions shown first. Official Checkout.com endpoint: GET /issuing/transactions.

Read read

Parameters: limit, skip, cardholder_id, card_id, entity_id, status, from, to

Generic call

kosmo integrations:call checkout-com.checkout_com_get_transactions '{"limit":1,"skip":1,"cardholder_id":"example_cardholder_id","card_id":"example_card_id","entity_id":"example_entity_id","status":"example_status","from":"example_from","to":"example_to"}' --json

Shortcut

kosmo integrations:checkout-com checkout_com_get_transactions '{"limit":1,"skip":1,"cardholder_id":"example_cardholder_id","card_id":"example_card_id","entity_id":"example_entity_id","status":"example_status","from":"example_from","to":"example_to"}' --json

`checkout-com.checkout_com_get_transaction_by_id`

Beta Get the details of a transaction using its ID. Official Checkout.com endpoint: GET /issuing/transactions/{transactionId}.

Read read

Parameters: transaction_id

Generic call

kosmo integrations:call checkout-com.checkout_com_get_transaction_by_id '{"transaction_id":"example_transaction_id"}' --json

Shortcut

kosmo integrations:checkout-com checkout_com_get_transaction_by_id '{"transaction_id":"example_transaction_id"}' --json

`checkout-com.checkout_com_request_card_metadata`

Beta Returns a single metadata record for the card specified by the Primary Account Number (PAN), Bank Identification Number (BIN), token, or instrument supplied. Official Checkout.com endpoint: POST /metadata/card.

Read read

Parameters: body

Generic call

kosmo integrations:call checkout-com.checkout_com_request_card_metadata '{"body":"example_body"}' --json

Shortcut

kosmo integrations:checkout-com checkout_com_request_card_metadata '{"body":"example_body"}' --json

`checkout-com.checkout_com_provision_network_token`

Beta Provisions a network token synchronously. If the merchant stores their cards with Checkout.com, then source ID can be used to request a network token for the given card. If the merchant does not store their cards with Checkout.com, then card details have to be provided. Official Checkout.com endpoint: POST /network-tokens.

Read read

Parameters: body

Generic call

kosmo integrations:call checkout-com.checkout_com_provision_network_token '{"body":"example_body"}' --json

Shortcut

kosmo integrations:checkout-com checkout_com_provision_network_token '{"body":"example_body"}' --json

`checkout-com.checkout_com_get_network_token`

Beta Given network token ID, this endpoint returns network token details: DPAN, expiry date, state, TRID and also card details like last four and expiry date. Official Checkout.com endpoint: GET /network-tokens/{network_token_id}.

Read read

Parameters: network_token_id

Generic call

kosmo integrations:call checkout-com.checkout_com_get_network_token '{"network_token_id":"example_network_token_id"}' --json

Shortcut

kosmo integrations:checkout-com checkout_com_get_network_token '{"network_token_id":"example_network_token_id"}' --json

`checkout-com.checkout_com_provision_cryptogram`

Beta Using network token ID as an input, this endpoint returns token cryptogram. Official Checkout.com endpoint: POST /network-tokens/{network_token_id}/cryptograms.

Read read

Parameters: network_token_id, body

Generic call

kosmo integrations:call checkout-com.checkout_com_provision_cryptogram '{"network_token_id":"example_network_token_id","body":"example_body"}' --json

Shortcut

kosmo integrations:checkout-com checkout_com_provision_cryptogram '{"network_token_id":"example_network_token_id","body":"example_body"}' --json

`checkout-com.checkout_com_delete_network_token`

Beta This endpoint is for permanently deleting a network token. A network token should be deleted when a payment instrument it is associated with is removed from file or if the security of the token has been compromised. Official Checkout.com endpoint: PATCH /network-tokens/{network_token_id}/delete.

Write write

Parameters: network_token_id, body

Generic call

kosmo integrations:call checkout-com.checkout_com_delete_network_token '{"network_token_id":"example_network_token_id","body":"example_body"}' --json

Shortcut

kosmo integrations:checkout-com checkout_com_delete_network_token '{"network_token_id":"example_network_token_id","body":"example_body"}' --json

`checkout-com.checkout_com_request_a_payment_context`

Send a Payment Context request.Note: Successful Payment Context requests will always return a 201 response. Official Checkout.com endpoint: POST /payment-contexts.

Read read

Parameters: cko_idempotency_key, body

Generic call

kosmo integrations:call checkout-com.checkout_com_request_a_payment_context '{"cko_idempotency_key":"example_cko_idempotency_key","body":"example_body"}' --json

Shortcut

kosmo integrations:checkout-com checkout_com_request_a_payment_context '{"cko_idempotency_key":"example_cko_idempotency_key","body":"example_body"}' --json

`checkout-com.checkout_com_get_payment_context`

Returns all the Payment Context details. Official Checkout.com endpoint: GET /payment-contexts/{id}.

Read read

Parameters: id

Generic call

kosmo integrations:call checkout-com.checkout_com_get_payment_context '{"id":"example_id"}' --json

Shortcut

kosmo integrations:checkout-com checkout_com_get_payment_context '{"id":"example_id"}' --json

`checkout-com.checkout_com_create_a_payment_link_session`

Create a Payment Link and pass through all the payment information, like the amount, currency, country and reference. Official Checkout.com endpoint: POST /payment-links.

Write write

Parameters: body

Generic call

kosmo integrations:call checkout-com.checkout_com_create_a_payment_link_session '{"body":"example_body"}' --json

Shortcut

kosmo integrations:checkout-com checkout_com_create_a_payment_link_session '{"body":"example_body"}' --json

`checkout-com.checkout_com_get_payment_link_details`

Retrieve details about a specific Payment Link using its ID returned when the link was created. In the response, you will see the status of the Payment Link. For more information, see the Payment Links documentation. Official Checkout.com endpoint: GET /payment-links/{id}.

Read read

Parameters: id

Generic call

kosmo integrations:call checkout-com.checkout_com_get_payment_link_details '{"id":"example_id"}' --json

Shortcut

kosmo integrations:checkout-com checkout_com_get_payment_link_details '{"id":"example_id"}' --json

`checkout-com.checkout_com_get_payment_methods`

Beta Get a list of all available payment methods for a specific Processing Channel ID. Official Checkout.com endpoint: GET /payment-methods.

Read read

Parameters: processing_channel_id

Generic call

kosmo integrations:call checkout-com.checkout_com_get_payment_methods '{"processing_channel_id":"example_processing_channel_id"}' --json

Shortcut

kosmo integrations:checkout-com checkout_com_get_payment_methods '{"processing_channel_id":"example_processing_channel_id"}' --json

`checkout-com.checkout_com_create_payment_session`

Creates a payment session. The values you provide in the request will be used to determine the payment methods available to Flow. Some payment methods may require you to provide specific values for certain fields. Refer to our documentation for more information. You must supply the unmodified response body when you initialize Flow. Official Checkout.com endpoint: POST /payment-sessions.

Write write

Parameters: body

Generic call

kosmo integrations:call checkout-com.checkout_com_create_payment_session '{"body":"example_body"}' --json

Shortcut

kosmo integrations:checkout-com checkout_com_create_payment_session '{"body":"example_body"}' --json

`checkout-com.checkout_com_submit_payment_session`

Submit a payment attempt for a payment session. This request works with the Flow handleSubmit callback, where you can perform a customized payment submission. You must send the unmodified response body as the response of the `handleSubmit` callback. Official Checkout.com endpoint: POST /payment-sessions/{id}/submit.

Write write

Parameters: id, body

Generic call

kosmo integrations:call checkout-com.checkout_com_submit_payment_session '{"id":"example_id","body":"example_body"}' --json

Shortcut

kosmo integrations:checkout-com checkout_com_submit_payment_session '{"id":"example_id","body":"example_body"}' --json

`checkout-com.checkout_com_create_and_submit_payment_session`

Request a Payment Session with Payment Official Checkout.com endpoint: POST /payment-sessions/complete.

Write write

Parameters: body

Generic call

kosmo integrations:call checkout-com.checkout_com_create_and_submit_payment_session '{"body":"example_body"}' --json

Shortcut

kosmo integrations:checkout-com checkout_com_create_and_submit_payment_session '{"body":"example_body"}' --json

`checkout-com.checkout_com_request_a_payment_or_payout`

Send a payment or payout.Note: successful payout requests will always return a 202 response. Official Checkout.com endpoint: POST /payments.

Read read

Parameters: cko_idempotency_key, body

Generic call

kosmo integrations:call checkout-com.checkout_com_request_a_payment_or_payout '{"cko_idempotency_key":"example_cko_idempotency_key","body":"example_body"}' --json

Shortcut

kosmo integrations:checkout-com checkout_com_request_a_payment_or_payout '{"cko_idempotency_key":"example_cko_idempotency_key","body":"example_body"}' --json

`checkout-com.checkout_com_get_payments_list`

Beta Returns a list of your business' payments that match the specified reference. Results are returned in reverse chronological order, with the most recent payments shown first. This will only return payments initiated from June 2022 onwards. Payments initiated before this date may return a `404` error code if you attempt to retrieve them. Official Checkout.com endpoint: GET /payments.

Read read

Parameters: limit, skip, reference

Generic call

kosmo integrations:call checkout-com.checkout_com_get_payments_list '{"limit":1,"skip":1,"reference":"example_reference"}' --json

Shortcut

kosmo integrations:checkout-com checkout_com_get_payments_list '{"limit":1,"skip":1,"reference":"example_reference"}' --json

`checkout-com.checkout_com_get_payment_details`

Returns the details of the payment with the specified identifier string. If the payment method requires a redirection to a third party (e.g., 3D Secure), the redirect URL back to your site will include a `cko-session-id` query parameter containing a payment session ID that can be used to obtain the details of the payment, for example: https://example.com/success?cko-session-id=sid_ubfj2q76miwundwlk72vxt2i7q. Official Checkout.com endpoint: GET /payments/{id}.

Read read

Parameters: id

Generic call

kosmo integrations:call checkout-com.checkout_com_get_payment_details '{"id":"example_id"}' --json

Shortcut

kosmo integrations:checkout-com checkout_com_get_payment_details '{"id":"example_id"}' --json

`checkout-com.checkout_com_get_payment_actions`

Returns all the actions associated with a payment ordered by processing date in descending order (latest first). Official Checkout.com endpoint: GET /payments/{id}/actions.

Read read

Parameters: id

Generic call

kosmo integrations:call checkout-com.checkout_com_get_payment_actions '{"id":"example_id"}' --json

Shortcut

kosmo integrations:checkout-com checkout_com_get_payment_actions '{"id":"example_id"}' --json

`checkout-com.checkout_com_increment_payment_authorization`

Request an incremental authorization to increase the authorization amount or extend the authorization's validity period. Official Checkout.com endpoint: POST /payments/{id}/authorizations.

Read read

Parameters: cko_idempotency_key, id, body

Generic call

kosmo integrations:call checkout-com.checkout_com_increment_payment_authorization '{"cko_idempotency_key":"example_cko_idempotency_key","id":"example_id","body":"example_body"}' --json

Shortcut

kosmo integrations:checkout-com checkout_com_increment_payment_authorization '{"cko_idempotency_key":"example_cko_idempotency_key","id":"example_id","body":"example_body"}' --json

`checkout-com.checkout_com_cancel_a_payment`

Cancels an upcoming retry, if there is one scheduled Cancellation requests are processed asynchronously. You can use [workflows](#tag/Workflows) to be notified if the cancellation is successful. Official Checkout.com endpoint: POST /payments/{id}/cancellations.

Write write

Parameters: cko_idempotency_key, id, body

Generic call

kosmo integrations:call checkout-com.checkout_com_cancel_a_payment '{"cko_idempotency_key":"example_cko_idempotency_key","id":"example_id","body":"example_body"}' --json

Shortcut

kosmo integrations:checkout-com checkout_com_cancel_a_payment '{"cko_idempotency_key":"example_cko_idempotency_key","id":"example_id","body":"example_body"}' --json

`checkout-com.checkout_com_capture_a_payment`

Captures a payment if supported by the payment method. For card payments, capture requests are processed asynchronously. You can use [workflows](#tag/Workflows) to be notified if the capture is successful. Official Checkout.com endpoint: POST /payments/{id}/captures.

Read read

Parameters: cko_idempotency_key, id, body

Generic call

kosmo integrations:call checkout-com.checkout_com_capture_a_payment '{"cko_idempotency_key":"example_cko_idempotency_key","id":"example_id","body":"example_body"}' --json

Shortcut

kosmo integrations:checkout-com checkout_com_capture_a_payment '{"cko_idempotency_key":"example_cko_idempotency_key","id":"example_id","body":"example_body"}' --json

`checkout-com.checkout_com_refund_a_payment`

Refunds a payment if supported by the payment method. For card payments, refund requests are processed asynchronously. You can use [workflows](#tag/Workflows) to be notified if the refund is successful. Official Checkout.com endpoint: POST /payments/{id}/refunds.

Read read

Parameters: cko_idempotency_key, id, body

Generic call

kosmo integrations:call checkout-com.checkout_com_refund_a_payment '{"cko_idempotency_key":"example_cko_idempotency_key","id":"example_id","body":"example_body"}' --json

Shortcut

kosmo integrations:checkout-com checkout_com_refund_a_payment '{"cko_idempotency_key":"example_cko_idempotency_key","id":"example_id","body":"example_body"}' --json

`checkout-com.checkout_com_reverse_payment`

Returns funds back to the customer by automatically performing the appropriate payment action depending on the payment's status. For more information, see Reverse a payment. Official Checkout.com endpoint: POST /payments/{id}/reversals.

Read read

Parameters: cko_idempotency_key, id, body

Generic call

kosmo integrations:call checkout-com.checkout_com_reverse_payment '{"cko_idempotency_key":"example_cko_idempotency_key","id":"example_id","body":"example_body"}' --json

Shortcut

kosmo integrations:checkout-com checkout_com_reverse_payment '{"cko_idempotency_key":"example_cko_idempotency_key","id":"example_id","body":"example_body"}' --json

`checkout-com.checkout_com_void_a_payment`

Voids a payment if supported by the payment method. For card payments, void requests are processed asynchronously. You can use [workflows](#tag/Workflows) to be notified if the void is successful. Official Checkout.com endpoint: POST /payments/{id}/voids.

Read read

Parameters: cko_idempotency_key, id, body

Generic call

kosmo integrations:call checkout-com.checkout_com_void_a_payment '{"cko_idempotency_key":"example_cko_idempotency_key","id":"example_id","body":"example_body"}' --json

Shortcut

kosmo integrations:checkout-com checkout_com_void_a_payment '{"cko_idempotency_key":"example_cko_idempotency_key","id":"example_id","body":"example_body"}' --json

`checkout-com.checkout_com_search`

Beta Search and filter through your payment data to retrieve payments that match your query. If a search returns more results than the value specified in `limit`, additional results are returned in a new page. A link to the next page of results is returned in the response's `_links.next.href` field. For more information on search syntax, see the Search and filter payments documentation. Official Checkout.com endpoint: POST /payments/search.

Read read

Parameters: body

Generic call

kosmo integrations:call checkout-com.checkout_com_search '{"body":"example_body"}' --json

Shortcut

kosmo integrations:checkout-com checkout_com_search '{"body":"example_body"}' --json

`checkout-com.checkout_com_create_a_payment_setup`

Beta Creates a Payment Setup. To maximize the information available to the payment setup, create a Payment Setup as early as possible in the customer's journey. For example, create it the first time they land on the basket page. Official Checkout.com endpoint: POST /payments/setups.

Write write

Parameters: body

Generic call

kosmo integrations:call checkout-com.checkout_com_create_a_payment_setup '{"body":"example_body"}' --json

Shortcut

kosmo integrations:checkout-com checkout_com_create_a_payment_setup '{"body":"example_body"}' --json

`checkout-com.checkout_com_update_a_payment_setup`

Beta Updates a Payment Setup. Update the Payment Setup whenever there are significant changes in the data relevant to the customer's transaction. For example, when the customer makes a change that impacts the total payment amount. Official Checkout.com endpoint: PUT /payments/setups/{id}.

Write write

Parameters: id, body

Generic call

kosmo integrations:call checkout-com.checkout_com_update_a_payment_setup '{"id":"example_id","body":"example_body"}' --json

Shortcut

kosmo integrations:checkout-com checkout_com_update_a_payment_setup '{"id":"example_id","body":"example_body"}' --json

`checkout-com.checkout_com_get_a_payment_setup`

Beta Retrieves a Payment Setup by its unique identifier. Official Checkout.com endpoint: GET /payments/setups/{id}.

Read read

Parameters: id

Generic call

kosmo integrations:call checkout-com.checkout_com_get_a_payment_setup '{"id":"example_id"}' --json

Shortcut

kosmo integrations:checkout-com checkout_com_get_a_payment_setup '{"id":"example_id"}' --json

`checkout-com.checkout_com_confirm_a_payment_setup`

Beta Confirm a Payment Setup to begin processing the payment request with your chosen payment method. Official Checkout.com endpoint: POST /payments/setups/{id}/confirm/{payment_method_name}.

Read read

Parameters: id, payment_method_name, body

Generic call

kosmo integrations:call checkout-com.checkout_com_confirm_a_payment_setup '{"id":"example_id","payment_method_name":"example_payment_method_name","body":"example_body"}' --json

Shortcut

kosmo integrations:checkout-com checkout_com_confirm_a_payment_setup '{"id":"example_id","payment_method_name":"example_payment_method_name","body":"example_body"}' --json

`checkout-com.checkout_com_get_reports`

Returns the list of reports and their details. Official Checkout.com endpoint: GET /reports.

Read read

Parameters: created_after, created_before, entity_id, limit, pagination_token

Generic call

kosmo integrations:call checkout-com.checkout_com_get_reports '{"created_after":"example_created_after","created_before":"example_created_before","entity_id":"example_entity_id","limit":1,"pagination_token":"example_pagination_token"}' --json

Shortcut

kosmo integrations:checkout-com checkout_com_get_reports '{"created_after":"example_created_after","created_before":"example_created_before","entity_id":"example_entity_id","limit":1,"pagination_token":"example_pagination_token"}' --json

`checkout-com.checkout_com_get_report_details`

Use this endpoint to retrieve a specific report using its ID. Official Checkout.com endpoint: GET /reports/{id}.

Read read

Parameters: id

Generic call

kosmo integrations:call checkout-com.checkout_com_get_report_details '{"id":"example_id"}' --json

Shortcut

kosmo integrations:checkout-com checkout_com_get_report_details '{"id":"example_id"}' --json

`checkout-com.checkout_com_get_report_file`

Use this endpoint to retrieve a specific file from a given report using their respective IDs. Official Checkout.com endpoint: GET /reports/{id}/files/{fileId}.

Read read

Parameters: id, file_id

Generic call

kosmo integrations:call checkout-com.checkout_com_get_report_file '{"id":"example_id","file_id":"example_file_id"}' --json

Shortcut

kosmo integrations:checkout-com checkout_com_get_report_file '{"id":"example_id","file_id":"example_file_id"}' --json

`checkout-com.checkout_com_create_session`

Create a payment session to authenticate a cardholder before requesting a payment. Payment sessions can be linked to one or more payments (in the case of recurring and other merchant-initiated payments). The `next_actions` object in the response tells you which actions can be performed next. Official Checkout.com endpoint: POST /sessions.

Write write

Parameters: body

Generic call

kosmo integrations:call checkout-com.checkout_com_create_session '{"body":"example_body"}' --json

Shortcut

kosmo integrations:checkout-com checkout_com_create_session '{"body":"example_body"}' --json

`checkout-com.checkout_com_get_session`

Returns the details of the session with the specified identifier string. Official Checkout.com endpoint: GET /sessions/{id}.

Read read

Parameters: id, channel

Generic call

kosmo integrations:call checkout-com.checkout_com_get_session '{"id":"example_id","channel":"example_channel"}' --json

Shortcut

kosmo integrations:checkout-com checkout_com_get_session '{"id":"example_id","channel":"example_channel"}' --json

`checkout-com.checkout_com_update_session`

Update a session by providing information about the environment. Official Checkout.com endpoint: PUT /sessions/{id}/collect-data.

Write write

Parameters: id, body

Generic call

kosmo integrations:call checkout-com.checkout_com_update_session '{"id":"example_id","body":"example_body"}' --json

Shortcut

kosmo integrations:checkout-com checkout_com_update_session '{"id":"example_id","body":"example_body"}' --json

`checkout-com.checkout_com_complete_session`

Complete a session Official Checkout.com endpoint: POST /sessions/{id}/complete.

Read read

Parameters: id, body

Generic call

kosmo integrations:call checkout-com.checkout_com_complete_session '{"id":"example_id","body":"example_body"}' --json

Shortcut

kosmo integrations:checkout-com checkout_com_complete_session '{"id":"example_id","body":"example_body"}' --json

`checkout-com.checkout_com_update_session_three_ds_method_completion`

Update the session's 3DS Method completion indicator based on the result of accessing the 3DS Method URL. Official Checkout.com endpoint: PUT /sessions/{id}/issuer-fingerprint.

Write write

Parameters: id, body

Generic call

kosmo integrations:call checkout-com.checkout_com_update_session_three_ds_method_completion '{"id":"example_id","body":"example_body"}' --json

Shortcut

kosmo integrations:checkout-com checkout_com_update_session_three_ds_method_completion '{"id":"example_id","body":"example_body"}' --json

`checkout-com.checkout_com_request_a_token`

Exchange card details for a reference token that can be used later to request a card payment. Tokens are single use and expire after 15 minutes. To create a token, please authenticate using your public key. **Please note:** You should only use the `card` type for testing purposes. Official Checkout.com endpoint: POST /tokens.

Read read

Parameters: body

Generic call

kosmo integrations:call checkout-com.checkout_com_request_a_token '{"body":"example_body"}' --json

Shortcut

kosmo integrations:checkout-com checkout_com_request_a_token '{"body":"example_body"}' --json

`checkout-com.checkout_com_create_transfer`

Initiate a transfer of funds from source entity to destination entity. Official Checkout.com endpoint: POST /transfers.

Write write

Parameters: cko_idempotency_key, body

Generic call

kosmo integrations:call checkout-com.checkout_com_create_transfer '{"cko_idempotency_key":"example_cko_idempotency_key","body":"example_body"}' --json

Shortcut

kosmo integrations:checkout-com checkout_com_create_transfer '{"cko_idempotency_key":"example_cko_idempotency_key","body":"example_body"}' --json

`checkout-com.checkout_com_get_transfer_details`

Retrieve transfer details using the transfer identifier. Official Checkout.com endpoint: GET /transfers/{id}.

Read read

Parameters: id

Generic call

kosmo integrations:call checkout-com.checkout_com_get_transfer_details '{"id":"example_id"}' --json

Shortcut

kosmo integrations:checkout-com checkout_com_get_transfer_details '{"id":"example_id"}' --json

`checkout-com.checkout_com_get_bank_account_fields`

Returns the bank account field formatting required to create bank account instruments or perform payouts for the specified country and currency. Official Checkout.com endpoint: GET /validation/bank-accounts/{country}/{currency}.

Read read

Parameters: country, currency, account_holder_type, payment_network

Generic call

kosmo integrations:call checkout-com.checkout_com_get_bank_account_fields '{"country":"example_country","currency":"example_currency","account_holder_type":"example_account_holder_type","payment_network":"example_payment_network"}' --json

Shortcut

kosmo integrations:checkout-com checkout_com_get_bank_account_fields '{"country":"example_country","currency":"example_currency","account_holder_type":"example_account_holder_type","payment_network":"example_payment_network"}' --json

Function Schemas

Use these parameter tables when building CLI payloads without calling integrations:schema first.

checkout-com.checkout_com_retrieve_updated_card_details 1 parameters

Schema command

kosmo integrations:schema checkout-com.checkout_com_retrieve_updated_card_details --json

Parameter	Type	Required	Description
`body`	object	no	Request body matching the official Checkout.com OpenAPI schema.

checkout-com.checkout_com_onboard_entity 2 parameters

Schema command

kosmo integrations:schema checkout-com.checkout_com_onboard_entity --json

Parameter	Type	Required	Description
`accept`	string	yes	Used to describe the type of content the client can interpret. Use the schema_version value to specify the payload format. The latest version is 3.0.
`body`	object	yes	Request body matching the official Checkout.com OpenAPI schema.

checkout-com.checkout_com_get_sub_entity_members 1 parameters

Schema command

kosmo integrations:schema checkout-com.checkout_com_get_sub_entity_members --json

Parameter	Type	Required	Description
`entity_id`	string	yes	The ID of the sub-entity

checkout-com.checkout_com_reinvite_sub_entity_members 3 parameters

Schema command

kosmo integrations:schema checkout-com.checkout_com_reinvite_sub_entity_members --json

Parameter	Type	Required	Description
`entity_id`	string	yes	The ID of the sub-entity
`user_id`	string	yes	The ID of the invited user.
`body`	object	yes	Request body matching the official Checkout.com OpenAPI schema.

checkout-com.checkout_com_get_platforms_payment_instrument 2 parameters

Schema command

kosmo integrations:schema checkout-com.checkout_com_get_platforms_payment_instrument --json

Parameter	Type	Required	Description
`entity_id`	string	yes	The sub-entity's ID.
`id`	string	yes	The payment instrument's ID.

checkout-com.checkout_com_update_platforms_payment_instrument 3 parameters

Schema command

kosmo integrations:schema checkout-com.checkout_com_update_platforms_payment_instrument --json

Parameter	Type	Required	Description
`entity_id`	string	yes	The sub-entity's ID.
`id`	string	yes	The payment instrument's ID.
`body`	object	yes	Request body matching the official Checkout.com OpenAPI schema.

checkout-com.checkout_com_get_reserve_rule 2 parameters

Schema command

kosmo integrations:schema checkout-com.checkout_com_get_reserve_rule --json

Parameter	Type	Required	Description
`entity_id`	string	yes	The sub-entity's ID.
`id`	string	yes	The reserve rule ID.

checkout-com.checkout_com_update_reserve_rule 4 parameters

Schema command

kosmo integrations:schema checkout-com.checkout_com_update_reserve_rule --json

Parameter	Type	Required	Description
`entity_id`	string	yes	The sub-entity's ID.
`id`	string	yes	The reserve rule ID.
`if_match`	string	yes	Identifies a specific version of a reserve rule to update.
`body`	object	yes	Request body matching the official Checkout.com OpenAPI schema.

checkout-com.checkout_com_get_entity_details 2 parameters

Schema command

kosmo integrations:schema checkout-com.checkout_com_get_entity_details --json

Parameter	Type	Required	Description
`accept`	string	yes	Used to describe the type of content the client can interpret. Use the schema_version value to specify the payload format. The latest version is 3.0.
`id`	string	yes	The ID of the entity.

checkout-com.checkout_com_update_entity_details 3 parameters

Schema command

kosmo integrations:schema checkout-com.checkout_com_update_entity_details --json

Parameter	Type	Required	Description
`accept`	string	yes	Used to describe the type of content the client can interpret. Use the schema_version value to specify the payload format. The latest version is 3.0.
`id`	string	yes	The ID of the entity.
`body`	object	yes	Request body matching the official Checkout.com OpenAPI schema.

checkout-com.checkout_com_add_platforms_payment_instrument 2 parameters

Schema command

kosmo integrations:schema checkout-com.checkout_com_add_platforms_payment_instrument --json

Parameter	Type	Required	Description
`id`	string	yes	The sub-entity's ID.
`body`	object	yes	Request body matching the official Checkout.com OpenAPI schema.

checkout-com.checkout_com_query_platforms_payment_instruments 2 parameters

Schema command

kosmo integrations:schema checkout-com.checkout_com_query_platforms_payment_instruments --json

Parameter	Type	Required	Description
`id`	string	yes	The sub-entity's ID.
`status`	string	no	status

checkout-com.checkout_com_get_sub_entitys_payout_schedule 1 parameters

Schema command

kosmo integrations:schema checkout-com.checkout_com_get_sub_entitys_payout_schedule --json

Parameter	Type	Required	Description
`id`	string	yes	The ID of the sub-entity

checkout-com.checkout_com_put_sub_entitys_payout_schedule 2 parameters

Schema command

kosmo integrations:schema checkout-com.checkout_com_put_sub_entitys_payout_schedule --json

Parameter	Type	Required	Description
`id`	string	yes	The ID of the sub-entity
`body`	object	yes	Request body matching the official Checkout.com OpenAPI schema.

checkout-com.checkout_com_add_reserve_rule 2 parameters

Schema command

kosmo integrations:schema checkout-com.checkout_com_add_reserve_rule --json

Parameter	Type	Required	Description
`id`	string	yes	The sub-entity's ID.
`body`	object	yes	Request body matching the official Checkout.com OpenAPI schema.

checkout-com.checkout_com_query_reserve_rules 1 parameters

Schema command

kosmo integrations:schema checkout-com.checkout_com_query_reserve_rules --json

Parameter	Type	Required	Description
`id`	string	yes	The sub-entity's ID.

checkout-com.checkout_com_delegate_payment 5 parameters

Schema command

kosmo integrations:schema checkout-com.checkout_com_delegate_payment --json

Parameter	Type	Required	Description
`signature`	string	yes	A Base64-encoded HMAC-SHA256 signature used for request body integrity verification. Compute the signature as follows: 1. Concatenate the `Timestamp` header value (as a UTF-8 string) with the raw JSON request body (as a UTF-8 string). 2. Compute the HMAC-SHA25
`timestamp`	string	yes	The timestamp of the request, in RFC 3339 format (for example, `2026-03-11T10:30:00Z`). The timestamp must be within 5 minutes of the server time. Requests with a timestamp outside this window are rejected with a `401` response.
`cko_idempotency_key`	string	no	An optional idempotency key for safely retrying payment requests
`api_version`	string	no	The API version to use for the request. If not specified, the default version (`2026-01-30`) is used.
`body`	object	no	Request body matching the official Checkout.com OpenAPI schema.

checkout-com.checkout_com_create_aml_verification 1 parameters

Schema command

kosmo integrations:schema checkout-com.checkout_com_create_aml_verification --json

Parameter	Type	Required	Description
`body`	object	yes	Request body matching the official Checkout.com OpenAPI schema.

checkout-com.checkout_com_retrieve_aml_screening 1 parameters

Schema command

kosmo integrations:schema checkout-com.checkout_com_retrieve_aml_screening --json

Parameter	Type	Required	Description
`aml_verification_id`	string	yes	The AML screening's unique identifier.

checkout-com.checkout_com_upload_apple_pay_certificate 1 parameters

Schema command

kosmo integrations:schema checkout-com.checkout_com_upload_apple_pay_certificate --json

Parameter	Type	Required	Description
`body`	object	no	Request body matching the official Checkout.com OpenAPI schema.

checkout-com.checkout_com_apple_pay_enroll_merchant 1 parameters

Schema command

kosmo integrations:schema checkout-com.checkout_com_apple_pay_enroll_merchant --json

Parameter	Type	Required	Description
`body`	object	no	Request body matching the official Checkout.com OpenAPI schema.

checkout-com.checkout_com_generate_apple_pay_signing_request 1 parameters

Schema command

kosmo integrations:schema checkout-com.checkout_com_generate_apple_pay_signing_request --json

Parameter	Type	Required	Description
`body`	object	no	Request body matching the official Checkout.com OpenAPI schema.

checkout-com.checkout_com_get_entity_balances 3 parameters

Schema command

kosmo integrations:schema checkout-com.checkout_com_get_entity_balances --json

Parameter	Type	Required	Description
`id`	string	yes	The ID of the entity.
`query`	string	no	The query to apply to limit the currency accounts.
`with_currency_account_id`	boolean	no	Specifies if the response should include the sub-account ID that corresponds to each set of balances.

checkout-com.checkout_com_compliance_requests_get_compliance_request 1 parameters

Schema command

kosmo integrations:schema checkout-com.checkout_com_compliance_requests_get_compliance_request --json

Parameter	Type	Required	Description
`payment_id`	string	yes	The compliance request's payment ID.

checkout-com.checkout_com_compliance_requests_submit_compliance_request_response 2 parameters

Schema command

kosmo integrations:schema checkout-com.checkout_com_compliance_requests_submit_compliance_request_response --json

Parameter	Type	Required	Description
`payment_id`	string	yes	The compliance request's payment ID.
`body`	object	no	Request body matching the official Checkout.com OpenAPI schema.

checkout-com.checkout_com_request_an_access_token 1 parameters

Schema command

kosmo integrations:schema checkout-com.checkout_com_request_an_access_token --json

Parameter	Type	Required	Description
`body`	object	no	Request body matching the official Checkout.com OpenAPI schema.

checkout-com.checkout_com_create_customer 1 parameters

Schema command

kosmo integrations:schema checkout-com.checkout_com_create_customer --json

Parameter	Type	Required	Description
`body`	object	yes	Request body matching the official Checkout.com OpenAPI schema.

checkout-com.checkout_com_get_customer_details 1 parameters

Schema command

kosmo integrations:schema checkout-com.checkout_com_get_customer_details --json

Parameter	Type	Required	Description
`identifier`	object	yes	The customer's ID or email

checkout-com.checkout_com_update_customer_details 2 parameters

Schema command

kosmo integrations:schema checkout-com.checkout_com_update_customer_details --json

Parameter	Type	Required	Description
`identifier`	string	yes	The customer's ID
`body`	object	yes	Request body matching the official Checkout.com OpenAPI schema.

checkout-com.checkout_com_delete_customer 1 parameters

Schema command

kosmo integrations:schema checkout-com.checkout_com_delete_customer --json

Parameter	Type	Required	Description
`identifier`	string	yes	The customer's ID

checkout-com.checkout_com_get_disputes 15 parameters

Schema command

kosmo integrations:schema checkout-com.checkout_com_get_disputes --json

Parameter	Type	Required	Description
`limit`	number	no	The numbers of results to return
`skip`	number	no	The number of results to skip
`from`	string	no	The date and time from which to filter disputes, based on the dispute's `last_update` field
`to`	string	no	The date and time until which to filter disputes, based on the dispute's `last_update` field
`id`	string	no	The unique identifier of the dispute
`entity_ids`	string	no	One or more comma-separated client entities. This works like a logical OR operator
`sub_entity_ids`	string	no	One or more comma-separated sub-entities. This works like a logical OR operator
`processing_channel_ids`	string	no	One or more comma-separated processing channels. This works like a logical OR operator.
`segment_ids`	string	no	One or more comma-separated segments. This works like a logical OR operator.
`statuses`	string	no	One or more comma-separated statuses. This works like a logical OR operator
`payment_id`	string	no	The unique identifier of the payment
`payment_reference`	string	no	An optional reference (such as an order ID) that you can use later to identify the payment. Previously known as `TrackId`
`payment_arn`	string	no	The acquirer reference number (ARN) that you can use to query the issuing bank
`payment_mcc`	string	no	The merchant category code (MCC) of the payment (ISO 18245)
`this_channel_only`	boolean	no	If `true`, only returns disputes of the specific channel that the secret key is associated with. Otherwise, returns all disputes for that business

checkout-com.checkout_com_get_dispute_details 1 parameters

Schema command

kosmo integrations:schema checkout-com.checkout_com_get_dispute_details --json

Parameter	Type	Required	Description
`dispute_id`	string	yes	The dispute identifier

checkout-com.checkout_com_accept_dispute 2 parameters

Schema command

kosmo integrations:schema checkout-com.checkout_com_accept_dispute --json

Parameter	Type	Required	Description
`dispute_id`	string	yes	The dispute identifier
`body`	object	no	Request body matching the official Checkout.com OpenAPI schema.

checkout-com.checkout_com_provide_dispute_evidence 2 parameters

Schema command

kosmo integrations:schema checkout-com.checkout_com_provide_dispute_evidence --json

Parameter	Type	Required	Description
`dispute_id`	string	yes	The dispute identifier.
`body`	object	no	Request body matching the official Checkout.com OpenAPI schema.

checkout-com.checkout_com_get_dispute_evidence 1 parameters

Schema command

kosmo integrations:schema checkout-com.checkout_com_get_dispute_evidence --json

Parameter	Type	Required	Description
`dispute_id`	string	yes	The dispute identifier.

checkout-com.checkout_com_submit_dispute_evidence 2 parameters

Schema command

kosmo integrations:schema checkout-com.checkout_com_submit_dispute_evidence --json

Parameter	Type	Required	Description
`dispute_id`	string	yes	The dispute identifier.
`body`	object	no	Request body matching the official Checkout.com OpenAPI schema.

checkout-com.checkout_com_submit_dispute_arbitration_evidence 2 parameters

Schema command

kosmo integrations:schema checkout-com.checkout_com_submit_dispute_arbitration_evidence --json

Parameter	Type	Required	Description
`dispute_id`	string	yes	The dispute identifier.
`body`	object	no	Request body matching the official Checkout.com OpenAPI schema.

checkout-com.checkout_com_get_dispute_submitted_arbitration_evidence 1 parameters

Schema command

kosmo integrations:schema checkout-com.checkout_com_get_dispute_submitted_arbitration_evidence --json

Parameter	Type	Required	Description
`dispute_id`	string	yes	The dispute identifier.

checkout-com.checkout_com_get_dispute_submitted_evidence 1 parameters

Schema command

kosmo integrations:schema checkout-com.checkout_com_get_dispute_submitted_evidence --json

Parameter	Type	Required	Description
`dispute_id`	string	yes	The dispute identifier.

checkout-com.checkout_com_get_dispute_scheme_files 1 parameters

Schema command

kosmo integrations:schema checkout-com.checkout_com_get_dispute_scheme_files --json

Parameter	Type	Required	Description
`dispute_id`	string	yes	The dispute identifier

checkout-com.checkout_com_upload_a_file 2 parameters

Schema command

kosmo integrations:schema checkout-com.checkout_com_upload_a_file --json

Parameter	Type	Required	Description
`entity_id`	string	yes	The ID of the sub-entity
`body`	object	no	Request body matching the official Checkout.com OpenAPI schema.

checkout-com.checkout_com_retrieve_a_file 2 parameters

Schema command

kosmo integrations:schema checkout-com.checkout_com_retrieve_a_file --json

Parameter	Type	Required	Description
`entity_id`	string	yes	The ID of the sub-entity
`file_id`	string	yes	The ID of the file. The value is always prefixed with `file_`.

checkout-com.checkout_com_create_face_authentication 1 parameters

Schema command

kosmo integrations:schema checkout-com.checkout_com_create_face_authentication --json

Parameter	Type	Required	Description
`body`	object	yes	Request body matching the official Checkout.com OpenAPI schema.

checkout-com.checkout_com_retrieve_face_authentication 1 parameters

Schema command

kosmo integrations:schema checkout-com.checkout_com_retrieve_face_authentication --json

Parameter	Type	Required	Description
`face_authentication_id`	string	yes	The face authentication's unique identifier.

checkout-com.checkout_com_anonymize_face_authentication 2 parameters

Schema command

kosmo integrations:schema checkout-com.checkout_com_anonymize_face_authentication --json

Parameter	Type	Required	Description
`face_authentication_id`	string	yes	The face authentication's unique identifier.
`body`	object	no	Request body matching the official Checkout.com OpenAPI schema.

checkout-com.checkout_com_create_fav_attempt 2 parameters

Schema command

kosmo integrations:schema checkout-com.checkout_com_create_fav_attempt --json

Parameter	Type	Required	Description
`face_authentication_id`	string	yes	The face authentication's unique identifier.
`body`	object	no	Request body matching the official Checkout.com OpenAPI schema.

checkout-com.checkout_com_list_fav_attempts 1 parameters

Schema command

kosmo integrations:schema checkout-com.checkout_com_list_fav_attempts --json

Parameter	Type	Required	Description
`face_authentication_id`	string	yes	The face authentication's unique identifier.

checkout-com.checkout_com_get_fav_attempt 2 parameters

Schema command

kosmo integrations:schema checkout-com.checkout_com_get_fav_attempt --json

Parameter	Type	Required	Description
`face_authentication_id`	string	yes	The face authentication's unique identifier.
`attempt_id`	string	yes	The attempt's unique identifier.

checkout-com.checkout_com_upload_file 1 parameters

Schema command

kosmo integrations:schema checkout-com.checkout_com_upload_file --json

Parameter	Type	Required	Description
`body`	object	no	Request body matching the official Checkout.com OpenAPI schema.

checkout-com.checkout_com_get_file_information 1 parameters

Schema command

kosmo integrations:schema checkout-com.checkout_com_get_file_information --json

Parameter	Type	Required	Description
`file_id`	string	yes	The file identifier. It is always prefixed by `file_`.

checkout-com.checkout_com_get_financial_actions 4 parameters

Schema command

kosmo integrations:schema checkout-com.checkout_com_get_financial_actions --json

Parameter	Type	Required	Description
`payment_id`	string	no	The ID of the payment you want to retrieve financial actions for. Required if `action_id` is not used.
`action_id`	string	no	The ID of the action you want to retrieve financial actions for. Required if `payment_id` is not used.
`limit`	number	no	The number of results to retrieve per page. </br> For example, if the total result count is 50, and you use `limit=10`, you will need to iterate over 5 pages containing 10 results each to retrieve all of the reports that match your query.
`pagination_token`	string	no	A token used for pagination when a response contains results across multiple pages.

checkout-com.checkout_com_get_all_workflows 0 parameters

Schema command

kosmo integrations:schema checkout-com.checkout_com_get_all_workflows --json

Parameter	Type	Required	Description
No parameters.

checkout-com.checkout_com_add_workflow 1 parameters

Schema command

kosmo integrations:schema checkout-com.checkout_com_add_workflow --json

Parameter	Type	Required	Description
`body`	object	yes	Request body matching the official Checkout.com OpenAPI schema.

checkout-com.checkout_com_get_workflow 1 parameters

Schema command

kosmo integrations:schema checkout-com.checkout_com_get_workflow --json

Parameter	Type	Required	Description
`workflow_id`	string	yes	The workflow identifier

checkout-com.checkout_com_remove_workflow 1 parameters

Schema command

kosmo integrations:schema checkout-com.checkout_com_remove_workflow --json

Parameter	Type	Required	Description
`workflow_id`	string	yes	The workflow identifier

checkout-com.checkout_com_patch_workflow 2 parameters

Schema command

kosmo integrations:schema checkout-com.checkout_com_patch_workflow --json

Parameter	Type	Required	Description
`workflow_id`	string	yes	The workflow identifier
`body`	object	yes	Request body matching the official Checkout.com OpenAPI schema.

checkout-com.checkout_com_add_workflow_action 2 parameters

Schema command

kosmo integrations:schema checkout-com.checkout_com_add_workflow_action --json

Parameter	Type	Required	Description
`workflow_id`	string	yes	The workflow identifier
`body`	object	yes	Request body matching the official Checkout.com OpenAPI schema.

checkout-com.checkout_com_update_workflow_action 3 parameters

Schema command

kosmo integrations:schema checkout-com.checkout_com_update_workflow_action --json

Parameter	Type	Required	Description
`workflow_id`	string	yes	The workflow identifier
`workflow_action_id`	string	yes	The workflow action identifier
`body`	object	yes	Request body matching the official Checkout.com OpenAPI schema.

checkout-com.checkout_com_remove_workflow_action 2 parameters

Schema command

kosmo integrations:schema checkout-com.checkout_com_remove_workflow_action --json

Parameter	Type	Required	Description
`workflow_id`	string	yes	The workflow identifier
`workflow_action_id`	string	yes	The workflow action identifier

checkout-com.checkout_com_add_workflow_condition 2 parameters

Schema command

kosmo integrations:schema checkout-com.checkout_com_add_workflow_condition --json

Parameter	Type	Required	Description
`workflow_id`	string	yes	The workflow identifier
`body`	object	yes	Request body matching the official Checkout.com OpenAPI schema.

checkout-com.checkout_com_update_workflow_condition 3 parameters

Schema command

kosmo integrations:schema checkout-com.checkout_com_update_workflow_condition --json

Parameter	Type	Required	Description
`workflow_id`	string	yes	The workflow identifier
`workflow_condition_id`	string	yes	The workflow condition identifier
`body`	object	yes	Request body matching the official Checkout.com OpenAPI schema.

checkout-com.checkout_com_remove_workflow_condition 2 parameters

Schema command

kosmo integrations:schema checkout-com.checkout_com_remove_workflow_condition --json

Parameter	Type	Required	Description
`workflow_id`	string	yes	The workflow identifier
`workflow_condition_id`	string	yes	The workflow condition identifier

checkout-com.checkout_com_test_workflow 2 parameters

Schema command

kosmo integrations:schema checkout-com.checkout_com_test_workflow --json

Parameter	Type	Required	Description
`workflow_id`	string	yes	The workflow identifier
`body`	object	yes	Request body matching the official Checkout.com OpenAPI schema.

checkout-com.checkout_com_get_event_types 0 parameters

Schema command

kosmo integrations:schema checkout-com.checkout_com_get_event_types --json

Parameter	Type	Required	Description
No parameters.

checkout-com.checkout_com_get_workflow_event 1 parameters

Schema command

kosmo integrations:schema checkout-com.checkout_com_get_workflow_event --json

Parameter	Type	Required	Description
`event_id`	string	yes	The event identifier

checkout-com.checkout_com_get_workflow_action_invocations 2 parameters

Schema command

kosmo integrations:schema checkout-com.checkout_com_get_workflow_action_invocations --json

Parameter	Type	Required	Description
`event_id`	string	yes	The event identifier
`workflow_action_id`	string	yes	The workflow action identifier

checkout-com.checkout_com_reflow_by_event 2 parameters

Schema command

kosmo integrations:schema checkout-com.checkout_com_reflow_by_event --json

Parameter	Type	Required	Description
`event_id`	string	yes	The unique identifier for the event to be reflowed.
`body`	object	no	Request body matching the official Checkout.com OpenAPI schema.

checkout-com.checkout_com_reflow_by_event_and_workflow 3 parameters

Schema command

kosmo integrations:schema checkout-com.checkout_com_reflow_by_event_and_workflow --json

Parameter	Type	Required	Description
`event_id`	string	yes	The unique identifier for the event to be reflowed.
`workflow_id`	string	yes	The identifier of the workflow whose actions you want to trigger.
`body`	object	no	Request body matching the official Checkout.com OpenAPI schema.

checkout-com.checkout_com_reflow_events 1 parameters

Schema command

kosmo integrations:schema checkout-com.checkout_com_reflow_events --json

Parameter	Type	Required	Description
`body`	object	yes	Request body matching the official Checkout.com OpenAPI schema.

checkout-com.checkout_com_get_subject_events 1 parameters

Schema command

kosmo integrations:schema checkout-com.checkout_com_get_subject_events --json

Parameter	Type	Required	Description
`subject_id`	string	yes	The event identifier

checkout-com.checkout_com_reflow_by_subject 2 parameters

Schema command

kosmo integrations:schema checkout-com.checkout_com_reflow_by_subject --json

Parameter	Type	Required	Description
`subject_id`	string	yes	The subject identifier (for example, a payment ID or a dispute ID). The events associated with these subjects will be reflowed.
`body`	object	no	Request body matching the official Checkout.com OpenAPI schema.

checkout-com.checkout_com_reflow_by_subject_and_workflow 3 parameters

Schema command

kosmo integrations:schema checkout-com.checkout_com_reflow_by_subject_and_workflow --json

Parameter	Type	Required	Description
`subject_id`	string	yes	The subject identifier (for example, a payment ID or a dispute ID). The events associated with these subjects will be reflowed.
`workflow_id`	string	yes	The identifier of the workflow whose actions you want to trigger.
`body`	object	no	Request body matching the official Checkout.com OpenAPI schema.

checkout-com.checkout_com_get_fx_rates 4 parameters

Schema command

kosmo integrations:schema checkout-com.checkout_com_get_fx_rates --json

Parameter	Type	Required	Description
`product`	string	yes	product
`source`	string	yes	source
`currency_pairs`	string	yes	currency_pairs
`processing_channel_id`	string	yes	processing_channel_id

checkout-com.checkout_com_forward_request 1 parameters

Schema command

kosmo integrations:schema checkout-com.checkout_com_forward_request --json

Parameter	Type	Required	Description
`body`	object	yes	Request body matching the official Checkout.com OpenAPI schema.

checkout-com.checkout_com_get_forward_request 1 parameters

Schema command

kosmo integrations:schema checkout-com.checkout_com_get_forward_request --json

Parameter	Type	Required	Description
`id`	string	yes	The unique identifier of the forward request.

checkout-com.checkout_com_create_secret 1 parameters

Schema command

kosmo integrations:schema checkout-com.checkout_com_create_secret --json

Parameter	Type	Required	Description
`body`	object	yes	Request body matching the official Checkout.com OpenAPI schema.

checkout-com.checkout_com_list_secrets 0 parameters

Schema command

kosmo integrations:schema checkout-com.checkout_com_list_secrets --json

Parameter	Type	Required	Description
No parameters.

checkout-com.checkout_com_update_secret 2 parameters

Schema command

kosmo integrations:schema checkout-com.checkout_com_update_secret --json

Parameter	Type	Required	Description
`name`	string	yes	Secret name.
`body`	object	yes	Request body matching the official Checkout.com OpenAPI schema.

checkout-com.checkout_com_delete_secret 1 parameters

Schema command

kosmo integrations:schema checkout-com.checkout_com_delete_secret --json

Parameter	Type	Required	Description
`name`	string	yes	Secret name.

checkout-com.checkout_com_google_pay_enroll_merchant 1 parameters

Schema command

kosmo integrations:schema checkout-com.checkout_com_google_pay_enroll_merchant --json

Parameter	Type	Required	Description
`body`	object	no	Request body matching the official Checkout.com OpenAPI schema.

checkout-com.checkout_com_google_pay_register_domain 2 parameters

Schema command

kosmo integrations:schema checkout-com.checkout_com_google_pay_register_domain --json

Parameter	Type	Required	Description
`entity_id`	string	yes	Unique identifier of the entity.
`body`	object	no	Request body matching the official Checkout.com OpenAPI schema.

checkout-com.checkout_com_google_pay_get_registered_domains 1 parameters

Schema command

kosmo integrations:schema checkout-com.checkout_com_google_pay_get_registered_domains --json

Parameter	Type	Required	Description
`entity_id`	string	yes	Unique identifier of the entity.

checkout-com.checkout_com_google_pay_get_enrollment_state 1 parameters

Schema command

kosmo integrations:schema checkout-com.checkout_com_google_pay_get_enrollment_state --json

Parameter	Type	Required	Description
`entity_id`	string	yes	Unique identifier of the entity.

checkout-com.checkout_com_create_a_hosted_payments_session 1 parameters

Schema command

kosmo integrations:schema checkout-com.checkout_com_create_a_hosted_payments_session --json

Parameter	Type	Required	Description
`body`	object	yes	Request body matching the official Checkout.com OpenAPI schema.

checkout-com.checkout_com_get_hosted_payments_page_details 1 parameters

Schema command

kosmo integrations:schema checkout-com.checkout_com_get_hosted_payments_page_details --json

Parameter	Type	Required	Description
`id`	object	yes	id

checkout-com.checkout_com_create_id_document_verification 1 parameters

Schema command

kosmo integrations:schema checkout-com.checkout_com_create_id_document_verification --json

Parameter	Type	Required	Description
`body`	object	yes	Request body matching the official Checkout.com OpenAPI schema.

checkout-com.checkout_com_retrieve_id_document_verification 1 parameters

Schema command

kosmo integrations:schema checkout-com.checkout_com_retrieve_id_document_verification --json

Parameter	Type	Required	Description
`id_document_verification_id`	string	yes	The ID document verification's unique identifier.

checkout-com.checkout_com_anonymize_id_document_verification 2 parameters

Schema command

kosmo integrations:schema checkout-com.checkout_com_anonymize_id_document_verification --json

Parameter	Type	Required	Description
`id_document_verification_id`	string	yes	The ID document verification's unique identifier.
`body`	object	no	Request body matching the official Checkout.com OpenAPI schema.

checkout-com.checkout_com_create_id_document_verification_attempt 2 parameters

Schema command

kosmo integrations:schema checkout-com.checkout_com_create_id_document_verification_attempt --json

Parameter	Type	Required	Description
`id_document_verification_id`	string	yes	The ID document verification's unique identifier.
`body`	object	no	Request body matching the official Checkout.com OpenAPI schema.

checkout-com.checkout_com_list_attempts_id_document_verification 1 parameters

Schema command

kosmo integrations:schema checkout-com.checkout_com_list_attempts_id_document_verification --json

Parameter	Type	Required	Description
`id_document_verification_id`	string	yes	The ID document verification's unique identifier.

checkout-com.checkout_com_get_id_document_verification_attempt 2 parameters

Schema command

kosmo integrations:schema checkout-com.checkout_com_get_id_document_verification_attempt --json

Parameter	Type	Required	Description
`id_document_verification_id`	string	yes	The ID document verification's unique identifier.
`attempt_id`	string	yes	The attempt's unique identifier.

checkout-com.checkout_com_pdf_id_document_verification 1 parameters

Schema command

kosmo integrations:schema checkout-com.checkout_com_pdf_id_document_verification --json

Parameter	Type	Required	Description
`id_document_verification_id`	string	yes	The ID document verification's unique identifier.

checkout-com.checkout_com_create_applicant 1 parameters

Schema command

kosmo integrations:schema checkout-com.checkout_com_create_applicant --json

Parameter	Type	Required	Description
`body`	object	no	Request body matching the official Checkout.com OpenAPI schema.

checkout-com.checkout_com_retrieve_applicant 1 parameters

Schema command

kosmo integrations:schema checkout-com.checkout_com_retrieve_applicant --json

Parameter	Type	Required	Description
`applicant_id`	string	yes	The applicant profile's unique identifier.

checkout-com.checkout_com_update_applicant 2 parameters

Schema command

kosmo integrations:schema checkout-com.checkout_com_update_applicant --json

Parameter	Type	Required	Description
`applicant_id`	string	yes	The applicant profile's unique identifier.
`body`	object	no	Request body matching the official Checkout.com OpenAPI schema.

checkout-com.checkout_com_anonymize_applicant 2 parameters

Schema command

kosmo integrations:schema checkout-com.checkout_com_anonymize_applicant --json

Parameter	Type	Required	Description
`applicant_id`	string	yes	The applicant profile's unique identifier.
`body`	object	no	Request body matching the official Checkout.com OpenAPI schema.

checkout-com.checkout_com_create_and_start_identity_verification 1 parameters

Schema command

kosmo integrations:schema checkout-com.checkout_com_create_and_start_identity_verification --json

Parameter	Type	Required	Description
`body`	object	yes	Request body matching the official Checkout.com OpenAPI schema.

checkout-com.checkout_com_create_identity_verification 1 parameters

Schema command

kosmo integrations:schema checkout-com.checkout_com_create_identity_verification --json

Parameter	Type	Required	Description
`body`	object	yes	Request body matching the official Checkout.com OpenAPI schema.

checkout-com.checkout_com_retrieve_identity_verification 1 parameters

Schema command

kosmo integrations:schema checkout-com.checkout_com_retrieve_identity_verification --json

Parameter	Type	Required	Description
`identity_verification_id`	string	yes	The identity verification's unique identifier.

checkout-com.checkout_com_anonymize_identity_verification 2 parameters

Schema command

kosmo integrations:schema checkout-com.checkout_com_anonymize_identity_verification --json

Parameter	Type	Required	Description
`identity_verification_id`	string	yes	The identity verification's unique identifier.
`body`	object	no	Request body matching the official Checkout.com OpenAPI schema.

checkout-com.checkout_com_create_attempt 2 parameters

Schema command

kosmo integrations:schema checkout-com.checkout_com_create_attempt --json

Parameter	Type	Required	Description
`identity_verification_id`	string	yes	The identity verification's unique identifier.
`body`	object	no	Request body matching the official Checkout.com OpenAPI schema.

checkout-com.checkout_com_list_attempts 1 parameters

Schema command

kosmo integrations:schema checkout-com.checkout_com_list_attempts --json

Parameter	Type	Required	Description
`identity_verification_id`	string	yes	The identity verification's unique identifier.

checkout-com.checkout_com_get_attempt 2 parameters

Schema command

kosmo integrations:schema checkout-com.checkout_com_get_attempt --json

Parameter	Type	Required	Description
`identity_verification_id`	string	yes	The identity verification's unique identifier.
`attempt_id`	string	yes	The attempt's unique identifier.

checkout-com.checkout_com_pdf_identity_verification 1 parameters

Schema command

kosmo integrations:schema checkout-com.checkout_com_pdf_identity_verification --json

Parameter	Type	Required	Description
`identity_verification_id`	string	yes	The identity verification's unique identifier.

checkout-com.checkout_com_create_an_instrument 1 parameters

Schema command

kosmo integrations:schema checkout-com.checkout_com_create_an_instrument --json

Parameter	Type	Required	Description
`body`	object	yes	Request body matching the official Checkout.com OpenAPI schema.

checkout-com.checkout_com_get_instrument_details 1 parameters

Schema command

kosmo integrations:schema checkout-com.checkout_com_get_instrument_details --json

Parameter	Type	Required	Description
`id`	string	yes	The instrument ID

checkout-com.checkout_com_update_instrument 2 parameters

Schema command

kosmo integrations:schema checkout-com.checkout_com_update_instrument --json

Parameter	Type	Required	Description
`id`	string	yes	The instrument ID
`body`	object	yes	Request body matching the official Checkout.com OpenAPI schema.

checkout-com.checkout_com_delete_instrument 1 parameters

Schema command

kosmo integrations:schema checkout-com.checkout_com_delete_instrument --json

Parameter	Type	Required	Description
`id`	string	yes	The ID of the payment instrument to be deleted

checkout-com.checkout_com_request_cardholder_access_token 1 parameters

Schema command

kosmo integrations:schema checkout-com.checkout_com_request_cardholder_access_token --json

Parameter	Type	Required	Description
`body`	object	no	Request body matching the official Checkout.com OpenAPI schema.

checkout-com.checkout_com_create_cardholder 1 parameters

Schema command

kosmo integrations:schema checkout-com.checkout_com_create_cardholder --json

Parameter	Type	Required	Description
`body`	object	yes	Request body matching the official Checkout.com OpenAPI schema.

checkout-com.checkout_com_get_cardholder 1 parameters

Schema command

kosmo integrations:schema checkout-com.checkout_com_get_cardholder --json

Parameter	Type	Required	Description
`cardholder_id`	string	yes	cardholderId

checkout-com.checkout_com_update_cardholder 2 parameters

Schema command

kosmo integrations:schema checkout-com.checkout_com_update_cardholder --json

Parameter	Type	Required	Description
`cardholder_id`	string	yes	cardholderId
`body`	object	yes	Request body matching the official Checkout.com OpenAPI schema.

checkout-com.checkout_com_get_cardholder_cards 2 parameters

Schema command

kosmo integrations:schema checkout-com.checkout_com_get_cardholder_cards --json

Parameter	Type	Required	Description
`cardholder_id`	string	yes	cardholderId
`statuses`	string	no	The card statuses to filter the results by. Cards matching any status in this list are returned. If the list is empty, all cards are returned. Format - Comma-separated list

checkout-com.checkout_com_create_card 2 parameters

Schema command

kosmo integrations:schema checkout-com.checkout_com_create_card --json

Parameter	Type	Required	Description
`cko_idempotency_key`	string	no	An optional idempotency key for safely retrying Issuing requests.
`body`	object	yes	Request body matching the official Checkout.com OpenAPI schema.

checkout-com.checkout_com_get_card 1 parameters

Schema command

kosmo integrations:schema checkout-com.checkout_com_get_card --json

Parameter	Type	Required	Description
`card_id`	string	yes	cardId

checkout-com.checkout_com_update_card 2 parameters

Schema command

kosmo integrations:schema checkout-com.checkout_com_update_card --json

Parameter	Type	Required	Description
`card_id`	string	yes	cardId
`body`	object	yes	Request body matching the official Checkout.com OpenAPI schema.

checkout-com.checkout_com_enroll_card 2 parameters

Schema command

kosmo integrations:schema checkout-com.checkout_com_enroll_card --json

Parameter	Type	Required	Description
`card_id`	string	yes	cardId
`body`	object	yes	Request body matching the official Checkout.com OpenAPI schema.

checkout-com.checkout_com_update_card_enrollment_details 2 parameters

Schema command

kosmo integrations:schema checkout-com.checkout_com_update_card_enrollment_details --json

Parameter	Type	Required	Description
`card_id`	string	yes	cardId
`body`	object	yes	Request body matching the official Checkout.com OpenAPI schema.

checkout-com.checkout_com_get_card_enrollment_details 1 parameters

Schema command

kosmo integrations:schema checkout-com.checkout_com_get_card_enrollment_details --json

Parameter	Type	Required	Description
`card_id`	string	yes	cardId

checkout-com.checkout_com_activate_card 2 parameters

Schema command

kosmo integrations:schema checkout-com.checkout_com_activate_card --json

Parameter	Type	Required	Description
`card_id`	string	yes	cardId
`body`	object	no	Request body matching the official Checkout.com OpenAPI schema.

checkout-com.checkout_com_get_card_credentials 2 parameters

Schema command

kosmo integrations:schema checkout-com.checkout_com_get_card_credentials --json

Parameter	Type	Required	Description
`card_id`	string	yes	cardId
`credentials`	string	no	credentials

checkout-com.checkout_com_renew_card 2 parameters

Schema command

kosmo integrations:schema checkout-com.checkout_com_renew_card --json

Parameter	Type	Required	Description
`card_id`	string	yes	cardId
`body`	object	yes	Request body matching the official Checkout.com OpenAPI schema.

checkout-com.checkout_com_revoke_card 2 parameters

Schema command

kosmo integrations:schema checkout-com.checkout_com_revoke_card --json

Parameter	Type	Required	Description
`card_id`	string	yes	cardId
`body`	object	yes	Request body matching the official Checkout.com OpenAPI schema.

checkout-com.checkout_com_add_scheduled_revocation_date 2 parameters

Schema command

kosmo integrations:schema checkout-com.checkout_com_add_scheduled_revocation_date --json

Parameter	Type	Required	Description
`card_id`	string	yes	cardId
`body`	object	yes	Request body matching the official Checkout.com OpenAPI schema.

checkout-com.checkout_com_delete_scheduled_revocation_date 1 parameters

Schema command

kosmo integrations:schema checkout-com.checkout_com_delete_scheduled_revocation_date --json

Parameter	Type	Required	Description
`card_id`	string	yes	cardId

checkout-com.checkout_com_suspend_card 2 parameters

Schema command

kosmo integrations:schema checkout-com.checkout_com_suspend_card --json

Parameter	Type	Required	Description
`card_id`	string	yes	cardId
`body`	object	yes	Request body matching the official Checkout.com OpenAPI schema.

checkout-com.checkout_com_create_control 2 parameters

Schema command

kosmo integrations:schema checkout-com.checkout_com_create_control --json

Parameter	Type	Required	Description
`cko_idempotency_key`	string	no	An optional idempotency key for safely retrying Issuing requests.
`body`	object	yes	Request body matching the official Checkout.com OpenAPI schema.

checkout-com.checkout_com_get_control_by_target 1 parameters

Schema command

kosmo integrations:schema checkout-com.checkout_com_get_control_by_target --json

Parameter	Type	Required	Description
`target_id`	string	yes	target_id

checkout-com.checkout_com_get_control 2 parameters

Schema command

kosmo integrations:schema checkout-com.checkout_com_get_control --json

Parameter	Type	Required	Description
`control_id`	string	yes	controlId
`card_id`	string	no	The unique identifier for the card you want to get the remaining cascading velocity control for.

checkout-com.checkout_com_update_control 2 parameters

Schema command

kosmo integrations:schema checkout-com.checkout_com_update_control --json

Parameter	Type	Required	Description
`control_id`	string	yes	controlId
`body`	object	yes	Request body matching the official Checkout.com OpenAPI schema.

checkout-com.checkout_com_delete_control 1 parameters

Schema command

kosmo integrations:schema checkout-com.checkout_com_delete_control --json

Parameter	Type	Required	Description
`control_id`	string	yes	controlId

checkout-com.checkout_com_create_control_group 1 parameters

Schema command

kosmo integrations:schema checkout-com.checkout_com_create_control_group --json

Parameter	Type	Required	Description
`body`	object	yes	Request body matching the official Checkout.com OpenAPI schema.

checkout-com.checkout_com_get_control_group_by_target 1 parameters

Schema command

kosmo integrations:schema checkout-com.checkout_com_get_control_group_by_target --json

Parameter	Type	Required	Description
`target_id`	string	yes	target_id

checkout-com.checkout_com_get_control_group 1 parameters

Schema command

kosmo integrations:schema checkout-com.checkout_com_get_control_group --json

Parameter	Type	Required	Description
`control_group_id`	string	yes	controlGroupId

checkout-com.checkout_com_delete_control_group 1 parameters

Schema command

kosmo integrations:schema checkout-com.checkout_com_delete_control_group --json

Parameter	Type	Required	Description
`control_group_id`	string	yes	controlGroupId

checkout-com.checkout_com_create_control_profile 1 parameters

Schema command

kosmo integrations:schema checkout-com.checkout_com_create_control_profile --json

Parameter	Type	Required	Description
`body`	object	yes	Request body matching the official Checkout.com OpenAPI schema.

checkout-com.checkout_com_get_control_profiles_by_target 1 parameters

Schema command

kosmo integrations:schema checkout-com.checkout_com_get_control_profiles_by_target --json

Parameter	Type	Required	Description
`target_id`	string	no	target_id

checkout-com.checkout_com_get_control_profile 1 parameters

Schema command

kosmo integrations:schema checkout-com.checkout_com_get_control_profile --json

Parameter	Type	Required	Description
`control_profile_id`	string	yes	controlProfileId

checkout-com.checkout_com_update_control_profile 2 parameters

Schema command

kosmo integrations:schema checkout-com.checkout_com_update_control_profile --json

Parameter	Type	Required	Description
`control_profile_id`	string	yes	controlProfileId
`body`	object	yes	Request body matching the official Checkout.com OpenAPI schema.

checkout-com.checkout_com_delete_control_profile 1 parameters

Schema command

kosmo integrations:schema checkout-com.checkout_com_delete_control_profile --json

Parameter	Type	Required	Description
`control_profile_id`	string	yes	controlProfileId

checkout-com.checkout_com_add_target_to_control_profile 3 parameters

Schema command

kosmo integrations:schema checkout-com.checkout_com_add_target_to_control_profile --json

Parameter	Type	Required	Description
`control_profile_id`	string	yes	controlProfileId
`target_id`	string	yes	targetId
`body`	object	no	Request body matching the official Checkout.com OpenAPI schema.

checkout-com.checkout_com_remove_target_from_control_profile 3 parameters

Schema command

kosmo integrations:schema checkout-com.checkout_com_remove_target_from_control_profile --json

Parameter	Type	Required	Description
`control_profile_id`	string	yes	controlProfileId
`target_id`	string	yes	targetId
`body`	object	no	Request body matching the official Checkout.com OpenAPI schema.

checkout-com.checkout_com_get_digital_card 1 parameters

Schema command

kosmo integrations:schema checkout-com.checkout_com_get_digital_card --json

Parameter	Type	Required	Description
`digital_card_id`	string	yes	digitalCardId

checkout-com.checkout_com_create_dispute 2 parameters

Schema command

kosmo integrations:schema checkout-com.checkout_com_create_dispute --json

Parameter	Type	Required	Description
`cko_idempotency_key`	string	yes	An idempotency key for safely retrying requests.
`body`	object	yes	Request body matching the official Checkout.com OpenAPI schema.

checkout-com.checkout_com_get_dispute 1 parameters

Schema command

kosmo integrations:schema checkout-com.checkout_com_get_dispute --json

Parameter	Type	Required	Description
`dispute_id`	string	yes	disputeId

checkout-com.checkout_com_cancel_dispute 3 parameters

Schema command

kosmo integrations:schema checkout-com.checkout_com_cancel_dispute --json

Parameter	Type	Required	Description
`cko_idempotency_key`	string	yes	An idempotency key for safely retrying requests.
`dispute_id`	string	yes	disputeId
`body`	object	no	Request body matching the official Checkout.com OpenAPI schema.

checkout-com.checkout_com_escalate_dispute 3 parameters

Schema command

kosmo integrations:schema checkout-com.checkout_com_escalate_dispute --json

Parameter	Type	Required	Description
`cko_idempotency_key`	string	yes	An idempotency key for safely retrying requests.
`dispute_id`	string	yes	disputeId
`body`	object	no	Request body matching the official Checkout.com OpenAPI schema.

checkout-com.checkout_com_simulate_authorization 1 parameters

Schema command

kosmo integrations:schema checkout-com.checkout_com_simulate_authorization --json

Parameter	Type	Required	Description
`body`	object	yes	Request body matching the official Checkout.com OpenAPI schema.

checkout-com.checkout_com_simulate_incremental_authorization 2 parameters

Schema command

kosmo integrations:schema checkout-com.checkout_com_simulate_incremental_authorization --json

Parameter	Type	Required	Description
`id`	string	yes	id
`body`	object	yes	Request body matching the official Checkout.com OpenAPI schema.

checkout-com.checkout_com_simulate_presentment 2 parameters

Schema command

kosmo integrations:schema checkout-com.checkout_com_simulate_presentment --json

Parameter	Type	Required	Description
`id`	string	yes	id
`body`	object	yes	Request body matching the official Checkout.com OpenAPI schema.

checkout-com.checkout_com_simulate_refund 2 parameters

Schema command

kosmo integrations:schema checkout-com.checkout_com_simulate_refund --json

Parameter	Type	Required	Description
`id`	string	yes	id
`body`	object	yes	Request body matching the official Checkout.com OpenAPI schema.

checkout-com.checkout_com_simulate_reversal 2 parameters

Schema command

kosmo integrations:schema checkout-com.checkout_com_simulate_reversal --json

Parameter	Type	Required	Description
`id`	string	yes	id
`body`	object	yes	Request body matching the official Checkout.com OpenAPI schema.

checkout-com.checkout_com_simulate_oob_authentication 1 parameters

Schema command

kosmo integrations:schema checkout-com.checkout_com_simulate_oob_authentication --json

Parameter	Type	Required	Description
`body`	object	no	Request body matching the official Checkout.com OpenAPI schema.

checkout-com.checkout_com_get_transactions 8 parameters

Schema command

kosmo integrations:schema checkout-com.checkout_com_get_transactions --json

Parameter	Type	Required	Description
`limit`	number	no	The maximum number of transactions returned (between 10-100). The default is 10.
`skip`	number	no	The number of transactions to skip. The default is 0.
`cardholder_id`	string	no	cardholder_id
`card_id`	string	no	card_id
`entity_id`	string	no	entity_id
`status`	string	no	An optional filter for the transaction lifecycle status.
`from`	string	no	An optional start date filter for transactions, in ISO 8601 format.
`to`	string	no	An optional end date filter for transactions, in ISO 8601 format.

checkout-com.checkout_com_get_transaction_by_id 1 parameters

Schema command

kosmo integrations:schema checkout-com.checkout_com_get_transaction_by_id --json

Parameter	Type	Required	Description
`transaction_id`	string	yes	transactionId

checkout-com.checkout_com_request_card_metadata 1 parameters

Schema command

kosmo integrations:schema checkout-com.checkout_com_request_card_metadata --json

Parameter	Type	Required	Description
`body`	object	no	Request body matching the official Checkout.com OpenAPI schema.

checkout-com.checkout_com_provision_network_token 1 parameters

Schema command

kosmo integrations:schema checkout-com.checkout_com_provision_network_token --json

Parameter	Type	Required	Description
`body`	object	no	Request body matching the official Checkout.com OpenAPI schema.

checkout-com.checkout_com_get_network_token 1 parameters

Schema command

kosmo integrations:schema checkout-com.checkout_com_get_network_token --json

Parameter	Type	Required	Description
`network_token_id`	string	yes	Unique token ID assigned by Checkout.com for each token

checkout-com.checkout_com_provision_cryptogram 2 parameters

Schema command

kosmo integrations:schema checkout-com.checkout_com_provision_cryptogram --json

Parameter	Type	Required	Description
`network_token_id`	string	yes	Unique token ID assigned by Checkout.com for each token
`body`	object	no	Request body matching the official Checkout.com OpenAPI schema.

checkout-com.checkout_com_delete_network_token 2 parameters

Schema command

kosmo integrations:schema checkout-com.checkout_com_delete_network_token --json

Parameter	Type	Required	Description
`network_token_id`	string	yes	Unique token ID assigned by Checkout.com for each token
`body`	object	no	Request body matching the official Checkout.com OpenAPI schema.

checkout-com.checkout_com_request_a_payment_context 2 parameters

Schema command

kosmo integrations:schema checkout-com.checkout_com_request_a_payment_context --json

Parameter	Type	Required	Description
`cko_idempotency_key`	string	no	An optional idempotency key for safely retrying payment requests
`body`	object	no	Request body matching the official Checkout.com OpenAPI schema.

checkout-com.checkout_com_get_payment_context 1 parameters

Schema command

kosmo integrations:schema checkout-com.checkout_com_get_payment_context --json

Parameter	Type	Required	Description
`id`	string	yes	id

checkout-com.checkout_com_create_a_payment_link_session 1 parameters

Schema command

kosmo integrations:schema checkout-com.checkout_com_create_a_payment_link_session --json

Parameter	Type	Required	Description
`body`	object	yes	Request body matching the official Checkout.com OpenAPI schema.

checkout-com.checkout_com_get_payment_link_details 1 parameters

Schema command

kosmo integrations:schema checkout-com.checkout_com_get_payment_link_details --json

Parameter	Type	Required	Description
`id`	object	yes	id

checkout-com.checkout_com_get_payment_methods 1 parameters

Schema command

kosmo integrations:schema checkout-com.checkout_com_get_payment_methods --json

Parameter	Type	Required	Description
`processing_channel_id`	string	yes	processing_channel_id

checkout-com.checkout_com_create_payment_session 1 parameters

Schema command

kosmo integrations:schema checkout-com.checkout_com_create_payment_session --json

Parameter	Type	Required	Description
`body`	object	no	Request body matching the official Checkout.com OpenAPI schema.

checkout-com.checkout_com_submit_payment_session 2 parameters

Schema command

kosmo integrations:schema checkout-com.checkout_com_submit_payment_session --json

Parameter	Type	Required	Description
`id`	string	yes	The Payment Sessions unique identifier
`body`	object	no	Request body matching the official Checkout.com OpenAPI schema.

checkout-com.checkout_com_create_and_submit_payment_session 1 parameters

Schema command

kosmo integrations:schema checkout-com.checkout_com_create_and_submit_payment_session --json

Parameter	Type	Required	Description
`body`	object	no	Request body matching the official Checkout.com OpenAPI schema.

checkout-com.checkout_com_request_a_payment_or_payout 2 parameters

Schema command

kosmo integrations:schema checkout-com.checkout_com_request_a_payment_or_payout --json

Parameter	Type	Required	Description
`cko_idempotency_key`	string	no	An optional idempotency key for safely retrying payment requests
`body`	object	no	Request body matching the official Checkout.com OpenAPI schema.

checkout-com.checkout_com_get_payments_list 3 parameters

Schema command

kosmo integrations:schema checkout-com.checkout_com_get_payments_list --json

Parameter	Type	Required	Description
`limit`	number	no	The numbers of results to retrieve
`skip`	number	no	The number of results to skip
`reference`	string	yes	A reference, such as an order ID, that can be used to identify the payment

checkout-com.checkout_com_get_payment_details 1 parameters

Schema command

kosmo integrations:schema checkout-com.checkout_com_get_payment_details --json

Parameter	Type	Required	Description
`id`	string	yes	The payment or payment session identifier

checkout-com.checkout_com_get_payment_actions 1 parameters

Schema command

kosmo integrations:schema checkout-com.checkout_com_get_payment_actions --json

Parameter	Type	Required	Description
`id`	string	yes	The payment identifier

checkout-com.checkout_com_increment_payment_authorization 3 parameters

Schema command

kosmo integrations:schema checkout-com.checkout_com_increment_payment_authorization --json

Parameter	Type	Required	Description
`cko_idempotency_key`	string	no	An optional idempotency key for safely retrying payment requests
`id`	string	yes	The payment identifier
`body`	object	no	Request body matching the official Checkout.com OpenAPI schema.

checkout-com.checkout_com_cancel_a_payment 3 parameters

Schema command

kosmo integrations:schema checkout-com.checkout_com_cancel_a_payment --json

Parameter	Type	Required	Description
`cko_idempotency_key`	string	no	An optional idempotency key for safely retrying payment requests
`id`	string	yes	The unique payment identifier.
`body`	object	no	Request body matching the official Checkout.com OpenAPI schema.

checkout-com.checkout_com_capture_a_payment 3 parameters

Schema command

kosmo integrations:schema checkout-com.checkout_com_capture_a_payment --json

Parameter	Type	Required	Description
`cko_idempotency_key`	string	no	An optional idempotency key for safely retrying payment requests
`id`	string	yes	The payment identifier
`body`	object	no	Request body matching the official Checkout.com OpenAPI schema.

checkout-com.checkout_com_refund_a_payment 3 parameters

Schema command

kosmo integrations:schema checkout-com.checkout_com_refund_a_payment --json

Parameter	Type	Required	Description
`cko_idempotency_key`	string	no	An optional idempotency key for safely retrying payment requests
`id`	string	yes	The payment identifier
`body`	object	no	Request body matching the official Checkout.com OpenAPI schema.

checkout-com.checkout_com_reverse_payment 3 parameters

Schema command

kosmo integrations:schema checkout-com.checkout_com_reverse_payment --json

Parameter	Type	Required	Description
`cko_idempotency_key`	string	no	An optional idempotency key for safely retrying payment requests
`id`	string	yes	The unique identifier for the payment.
`body`	object	no	Request body matching the official Checkout.com OpenAPI schema.

checkout-com.checkout_com_void_a_payment 3 parameters

Schema command

kosmo integrations:schema checkout-com.checkout_com_void_a_payment --json

Parameter	Type	Required	Description
`cko_idempotency_key`	string	no	An optional idempotency key for safely retrying payment requests
`id`	string	yes	The payment identifier
`body`	object	no	Request body matching the official Checkout.com OpenAPI schema.

checkout-com.checkout_com_search 1 parameters

Schema command

kosmo integrations:schema checkout-com.checkout_com_search --json

Parameter	Type	Required	Description
`body`	object	yes	Request body matching the official Checkout.com OpenAPI schema.

checkout-com.checkout_com_create_a_payment_setup 1 parameters

Schema command

kosmo integrations:schema checkout-com.checkout_com_create_a_payment_setup --json

Parameter	Type	Required	Description
`body`	object	yes	Request body matching the official Checkout.com OpenAPI schema.

checkout-com.checkout_com_update_a_payment_setup 2 parameters

Schema command

kosmo integrations:schema checkout-com.checkout_com_update_a_payment_setup --json

Parameter	Type	Required	Description
`id`	string	yes	The unique identifier of the Payment Setup to update.
`body`	object	yes	Request body matching the official Checkout.com OpenAPI schema.

checkout-com.checkout_com_get_a_payment_setup 1 parameters

Schema command

kosmo integrations:schema checkout-com.checkout_com_get_a_payment_setup --json

Parameter	Type	Required	Description
`id`	string	yes	The unique identifier of the Payment Setup to retrieve.

checkout-com.checkout_com_confirm_a_payment_setup 3 parameters

Schema command

kosmo integrations:schema checkout-com.checkout_com_confirm_a_payment_setup --json

Parameter	Type	Required	Description
`id`	string	yes	The unique identifier of the Payment Setup.
`payment_method_name`	string	yes	The name of the payment method to process the payment with (For example, `tabby`, `klarna`, `card`).
`body`	object	no	Request body matching the official Checkout.com OpenAPI schema.

checkout-com.checkout_com_get_reports 5 parameters

Schema command

kosmo integrations:schema checkout-com.checkout_com_get_reports --json

Parameter	Type	Required	Description
`created_after`	string	no	Filters reports to those created on or after the specified timestamp, in UTC. <br/>Format – ISO 8601 code
`created_before`	string	no	Filters reports to those created before the specified timestamp, in UTC. <br/>Format – ISO 8601 code
`entity_id`	string	no	Filters reports to those created for the specified entity. <br/>Sub-entity IDs are not supported.
`limit`	number	no	The number of results you want to include per page. </br> For example, if there are 50 results and you set limit=10, you receive 5 pages each containing 10 results.
`pagination_token`	string	no	A token used to paginate multiple pages of results.

checkout-com.checkout_com_get_report_details 1 parameters

Schema command

kosmo integrations:schema checkout-com.checkout_com_get_report_details --json

Parameter	Type	Required	Description
`id`	string	yes	The ID of the report to retrieve.

checkout-com.checkout_com_get_report_file 2 parameters

Schema command

kosmo integrations:schema checkout-com.checkout_com_get_report_file --json

Parameter	Type	Required	Description
`id`	string	yes	The ID of the report that the file belongs to.
`file_id`	string	yes	The ID of the file to retrieve.

checkout-com.checkout_com_create_session 1 parameters

Schema command

kosmo integrations:schema checkout-com.checkout_com_create_session --json

Parameter	Type	Required	Description
`body`	object	no	Request body matching the official Checkout.com OpenAPI schema.

checkout-com.checkout_com_get_session 2 parameters

Schema command

kosmo integrations:schema checkout-com.checkout_com_get_session --json

Parameter	Type	Required	Description
`id`	string	yes	Session ID
`channel`	string	no	Optionally provide the type of channnel so you only get the relevant actions

checkout-com.checkout_com_update_session 2 parameters

Schema command

kosmo integrations:schema checkout-com.checkout_com_update_session --json

Parameter	Type	Required	Description
`id`	string	yes	Session ID
`body`	object	yes	Request body matching the official Checkout.com OpenAPI schema.

checkout-com.checkout_com_complete_session 2 parameters

Schema command

kosmo integrations:schema checkout-com.checkout_com_complete_session --json

Parameter	Type	Required	Description
`id`	string	yes	Session ID
`body`	object	no	Request body matching the official Checkout.com OpenAPI schema.

checkout-com.checkout_com_update_session_three_ds_method_completion 2 parameters

Schema command

kosmo integrations:schema checkout-com.checkout_com_update_session_three_ds_method_completion --json

Parameter	Type	Required	Description
`id`	string	yes	Session ID
`body`	object	yes	Request body matching the official Checkout.com OpenAPI schema.

checkout-com.checkout_com_request_a_token 1 parameters

Schema command

kosmo integrations:schema checkout-com.checkout_com_request_a_token --json

Parameter	Type	Required	Description
`body`	object	no	Request body matching the official Checkout.com OpenAPI schema.

checkout-com.checkout_com_create_transfer 2 parameters

Schema command

kosmo integrations:schema checkout-com.checkout_com_create_transfer --json

Parameter	Type	Required	Description
`cko_idempotency_key`	string	yes	An idempotency key for safely retrying transfer requests
`body`	object	yes	Request body matching the official Checkout.com OpenAPI schema.

checkout-com.checkout_com_get_transfer_details 1 parameters

Schema command

kosmo integrations:schema checkout-com.checkout_com_get_transfer_details --json

Parameter	Type	Required	Description
`id`	string	yes	The transfer identifier

checkout-com.checkout_com_get_bank_account_fields 4 parameters

Schema command

kosmo integrations:schema checkout-com.checkout_com_get_bank_account_fields --json

Parameter	Type	Required	Description
`country`	string	yes	The two-letter <a href="https://www.checkout.com/docs/resources/codes/country-codes" target="_blank">ISO country code</a>
`currency`	string	yes	The three-letter <a href="https://www.checkout.com/docs/resources/codes/currency-codes" target="_blank">ISO currency code</a>
`account_holder_type`	string	no	The type of account holder that will be used to filter the fields returned
`payment_network`	string	no	The banking network that will be used to filter the fields returned

Permissions

Headless calls still follow the integration read/write permission policy. Configure read/write defaults with integrations:configure. Add --force only for trusted automation that should bypass that policy.