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 Lua API for KosmoKrator Agents

Agent-facing Lua documentation and function reference for the Checkout.com KosmoKrator integration.

Lua Namespace

Agents call this integration through app.integrations.checkout_com.*. Use lua_read_doc("integrations.checkout-com") inside KosmoKrator to discover the same reference at runtime.

Call Lua from the Headless CLI

Use kosmo integrations:lua when a shell script, CI job, cron job, or another coding CLI should run a deterministic Checkout.com workflow without starting an interactive agent session.

Inline Lua call

kosmo integrations:lua --eval 'dump(app.integrations.checkout_com.retrieve_updated_card_details({body = "example_body"}))' --json

Read Lua docs headlessly

kosmo integrations:lua --eval 'print(docs.read("checkout-com"))' --json
kosmo integrations:lua --eval 'print(docs.read("checkout-com.retrieve_updated_card_details"))' --json

Workflow file

Put repeatable logic in a Lua file, then execute it with JSON output for the calling process.

workflow.lua

local checkout_com = app.integrations.checkout_com
local result = checkout_com.retrieve_updated_card_details({body = "example_body"})

dump(result)

Run the workflow

kosmo integrations:lua workflow.lua --json
kosmo integrations:lua workflow.lua --force --json

Namespace note. integrations:lua exposes app.integrations.checkout_com, app.mcp.*, docs.*, json.*, and regex.*. Use app.integrations.checkout_com.default.* or app.integrations.checkout_com.work.* when you configured named credential accounts.

MCP-only Lua

If the script only needs configured MCP servers and does not need Checkout.com, use the narrower mcp:lua command.

MCP Lua command

# Use mcp:lua for MCP-only scripts; use integrations:lua for this integration namespace.
kosmo mcp:lua --eval 'dump(mcp.servers())' --json

Agent-Facing Lua Docs

This is the rendered version of the full Lua documentation exposed to agents when they inspect the integration namespace.

Checkout.com Integration

Use the checkout-com integration to manage Checkout.com payments, payouts, payment sessions, hosted payments, payment links, disputes, issuing cards and controls, platform entities, workflows, balances, transfers, reports, files, and authentication token requests.

All endpoint tools are generated from the official Checkout.com OpenAPI document at https://api-reference.checkout.com/v1/swagger.json. Configure a Checkout.com key or access token; authenticated runtime calls send Authorization: Bearer <value>. Checkout.com base URLs are unique per account, so set url and access_url to the sandbox or production URLs shown in your Checkout.com dashboard.

Common Tools

checkout_com_request_a_payment_or_payout, checkout_com_get_payments_list, checkout_com_get_payment_details, checkout_com_capture_a_payment, checkout_com_refund_a_payment, checkout_com_cancel_a_payment, and checkout_com_void_a_payment cover payment lifecycle operations.
checkout_com_create_payment_session, checkout_com_submit_payment_session, and checkout_com_create_and_submit_payment_session cover payment sessions.
Platform entity, payment instrument, dispute, issuing card, control, transfer, workflow, balance, report, file, and identity-verification tools map directly to the official API reference.
checkout_com_request_an_access_token uses access_url and form-encoded body fields such as grant_type, client_id, client_secret, and scope.

Request Shape

Path, query, and header parameters are exposed as snake_case tool parameters. JSON, form-encoded, and multipart request bodies are passed through the body object and should match the official Checkout.com schema for the endpoint. Header parameters such as cko_idempotency_key are mapped to their documented names.

Return Shape

JSON responses are returned as decoded arrays/objects from Checkout.com. Empty successful responses return { success = true, status = <http_status> }.

Examples

local methods = app.integrations["checkout-com"].get_payment_methods({})

local payment = app.integrations["checkout-com"].request_a_payment_or_payout({
  cko_idempotency_key = "example-payment-key-001",
  body = {
    source = { type = "token", token = "tok_example" },
    amount = 1299,
    currency = "USD",
    reference = "example-order-001"
  }
})

local token = app.integrations["checkout-com"].request_an_access_token({
  body = {
    grant_type = "client_credentials",
    client_id = "ack_example",
    client_secret = "example-secret",
    scope = "gateway"
  }
})

Use fake IDs, tokens, customers, disputes, cardholders, and metadata in tests and prompts. Never place real card data, customer data, payment IDs, account prefixes, API keys, access tokens, or files in fixtures or Lua examples.

Raw agent markdown

# Checkout.com Integration

Use the `checkout-com` integration to manage Checkout.com payments, payouts, payment sessions, hosted payments, payment links, disputes, issuing cards and controls, platform entities, workflows, balances, transfers, reports, files, and authentication token requests.

All endpoint tools are generated from the official Checkout.com OpenAPI document at `https://api-reference.checkout.com/v1/swagger.json`. Configure a Checkout.com key or access token; authenticated runtime calls send `Authorization: Bearer <value>`. Checkout.com base URLs are unique per account, so set `url` and `access_url` to the sandbox or production URLs shown in your Checkout.com dashboard.

## Common Tools

