Checkout.com MCP by usefulapi is an MCP server published by io.usefulapi, hosted at checkoutcom.usefulapi.io. When last checked on 2026-11-21 it was working: it answers and lists its tools. It declares 18 tools, including checkout_get_payment, checkout_list_payments, checkout_search_payments, checkout_get_payment_actions, checkout_get_payment_link.
Read Checkout.com payments, disputes, reports and payouts.
4,120 connections through 5 shared values. Tap any node.
Squares are this server's values; dots are other servers sharing them. A shared address or publisher is a lead, not proof of a common operator.
Inferred from the host name and headers: what a server runs on, not who runs it.
Get the full details of a payment (or payment session) by its id, e.g. 'pay_...'. Checkout.com: GET /payments/{id}.
| Parameter | Type | Description |
|---|---|---|
| id * | string | Payment id, e.g. 'pay_mbabizu24mvu3mela5njyhpit4' (or a 'sid_' payment session id). |
{
"name": "checkout_get_payment",
"title": "Get payment",
"description": "Get the full details of a payment (or payment session) by its id, e.g. 'pay_...'. Checkout.com: GET /payments/{id}.",
"inputSchema": {
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"id"
],
"properties": {
"id": {
"type": "string",
"description": "Payment id, e.g. 'pay_mbabizu24mvu3mela5njyhpit4' (or a 'sid_' payment session id)."
}
}
},
"annotations": {
"title": "Get payment",
"readOnlyHint": true
}
}List your business's payments that match a given reference. Checkout.com: GET /payments (query parameters). For richer filtering use checkout_search_payments.
| Parameter | Type | Description |
|---|---|---|
| skip | integer | Number of payments to skip (pagination offset). |
| limit | integer | Maximum number of payments to return. |
| reference | string | Return only payments with this reference. |
{
"name": "checkout_list_payments",
"title": "List payments by reference",
"description": "List your business's payments that match a given reference. Checkout.com: GET /payments (query parameters). For richer filtering use checkout_search_payments.",
"inputSchema": {
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {
"skip": {
"type": "integer",
"maximum": 9007199254740991,
"minimum": 0,
"description": "Number of payments to skip (pagination offset)."
},
"limit": {
"type": "integer",
"maximum": 100,
"minimum": 1,
"description": "Maximum number of payments to return."
},
"reference": {
"type": "string",
"description": "Return only payments with this reference."
}
}
},
"annotations": {
"title": "List payments by reference",
"readOnlyHint": true
}
}Search payments using flexible query filters (this is a READ — it queries, it does not mutate). Checkout.com: POST /payments/search. Pass a `query` filter object and/or paging fields.
| Parameter | Type | Description |
|---|---|---|
| limit | integer | Maximum number of results to return. |
| query | object | Search filter object, e.g. { reference, id, status, currency, amount, from, to }. |
| pagination | object | Cursor pagination object (e.g. { after, before }) as returned in previous responses. |
{
"name": "checkout_search_payments",
"title": "Search payments",
"description": "Search payments using flexible query filters (this is a READ — it queries, it does not mutate). Checkout.com: POST /payments/search. Pass a `query` filter object and/or paging fields.",
"inputSchema": {
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {
"limit": {
"type": "integer",
"maximum": 100,
"minimum": 1,
"description": "Maximum number of results to return."
},
"query": {
"type": "object",
"description": "Search filter object, e.g. { reference, id, status, currency, amount, from, to }.",
"propertyNames": {
"type": "string"
},
"additionalProperties": {}
},
"pagination": {
"type": "object",
"description": "Cursor pagination object (e.g. { after, before }) as returned in previous responses.",
"propertyNames": {
"type": "string"
},
"additionalProperties": {}
}
}
},
"annotations": {
"title": "Search payments",
"readOnlyHint": true
}
}List all the actions (authorization, capture, refund, void, etc.) associated with a payment, latest first. Checkout.com: GET /payments/{id}/actions.
| Parameter | Type | Description |
|---|---|---|
| id * | string | Payment id, e.g. 'pay_...'. |
{
"name": "checkout_get_payment_actions",
"title": "Get payment actions",
"description": "List all the actions (authorization, capture, refund, void, etc.) associated with a payment, latest first. Checkout.com: GET /payments/{id}/actions.",
"inputSchema": {
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"id"
],
"properties": {
"id": {
"type": "string",
"description": "Payment id, e.g. 'pay_...'."
}
}
},
"annotations": {
"title": "Get payment actions",
"readOnlyHint": true
}
}Retrieve the details and status of a Payment Link by its id, e.g. 'pl_...'. Checkout.com: GET /payment-links/{id}.
| Parameter | Type | Description |
|---|---|---|
| id * | string | Payment Link id, e.g. 'pl_ok1itj8ykm3eyk1toywr6uwlwe'. |
{
"name": "checkout_get_payment_link",
"title": "Get payment link",
"description": "Retrieve the details and status of a Payment Link by its id, e.g. 'pl_...'. Checkout.com: GET /payment-links/{id}.",
"inputSchema": {
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"id"
],
"properties": {
"id": {
"type": "string",
"description": "Payment Link id, e.g. 'pl_ok1itj8ykm3eyk1toywr6uwlwe'."
}
}
},
"annotations": {
"title": "Get payment link",
"readOnlyHint": true
}
}Get a customer's details (email, name, phone, saved instruments) by id 'cus_...' or by email. Checkout.com: GET /customers/{id}.
| Parameter | Type | Description |
|---|---|---|
| id * | string | Customer id ('cus_...') or the customer's email address. |
{
"name": "checkout_get_customer",
"title": "Get customer",
"description": "Get a customer's details (email, name, phone, saved instruments) by id 'cus_...' or by email. Checkout.com: GET /customers/{id}.",
"inputSchema": {
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"id"
],
"properties": {
"id": {
"type": "string",
"description": "Customer id ('cus_...') or the customer's email address."
}
}
},
"annotations": {
"title": "Get customer",
"readOnlyHint": true
}
}Get the details of a saved payment instrument (tokenized card / bank account) by id 'src_...'. Checkout.com: GET /instruments/{id}.
| Parameter | Type | Description |
|---|---|---|
| id * | string | Instrument id, e.g. 'src_...'. |
{
"name": "checkout_get_instrument",
"title": "Get instrument",
"description": "Get the details of a saved payment instrument (tokenized card / bank account) by id 'src_...'. Checkout.com: GET /instruments/{id}.",
"inputSchema": {
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"id"
],
"properties": {
"id": {
"type": "string",
"description": "Instrument id, e.g. 'src_...'."
}
}
},
"annotations": {
"title": "Get instrument",
"readOnlyHint": true
}
}List disputes (chargebacks) against your business, most-recently-modified first, with optional filters. Checkout.com: GET /disputes.
| Parameter | Type | Description |
|---|---|---|
| to | string | Only disputes last modified on/before this ISO-8601 timestamp. |
| from | string | Only disputes last modified on/after this ISO-8601 timestamp. |
| skip | integer | Number of disputes to skip (pagination offset). |
| limit | integer | Maximum number of disputes to return (default 20). |
| statuses | string | Comma-separated dispute statuses to filter by, e.g. 'evidence_required,arbitration'. |
| entity_ids | string | Comma-separated sub-entity ids to filter by (for platforms). |
| payment_id | string | Filter to disputes for a specific payment id ('pay_...'). |
| this_channel_only | boolean | If true, only return disputes for the authenticating channel. |
{
"name": "checkout_list_disputes",
"title": "List disputes",
"description": "List disputes (chargebacks) against your business, most-recently-modified first, with optional filters. Checkout.com: GET /disputes.",
"inputSchema": {
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {
"to": {
"type": "string",
"description": "Only disputes last modified on/before this ISO-8601 timestamp."
},
"from": {
"type": "string",
"description": "Only disputes last modified on/after this ISO-8601 timestamp."
},
"skip": {
"type": "integer",
"maximum": 9007199254740991,
"minimum": 0,
"description": "Number of disputes to skip (pagination offset)."
},
"limit": {
"type": "integer",
"maximum": 250,
"minimum": 1,
"description": "Maximum number of disputes to return (default 20)."
},
"statuses": {
"type": "string",
"description": "Comma-separated dispute statuses to filter by, e.g. 'evidence_required,arbitration'."
},
"entity_ids": {
"type": "string",
"description": "Comma-separated sub-entity ids to filter by (for platforms)."
},
"payment_id": {
"type": "string",
"description": "Filter to disputes for a specific payment id ('pay_...')."
},
"this_channel_only": {
"type": "boolean",
"description": "If true, only return disputes for the authenticating channel."
}
}
},
"annotations": {
"title": "List disputes",
"readOnlyHint": true
}
}Get all the details of a single dispute (reason code, amount, deadline, evidence status) by id 'dsp_...'. Checkout.com: GET /disputes/{id}.
| Parameter | Type | Description |
|---|---|---|
| id * | string | Dispute id, e.g. 'dsp_...'. |
{
"name": "checkout_get_dispute",
"title": "Get dispute",
"description": "Get all the details of a single dispute (reason code, amount, deadline, evidence status) by id 'dsp_...'. Checkout.com: GET /disputes/{id}.",
"inputSchema": {
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"id"
],
"properties": {
"id": {
"type": "string",
"description": "Dispute id, e.g. 'dsp_...'."
}
}
},
"annotations": {
"title": "Get dispute",
"readOnlyHint": true
}
}List the reports available on your account (settlement, payments, etc.) and their details. Checkout.com: GET /reports.
| Parameter | Type | Description |
|---|---|---|
| limit | integer | Maximum number of reports to return. |
| entity_id | string | Filter reports to a specific entity id (for platforms). |
| created_after | string | Only reports created on/after this ISO-8601 timestamp. |
| created_before | string | Only reports created on/before this ISO-8601 timestamp. |
{
"name": "checkout_list_reports",
"title": "List reports",
"description": "List the reports available on your account (settlement, payments, etc.) and their details. Checkout.com: GET /reports.",
"inputSchema": {
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {
"limit": {
"type": "integer",
"maximum": 100,
"minimum": 1,
"description": "Maximum number of reports to return."
},
"entity_id": {
"type": "string",
"description": "Filter reports to a specific entity id (for platforms)."
},
"created_after": {
"type": "string",
"description": "Only reports created on/after this ISO-8601 timestamp."
},
"created_before": {
"type": "string",
"description": "Only reports created on/before this ISO-8601 timestamp."
}
}
},
"annotations": {
"title": "List reports",
"readOnlyHint": true
}
}Get the metadata of a specific report (including its downloadable files) by id 'rpt_...'. Checkout.com: GET /reports/{id}.
| Parameter | Type | Description |
|---|---|---|
| id * | string | Report id, e.g. 'rpt_...'. |
{
"name": "checkout_get_report",
"title": "Get report",
"description": "Get the metadata of a specific report (including its downloadable files) by id 'rpt_...'. Checkout.com: GET /reports/{id}.",
"inputSchema": {
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"id"
],
"properties": {
"id": {
"type": "string",
"description": "Report id, e.g. 'rpt_...'."
}
}
},
"annotations": {
"title": "Get report",
"readOnlyHint": true
}
}Get the indicative foreign-exchange rates Checkout.com uses (e.g. for card payouts). Checkout.com: GET /forex/rates.
| Parameter | Type | Description |
|---|---|---|
| source * | string | Rate source, e.g. 'visa' or 'mastercard' (required). |
| product | string | Product the rates are for, e.g. 'card_payouts'. |
| currency_pairs * | string | Comma-separated currency pairs, e.g. 'GBPEUR,USDNOK' (required, up to 20 pairs). |
| processing_channel_id | string | Processing channel id ('pc_...') to scope the rates. |
{
"name": "checkout_get_forex_rates",
"title": "Get forex rates",
"description": "Get the indicative foreign-exchange rates Checkout.com uses (e.g. for card payouts). Checkout.com: GET /forex/rates.",
"inputSchema": {
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"source",
"currency_pairs"
],
"properties": {
"source": {
"type": "string",
"description": "Rate source, e.g. 'visa' or 'mastercard' (required)."
},
"product": {
"type": "string",
"description": "Product the rates are for, e.g. 'card_payouts'."
},
"currency_pairs": {
"type": "string",
"description": "Comma-separated currency pairs, e.g. 'GBPEUR,USDNOK' (required, up to 20 pairs)."
},
"processing_channel_id": {
"type": "string",
"description": "Processing channel id ('pc_...') to scope the rates."
}
}
},
"annotations": {
"title": "Get forex rates",
"readOnlyHint": true
}
}CREATES a payment (request an authorization, or an immediate capture) — this MOVES MONEY: it charges a card / payment source. Checkout.com: POST /payments. Provide `amount` (minor units), `currency`, and a `source` object such as { type: 'token', token: 'tok_...' }, { type: 'id', id: 'src_...' } (a saved instrument), or { type: 'customer', id: 'cus_...' }.
| Parameter | Type | Description |
|---|---|---|
| amount * | integer | Amount in the currency's MINOR units (e.g. 1000 = $10.00; 0 = card verification). Required. |
| source * | object | Payment source object. Required. E.g. { type:'token', token:'tok_...' }, { type:'id', id:'src_...' }, or { type:'customer', id:'cus_...' }. |
| capture | boolean | If true (default for card), capture immediately; if false, authorize only. |
| currency * | string | 3-letter ISO currency code, e.g. 'USD', 'GBP', 'EUR'. Required. |
| customer | object | Customer object to associate/create, e.g. { id:'cus_...' } or { email, name }. |
| metadata | object | Arbitrary key/value metadata to attach to the payment. |
| reference | string | Your reference for the payment (e.g. order id). |
| description | string | Description shown on the customer's statement / for your records. |
CAPTURES a previously authorized payment — this MOVES MONEY: it settles the (full or partial) authorized amount. Checkout.com: POST /payments/{id}/captures.
| Parameter | Type | Description |
|---|---|---|
| id * | string | Payment id to capture, e.g. 'pay_...'. Required. |
| amount | integer | Amount to capture in MINOR units (defaults to the full authorized amount). |
| metadata | object | Arbitrary key/value metadata to attach to the capture. |
| reference | string | Your reference for the capture. |
| idempotency_key | string | Idempotency key — sent as the Cko-Idempotency-Key header. |
{
"name": "checkout_capture_payment",
"title": "Capture payment",
"description": "CAPTURES a previously authorized payment — this MOVES MONEY: it settles the (full or partial) authorized amount. Checkout.com: POST /payments/{id}/captures.",
"inputSchema": {
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"id"
],
"properties": {
"id": {
"type": "string",
"description": "Payment id to capture, e.g. 'pay_...'. Required."
},
"amount": {
"type": "integer",
"maximum": 9007199254740991,
"minimum": 0,
"description": "Amount to capture in MINOR units (defaults to the full authorized amount)."
},
"metadata": {
"type": "object",
"description": "Arbitrary key/value metadata to attach to the capture.",
"propertyNames": {
"type": "string"
},
"additionalProperties": {}
},
"reference": {
"type": "string",
"description": "Your reference for the capture."
},
"idempotency_key": {
"type": "string",
"description": "Idempotency key — sent as the Cko-Idempotency-Key header."
}
}
},
"annotations": {
"title": "Capture payment",
"destructiveHint": true
}
}REFUNDS a captured payment — this MOVES MONEY BACK to the customer (full or partial). Checkout.com: POST /payments/{id}/refunds.
| Parameter | Type | Description |
|---|---|---|
| id * | string | Payment id to refund, e.g. 'pay_...'. Required. |
| amount | integer | Amount to refund in MINOR units (defaults to the full captured amount). |
| metadata | object | Arbitrary key/value metadata to attach to the refund. |
| reference | string | Your reference for the refund. |
| idempotency_key | string | Idempotency key — sent as the Cko-Idempotency-Key header. |
{
"name": "checkout_refund_payment",
"title": "Refund payment",
"description": "REFUNDS a captured payment — this MOVES MONEY BACK to the customer (full or partial). Checkout.com: POST /payments/{id}/refunds.",
"inputSchema": {
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"id"
],
"properties": {
"id": {
"type": "string",
"description": "Payment id to refund, e.g. 'pay_...'. Required."
},
"amount": {
"type": "integer",
"maximum": 9007199254740991,
"minimum": 0,
"description": "Amount to refund in MINOR units (defaults to the full captured amount)."
},
"metadata": {
"type": "object",
"description": "Arbitrary key/value metadata to attach to the refund.",
"propertyNames": {
"type": "string"
},
"additionalProperties": {}
},
"reference": {
"type": "string",
"description": "Your reference for the refund."
},
"idempotency_key": {
"type": "string",
"description": "Idempotency key — sent as the Cko-Idempotency-Key header."
}
}
},
"annotations": {
"title": "Refund payment",
"destructiveHint": true
}
}VOIDS (cancels) a payment that has been authorized but not yet captured — this releases the hold on the customer's funds. Checkout.com: POST /payments/{id}/voids.
| Parameter | Type | Description |
|---|---|---|
| id * | string | Payment id to void, e.g. 'pay_...'. Required. |
| metadata | object | Arbitrary key/value metadata to attach to the void. |
| reference | string | Your reference for the void. |
| idempotency_key | string | Idempotency key — sent as the Cko-Idempotency-Key header. |
{
"name": "checkout_void_payment",
"title": "Void payment",
"description": "VOIDS (cancels) a payment that has been authorized but not yet captured — this releases the hold on the customer's funds. Checkout.com: POST /payments/{id}/voids.",
"inputSchema": {
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"id"
],
"properties": {
"id": {
"type": "string",
"description": "Payment id to void, e.g. 'pay_...'. Required."
},
"metadata": {
"type": "object",
"description": "Arbitrary key/value metadata to attach to the void.",
"propertyNames": {
"type": "string"
},
"additionalProperties": {}
},
"reference": {
"type": "string",
"description": "Your reference for the void."
},
"idempotency_key": {
"type": "string",
"description": "Idempotency key — sent as the Cko-Idempotency-Key header."
}
}
},
"annotations": {
"title": "Void payment",
"destructiveHint": true
}
}CREATES a hosted Payment Link the customer can pay through — this sets up a way to COLLECT MONEY. Checkout.com: POST /payment-links. Returns a URL to share with the customer.
| Parameter | Type | Description |
|---|---|---|
| amount * | integer | Amount in MINOR units (e.g. 1000 = $10.00). Required. |
| billing | object | Billing object, e.g. { address: { country: 'GB' } }. |
| currency * | string | 3-letter ISO currency code, e.g. 'USD'. Required. |
| customer | object | Customer object, e.g. { email, name }. |
| metadata | object | Arbitrary key/value metadata to attach to the payment link. |
| products | array | Line items, each e.g. { name, quantity, unit_price }. |
| reference | string | Your reference for the payment link (e.g. order id). |
| expires_in | integer | Seconds until the link expires. |
| return_url | string | URL the customer is returned to after paying. |
| description | string |
CREATES a customer record (which saved instruments and future payments can be attached to). This ADDS data to your account. Checkout.com: POST /customers.
| Parameter | Type | Description |
|---|---|---|
| name | string | Customer full name. |
| email * | string | Customer email address (required, must be unique on the account). |
| phone | object | Phone object, e.g. { country_code: '+1', number: '4155552671' }. |
| default | string | Id of the default instrument ('src_...') for this customer. |
| metadata | object | Arbitrary key/value metadata to attach to the customer. |
| idempotency_key | string | Idempotency key — sent as the Cko-Idempotency-Key header. |
{
"name": "checkout_create_customer",
"title": "Create customer",
"description": "CREATES a customer record (which saved instruments and future payments can be attached to). This ADDS data to your account. Checkout.com: POST /customers.",
"inputSchema": {
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"email"
],
"properties": {
"name": {
"type": "string",
"description": "Customer full name."
},
"email": {
"type": "string",
"description": "Customer email address (required, must be unique on the account)."
},
"phone": {
"type": "object",
"description": "Phone object, e.g. { country_code: '+1', number: '4155552671' }.",
"propertyNames": {
"type": "string"
},
"additionalProperties": {}
},
"default": {
"type": "string",
"description": "Id of the default instrument ('src_...') for this customer."
},
"metadata": {
"type": "object",
"description": "Arbitrary key/value metadata to attach to the customer.",
"propertyNames": {
"type": "string"
},
"additionalProperties": {}
},
"idempotency_key": {
"type": "string",
"description": "Idempotency key — sent as the Cko-Idempotency-Key header."
}
}
},
"annotations": {
"title": "Create customer",
"destructiveHint": true
}
}Tools for Checkout.com, hosted by usefulapi.io. If the user is new or asks what this server can do, suggest requests such as: "Show payments from the last 7 days and how many were declined."; "List all open chargebacks and their response deadlines."; "Find the payment with reference ORDER-1042 and show its history.". Read-only tools never change data; ask the user before a tool that creates, changes or deletes Checkout.com data. Free plan: 50 tool calls per month. Run checkoutcom_usage_status to see the calls used this month. If the user asks for something none of these tools can do, tell the user and, with their OK, run checkoutcom_request_feature to record the request. Paid plans: Pro (10,000 tool calls a month, $9/month or $90/year, for normal use) and Pro+ (100,000 tool calls a month, $39/month or $390/year, for automations and heavy use). A plan can be cancelled at any time and then runs to the end of the paid period, so it also suits a one-time job. When the user wants more calls or reaches the limit, run checkoutcom_upgrade without a plan: it returns both plans, each with a payment link for the user to open. checkoutcom_cancel_subscription cancels Pro at the end of the paid period.
Names, descriptions and schemas were written by the server and are shown as data.
Pattern matches on what the server declares. They show what it says it can do, not what it does.
None yet. Changes appear after a server's second daily check.
| payment_type | string | Payment type, e.g. 'Regular', 'Recurring', 'MOTO'. |
| idempotency_key | string | Idempotency key — sent as the Cko-Idempotency-Key header to safely retry. |
| processing_channel_id | string | Processing channel id ('pc_...') to route the payment through. |
{
"name": "checkout_create_payment",
"title": "Create payment",
"description": "CREATES a payment (request an authorization, or an immediate capture) — this MOVES MONEY: it charges a card / payment source. Checkout.com: POST /payments. Provide `amount` (minor units), `currency`, and a `source` object such as { type: 'token', token: 'tok_...' }, { type: 'id', id: 'src_...' } (a saved instrument), or { type: 'customer', id: 'cus_...' }.",
"inputSchema": {
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"amount",
"currency",
"source"
],
"properties": {
"amount": {
"type": "integer",
"maximum": 9007199254740991,
"minimum": 0,
"description": "Amount in the currency's MINOR units (e.g. 1000 = $10.00; 0 = card verification). Required."
},
"source": {
"type": "object",
"description": "Payment source object. Required. E.g. { type:'token', token:'tok_...' }, { type:'id', id:'src_...' }, or { type:'customer', id:'cus_...' }.",
"propertyNames": {
"type": "string"
},
"additionalProperties": {}
},
"capture": {
"type": "boolean",
"description": "If true (default for card), capture immediately; if false, authorize only."
},
"currency": {
"type": "string",
"description": "3-letter ISO currency code, e.g. 'USD', 'GBP', 'EUR'. Required."
},
"customer": {
"type": "object",
"description": "Customer object to associate/create, e.g. { id:'cus_...' } or { email, name }.",
"propertyNames": {
"type": "string"
},
"additionalProperties": {}
},
"metadata": {
"type": "object",
"description": "Arbitrary key/value metadata to attach to the payment.",
"propertyNames": {
"type": "string"
},
"additionalProperties": {}
},
"reference": {
"type": "string",
"description": "Your reference for the payment (e.g. order id)."
},
"description": {
"type": "string",
"description": "Description shown on the customer's statement / for your records."
},
"payment_type": {
"type": "string",
"description": "Payment type, e.g. 'Regular', 'Recurring', 'MOTO'."
},
"idempotency_key": {
"type": "string",
"description": "Idempotency key — sent as the Cko-Idempotency-Key header to safely retry."
},
"processing_channel_id": {
"type": "string",
"description": "Processing channel id ('pc_...') to route the payment through."
}
}
},
"annotations": {
"title": "Create payment",
"destructiveHint": true
}
}| Description shown to the customer on the payment page. |
| idempotency_key | string | Idempotency key — sent as the Cko-Idempotency-Key header. |
{
"name": "checkout_create_payment_link",
"title": "Create payment link",
"description": "CREATES a hosted Payment Link the customer can pay through — this sets up a way to COLLECT MONEY. Checkout.com: POST /payment-links. Returns a URL to share with the customer.",
"inputSchema": {
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"amount",
"currency"
],
"properties": {
"amount": {
"type": "integer",
"maximum": 9007199254740991,
"minimum": 0,
"description": "Amount in MINOR units (e.g. 1000 = $10.00). Required."
},
"billing": {
"type": "object",
"description": "Billing object, e.g. { address: { country: 'GB' } }.",
"propertyNames": {
"type": "string"
},
"additionalProperties": {}
},
"currency": {
"type": "string",
"description": "3-letter ISO currency code, e.g. 'USD'. Required."
},
"customer": {
"type": "object",
"description": "Customer object, e.g. { email, name }.",
"propertyNames": {
"type": "string"
},
"additionalProperties": {}
},
"metadata": {
"type": "object",
"description": "Arbitrary key/value metadata to attach to the payment link.",
"propertyNames": {
"type": "string"
},
"additionalProperties": {}
},
"products": {
"type": "array",
"items": {
"type": "object",
"propertyNames": {
"type": "string"
},
"additionalProperties": {}
},
"description": "Line items, each e.g. { name, quantity, unit_price }."
},
"reference": {
"type": "string",
"description": "Your reference for the payment link (e.g. order id)."
},
"expires_in": {
"type": "integer",
"maximum": 9007199254740991,
"minimum": 1,
"description": "Seconds until the link expires."
},
"return_url": {
"type": "string",
"description": "URL the customer is returned to after paying."
},
"description": {
"type": "string",
"description": "Description shown to the customer on the payment page."
},
"idempotency_key": {
"type": "string",
"description": "Idempotency key — sent as the Cko-Idempotency-Key header."
}
}
},
"annotations": {
"title": "Create payment link",
"destructiveHint": true
}
}