How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Dojo Payment intents API

Allows you to take and manage payments.**Documentation**: [Payment intents](../../payments/manage-payments/payment-intent)

Dojo Payment intents API is one of 19 APIs that Dojo publishes on the APIs.io network, described by a machine-readable OpenAPI specification and an AsyncAPI event-driven specification.

Tagged areas include Payment Intents. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an API reference, and an AsyncAPI specification.

This API exposes 9 operations across 8 paths, and defines 58 schemas. It is described by OpenAPI 3.2.0, at version 2026-02-27.

Requests are made against a single base URL, https://api.dojo.tech.

9 operations 8 paths 58 schemas 1 DELETE1 GET7 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
2026-02-27
Base URL
https://api.dojo.tech
Authentication
API Key
Contact
Dojo Developer Experience Team
Terms of Service
Resource Areas
1

Authentication & Security 1

Dojo Payment intents API declares 1 security scheme for authenticating requests. An API key is passed in the header as Authorization (ApiKeyAuth). By default, every request must be authenticated.

Paths & Operations 9

Across 8 paths, the API surfaces 9 operations — 1 DELETE, 1 GET, 7 POST. Each is listed below with its method, path, parameters, and response codes.

Payment intents 9

Allows you to take and manage payments. Documentation: [Payment intents](../../payments/manage-payments/payment-intent)

POST
/payment-intents
Create a payment intent
PaymentIntents_CreatePaymentIntent 1 param body → 200400401403
GET
/payment-intents/{paymentIntentId}
Retrieve a payment intent
PaymentIntents_Get 3 params → 200400401404
DELETE
/payment-intents/{paymentIntentId}
Cancel a payment intent
PaymentIntents_Delete 2 params → 200400401404
POST
/payment-intents/{paymentIntentId}/charge
Charge a card
PaymentIntents_ChargePaymentIntent 2 params → 200400401403
POST
/payment-intents/{paymentIntentId}/refresh-client-session-secret
Update a client session secret
PaymentIntents_RefreshClientSessionSecret 2 params → 200400401
POST
/payment-intents/search
List all payment intents
PaymentIntents_Search 1 param body → 200400401
POST
/payment-intents/{paymentIntentId}/tips-amount
Change tips amount
PaymentIntents_SetTipsAmount 2 params body → 200400401405
POST
/payment-intents/{paymentIntentId}/amount
Change a payment intent amount
PaymentIntents_SetCustomAmount 2 params body → 200400401405
POST
/payment-intents/{paymentIntentId}/receipt
Send a receipt
Receipt_Create 3 params body → 204400401404

Schemas 58

The contract defines 58 schemas that model the data the API accepts and returns. The most detailed are PaymentIntent (38 properties), CreatePaymentIntentRequest (25 properties), Address (10 properties), TerminalSessionResponse (9 properties). Each schema is shown below with its type and property counts.