- `checkout_com_request_a_payment_or_payout`, `checkout_com_get_payments_list`, `checkout_com_get_payment_details`, `checkout_com_capture_a_payment`, `checkout_com_refund_a_payment`, `checkout_com_cancel_a_payment`, and `checkout_com_void_a_payment` cover payment lifecycle operations.
- `checkout_com_create_payment_session`, `checkout_com_submit_payment_session`, and `checkout_com_create_and_submit_payment_session` cover payment sessions.
- Platform entity, payment instrument, dispute, issuing card, control, transfer, workflow, balance, report, file, and identity-verification tools map directly to the official API reference.
- `checkout_com_request_an_access_token` uses `access_url` and form-encoded `body` fields such as `grant_type`, `client_id`, `client_secret`, and `scope`.

## Request Shape

Path, query, and header parameters are exposed as snake_case tool parameters. JSON, form-encoded, and multipart request bodies are passed through the `body` object and should match the official Checkout.com schema for the endpoint. Header parameters such as `cko_idempotency_key` are mapped to their documented names.

## Return Shape

JSON responses are returned as decoded arrays/objects from Checkout.com. Empty successful responses return `{ success = true, status = <http_status> }`.

## Examples

```lua
local methods = app.integrations["checkout-com"].get_payment_methods({})

local payment = app.integrations["checkout-com"].request_a_payment_or_payout({
  cko_idempotency_key = "example-payment-key-001",
  body = {
    source = { type = "token", token = "tok_example" },
    amount = 1299,
    currency = "USD",
    reference = "example-order-001"
  }
})

local token = app.integrations["checkout-com"].request_an_access_token({
  body = {
    grant_type = "client_credentials",
    client_id = "ack_example",
    client_secret = "example-secret",
    scope = "gateway"
  }
})
```

Use fake IDs, tokens, customers, disputes, cardholders, and metadata in tests and prompts. Never place real card data, customer data, payment IDs, account prefixes, API keys, access tokens, or files in fixtures or Lua examples.

Metadata-derived Lua example

local result = app.integrations.checkout_com.retrieve_updated_card_details({body = "example_body"})
print(result)

Functions

retrieve_updated_card_details Read

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

Lua path: app.integrations.checkout_com.retrieve_updated_card_details
Full name: checkout-com.checkout_com_retrieve_updated_card_details

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

onboard_entity Read

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

Lua path: app.integrations.checkout_com.onboard_entity
Full name: checkout-com.checkout_com_onboard_entity

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.

get_sub_entity_members Read

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.

Lua path: app.integrations.checkout_com.get_sub_entity_members
Full name: checkout-com.checkout_com_get_sub_entity_members

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

reinvite_sub_entity_members Read

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}.

Lua path: app.integrations.checkout_com.reinvite_sub_entity_members
Full name: checkout-com.checkout_com_reinvite_sub_entity_members

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.

get_platforms_payment_instrument Read

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

Lua path: app.integrations.checkout_com.get_platforms_payment_instrument
Full name: checkout-com.checkout_com_get_platforms_payment_instrument

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

update_platforms_payment_instrument Write

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}.

Lua path: app.integrations.checkout_com.update_platforms_payment_instrument
Full name: checkout-com.checkout_com_update_platforms_payment_instrument

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.

get_reserve_rule Read

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

Lua path: app.integrations.checkout_com.get_reserve_rule
Full name: checkout-com.checkout_com_get_reserve_rule

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

update_reserve_rule Write

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}.

Lua path: app.integrations.checkout_com.update_reserve_rule
Full name: checkout-com.checkout_com_update_reserve_rule

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.

get_entity_details Read

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

Lua path: app.integrations.checkout_com.get_entity_details
Full name: checkout-com.checkout_com_get_entity_details

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.

update_entity_details Write

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}.

Lua path: app.integrations.checkout_com.update_entity_details
Full name: checkout-com.checkout_com_update_entity_details

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.

add_platforms_payment_instrument Write

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.

Lua path: app.integrations.checkout_com.add_platforms_payment_instrument
Full name: checkout-com.checkout_com_add_platforms_payment_instrument

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

query_platforms_payment_instruments Read

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.

Lua path: app.integrations.checkout_com.query_platforms_payment_instruments
Full name: checkout-com.checkout_com_query_platforms_payment_instruments

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

get_sub_entitys_payout_schedule Read

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.

Lua path: app.integrations.checkout_com.get_sub_entitys_payout_schedule
Full name: checkout-com.checkout_com_get_sub_entitys_payout_schedule

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

put_sub_entitys_payout_schedule Read

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.

Lua path: app.integrations.checkout_com.put_sub_entitys_payout_schedule
Full name: checkout-com.checkout_com_put_sub_entitys_payout_schedule

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.

add_reserve_rule Write

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

Lua path: app.integrations.checkout_com.add_reserve_rule
Full name: checkout-com.checkout_com_add_reserve_rule

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

query_reserve_rules Read

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

Lua path: app.integrations.checkout_com.query_reserve_rules
Full name: checkout-com.checkout_com_query_reserve_rules

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

delegate_payment Read

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

Lua path: app.integrations.checkout_com.delegate_payment
Full name: checkout-com.checkout_com_delegate_payment

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.

create_aml_verification Write

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.

Lua path: app.integrations.checkout_com.create_aml_verification
Full name: checkout-com.checkout_com_create_aml_verification

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

retrieve_aml_screening Read

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}.

Lua path: app.integrations.checkout_com.retrieve_aml_screening
Full name: checkout-com.checkout_com_retrieve_aml_screening

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

