Skip to content

POST /instruments ​

Create a stored payment instrument

DetailValue
Operation IDpayments.createInstrument
MethodPOST
Path/instruments
ConnectorCheckout.com

Parameters ​

No parameters.

Request Body ​

FieldType
typestring
tokenstring
customerobject

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.