Checkout.com

Accept and manage global payments, disputes, and stored instruments via the Checkout.com Unified Payments API.

Detail	Value
Category	Payments
Base URL	https://api.checkout.com
Authentication	Bearer Token
Endpoints	13
Connector key	checkout-com

Using Checkout.com in a workflow

1. Go to Connections and click New Connection.
2. Pick Checkout.com from the marketplace.
3. Enter your credentials (see Authentication above for what's expected).
4. In a workflow, drop an API Call node and select this connection.
5. Pick the operation you need from the Operation dropdown — the full list is below.

Available endpoints

Endpoint	Summary
POST /payments	Request a payment or payout
GET /payments/{id}	Get payment details
GET /payments/{id}/actions	Get payment actions
POST /payments/{id}/capture	Capture an authorized payment
POST /payments/{id}/refund	Refund a captured payment
POST /payments/{id}/void	Void an authorized payment
POST /customers	Create a customer
GET /customers/{id}	Get customer details
POST /instruments	Create a stored payment instrument
GET /instruments/{id}	Get instrument details
GET /disputes	List disputes
GET /disputes/{id}	Get dispute details
POST /disputes/{id}/accept	Accept a dispute

Each endpoint is documented in full below. Use the outline on the right to jump to one.

POST /payments

Request a payment or payout

Detail	Value
Operation ID	payments.requestPayment
Method	POST
Path	/payments

Parameters

No parameters.

Request Body

Field	Type
source	object
amount	integer
currency	string
capture	boolean
reference	string

Using this endpoint in a workflow

1. Add an API Call node to your workflow.
2. Pick your Checkout.com connection from the Connection dropdown.
3. In the Operation dropdown, select payments.requestPayment.
4. Fill in the parameter fields that appear. Use {{...}} to reference upstream values.

Required fields are marked — fill them or the call will fail at runtime.

What it returns

The API Call node writes the response to the workflow context:

{
  status: 200,
  success: true,
  data: { ...response body from the API... },
  latencyMs: 142
}

Reference response fields downstream as {{nodeId.data.path}}. The exact response shape is documented on the upstream Checkout.com API reference.

GET /payments/{id}

Get payment details

Detail	Value
Operation ID	payments.getPayment
Method	GET
Path	/payments/{id}

Parameters

Name	Location	Type	Required
id	path	string	Yes

Using this endpoint in a workflow

1. Add an API Call node to your workflow.
2. Pick your Checkout.com connection from the Connection dropdown.
3. In the Operation dropdown, select payments.getPayment.
4. Fill in the parameter fields that appear. Use {{...}} to reference upstream values.

Required fields are marked — fill them or the call will fail at runtime.

What it returns

The API Call node writes the response to the workflow context:

{
  status: 200,
  success: true,
  data: { ...response body from the API... },
  latencyMs: 142
}

Reference response fields downstream as {{nodeId.data.path}}. The exact response shape is documented on the upstream Checkout.com API reference.

GET /payments/{id}/actions

Get payment actions

Detail	Value
Operation ID	payments.getPaymentActions
Method	GET
Path	/payments/{id}/actions

Parameters

Name	Location	Type	Required
id	path	string	Yes

Using this endpoint in a workflow

1. Add an API Call node to your workflow.
2. Pick your Checkout.com connection from the Connection dropdown.
3. In the Operation dropdown, select payments.getPaymentActions.
4. Fill in the parameter fields that appear. Use {{...}} to reference upstream values.

Required fields are marked — fill them or the call will fail at runtime.

What it returns

The API Call node writes the response to the workflow context:

{
  status: 200,
  success: true,
  data: { ...response body from the API... },
  latencyMs: 142
}

Reference response fields downstream as {{nodeId.data.path}}. The exact response shape is documented on the upstream Checkout.com API reference.

POST /payments/{id}/capture

Capture an authorized payment

Detail	Value
Operation ID	payments.capturePayment
Method	POST
Path	/payments/{id}/capture

Parameters

Name	Location	Type	Required
id	path	string	Yes

Request Body

Field	Type
amount	integer
reference	string

Using this endpoint in a workflow

1. Add an API Call node to your workflow.
2. Pick your Checkout.com connection from the Connection dropdown.
3. In the Operation dropdown, select payments.capturePayment.
4. Fill in the parameter fields that appear. Use {{...}} to reference upstream values.

Required fields are marked — fill them or the call will fail at runtime.

What it returns

The API Call node writes the response to the workflow context:

{
  status: 200,
  success: true,
  data: { ...response body from the API... },
  latencyMs: 142
}

Reference response fields downstream as {{nodeId.data.path}}. The exact response shape is documented on the upstream Checkout.com API reference.

POST /payments/{id}/refund

Refund a captured payment

Detail	Value
Operation ID	payments.refundPayment
Method	POST
Path	/payments/{id}/refund

Parameters

Name	Location	Type	Required
id	path	string	Yes

Request Body

Field	Type
amount	integer
reference	string

Using this endpoint in a workflow

1. Add an API Call node to your workflow.
2. Pick your Checkout.com connection from the Connection dropdown.
3. In the Operation dropdown, select payments.refundPayment.
4. Fill in the parameter fields that appear. Use {{...}} to reference upstream values.

Required fields are marked — fill them or the call will fail at runtime.

What it returns

The API Call node writes the response to the workflow context:

{
  status: 200,
  success: true,
  data: { ...response body from the API... },
  latencyMs: 142
}

Reference response fields downstream as {{nodeId.data.path}}. The exact response shape is documented on the upstream Checkout.com API reference.

POST /payments/{id}/void

Void an authorized payment

Detail	Value
Operation ID	payments.voidPayment
Method	POST
Path	/payments/{id}/void

Parameters

Name	Location	Type	Required
id	path	string	Yes

Using this endpoint in a workflow

1. Add an API Call node to your workflow.
2. Pick your Checkout.com connection from the Connection dropdown.
3. In the Operation dropdown, select payments.voidPayment.
4. Fill in the parameter fields that appear. Use {{...}} to reference upstream values.

Required fields are marked — fill them or the call will fail at runtime.

What it returns

The API Call node writes the response to the workflow context:

{
  status: 200,
  success: true,
  data: { ...response body from the API... },
  latencyMs: 142
}

Reference response fields downstream as {{nodeId.data.path}}. The exact response shape is documented on the upstream Checkout.com API reference.

POST /customers

Create a customer

Detail	Value
Operation ID	payments.createCustomer
Method	POST
Path	/customers

Parameters

No parameters.

Request Body

Field	Type
email	string
name	string

Using this endpoint in a workflow

1. Add an API Call node to your workflow.
2. Pick your Checkout.com connection from the Connection dropdown.
3. In the Operation dropdown, select payments.createCustomer.
4. Fill in the parameter fields that appear. Use {{...}} to reference upstream values.

Required fields are marked — fill them or the call will fail at runtime.

What it returns

The API Call node writes the response to the workflow context:

{
  status: 200,
  success: true,
  data: { ...response body from the API... },
  latencyMs: 142
}

Reference response fields downstream as {{nodeId.data.path}}. The exact response shape is documented on the upstream Checkout.com API reference.

GET /customers/{id}

Get customer details

Detail	Value
Operation ID	payments.getCustomer
Method	GET
Path	/customers/{id}

Parameters

Name	Location	Type	Required
id	path	string	Yes

Using this endpoint in a workflow

1. Add an API Call node to your workflow.
2. Pick your Checkout.com connection from the Connection dropdown.
3. In the Operation dropdown, select payments.getCustomer.
4. Fill in the parameter fields that appear. Use {{...}} to reference upstream values.

Required fields are marked — fill them or the call will fail at runtime.

What it returns

The API Call node writes the response to the workflow context:

{
  status: 200,
  success: true,
  data: { ...response body from the API... },
  latencyMs: 142
}

Reference response fields downstream as {{nodeId.data.path}}. The exact response shape is documented on the upstream Checkout.com API reference.

POST /instruments

Create a stored payment instrument

Detail	Value
Operation ID	payments.createInstrument
Method	POST
Path	/instruments

Parameters

No parameters.

Request Body

Field	Type
type	string
token	string
customer	object

Using this endpoint in a workflow

1. Add an API Call node to your workflow.
2. Pick your Checkout.com connection from the Connection dropdown.
3. In the Operation dropdown, select payments.createInstrument.
4. Fill in the parameter fields that appear. Use {{...}} to reference upstream values.

Required fields are marked — fill them or the call will fail at runtime.

What it returns

The API Call node writes the response to the workflow context:

{
  status: 200,
  success: true,
  data: { ...response body from the API... },
  latencyMs: 142
}

Reference response fields downstream as {{nodeId.data.path}}. The exact response shape is documented on the upstream Checkout.com API reference.

GET /instruments/{id}

Get instrument details

Detail	Value
Operation ID	payments.getInstrument
Method	GET
Path	/instruments/{id}

Parameters

Name	Location	Type	Required
id	path	string	Yes

Using this endpoint in a workflow

1. Add an API Call node to your workflow.
2. Pick your Checkout.com connection from the Connection dropdown.
3. In the Operation dropdown, select payments.getInstrument.
4. Fill in the parameter fields that appear. Use {{...}} to reference upstream values.

Required fields are marked — fill them or the call will fail at runtime.

What it returns

The API Call node writes the response to the workflow context:

{
  status: 200,
  success: true,
  data: { ...response body from the API... },
  latencyMs: 142
}

Reference response fields downstream as {{nodeId.data.path}}. The exact response shape is documented on the upstream Checkout.com API reference.

GET /disputes

List disputes

Detail	Value
Operation ID	payments.listDisputes
Method	GET
Path	/disputes

Parameters

Name	Location	Type	Required
limit	query	integer	No
from	query	string	No
to	query	string	No
statuses	query	string	No

Using this endpoint in a workflow

1. Add an API Call node to your workflow.
2. Pick your Checkout.com connection from the Connection dropdown.
3. In the Operation dropdown, select payments.listDisputes.
4. Fill in the parameter fields that appear. Use {{...}} to reference upstream values.

What it returns

The API Call node writes the response to the workflow context:

{
  status: 200,
  success: true,
  data: { ...response body from the API... },
  latencyMs: 142
}

Reference response fields downstream as {{nodeId.data.path}}. The exact response shape is documented on the upstream Checkout.com API reference.

GET /disputes/{id}

Get dispute details

Detail	Value
Operation ID	payments.getDispute
Method	GET
Path	/disputes/{id}

Parameters

Name	Location	Type	Required
id	path	string	Yes

Using this endpoint in a workflow

1. Add an API Call node to your workflow.
2. Pick your Checkout.com connection from the Connection dropdown.
3. In the Operation dropdown, select payments.getDispute.
4. Fill in the parameter fields that appear. Use {{...}} to reference upstream values.

Required fields are marked — fill them or the call will fail at runtime.

What it returns

The API Call node writes the response to the workflow context:

{
  status: 200,
  success: true,
  data: { ...response body from the API... },
  latencyMs: 142
}

Reference response fields downstream as {{nodeId.data.path}}. The exact response shape is documented on the upstream Checkout.com API reference.

POST /disputes/{id}/accept

Accept a dispute

Detail	Value
Operation ID	payments.acceptDispute
Method	POST
Path	/disputes/{id}/accept

Parameters

Name	Location	Type	Required
id	path	string	Yes

Using this endpoint in a workflow

1. Add an API Call node to your workflow.
2. Pick your Checkout.com connection from the Connection dropdown.
3. In the Operation dropdown, select payments.acceptDispute.
4. Fill in the parameter fields that appear. Use {{...}} to reference upstream values.

Required fields are marked — fill them or the call will fail at runtime.

What it returns

The API Call node writes the response to the workflow context:

{
  status: 200,
  success: true,
  data: { ...response body from the API... },
  latencyMs: 142
}

Reference response fields downstream as {{nodeId.data.path}}. The exact response shape is documented on the upstream Checkout.com API reference.