upload_apple_pay_certificate Read

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

Lua path: app.integrations.checkout_com.upload_apple_pay_certificate
Full name: checkout-com.checkout_com_upload_apple_pay_certificate

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

apple_pay_enroll_merchant Read

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

Lua path: app.integrations.checkout_com.apple_pay_enroll_merchant
Full name: checkout-com.checkout_com_apple_pay_enroll_merchant

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

generate_apple_pay_signing_request Read

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.

Lua path: app.integrations.checkout_com.generate_apple_pay_signing_request
Full name: checkout-com.checkout_com_generate_apple_pay_signing_request

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

get_entity_balances Read

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}.

Lua path: app.integrations.checkout_com.get_entity_balances
Full name: checkout-com.checkout_com_get_entity_balances

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.

compliance_requests_get_compliance_request Read

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

Lua path: app.integrations.checkout_com.compliance_requests_get_compliance_request
Full name: checkout-com.checkout_com_compliance_requests_get_compliance_request

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

compliance_requests_submit_compliance_request_response Write

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

Lua path: app.integrations.checkout_com.compliance_requests_submit_compliance_request_response
Full name: checkout-com.checkout_com_compliance_requests_submit_compliance_request_response

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.

request_access_token Read

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

Lua path: app.integrations.checkout_com.request_access_token
Full name: checkout-com.checkout_com_request_an_access_token

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

create_customer Write

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.

Lua path: app.integrations.checkout_com.create_customer
Full name: checkout-com.checkout_com_create_customer

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

get_customer_details Read

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

Lua path: app.integrations.checkout_com.get_customer_details
Full name: checkout-com.checkout_com_get_customer_details

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

update_customer_details Write

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

Lua path: app.integrations.checkout_com.update_customer_details
Full name: checkout-com.checkout_com_update_customer_details

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

delete_customer Write

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

Lua path: app.integrations.checkout_com.delete_customer
Full name: checkout-com.checkout_com_delete_customer

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

get_disputes Read

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.

Lua path: app.integrations.checkout_com.get_disputes
Full name: checkout-com.checkout_com_get_disputes

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

get_dispute_details Read

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

Lua path: app.integrations.checkout_com.get_dispute_details
Full name: checkout-com.checkout_com_get_dispute_details

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

accept_dispute Read

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.

Lua path: app.integrations.checkout_com.accept_dispute
Full name: checkout-com.checkout_com_accept_dispute

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

provide_dispute_evidence Read

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

Lua path: app.integrations.checkout_com.provide_dispute_evidence
Full name: checkout-com.checkout_com_provide_dispute_evidence

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

get_dispute_evidence Read

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

Lua path: app.integrations.checkout_com.get_dispute_evidence
Full name: checkout-com.checkout_com_get_dispute_evidence

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

submit_dispute_evidence Write

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.

Lua path: app.integrations.checkout_com.submit_dispute_evidence
Full name: checkout-com.checkout_com_submit_dispute_evidence

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

submit_dispute_arbitration_evidence Write

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.

Lua path: app.integrations.checkout_com.submit_dispute_arbitration_evidence
Full name: checkout-com.checkout_com_submit_dispute_arbitration_evidence

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

get_dispute_submitted_arbitration_evidence Read

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.

Lua path: app.integrations.checkout_com.get_dispute_submitted_arbitration_evidence
Full name: checkout-com.checkout_com_get_dispute_submitted_arbitration_evidence

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

get_dispute_submitted_evidence Read

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.

Lua path: app.integrations.checkout_com.get_dispute_submitted_evidence
Full name: checkout-com.checkout_com_get_dispute_submitted_evidence

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

get_dispute_scheme_files Read

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.

Lua path: app.integrations.checkout_com.get_dispute_scheme_files
Full name: checkout-com.checkout_com_get_dispute_scheme_files

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

upload_file Read

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

Lua path: app.integrations.checkout_com.upload_file
Full name: checkout-com.checkout_com_upload_a_file

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.

retrieve_file Read

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}.

