DOdojo
Payment intents

Retrieve a payment intent

Retrieves the details of a payment intent.

get/payment-intents/{paymentIntentId}

Request

Path parameters

paymentIntentIdstring nullable required

The unique identifier of the payment intent.

Query parameters

returnCanceledboolean

If the value is true, and the payment intent being retrieved has a status of Canceled, the payment intent will be returned in the response. Otherwise a 404 (not found) status code will be returned.

Headers

versionstring date required

The API version with format yyyy-mm-dd. The current version is 2026-02-27.

Response

OK

idstring nullable

The unique identifier of the payment intent.

captureMode'Auto' | 'Manual'

The type of capture for the payment, where:

  • Auto payments are captured automatically, once authorization is complete.
  • Manual payments are captured only when a capture request is made.
cardHolderNotPresentboolean

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 machine skips the Present Card screen and goes directly into Key Card Number.

clientSessionSecretstring nullable

The client secret.

clientSessionSecretExpirationDatestring date-time

The expiration date of clientSessionSecret.

status'Created' | 'Authorized' | 'Captured' | 'Reversed' | 'Refunded' | 'Canceled'

Current status of the payment intent.

paymentMethodsPaymentMethod[] nullable

The payment methods that customers can use to pay. (Card, Wallet, SavedCard)

refundedAmountinteger nullable

The amount that was refunded.

createdAtstring date-time

The creation date, in ISO 8601 UTC format.

updatedAtstring date-time

The timestamp of the update date, in ISO 8601 UTC format.

referencestring nullable

A unique identifier for the payment. For example, Order 236.

descriptionstring nullable

The payment description.

autoExpireAction'Release' | 'Capture'

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 mode is set to Manual.

expireAtstring date-time nullable

The timestamp and date of when a payment intent will be voided, in ISO 8601 UTC format. This occurs when a payment intent is created and not yet authorized. If null, the payment intent is voided after 30 days.

autoExpireInstring timespan nullable

The time interval after which a Manual payment intent will be captured or reversed, in dd.hh:MM:ss format. The timestamp value must be more than 30 seconds and less than 7 days.

metadataobject nullable

A set of key-value pairs that you can use to store additional information.

setupIntentIdstring nullable

The unique identifier for the setup intent.

paymentLinkstring uri nullable

The URL of the generated payment link. The customer will be redirected to this URL in order to complete the payment.

Example response

{
  "customer": {
    "emailAddress": "support@dojo.com",
    "phoneNumber": "+448000443550"
  },
  "requestSecurity": {
    "userAgent": null,
    "ipAddress": null,
    "device": null
  },
  "billingAddress": {
    "address1": "The Brunel Building",
    "address2": "2 Canalside Walk",
    "city": "London",
    "postcode": "W2 1DG",
    "countryCode": "GB",
    "county": "UK"
  },
  "shippingDetails": {
    "address": {
      "address1": "The Brunel Building",
      "address2": "2 Canalside Walk",
      "city": "London",
      "postcode": "W2 1DG",
      "countryCode": "GB",
      "county": "UK"
    }
  },
  "actionLink": {
    "url": "https://docs.dojo.tech/payments/getting-started",
    "label": "docs-link"
  },
  "terminalSessionHistory": [
    {
      "terminalSession": {
        "details": {
          "sale": {
            "paymentIntentId": "pi_sandbox_RBMHTJ4fIkmSppDILZVCGw"
          }
        }
      }
    }
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.