Checkout.com
Keep Checkout.com in step with your orders, invoices and payments without re-keying, with the right person approving what changes.
30 ways to read, 4 ways to write, each write switched on by you.
Quality checks
Built and tested with example responses.
- Ready to connect: doneEvery listed action is built in.
- Built and tested with example responses: doneEach action is built from the provider’s published API and tested against example responses, errors, rate limits and paging.
Connected, approved, proven.
The things teams do most with Checkout.com, an example flow with a person in the loop, and what Nexra keeps as proof.
Top actions
- Create customer
customers.createApproval by rule - Create hosted payments page
hosted_payments.createApproval by rule - List entity balances
balances.listRead
Example flow
- Checkout.com · List entity balances
balances.listDone - Checkout.com · Create customer
customers.createMaker-checker - Nexra · Record the decision and result in the evidence chainProven
Example workflow. Routine runs go through on their own. Only a change your rules flag, such as one over a limit you set, waits for the right person, who sees the exact change and the rule before it reaches Checkout.com.
What gets logged
- Whether it ran on its own or who approved it, and under which rule
- A fingerprint of the exact request sent to Checkout.com
- Checkout.com's reply: what it created or changed
- One entry in the evidence chain, linked to the one before
Try this in the sandbox
Run the whole flow with test data in your sandbox, then connect a Checkout.com test account before you go live.
For developers
Technical detail
Checkout.com payments, disputes, financial actions, reports, balances, workflows and transfers (read); payment links, hosted payment pages and customers (create and update).
Checkout.com API docs- Source actions
- 30
- Destination actions
- 4
- Data types
- 24
What you can map
Reads are always available. Writes are off until you switch them on for a connection, and governed writes follow your policies.
balances1
- List entity balancesSource
Pending, available, payable, collateral and operational balances for each currency account of an entity.
customers3
- Create customerDestinationNot retried automaticallyApproval before production
Store a customer (email required) for use with saved instruments.
- Get customerSource
Read a customer by ID or email address (sent in the path, never the query).
- Update customerDestinationProvider duplicate protectionApproval before production
Update email, name, phone, metadata or default instrument.
dispute arbitration evidence1
- Get submitted arbitration evidenceSource
Get submitted arbitration evidence as a single file ID (read only; Nexra never submits evidence).
dispute evidence1
- Get dispute evidenceSource
Evidence currently saved on a dispute (text and file IDs). Submitting is not exposed.
dispute scheme files1
- List dispute scheme filesSource
Files the card scheme provided for a dispute, by dispute status.
dispute submitted evidence1
- Get submitted dispute evidenceSource
Get submitted dispute evidence as a single file ID (read only; Nexra never submits evidence).
disputes2
- Get disputeSource
Read one dispute by ID.
- List disputesSourceIncremental
Disputes filtered by time window, status, payment ID or payment reference.
files1
- Get file informationSource
Metadata of an uploaded or scheme-provided dispute file.
financial actions1
- List financial actionsSource
Settled financial actions (captures, refunds, chargebacks) with fee, interchange and scheme breakdowns for one payment or action.
fx rates1
- Get FX ratesSource
Indicative FX rates for a product, card scheme and processing channel.
google pay domains1
- List Google Pay domainsSource
Web domains registered for Google Pay for an enrolled entity.
google pay enrollment1
- Get Google Pay enrollment stateSource
Whether an entity is enrolled for Google Pay.
hosted payments2
- Create hosted payments pageDestinationNot retried automaticallyApproval before production
Create a Hosted Payments Page session. The customer is redirected to pay; nothing is charged by Nexra.
- Get hosted payments pageSource
Read one hosted payments page by ID.
instruments1
- Get instrumentSource
Read one instrument by ID.
payment actions1
- List payment actionsSource
Authorizations, captures, refunds and voids already processed on a payment.
payment links2
- Create payment linkDestinationNot retried automaticallyApproval before production
Create a Payment Link for a customer to pay on Checkout.com's hosted page. No money moves until they pay.
- Get payment linkSource
Read one payment link by ID.
payment methods1
- List available payment methodsSource
Payment methods enabled for a processing channel.
payments3
- Read payment detailsSource
Read an existing Checkout.com payment; no payment is created.
- List payments by referenceSource
Payments that share your reference (for example an order number).
- Search paymentsSource
Search payments with Checkout.com's query syntax in a UTC time window (single page of up to 1,000).
reports2
- Get reportSource
Read one report by ID.
- List reportsSourceIncremental
Generated reports (balances, financial actions, disputes, payouts) created in a time window.
transfers1
- Get transferSource
Read a transfer between entities (read only; Nexra never initiates transfers).
workflow action invocations1
- List workflow action invocationsSource
Delivery attempts of one workflow action for one event.
workflow event types1
- List workflow event typesSource
Event types a workflow can subscribe to, grouped by source.
workflow events2
- Get workflow eventSource
Read one workflow event by ID.
- List events for a subjectSource
Events raised for one payment, dispute or other subject.
workflows2
- Get workflowSource
Read one workflow by ID.
- List workflowsSource
Webhook workflows (names and active state).
Access and limits
- Authentication
- Checkout.com secret key
- Plans and access
- A Checkout.com account with a secret API key (or OAuth access key) for the unified payments API. Keys need the scopes for each operation (payments, payment-links, hosted-payments, vault customers and instruments, disputes:view).
- Test environment
- Use the sandbox dashboard key and your {prefix}.api.sandbox.checkout.com origin.
- Rate limits
- Checkout.com returns HTTP 429 when limits are exceeded. Nexra honours Retry-After for reads; link, page and customer creates are never retried automatically.
- Pagination
- Payment and dispute lists use skip/limit with total_count. Search returns one page.
- Provider events
- Checkout.com webhooks for payment, dispute and payment-link events. Flows can start the moment something happens: when a payment succeeds; when a payment is declined; when a refund is processed; when a dispute is opened.
Before you build a flow
- Intentional exclusions: requesting payments or payouts, authorization increments, captures, refunds, voids, reversals, transfers, payment sessions, contexts and setups, accepting disputes or providing and submitting evidence, file uploads, creating, updating or deleting instruments, tokens, network tokens and card metadata lookups (these take card data), deleting customers, workflow writes and reflows as operations (a flow trigger creates and removes only its own webhook workflow), reserve rules and payout schedules, Issuing, identity verification, the Forward API and secrets.
- Platforms (sub-entity onboarding, members, payment instruments, requirements) require OAuth with the accounts scope and return personal and bank data, so they are not exposed.
- Compliance requests return sender and recipient personal data and are not exposed.
- Report file downloads are not fetched; reports return file IDs and formats only.
- Payouts and payout lines: Checkout.com's current API has no payout or settlement list endpoint. Payouts are only in the Payouts report and the Financial Actions by Payout ID report, which List reports finds but this connector does not download.
- Refunds: Checkout.com has no refund list endpoint. Refunds are read per payment with List payment actions or List financial actions, or found with Search payments.
- Fees are returned per payment or action in the breakdown of List financial actions (fee, interchange and scheme lines in major units); there is no date-filtered fee list.
- Payment search is not offered as an incremental read because it returns a single page of up to 1,000 payments.
- Workflows return action IDs, types and URLs; webhook headers and signature keys are never mapped.
- Balances and transfers use Checkout.com's separate balances and transfers hosts, chosen from the sandbox or live API prefix.
- Checkout.com has no list-all-payments or list-customers endpoint; payments are listed by reference or found with search.
- Cko-Idempotency-Key is documented only for payment actions (payments, captures, refunds, voids), so link, page and customer creates have no duplicate protection and are not retried.
- Payment search returns the first page only; the continuation-link method is not documented in the OpenAPI reference.
- The connection check reads the configured existing payment ID.
Developer reference
- Create the Checkout.com credentials described above with the narrowest permissions your flows need.
- In Nexra, open Connect, then Connections, then New connection, choose Checkout.com, enter its settings and credentials, and tick only the write actions you need. Connection guide
- Test the connection, then use its actions as flow sources and destinations. Flow guide
Machine-readable detail: GET /api/public/connect/connectors/checkout-com and the Connections API.