PaymentMethod
string
The payment methods that customers can use to pay. (Card, Wallet, SavedCard)
PagedPaymentIntent
PaymentIntentConfigShippingDetails
object
1 property
PaymentCustomerDetails
PaymentIntentConfigCustomerEmail
object
Include a configurable customer email address as part of the payment intent. Configurable fields can be altered later by [updating](./payments/manage-payments/…
1 property
CardFundingType
string
The main funding types are credit, debit, pre-paid, and charge.
PaymentIntentConfigBillingAddress
object
1 property
Address
object
Details about the address.
10 properties 1 required
TerminalSessionNotificationType
string
Terminal notifications. (Approved, Declined, InsertCard, EnterPin, PleaseWait, PresentCard, PresentOnlyOneCard, RemoveCard, CardUnsupported, CardError, ReEnter…
CreatePaymentIntentRequest
object
The payment intent request object.
25 properties 2 required
PaymentIntent
object
The PaymentIntent object.
38 properties
PaymentDetails
object
The payment details object.
7 properties
WalletPaymentOption
string
Wallet payment options (e.g., Apple Pay, Google Pay).
RequestSecurity
object
Customer's device information.
3 properties
Money
object
The amount intended to be collected by this payment intent excluding tipsAmount serviceChargeAmount and cashbackAmount.
2 properties 2 required
AutoExpireAction
string
The action triggered when a Manual payment intent expires. This is determined by the expiry time set in the autoExpireIn property. Required, if the capture mod…
PaymentIntentConfigResponse
object
8 properties
TerminalSessionResponse
object
9 properties
ProblemDetails
object
Dojo follows the error response format proposed in [RFC 7807](https://datatracker.ietf.org/doc/html/rfc7807), also known as Problem Details for HTTP APIs.
6 properties
TerminalSessionStatusEvent
object
The current progress of the terminal session, including whether it is in-progress or finished.
3 properties 3 required
SupportedPaymentMethods
object
2 properties
TerminalSessionPaymentResponse
object
8 properties
TerminalSessionType
string
Decide which type of transaction a terminal session is going to be associated with.
TerminalSessionDetails
object
Details about the terminal session, including which type of transaction it is associated with.
4 properties 1 required
CardScheme
string
Supported card schemes (VISA, MASTERCARD, MAESTRO, DISCOVER, DCI, AMEX)
TerminalSessionHistoryResponse
object
2 properties
Cursor
object
A cursor for use in pagination.
3 properties
ChargeResponse
object
The charge response object.
3 properties
TerminalSessionNotification
object
2 properties
SendEmailReceiptRequest
object
Request to send an email receipt to one or more specified addresses.
1 property 1 required
TerminalSessionStatus
string
The current status of the terminal session. A finalized, successful session will be Captured.
MerchantConfig
object
Details about the merchant configuration.
1 property
CaptureDetails
object
5 properties
PaymentConfigDetails
object
2 properties
TerminalSessionSaleDetails
object
Use this field when creating a terminal session request to name a payment intent by its ID to associate with the session.
1 property 1 required
OrderDetails
object
4 properties
ActionType
string
The type of action associated with the link.
TerminalSessionMatchedRefundDetails
object
A matched refund is associated with the payment intent of the initial transaction.
2 properties 1 required
Customer
object
Details about the customer.
3 properties
PaymentIntentConfigDetails
object
2 properties
TerminalSessionUnlinkedRefundDetails
object
A refund which is not linked to any previous transaction.
2 properties 1 required
CaptureStatus
string
Current capture status.
ItemLine
object
The item line object.
7 properties 1 required
ActionLink
object
The link to the payment's associated actions.
4 properties 2 required
ShippingDetails
object
Details about the shipping.
3 properties
SetAmountRequest
object
Send a request to set an amount.
3 properties 1 required
TaxLine
object
The tax line object.
5 properties 1 required
TerminalSessionPaymentVerificationMode
string
Method used to verify that the person presenting the card is the legitimate cardholder. The most common verification methods are PIN and signature. (Pin, Signa…
CaptureMode
string
The type of capture for the payment, where: - Auto payments are captured automatically, once authorization is complete. - Manual payments are captured only whe…
Modifier
object
Modifiers affect how the bill is calculated and therefore change the bill total. Common examples are Buy One, Get One Free deals, or concessionary discounts fo…
4 properties 4 required
PaymentIntentConfigRequest
object
8 properties
PaymentIntentStatus
string
Current status of the payment intent.
SetTipsAmountRequest
object
The tip amount.
1 property 1 required
TerminalSessionPaymentEntryMode
string
Entry mode of the payment. (Contactless, ContactChip, Magstripe, ManualEntry, Unknown)
Card
object
8 properties
PagedResultOfPaymentIntent
object
3 properties
CardHolderNotPresent
booleannull
Indicates whether this transaction should be completed as Cardholder Not Present (CNP), with manual entry of card details. If the flag is true, the card machin…
SearchPaymentIntentRequest
object
Request a list of payment intents with specified filtering criteria.
4 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

dojo-payment-intents-api-openapi.yml Raw ↑

Other APIs Dojo publishes across the network.

Dojo Areas API
Dojo Capabilities API
Dojo Captures API
Dojo Customers API
Dojo Events API
Dojo Flows API
Dojo Orders API
Dojo Parties API
Dojo Refunds API
Dojo Reservations API
Dojo Reversal API
Dojo Setup intents API
Where this information came from

This is an independent, third-party profile of Dojo Payment intents API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.