Lua path: app.integrations.checkout_com.retrieve_file
Full name: checkout-com.checkout_com_retrieve_a_file

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_`.

create_face_authentication Write

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

Lua path: app.integrations.checkout_com.create_face_authentication
Full name: checkout-com.checkout_com_create_face_authentication

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

retrieve_face_authentication Read

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}.

Lua path: app.integrations.checkout_com.retrieve_face_authentication
Full name: checkout-com.checkout_com_retrieve_face_authentication

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

anonymize_face_authentication Read

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.

Lua path: app.integrations.checkout_com.anonymize_face_authentication
Full name: checkout-com.checkout_com_anonymize_face_authentication

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.

create_fav_attempt Write

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

Lua path: app.integrations.checkout_com.create_fav_attempt
Full name: checkout-com.checkout_com_create_fav_attempt

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.

list_fav_attempts Read

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.

Lua path: app.integrations.checkout_com.list_fav_attempts
Full name: checkout-com.checkout_com_list_fav_attempts

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

get_fav_attempt Read

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}.

Lua path: app.integrations.checkout_com.get_fav_attempt
Full name: checkout-com.checkout_com_get_fav_attempt

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

upload_file Read

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.

Lua path: app.integrations.checkout_com.upload_file
Full name: checkout-com.checkout_com_upload_file

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

get_file_information Read

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

Lua path: app.integrations.checkout_com.get_file_information
Full name: checkout-com.checkout_com_get_file_information

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

get_financial_actions Read

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

Lua path: app.integrations.checkout_com.get_financial_actions
Full name: checkout-com.checkout_com_get_financial_actions

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.

get_all_workflows Read

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

Lua path: app.integrations.checkout_com.get_all_workflows
Full name: checkout-com.checkout_com_get_all_workflows

Parameter	Type	Required	Description
No parameters.

add_workflow Write

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

Lua path: app.integrations.checkout_com.add_workflow
Full name: checkout-com.checkout_com_add_workflow

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

get_workflow Read

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

Lua path: app.integrations.checkout_com.get_workflow
Full name: checkout-com.checkout_com_get_workflow

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

remove_workflow Write

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}.

Lua path: app.integrations.checkout_com.remove_workflow
Full name: checkout-com.checkout_com_remove_workflow

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

patch_workflow Read

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

Lua path: app.integrations.checkout_com.patch_workflow
Full name: checkout-com.checkout_com_patch_workflow

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

add_workflow_action Write

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

Lua path: app.integrations.checkout_com.add_workflow_action
Full name: checkout-com.checkout_com_add_workflow_action

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

update_workflow_action Write

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

Lua path: app.integrations.checkout_com.update_workflow_action
Full name: checkout-com.checkout_com_update_workflow_action

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.

remove_workflow_action Write

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

Lua path: app.integrations.checkout_com.remove_workflow_action
Full name: checkout-com.checkout_com_remove_workflow_action

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

add_workflow_condition Write

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

Lua path: app.integrations.checkout_com.add_workflow_condition
Full name: checkout-com.checkout_com_add_workflow_condition

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

update_workflow_condition Write

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

Lua path: app.integrations.checkout_com.update_workflow_condition
Full name: checkout-com.checkout_com_update_workflow_condition

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.

remove_workflow_condition Write

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

Lua path: app.integrations.checkout_com.remove_workflow_condition
Full name: checkout-com.checkout_com_remove_workflow_condition

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

test_workflow Write

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

Lua path: app.integrations.checkout_com.test_workflow
Full name: checkout-com.checkout_com_test_workflow

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

get_event_types Read

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

Lua path: app.integrations.checkout_com.get_event_types
Full name: checkout-com.checkout_com_get_event_types

Parameter	Type	Required	Description
No parameters.

get_workflow_event Read

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

Lua path: app.integrations.checkout_com.get_workflow_event
Full name: checkout-com.checkout_com_get_workflow_event

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

get_workflow_action_invocations Read

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

Lua path: app.integrations.checkout_com.get_workflow_action_invocations
Full name: checkout-com.checkout_com_get_workflow_action_invocations

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

reflow_by_event Read

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.

Lua path: app.integrations.checkout_com.reflow_by_event
Full name: checkout-com.checkout_com_reflow_by_event

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.

reflow_by_event_and_workflow Read

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.

Lua path: app.integrations.checkout_com.reflow_by_event_and_workflow
Full name: checkout-com.checkout_com_reflow_by_event_and_workflow

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.

reflow_events Read

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.

Lua path: app.integrations.checkout_com.reflow_events
Full name: checkout-com.checkout_com_reflow_events

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

get_subject_events Read

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

Lua path: app.integrations.checkout_com.get_subject_events
Full name: checkout-com.checkout_com_get_subject_events

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

reflow_by_subject Read

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.

Lua path: app.integrations.checkout_com.reflow_by_subject
Full name: checkout-com.checkout_com_reflow_by_subject

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.

reflow_by_subject_and_workflow Read

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.

Lua path: app.integrations.checkout_com.reflow_by_subject_and_workflow
Full name: checkout-com.checkout_com_reflow_by_subject_and_workflow

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.

get_fx_rates Read

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.

Lua path: app.integrations.checkout_com.get_fx_rates
Full name: checkout-com.checkout_com_get_fx_rates

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

forward_request Write

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.

Lua path: app.integrations.checkout_com.forward_request
Full name: checkout-com.checkout_com_forward_request

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

get_forward_request Write

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}.

Lua path: app.integrations.checkout_com.get_forward_request
Full name: checkout-com.checkout_com_get_forward_request

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

create_secret Write

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.

Lua path: app.integrations.checkout_com.create_secret
Full name: checkout-com.checkout_com_create_secret

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

list_secrets Read

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

Lua path: app.integrations.checkout_com.list_secrets
Full name: checkout-com.checkout_com_list_secrets

Parameter	Type	Required	Description
No parameters.

update_secret Write

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}.

Lua path: app.integrations.checkout_com.update_secret
Full name: checkout-com.checkout_com_update_secret

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

delete_secret Write

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

Lua path: app.integrations.checkout_com.delete_secret
Full name: checkout-com.checkout_com_delete_secret

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

google_pay_enroll_merchant Read

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.

Lua path: app.integrations.checkout_com.google_pay_enroll_merchant
Full name: checkout-com.checkout_com_google_pay_enroll_merchant

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

google_pay_register_domain Read

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

Lua path: app.integrations.checkout_com.google_pay_register_domain
Full name: checkout-com.checkout_com_google_pay_register_domain

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.

google_pay_get_registered_domains Read

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

Lua path: app.integrations.checkout_com.google_pay_get_registered_domains
Full name: checkout-com.checkout_com_google_pay_get_registered_domains

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

google_pay_get_enrollment_state Read

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

Lua path: app.integrations.checkout_com.google_pay_get_enrollment_state
Full name: checkout-com.checkout_com_google_pay_get_enrollment_state

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

create_hosted_payments_session Write

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.

Lua path: app.integrations.checkout_com.create_hosted_payments_session
Full name: checkout-com.checkout_com_create_a_hosted_payments_session

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

get_hosted_payments_page_details Read

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}.

Lua path: app.integrations.checkout_com.get_hosted_payments_page_details
Full name: checkout-com.checkout_com_get_hosted_payments_page_details

Parameter	Type	Required	Description
`id`	object	yes	id

create_id_document_verification Write

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.

Lua path: app.integrations.checkout_com.create_id_document_verification
Full name: checkout-com.checkout_com_create_id_document_verification

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

retrieve_id_document_verification Read

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}.

Lua path: app.integrations.checkout_com.retrieve_id_document_verification
Full name: checkout-com.checkout_com_retrieve_id_document_verification

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

anonymize_id_document_verification Read

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.

Lua path: app.integrations.checkout_com.anonymize_id_document_verification
Full name: checkout-com.checkout_com_anonymize_id_document_verification

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.

create_id_document_verification_attempt Write

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

Lua path: app.integrations.checkout_com.create_id_document_verification_attempt
Full name: checkout-com.checkout_com_create_id_document_verification_attempt

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.

list_attempts_id_document_verification Read

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.

Lua path: app.integrations.checkout_com.list_attempts_id_document_verification
Full name: checkout-com.checkout_com_list_attempts_id_document_verification

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

get_id_document_verification_attempt Read

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}.

Lua path: app.integrations.checkout_com.get_id_document_verification_attempt
Full name: checkout-com.checkout_com_get_id_document_verification_attempt

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.

pdf_id_document_verification Read

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

Lua path: app.integrations.checkout_com.pdf_id_document_verification
Full name: checkout-com.checkout_com_pdf_id_document_verification

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

create_applicant Write

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

Lua path: app.integrations.checkout_com.create_applicant
Full name: checkout-com.checkout_com_create_applicant

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

retrieve_applicant Read

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}.

Lua path: app.integrations.checkout_com.retrieve_applicant
Full name: checkout-com.checkout_com_retrieve_applicant

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

update_applicant Write

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}.

Lua path: app.integrations.checkout_com.update_applicant
Full name: checkout-com.checkout_com_update_applicant

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.

anonymize_applicant Read

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.

Lua path: app.integrations.checkout_com.anonymize_applicant
Full name: checkout-com.checkout_com_anonymize_applicant

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.

create_and_start_identity_verification Write

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

Lua path: app.integrations.checkout_com.create_and_start_identity_verification
Full name: checkout-com.checkout_com_create_and_start_identity_verification

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

create_identity_verification Write

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.

Lua path: app.integrations.checkout_com.create_identity_verification
Full name: checkout-com.checkout_com_create_identity_verification

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

retrieve_identity_verification Read

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}.

Lua path: app.integrations.checkout_com.retrieve_identity_verification
Full name: checkout-com.checkout_com_retrieve_identity_verification

Parameter	Type	Required	Description
`identity_verification_id`	string	yes	The identity verification's unique identifier.

anonymize_identity_verification Read

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.

Lua path: app.integrations.checkout_com.anonymize_identity_verification
Full name: checkout-com.checkout_com_anonymize_identity_verification

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.

create_attempt Write

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

Lua path: app.integrations.checkout_com.create_attempt
Full name: checkout-com.checkout_com_create_attempt

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.

list_attempts Read

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.

Lua path: app.integrations.checkout_com.list_attempts
Full name: checkout-com.checkout_com_list_attempts

Parameter	Type	Required	Description
`identity_verification_id`	string	yes	The identity verification's unique identifier.

get_attempt Read

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}.

Lua path: app.integrations.checkout_com.get_attempt
Full name: checkout-com.checkout_com_get_attempt

Parameter	Type	Required	Description
`identity_verification_id`	string	yes	The identity verification's unique identifier.
`attempt_id`	string	yes	The attempt's unique identifier.

pdf_identity_verification Read

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

Lua path: app.integrations.checkout_com.pdf_identity_verification
Full name: checkout-com.checkout_com_pdf_identity_verification

Parameter	Type	Required	Description
`identity_verification_id`	string	yes	The identity verification's unique identifier.

create_instrument Write

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.

Lua path: app.integrations.checkout_com.create_instrument
Full name: checkout-com.checkout_com_create_an_instrument

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

get_instrument_details Read

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

Lua path: app.integrations.checkout_com.get_instrument_details
Full name: checkout-com.checkout_com_get_instrument_details

Parameter	Type	Required	Description
`id`	string	yes	The instrument ID

update_instrument Write

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

Lua path: app.integrations.checkout_com.update_instrument
Full name: checkout-com.checkout_com_update_instrument

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

delete_instrument Write

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

Lua path: app.integrations.checkout_com.delete_instrument
Full name: checkout-com.checkout_com_delete_instrument

Parameter	Type	Required	Description
`id`	string	yes	The ID of the payment instrument to be deleted

request_cardholder_access_token Read

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.

Lua path: app.integrations.checkout_com.request_cardholder_access_token
Full name: checkout-com.checkout_com_request_cardholder_access_token

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

create_cardholder Write

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

Lua path: app.integrations.checkout_com.create_cardholder
Full name: checkout-com.checkout_com_create_cardholder

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

get_cardholder Read

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

Lua path: app.integrations.checkout_com.get_cardholder
Full name: checkout-com.checkout_com_get_cardholder

Parameter	Type	Required	Description
`cardholder_id`	string	yes	cardholderId

update_cardholder Write

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

Lua path: app.integrations.checkout_com.update_cardholder
Full name: checkout-com.checkout_com_update_cardholder

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

get_cardholder_cards Read

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.

Lua path: app.integrations.checkout_com.get_cardholder_cards
Full name: checkout-com.checkout_com_get_cardholder_cards

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

create_card Write

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

Lua path: app.integrations.checkout_com.create_card
Full name: checkout-com.checkout_com_create_card

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.

get_card Read

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}.

Lua path: app.integrations.checkout_com.get_card
Full name: checkout-com.checkout_com_get_card

Parameter	Type	Required	Description
`card_id`	string	yes	cardId

update_card Write

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}.

Lua path: app.integrations.checkout_com.update_card
Full name: checkout-com.checkout_com_update_card

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

enroll_card Read

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.

Lua path: app.integrations.checkout_com.enroll_card
Full name: checkout-com.checkout_com_enroll_card

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

update_card_enrollment_details Write

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.

Lua path: app.integrations.checkout_com.update_card_enrollment_details
Full name: checkout-com.checkout_com_update_card_enrollment_details

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

get_card_enrollment_details Read

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

Lua path: app.integrations.checkout_com.get_card_enrollment_details
Full name: checkout-com.checkout_com_get_card_enrollment_details

Parameter	Type	Required	Description
`card_id`	string	yes	cardId

activate_card Write

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.

Lua path: app.integrations.checkout_com.activate_card
Full name: checkout-com.checkout_com_activate_card

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

get_card_credentials Read

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

Lua path: app.integrations.checkout_com.get_card_credentials
Full name: checkout-com.checkout_com_get_card_credentials

Parameter	Type	Required	Description
`card_id`	string	yes	cardId
`credentials`	string	no	credentials

renew_card Read

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

Lua path: app.integrations.checkout_com.renew_card
Full name: checkout-com.checkout_com_renew_card

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

revoke_card Read

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.

Lua path: app.integrations.checkout_com.revoke_card
Full name: checkout-com.checkout_com_revoke_card

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

add_scheduled_revocation_date Write

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

Lua path: app.integrations.checkout_com.add_scheduled_revocation_date
Full name: checkout-com.checkout_com_add_scheduled_revocation_date

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

delete_scheduled_revocation_date Write

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

Lua path: app.integrations.checkout_com.delete_scheduled_revocation_date
Full name: checkout-com.checkout_com_delete_scheduled_revocation_date

Parameter	Type	Required	Description
`card_id`	string	yes	cardId

suspend_card Read

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.

Lua path: app.integrations.checkout_com.suspend_card
Full name: checkout-com.checkout_com_suspend_card

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

create_control Write

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

Lua path: app.integrations.checkout_com.create_control
Full name: checkout-com.checkout_com_create_control

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.

get_control_by_target Read

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

Lua path: app.integrations.checkout_com.get_control_by_target
Full name: checkout-com.checkout_com_get_control_by_target

Parameter	Type	Required	Description
`target_id`	string	yes	target_id

get_control Read

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

Lua path: app.integrations.checkout_com.get_control
Full name: checkout-com.checkout_com_get_control

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.

update_control Write

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

Lua path: app.integrations.checkout_com.update_control
Full name: checkout-com.checkout_com_update_control

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

delete_control Write

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}.

Lua path: app.integrations.checkout_com.delete_control
Full name: checkout-com.checkout_com_delete_control

Parameter	Type	Required	Description
`control_id`	string	yes	controlId

create_control_group Write

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

Lua path: app.integrations.checkout_com.create_control_group
Full name: checkout-com.checkout_com_create_control_group

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

get_control_group_by_target Read

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

Lua path: app.integrations.checkout_com.get_control_group_by_target
Full name: checkout-com.checkout_com_get_control_group_by_target

Parameter	Type	Required	Description
`target_id`	string	yes	target_id

get_control_group Read

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

Lua path: app.integrations.checkout_com.get_control_group
Full name: checkout-com.checkout_com_get_control_group

Parameter	Type	Required	Description
`control_group_id`	string	yes	controlGroupId

delete_control_group Write

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}.

Lua path: app.integrations.checkout_com.delete_control_group
Full name: checkout-com.checkout_com_delete_control_group

Parameter	Type	Required	Description
`control_group_id`	string	yes	controlGroupId

create_control_profile Write

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

Lua path: app.integrations.checkout_com.create_control_profile
Full name: checkout-com.checkout_com_create_control_profile

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

get_control_profiles_by_target Read

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.

Lua path: app.integrations.checkout_com.get_control_profiles_by_target
Full name: checkout-com.checkout_com_get_control_profiles_by_target

Parameter	Type	Required	Description
`target_id`	string	no	target_id

get_control_profile Read

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

Lua path: app.integrations.checkout_com.get_control_profile
Full name: checkout-com.checkout_com_get_control_profile

Parameter	Type	Required	Description
`control_profile_id`	string	yes	controlProfileId

update_control_profile Write

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

Lua path: app.integrations.checkout_com.update_control_profile
Full name: checkout-com.checkout_com_update_control_profile

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

delete_control_profile Write

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}.

Lua path: app.integrations.checkout_com.delete_control_profile
Full name: checkout-com.checkout_com_delete_control_profile

Parameter	Type	Required	Description
`control_profile_id`	string	yes	controlProfileId

add_target_control_profile Write

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

Lua path: app.integrations.checkout_com.add_target_control_profile
Full name: checkout-com.checkout_com_add_target_to_control_profile

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.

remove_target_from_control_profile Write

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

Lua path: app.integrations.checkout_com.remove_target_from_control_profile
Full name: checkout-com.checkout_com_remove_target_from_control_profile

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.

get_digital_card Read

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

Lua path: app.integrations.checkout_com.get_digital_card
Full name: checkout-com.checkout_com_get_digital_card

Parameter	Type	Required	Description
`digital_card_id`	string	yes	digitalCardId

create_dispute Write

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.

Lua path: app.integrations.checkout_com.create_dispute
Full name: checkout-com.checkout_com_create_dispute

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.

get_dispute Read

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}.

Lua path: app.integrations.checkout_com.get_dispute
Full name: checkout-com.checkout_com_get_dispute

Parameter	Type	Required	Description
`dispute_id`	string	yes	disputeId

cancel_dispute Write

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.

Lua path: app.integrations.checkout_com.cancel_dispute
Full name: checkout-com.checkout_com_cancel_dispute

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.

escalate_dispute Read

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.

Lua path: app.integrations.checkout_com.escalate_dispute
Full name: checkout-com.checkout_com_escalate_dispute

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.

simulate_authorization Read

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

Lua path: app.integrations.checkout_com.simulate_authorization
Full name: checkout-com.checkout_com_simulate_authorization

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

simulate_incremental_authorization Read

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.

Lua path: app.integrations.checkout_com.simulate_incremental_authorization
Full name: checkout-com.checkout_com_simulate_incremental_authorization

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

simulate_presentment Read

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

Lua path: app.integrations.checkout_com.simulate_presentment
Full name: checkout-com.checkout_com_simulate_presentment

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

simulate_refund Read

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

Lua path: app.integrations.checkout_com.simulate_refund
Full name: checkout-com.checkout_com_simulate_refund

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

simulate_reversal Read

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

Lua path: app.integrations.checkout_com.simulate_reversal
Full name: checkout-com.checkout_com_simulate_reversal

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

simulate_oob_authentication Read

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

Lua path: app.integrations.checkout_com.simulate_oob_authentication
Full name: checkout-com.checkout_com_simulate_oob_authentication

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

get_transactions Read

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.

Lua path: app.integrations.checkout_com.get_transactions
Full name: checkout-com.checkout_com_get_transactions

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.

get_transaction_by_id Read

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

Lua path: app.integrations.checkout_com.get_transaction_by_id
Full name: checkout-com.checkout_com_get_transaction_by_id

Parameter	Type	Required	Description
`transaction_id`	string	yes	transactionId

request_card_metadata Read

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.

Lua path: app.integrations.checkout_com.request_card_metadata
Full name: checkout-com.checkout_com_request_card_metadata

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

provision_network_token Read

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.

Lua path: app.integrations.checkout_com.provision_network_token
Full name: checkout-com.checkout_com_provision_network_token

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

get_network_token Read

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}.

Lua path: app.integrations.checkout_com.get_network_token
Full name: checkout-com.checkout_com_get_network_token

Parameter	Type	Required	Description
`network_token_id`	string	yes	Unique token ID assigned by Checkout.com for each token

provision_cryptogram Read

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

Lua path: app.integrations.checkout_com.provision_cryptogram
Full name: checkout-com.checkout_com_provision_cryptogram

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.

delete_network_token Write

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.

Lua path: app.integrations.checkout_com.delete_network_token
Full name: checkout-com.checkout_com_delete_network_token

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.

request_payment_context Read

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

Lua path: app.integrations.checkout_com.request_payment_context
Full name: checkout-com.checkout_com_request_a_payment_context

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.

get_payment_context Read

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

Lua path: app.integrations.checkout_com.get_payment_context
Full name: checkout-com.checkout_com_get_payment_context

Parameter	Type	Required	Description
`id`	string	yes	id

create_payment_link_session Write

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.

Lua path: app.integrations.checkout_com.create_payment_link_session
Full name: checkout-com.checkout_com_create_a_payment_link_session

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

get_payment_link_details Read

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}.

Lua path: app.integrations.checkout_com.get_payment_link_details
Full name: checkout-com.checkout_com_get_payment_link_details

Parameter	Type	Required	Description
`id`	object	yes	id

get_payment_methods Read

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

Lua path: app.integrations.checkout_com.get_payment_methods
Full name: checkout-com.checkout_com_get_payment_methods

Parameter	Type	Required	Description
`processing_channel_id`	string	yes	processing_channel_id

create_payment_session Write

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.

Lua path: app.integrations.checkout_com.create_payment_session
Full name: checkout-com.checkout_com_create_payment_session

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

submit_payment_session Write

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.

Lua path: app.integrations.checkout_com.submit_payment_session
Full name: checkout-com.checkout_com_submit_payment_session

Parameter	Type	Required	Description
`id`	string	yes	The Payment Sessions unique identifier
`body`	object	no	Request body matching the official Checkout.com OpenAPI schema.

create_and_submit_payment_session Write

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

Lua path: app.integrations.checkout_com.create_and_submit_payment_session
Full name: checkout-com.checkout_com_create_and_submit_payment_session

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

request_payment_or_payout Read

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

Lua path: app.integrations.checkout_com.request_payment_or_payout
Full name: checkout-com.checkout_com_request_a_payment_or_payout

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.

get_payments_list Read

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.

Lua path: app.integrations.checkout_com.get_payments_list
Full name: checkout-com.checkout_com_get_payments_list

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

get_payment_details Read

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}.

Lua path: app.integrations.checkout_com.get_payment_details
Full name: checkout-com.checkout_com_get_payment_details

Parameter	Type	Required	Description
`id`	string	yes	The payment or payment session identifier

get_payment_actions Read

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.

Lua path: app.integrations.checkout_com.get_payment_actions
Full name: checkout-com.checkout_com_get_payment_actions

Parameter	Type	Required	Description
`id`	string	yes	The payment identifier

increment_payment_authorization Read

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

Lua path: app.integrations.checkout_com.increment_payment_authorization
Full name: checkout-com.checkout_com_increment_payment_authorization

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.

cancel_payment Write

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.

Lua path: app.integrations.checkout_com.cancel_payment
Full name: checkout-com.checkout_com_cancel_a_payment

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.

capture_payment Read

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.

Lua path: app.integrations.checkout_com.capture_payment
Full name: checkout-com.checkout_com_capture_a_payment

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.

refund_payment Read

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.

Lua path: app.integrations.checkout_com.refund_payment
Full name: checkout-com.checkout_com_refund_a_payment

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.

reverse_payment Read

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.

Lua path: app.integrations.checkout_com.reverse_payment
Full name: checkout-com.checkout_com_reverse_payment

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.

void_payment Read

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.

Lua path: app.integrations.checkout_com.void_payment
Full name: checkout-com.checkout_com_void_a_payment

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.

search Read

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.

Lua path: app.integrations.checkout_com.search
Full name: checkout-com.checkout_com_search

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

create_payment_setup Write

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.

Lua path: app.integrations.checkout_com.create_payment_setup
Full name: checkout-com.checkout_com_create_a_payment_setup

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

update_payment_setup Write

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}.

Lua path: app.integrations.checkout_com.update_payment_setup
Full name: checkout-com.checkout_com_update_a_payment_setup

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.

get_payment_setup Read

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

Lua path: app.integrations.checkout_com.get_payment_setup
Full name: checkout-com.checkout_com_get_a_payment_setup

Parameter	Type	Required	Description
`id`	string	yes	The unique identifier of the Payment Setup to retrieve.

confirm_payment_setup Read

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}.

Lua path: app.integrations.checkout_com.confirm_payment_setup
Full name: checkout-com.checkout_com_confirm_a_payment_setup

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.

get_reports Read

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

Lua path: app.integrations.checkout_com.get_reports
Full name: checkout-com.checkout_com_get_reports

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.

get_report_details Read

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

Lua path: app.integrations.checkout_com.get_report_details
Full name: checkout-com.checkout_com_get_report_details

Parameter	Type	Required	Description
`id`	string	yes	The ID of the report to retrieve.

get_report_file Read

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}.

Lua path: app.integrations.checkout_com.get_report_file
Full name: checkout-com.checkout_com_get_report_file

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.

create_session Write

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.

Lua path: app.integrations.checkout_com.create_session
Full name: checkout-com.checkout_com_create_session

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

get_session Read

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

Lua path: app.integrations.checkout_com.get_session
Full name: checkout-com.checkout_com_get_session

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

update_session Write

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

Lua path: app.integrations.checkout_com.update_session
Full name: checkout-com.checkout_com_update_session

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

complete_session Read

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

Lua path: app.integrations.checkout_com.complete_session
Full name: checkout-com.checkout_com_complete_session

Parameter	Type	Required	Description
`id`	string	yes	Session ID
`body`	object	no	Request body matching the official Checkout.com OpenAPI schema.

update_session_three_ds_method_completion Write

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.

Lua path: app.integrations.checkout_com.update_session_three_ds_method_completion
Full name: checkout-com.checkout_com_update_session_three_ds_method_completion

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

request_token Read

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.

Lua path: app.integrations.checkout_com.request_token
Full name: checkout-com.checkout_com_request_a_token

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

create_transfer Write

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

Lua path: app.integrations.checkout_com.create_transfer
Full name: checkout-com.checkout_com_create_transfer

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.

get_transfer_details Read

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

Lua path: app.integrations.checkout_com.get_transfer_details
Full name: checkout-com.checkout_com_get_transfer_details

Parameter	Type	Required	Description
`id`	string	yes	The transfer identifier

get_bank_account_fields Read

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}.

Lua path: app.integrations.checkout_com.get_bank_account_fields
Full name: checkout-com.checkout_com_get_bank_account_fields

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