The Dojo API is RESTful, using HTTP response codes to convey status, including successful responses and errors. Additionally, it accepts and returns JSON in the HTTP body.
Use the following base URL when making requests to the API: https://api.dojo.tech/
Try one of our pre-built solutions for your site.
The Dojo API uses Basic HTTP auth. You can generate API keys in Developer Portal.
Secret keys for the test environment have the prefix sk_sandbox_
and for production have the prefix sk_prod_
.
You must include your secret API key in the header of all requests, for example:
curl
--header 'content-type: application/json' \
--header 'Authorization: Basic sk_prod_your_key' \
...
API requests without authentication will fail.
The API returns standard HTTP response codes RFC 7231 on each request to indicate the success or otherwise of API requests. HTTP status codes summary are listed below:
200 OK
—The request was successful.201 Created
—The request was successful, and a new resource was created as a result.204 No Content
—The request was successful, but there is no content to send.400 Bad Request
—Bad request, probably due to a syntax error.401 Unauthorized
—Authentication required.403 Forbidden
—The API key doesn't have permissions.404 Not Found
—The resource doesn't exist.405 Method Not Allowed
—The request method is known by the server but isn't supported by the target resource.409 Conflict
—The request couldn't be completed because it conflicted with another request or the server's configuration.500
,502
,503
,504
Server Errors
—An error occurred with our API.
Dojo follows the error response format proposed in RFC 7807 also known as Problem Details for HTTP APIs. All errors are returned in the form of JSON.
Error Schema
In case of an error, the response object contains the following fields:
errors
[object]—A human-readable explanation of errors.type
[string]— A URI reference RFC 3986 that identifies the problem type.title
[string]—A short, human-readable summary of the error.status
[integer]—The HTTP status code.detail
[string]—A human-readable message giving more details about the error. Not always present.traceId
[string]—The unique identifier of the failing request.
The following example shows a possible error response:
{
"errors": {
"Reference": [
"The Reference field is required."
]
},
"type": "https://tools.ietf.org/html/rfc7231#section-6.5.1",
"title": "One or more validation errors occurred.",
"status": 400,
"traceId": "00-a405f077df056a498323ffbcec05923f-aa63e6f4dbbc734a-01",
}
Dojo API uses the yyyy-mm-dd API version-naming scheme. You have to pass the version as the version
header in all API calls, for example:
curl
--header 'content-type: application/json' \
--header 'Authorization: Basic sk_prod_your_key' \
--header 'version: 2022-04-07' \
When we make breaking changes to the API, we release new dated versions.
The current version is 2022-04-07
.
Allows you to take and manage payments.
Documentation: Payment intents
Create a payment intent
Creates a payment intent.
header Parameters
version required | string <date> Example: 2022-04-07 API version with format yyyy-mm-dd. Current version is 2022-04-07. Today's date will always give you the latest version. |
Request Body schema: application/jsonrequired
CaptureMode (string) The type of capture for the payment:
| |
required | Money (object) The amount intended to be collected by this payment intent. |
(Money (object or null)) The tips amount. | |
reference required | string [ 1 .. 60 ] characters Details of the reference for the payment. |
description | string or null <= 4096 characters The payment description. |
(Customer (object or null)) Details about the customer. | |
(Address (object or null)) The address where to send the invoice. | |
(ShippingDetails (object or null)) The address where to send the order. | |
(TransactionSource (string or null)) Information about the transaction source type. | |
(PaymentIntentConfigRequest (object or null)) Details about the payment intent configuration. | |
(RequestSecurity (object or null)) Customer's device information. | |
Array of objects or null The line items purchased by the customer. | |
Array of objects or null The taxes applied to the items. | |
paymentMethods | Array of strings or null Enum: "Card" "Wallet" The payment methods that customers can use to pay. |
(ActionLink (object or null)) The link to the payment's associated actions. | |
expireAt | string or null <date-time> 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 |
autoExpireIn | string or null <timespan> The time interval after which |
(AutoExpireAction (string or null)) The action that happens with the | |
object or null A set of key-value pairs that you can use for storing additional information. | |
setupIntentId | string or null Unique identifier for the setup intent. |
Responses
Response Schema: application/json
id | string or null Unique identifier for the payment intent. |
captureMode | string Default: "Auto" Enum: "Auto" "Manual" |
clientSessionSecret | string or null The client secret. |
clientSessionSecretExpirationDate | string <date-time> The expiration date of |
(PaymentDetails (object or null)) Details about the payment. | |
status | string Enum: "Created" "Authorized" "Captured" "Reversed" "Refunded" "Canceled" Current status of the payment intent. |
paymentMethods | Array of strings or null Enum: "Card" "Wallet" The payment methods that customers can use to pay. |
(Money (object or null)) The amount intended to be collected by this payment intent. | |
(Money (object or null)) The tips amount. | |
(Money (object or null)) The amount that was requested by this Payment intent. | |
(Money (object or null)) The total amount after applying discounts and taxes. | |
refundedAmount | integer or null <int64> The amount that was refunded. |
(Customer (object or null)) Details about the customer. | |
(RequestSecurity (object or null)) Customer's device information. | |
(Address (object or null)) The address where to send the invoice. | |
(ShippingDetails (object or null)) The address where to send the order. | |
createdAt | string <date-time> The timestamp of the create date, in ISO 8601 UTC format. |
updatedAt | string <date-time> The timestamp of the update date, in ISO 8601 UTC format. |
reference | string or null Details of the reference for the payment. |
description | string or null The payment description. |
(Money (object or null)) The total amount after applying discounts and taxes. | |
Array of objects or null The line items purchased by the customer. | |
Array of objects or null The taxes applied to the items. | |
(ActionLink (object or null)) The link to the payment's associated actions. | |
(PaymentIntentConfigResponse (object or null)) Details about the payment intent configuration. | |
(MerchantConfig (object or null)) Details of payment intent merchant configuration. | |
expireAt | string or null <date-time> 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 |
autoExpireIn | string or null <timespan> The time interval after which |
(AutoExpireAction (string or null)) The action that happens with the | |
object or null A set of key-value pairs that you can use for storing additional information. | |
setupIntentId | string or null Unique identifier for the setup intent. |
Array of objects or null The past events of the payment. |
Request samples
- Payload
- Python + Python3
- Node + Request
- Shell + Curl
- Php + Curl
- Csharp + Restsharp
- Python + Requests
- Javascript + Jquery
- Javascript + Xhr
- Swift + Nsurlsession
- Ruby + Native
- Go + Native
- C + Libcurl
- Powershell + Webrequest
{- "amount": {
- "value": 1000,
- "currencyCode": "GBP"
}, - "reference": "Order 234",
- "description": "Demo payment intent"
}
Response samples
- 200
- 400
- 401
- 403
{- "id": "pi_sandbox_RBMHTJ4fIkmSppDILZVCGw",
- "captureMode"": "Auto",
- "clientSessionSecret": "lmoFsbTJxoiOBgeWkEoFS05ADIQ6STJfJE3oGVNO2cFSb9kza06wGan2DVNceOYCsmZ5I1SiEioFausOAkecUPz8BKSmMV96ecXZZ4-NzoiYZJF0uVYeW8xosG6blQKtZ6HqIIF8--2a7DC_iQ==",
- "clientSessionSecretExpirationDate": "2022-02-21T15:09:21Z",
- "status": "Created",
- "paymentMethods": [
- "Card"
], - "amount": {
- "value": 1000,
- "currencyCode"": "GBP"
}, - "totalAmount": {
- "value": 1000,
- "currencyCode": "GBP"
}, - "createdAt": "2022-02-21T14:39:21.6050276Z",
- "updatedAt": "2022-02-21T14:39:21.6050277Z",
- "reference": "Order 234",
- "description": "Demo payment intent",
- "itemLines": [ ],
- "taxLines": [ ],
- "metadata": { }
}
Retrieve a payment intent
Retrieves the details of a payment intent.
path Parameters
paymentIntentId required | string Example: pi_sandbox_RBMHTJ4fIkmSppDILZVCGw Unique identifier for the payment intent. |
header Parameters
version required | string <date> Example: 2022-04-07 API version with format yyyy-mm-dd. Current version is 2022-04-07. Today's date will always give you the latest version. |
Responses
Response Schema: application/json
id | string or null Unique identifier for the payment intent. |
captureMode | string Default: "Auto" Enum: "Auto" "Manual" |
clientSessionSecret | string or null The client secret. |
clientSessionSecretExpirationDate | string <date-time> The expiration date of |
(PaymentDetails (object or null)) Details about the payment. | |
status | string Enum: "Created" "Authorized" "Captured" "Reversed" "Refunded" "Canceled" Current status of the payment intent. |
paymentMethods | Array of strings or null Enum: "Card" "Wallet" The payment methods that customers can use to pay. |
(Money (object or null)) The amount intended to be collected by this payment intent. | |
(Money (object or null)) The tips amount. | |
(Money (object or null)) The amount that was requested by this Payment intent. | |
(Money (object or null)) The total amount after applying discounts and taxes. | |
refundedAmount | integer or null <int64> The amount that was refunded. |
(Customer (object or null)) Details about the customer. | |
(RequestSecurity (object or null)) Customer's device information. | |
(Address (object or null)) The address where to send the invoice. | |
(ShippingDetails (object or null)) The address where to send the order. | |
createdAt | string <date-time> The timestamp of the create date, in ISO 8601 UTC format. |
updatedAt | string <date-time> The timestamp of the update date, in ISO 8601 UTC format. |
reference | string or null Details of the reference for the payment. |
description | string or null The payment description. |
(Money (object or null)) The total amount after applying discounts and taxes. | |
Array of objects or null The line items purchased by the customer. | |
Array of objects or null The taxes applied to the items. | |
(ActionLink (object or null)) The link to the payment's associated actions. | |
(PaymentIntentConfigResponse (object or null)) Details about the payment intent configuration. | |
(MerchantConfig (object or null)) Details of payment intent merchant configuration. | |
expireAt | string or null <date-time> 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 |
autoExpireIn | string or null <timespan> The time interval after which |
(AutoExpireAction (string or null)) The action that happens with the | |
object or null A set of key-value pairs that you can use for storing additional information. | |
setupIntentId | string or null Unique identifier for the setup intent. |
Array of objects or null The past events of the payment. |
Request samples
- Python + Python3
- Node + Request
- Shell + Curl
- Php + Curl
- Csharp + Restsharp
- Python + Requests
- Javascript + Jquery
- Javascript + Xhr
- Swift + Nsurlsession
- Ruby + Native
- Go + Native
- C + Libcurl
- Powershell + Webrequest
import http.client conn = http.client.HTTPSConnection("api.dojo.tech") headers = { 'version': "SOME_STRING_VALUE", 'Authorization': "REPLACE_KEY_VALUE" } conn.request("GET", "/payment-intents/pi_sandbox_RBMHTJ4fIkmSppDILZVCGw", headers=headers) res = conn.getresponse() data = res.read() print(data.decode("utf-8"))
Response samples
- 200
- 400
- 401
- 404
{- "id": "pi_sandbox_RBMHTJ4fIkmSppDILZVCGw",
- "captureMode"": "Auto",
- "clientSessionSecret": "lmoFsbTJxoiOBgeWkEoFS05ADIQ6STJfJE3oGVNO2cFSb9kza06wGan2DVNceOYCsmZ5I1SiEioFausOAkecUPz8BKSmMV96ecXZZ4-NzoiYZJF0uVYeW8xosG6blQKtZ6HqIIF8--2a7DC_iQ==",
- "clientSessionSecretExpirationDate": "2022-02-21T15:09:21Z",
- "status": "Created",
- "paymentMethods": [
- "Card"
], - "amount": {
- "value": 1000,
- "currencyCode"": "GBP"
}, - "totalAmount": {
- "value": 1000,
- "currencyCode": "GBP"
}, - "createdAt": "2022-02-21T14:39:21.6050276Z",
- "updatedAt": "2022-02-21T14:39:21.6050277Z",
- "reference": "Order 234",
- "description": "Demo payment intent",
- "itemLines": [ ],
- "taxLines": [ ],
- "metadata": { }
}
Cancel a payment intent
Cancels a payment intent. The payment intent can be canceled if it's in the Created
status. After cancellation, the payment intent will change the status to Canceled
and any operations on the payment intent will fail with an error.
path Parameters
paymentIntentId required | string Example: pi_sandbox_RBMHTJ4fIkmSppDILZVCGw Unique identifier for the payment intent. |
header Parameters
version required | string <date> Example: 2022-04-07 API version with format yyyy-mm-dd. Current version is 2022-04-07. Today's date will always give you the latest version. |
Responses
Response Schema: application/json
id | string or null Unique identifier for the payment intent. |
captureMode | string Default: "Auto" Enum: "Auto" "Manual" |
clientSessionSecret | string or null The client secret. |
clientSessionSecretExpirationDate | string <date-time> The expiration date of |
(PaymentDetails (object or null)) Details about the payment. | |
status | string Enum: "Created" "Authorized" "Captured" "Reversed" "Refunded" "Canceled" Current status of the payment intent. |
paymentMethods | Array of strings or null Enum: "Card" "Wallet" The payment methods that customers can use to pay. |
(Money (object or null)) The amount intended to be collected by this payment intent. | |
(Money (object or null)) The tips amount. | |
(Money (object or null)) The amount that was requested by this Payment intent. | |
(Money (object or null)) The total amount after applying discounts and taxes. | |
refundedAmount | integer or null <int64> The amount that was refunded. |
(Customer (object or null)) Details about the customer. | |
(RequestSecurity (object or null)) Customer's device information. | |
(Address (object or null)) The address where to send the invoice. | |
(ShippingDetails (object or null)) The address where to send the order. | |
createdAt | string <date-time> The timestamp of the create date, in ISO 8601 UTC format. |
updatedAt | string <date-time> The timestamp of the update date, in ISO 8601 UTC format. |
reference | string or null Details of the reference for the payment. |
description | string or null The payment description. |
(Money (object or null)) The total amount after applying discounts and taxes. | |
Array of objects or null The line items purchased by the customer. | |
Array of objects or null The taxes applied to the items. | |
(ActionLink (object or null)) The link to the payment's associated actions. | |
(PaymentIntentConfigResponse (object or null)) Details about the payment intent configuration. | |
(MerchantConfig (object or null)) Details of payment intent merchant configuration. | |
expireAt | string or null <date-time> 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 |
autoExpireIn | string or null <timespan> The time interval after which |
(AutoExpireAction (string or null)) The action that happens with the | |
object or null A set of key-value pairs that you can use for storing additional information. | |
setupIntentId | string or null Unique identifier for the setup intent. |
Array of objects or null The past events of the payment. |
Request samples
- Python + Python3
- Node + Request
- Shell + Curl
- Php + Curl
- Csharp + Restsharp
- Python + Requests
- Javascript + Jquery
- Javascript + Xhr
- Swift + Nsurlsession
- Ruby + Native
- Go + Native
- C + Libcurl
- Powershell + Webrequest
import http.client conn = http.client.HTTPSConnection("api.dojo.tech") headers = { 'version': "SOME_STRING_VALUE", 'Authorization': "REPLACE_KEY_VALUE" } conn.request("DELETE", "/payment-intents/pi_sandbox_RBMHTJ4fIkmSppDILZVCGw", headers=headers) res = conn.getresponse() data = res.read() print(data.decode("utf-8"))
Response samples
- 200
- 400
- 401
- 404
{- "id": "pi_sandbox_RBMHTJ4fIkmSppDILZVCGw",
- "captureMode"": "Auto",
- "clientSessionSecret": "lmoFsbTJxoiOBgeWkEoFS05ADIQ6STJfJE3oGVNO2cFSb9kza06wGan2DVNceOYCsmZ5I1SiEioFausOAkecUPz8BKSmMV96ecXZZ4-NzoiYZJF0uVYeW8xosG6blQKtZ6HqIIF8--2a7DC_iQ==",
- "clientSessionSecretExpirationDate": "2022-02-21T15:09:21Z",
- "status": "Canceled",
- "paymentMethods": [
- "Card"
], - "amount": {
- "value": 1000,
- "currencyCode"": "GBP"
}, - "totalAmount": {
- "value": 1000,
- "currencyCode": "GBP"
}, - "createdAt": "2022-02-21T14:39:21.6050276Z",
- "updatedAt": "2022-02-21T14:39:21.6050277Z",
- "reference": "Order 234",
- "description": "Demo payment intent",
- "itemLines": [ ],
- "taxLines": [ ],
- "metadata": { }
}
Charge a card
Allows you to charge a card later. This is available for merchant-initiated transactions only.
path Parameters
paymentIntentId required | string or null Example: pi_sandbox_RBMHTJ4fIkmSppDILZVCGw Unique identifier for the payment intent. |
header Parameters
version required | string <date> Example: 2022-04-07 API version with format yyyy-mm-dd. Current version is 2022-04-07. Today's date will always give you the latest version. |
Responses
Response Schema: application/json
paymentIntentId | string or null Unique identifier for the payment intent. |
status | string Enum: "Created" "Successful" "Declined" "Failed" Current capture status. |
message | string The description of the operation. |
Request samples
- Python + Python3
- Node + Request
- Shell + Curl
- Php + Curl
- Csharp + Restsharp
- Python + Requests
- Javascript + Jquery
- Javascript + Xhr
- Swift + Nsurlsession
- Ruby + Native
- Go + Native
- C + Libcurl
- Powershell + Webrequest
import http.client conn = http.client.HTTPSConnection("api.dojo.tech") headers = { 'version': "SOME_STRING_VALUE", 'Authorization': "REPLACE_KEY_VALUE" } conn.request("POST", "/payment-intents/pi_sandbox_RBMHTJ4fIkmSppDILZVCGw/charge", headers=headers) res = conn.getresponse() data = res.read() print(data.decode("utf-8"))
Response samples
- 200
- 400
- 401
- 403
{- "paymentIntentId": "string",
- "status": "Created",
- "message": "string"
}
Update a client session secret
Updates a client session secret.
path Parameters
paymentIntentId required | string Example: pi_sandbox_RBMHTJ4fIkmSppDILZVCGw Unique identifier for the payment intent. |
header Parameters
version required | string <date> Example: 2022-04-07 API version with format yyyy-mm-dd. Current version is 2022-04-07. Today's date will always give you the latest version. |
Responses
Response Schema: application/json
id | string or null Unique identifier for the payment intent. |
captureMode | string Default: "Auto" Enum: "Auto" "Manual" |
clientSessionSecret | string or null The client secret. |
clientSessionSecretExpirationDate | string <date-time> The expiration date of |
(PaymentDetails (object or null)) Details about the payment. | |
status | string Enum: "Created" "Authorized" "Captured" "Reversed" "Refunded" "Canceled" Current status of the payment intent. |
paymentMethods | Array of strings or null Enum: "Card" "Wallet" The payment methods that customers can use to pay. |
(Money (object or null)) The amount intended to be collected by this payment intent. | |
(Money (object or null)) The tips amount. | |
(Money (object or null)) The amount that was requested by this Payment intent. | |
(Money (object or null)) The total amount after applying discounts and taxes. | |
refundedAmount | integer or null <int64> The amount that was refunded. |
(Customer (object or null)) Details about the customer. | |
(RequestSecurity (object or null)) Customer's device information. | |
(Address (object or null)) The address where to send the invoice. | |
(ShippingDetails (object or null)) The address where to send the order. | |
createdAt | string <date-time> The timestamp of the create date, in ISO 8601 UTC format. |
updatedAt | string <date-time> The timestamp of the update date, in ISO 8601 UTC format. |
reference | string or null Details of the reference for the payment. |
description | string or null The payment description. |
(Money (object or null)) The total amount after applying discounts and taxes. | |
Array of objects or null The line items purchased by the customer. | |
Array of objects or null The taxes applied to the items. | |
(ActionLink (object or null)) The link to the payment's associated actions. | |
(PaymentIntentConfigResponse (object or null)) Details about the payment intent configuration. | |
(MerchantConfig (object or null)) Details of payment intent merchant configuration. | |
expireAt | string or null <date-time> 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 |
autoExpireIn | string or null <timespan> The time interval after which |
(AutoExpireAction (string or null)) The action that happens with the | |
object or null A set of key-value pairs that you can use for storing additional information. | |
setupIntentId | string or null Unique identifier for the setup intent. |
Array of objects or null The past events of the payment. |
Request samples
- Python + Python3
- Node + Request
- Shell + Curl
- Php + Curl
- Csharp + Restsharp
- Python + Requests
- Javascript + Jquery
- Javascript + Xhr
- Swift + Nsurlsession
- Ruby + Native
- Go + Native
- C + Libcurl
- Powershell + Webrequest
import http.client conn = http.client.HTTPSConnection("api.dojo.tech") headers = { 'version': "SOME_STRING_VALUE", 'Authorization': "REPLACE_KEY_VALUE" } conn.request("POST", "/payment-intents/pi_sandbox_RBMHTJ4fIkmSppDILZVCGw/refresh-client-session-secret", headers=headers) res = conn.getresponse() data = res.read() print(data.decode("utf-8"))
Response samples
- 200
- 400
- 401
{- "id": "pi_sandbox_RBMHTJ4fIkmSppDILZVCGw",
- "captureMode"": "Auto",
- "clientSessionSecret": "lmoFsbTJxoiOBgeWkEoFS05ADIQ6STJfJE3oGVNO2cFSb9kza06wGan2DVNceOYCsmZ5I1SiEioFausOAkecUPz8BKSmMV96ecXZZ4-NzoiYZJF0uVYeW8xosG6blQKtZ6HqIIF8--2a7DC_iQ==",
- "clientSessionSecretExpirationDate": "2022-02-21T15:09:21Z",
- "status": "Created",
- "paymentMethods": [
- "Card"
], - "amount": {
- "value": 1000,
- "currencyCode"": "GBP"
}, - "totalAmount": {
- "value": 1000,
- "currencyCode": "GBP"
}, - "createdAt": "2022-02-21T14:39:21.6050276Z",
- "updatedAt": "2022-02-21T14:39:21.6050277Z",
- "reference": "Order 234",
- "description": "Demo payment intent",
- "itemLines": [ ],
- "taxLines": [ ],
- "metadata": { }
}
List all payment intents
Retrieves a list of payment intents. Results are paginated, by default the method returns up to 50 payment intents.
header Parameters
version required | string <date> Example: 2022-04-07 API version with format yyyy-mm-dd. Current version is 2022-04-07. Today's date will always give you the latest version. |
Request Body schema: application/jsonrequired
statuses | Array of strings or null Enum: "Created" "Authorized" "Captured" "Reversed" "Refunded" "Canceled" Statuses of payment intents. |
startDate | string or null <date-time> Date and time from which to search, in ISO 8601 UTC format. |
endDate | string or null <date-time> Date and time until which to search in ISO 8601 UTC format. |
(Cursor (object or null)) A cursor for use in pagination. |
Responses
Response Schema: application/json
Array of objects or null An array of payment intents. | |
before | string or null A cursor for use in pagination for the previous page. |
after | string or null A cursor for use in pagination for the next page. |
Request samples
- Payload
- Python + Python3
- Node + Request
- Shell + Curl
- Php + Curl
- Csharp + Restsharp
- Python + Requests
- Javascript + Jquery
- Javascript + Xhr
- Swift + Nsurlsession
- Ruby + Native
- Go + Native
- C + Libcurl
- Powershell + Webrequest
{- "statuses": [
- "Created"
], - "startDate": "2019-08-24T14:15:22Z",
- "endDate": "2023-08-24T14:15:22Z",
- "cursor": {
- "limit": 20
}
}
Response samples
- 200
- 400
- 401
{- "data": [
- {
- "id": "string",
- "captureMode": "Auto",
- "clientSessionSecret": "string",
- "clientSessionSecretExpirationDate": "2019-08-24T14:15:22Z",
- "paymentDetails": {
- "transactionDateTime": "string",
- "message": "string",
- "authCode": "string",
- "cardNumber": "string",
- "cardName": "string",
- "expiryDate": "string",
- "cardType": "string"
}, - "status": "Created",
- "paymentMethods": [
- "Card"
], - "amount": {
- "value": 1000,
- "currencyCode": "GBP"
}, - "tipsAmount": {
- "value": 1000,
- "currencyCode": "GBP"
}, - "requestedAmount": {
- "value": 1000,
- "currencyCode": "GBP"
}, - "totalAmount": {
- "value": 1000,
- "currencyCode": "GBP"
}, - "refundedAmount": 0,
- "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": {
- "name": "string",
- "deliveryNotes": "string",
- "address": {
- "address1": "The Brunel Building",
- "address2": "2 Canalside Walk",
- "city": "London",
- "postcode": "W2 1DG",
- "countryCode": "GB",
- "county": "UK"
}
}, - "createdAt": "2019-08-24T14:15:22Z",
- "updatedAt": "2019-08-24T14:15:22Z",
- "reference": "string",
- "description": "string",
- "subtotalLineItems": {
- "value": 1000,
- "currencyCode": "GBP"
}, - "itemLines": [
- {
- "id": "string",
- "quantity": 0,
- "caption": "string",
- "amountTotal": {
- "value": 1000,
- "currencyCode": "GBP"
}
}
], - "taxLines": [
- {
- "id": "string",
- "caption": "string",
- "subCaption": "string",
- "amountTotal": {
- "value": 1000,
- "currencyCode": "GBP"
}
}
], - "config": {
- "title": "string",
- "customerEmail": {
- "collectionRequired": false
}, - "details": {
- "showTotal": true,
- "showReference": true
}, - "billingAddress": {
- "collectionRequired": true
}, - "shippingDetails": {
- "collectionRequired": true
}, - "payment": {
- "customAmountAllowed": true,
- "tipsAllowed": true
}
}, - "merchantConfig": {
- "supportedPaymentMethods": {
- "cardSchemes": [
- "VISA"
], - "wallets": [
- "APPLE_PAY"
]
}
}, - "expireAt": "2019-08-24T14:15:22Z",
- "autoExpireIn": "string",
- "autoExpireAction": "Release",
- "metadata": {
- "property1": "string",
- "property2": "string"
}, - "setupIntentId": "string",
- "paymentEvents": [
- {
- "transactionId": "string",
- "transactionDateTime": "string",
- "eventType": "Created",
- "authCode": "string",
- "cardNumber": "string",
- "expiryDate": "string",
- "cardType": "string",
- "cardholderName": "string"
}
]
}
], - "before": "string",
- "after": "string"
}
Change tip amount
Changes tips amount for a payment intent. Available if you allowed tips when creating this payment intent.
path Parameters
paymentIntentId required | string Example: pi_sandbox_RBMHTJ4fIkmSppDILZVCGw Unique identifier for the payment intent. |
header Parameters
version required | string <date> Example: 2022-04-07 API version with format yyyy-mm-dd. Current version is 2022-04-07. Today's date will always give you the latest version. |
Request Body schema: application/jsonrequired
required | Money (object) The tips amount. | ||||
One of
|
Responses
Response Schema: application/json
id | string or null Unique identifier for the payment intent. |
captureMode | string Default: "Auto" Enum: "Auto" "Manual" |
clientSessionSecret | string or null The client secret. |
clientSessionSecretExpirationDate | string <date-time> The expiration date of |
(PaymentDetails (object or null)) Details about the payment. | |
status | string Enum: "Created" "Authorized" "Captured" "Reversed" "Refunded" "Canceled" Current status of the payment intent. |
paymentMethods | Array of strings or null Enum: "Card" "Wallet" The payment methods that customers can use to pay. |
(Money (object or null)) The amount intended to be collected by this payment intent. | |
(Money (object or null)) The tips amount. | |
(Money (object or null)) The amount that was requested by this Payment intent. | |
(Money (object or null)) The total amount after applying discounts and taxes. | |
refundedAmount | integer or null <int64> The amount that was refunded. |
(Customer (object or null)) Details about the customer. | |
(RequestSecurity (object or null)) Customer's device information. | |
(Address (object or null)) The address where to send the invoice. | |
(ShippingDetails (object or null)) The address where to send the order. | |
createdAt | string <date-time> The timestamp of the create date, in ISO 8601 UTC format. |
updatedAt | string <date-time> The timestamp of the update date, in ISO 8601 UTC format. |
reference | string or null Details of the reference for the payment. |
description | string or null The payment description. |
(Money (object or null)) The total amount after applying discounts and taxes. | |
Array of objects or null The line items purchased by the customer. | |
Array of objects or null The taxes applied to the items. | |
(ActionLink (object or null)) The link to the payment's associated actions. | |
(PaymentIntentConfigResponse (object or null)) Details about the payment intent configuration. | |
(MerchantConfig (object or null)) Details of payment intent merchant configuration. | |
expireAt | string or null <date-time> 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 |
autoExpireIn | string or null <timespan> The time interval after which |
(AutoExpireAction (string or null)) The action that happens with the | |
object or null A set of key-value pairs that you can use for storing additional information. | |
setupIntentId | string or null Unique identifier for the setup intent. |
Array of objects or null The past events of the payment. |
Request samples
- Payload
- Python + Python3
- Node + Request
- Shell + Curl
- Php + Curl
- Csharp + Restsharp
- Python + Requests
- Javascript + Jquery
- Javascript + Xhr
- Swift + Nsurlsession
- Ruby + Native
- Go + Native
- C + Libcurl
- Powershell + Webrequest
{- "tipsAmount": {
- "value": 500,
- "currencyCode": "GBP"
}
}
Response samples
- 200
- 400
- 401
- 405
{- "id": "pi_sandbox_RBMHTJ4fIkmSppDILZVCGw",
- "captureMode"": "Auto",
- "clientSessionSecret": "lmoFsbTJxoiOBgeWkEoFS05ADIQ6STJfJE3oGVNO2cFSb9kza06wGan2DVNceOYCsmZ5I1SiEioFausOAkecUPz8BKSmMV96ecXZZ4-NzoiYZJF0uVYeW8xosG6blQKtZ6HqIIF8--2a7DC_iQ==",
- "clientSessionSecretExpirationDate": "2022-02-21T15:09:21Z",
- "status": "Created",
- "paymentMethods": [
- "Card"
], - "amount": {
- "value": 1000,
- "currencyCode"": "GBP"
}, - "totalAmount": {
- "value": 1000,
- "currencyCode": "GBP"
}, - "createdAt": "2022-02-21T14:39:21.6050276Z",
- "updatedAt": "2022-02-21T14:39:21.6050277Z",
- "reference": "Order 234",
- "description": "Demo payment intent",
- "itemLines": [ ],
- "taxLines": [ ],
- "metadata": { }
}
Change a payment intent amount
Changes the amount for a payment intent. Available if you allowed the amount changes when creating this payment intent.
path Parameters
paymentIntentId required | string Example: pi_sandbox_RBMHTJ4fIkmSppDILZVCGw Unique identifier for the payment intent. |
header Parameters
version required | string <date> Example: 2022-04-07 API version with format yyyy-mm-dd. Current version is 2022-04-07. Today's date will always give you the latest version. |
Request Body schema: application/jsonrequired
required | Money (object) The amount intended to be collected by this payment intent. | ||||
One of
|
Responses
Response Schema: application/json
id | string or null Unique identifier for the payment intent. |
captureMode | string Default: "Auto" Enum: "Auto" "Manual" |
clientSessionSecret | string or null The client secret. |
clientSessionSecretExpirationDate | string <date-time> The expiration date of |
(PaymentDetails (object or null)) Details about the payment. | |
status | string Enum: "Created" "Authorized" "Captured" "Reversed" "Refunded" "Canceled" Current status of the payment intent. |
paymentMethods | Array of strings or null Enum: "Card" "Wallet" The payment methods that customers can use to pay. |
(Money (object or null)) The amount intended to be collected by this payment intent. | |
(Money (object or null)) The tips amount. | |
(Money (object or null)) The amount that was requested by this Payment intent. | |
(Money (object or null)) The total amount after applying discounts and taxes. | |
refundedAmount | integer or null <int64> The amount that was refunded. |
(Customer (object or null)) Details about the customer. | |
(RequestSecurity (object or null)) Customer's device information. | |
(Address (object or null)) The address where to send the invoice. | |
(ShippingDetails (object or null)) The address where to send the order. | |
createdAt | string <date-time> The timestamp of the create date, in ISO 8601 UTC format. |
updatedAt | string <date-time> The timestamp of the update date, in ISO 8601 UTC format. |
reference | string or null Details of the reference for the payment. |
description | string or null The payment description. |
(Money (object or null)) The total amount after applying discounts and taxes. | |
Array of objects or null The line items purchased by the customer. | |
Array of objects or null The taxes applied to the items. | |
(ActionLink (object or null)) The link to the payment's associated actions. | |
(PaymentIntentConfigResponse (object or null)) Details about the payment intent configuration. | |
(MerchantConfig (object or null)) Details of payment intent merchant configuration. | |
expireAt | string or null <date-time> 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 |
autoExpireIn | string or null <timespan> The time interval after which |
(AutoExpireAction (string or null)) The action that happens with the | |
object or null A set of key-value pairs that you can use for storing additional information. | |
setupIntentId | string or null Unique identifier for the setup intent. |
Array of objects or null The past events of the payment. |
Request samples
- Payload
- Python + Python3
- Node + Request
- Shell + Curl
- Php + Curl
- Csharp + Restsharp
- Python + Requests
- Javascript + Jquery
- Javascript + Xhr
- Swift + Nsurlsession
- Ruby + Native
- Go + Native
- C + Libcurl
- Powershell + Webrequest
{- "amount": {
- "value": 1000,
- "currencyCode": "GBP"
}
}
Response samples
- 200
- 400
- 401
- 405
{- "id": "pi_sandbox_RBMHTJ4fIkmSppDILZVCGw",
- "captureMode"": "Auto",
- "clientSessionSecret": "lmoFsbTJxoiOBgeWkEoFS05ADIQ6STJfJE3oGVNO2cFSb9kza06wGan2DVNceOYCsmZ5I1SiEioFausOAkecUPz8BKSmMV96ecXZZ4-NzoiYZJF0uVYeW8xosG6blQKtZ6HqIIF8--2a7DC_iQ==",
- "clientSessionSecretExpirationDate": "2022-02-21T15:09:21Z",
- "status": "Created",
- "paymentMethods": [
- "Card"
], - "amount": {
- "value": 1000,
- "currencyCode"": "GBP"
}, - "totalAmount": {
- "value": 1000,
- "currencyCode": "GBP"
}, - "createdAt": "2022-02-21T14:39:21.6050276Z",
- "updatedAt": "2022-02-21T14:39:21.6050277Z",
- "reference": "Order 234",
- "description": "Demo payment intent",
- "itemLines": [ ],
- "taxLines": [ ],
- "metadata": { }
}
Send a receipt
Sends a receipt to the email addresses you specified.
path Parameters
paymentIntentId required | string Example: pi_sandbox_RBMHTJ4fIkmSppDILZVCGw Unique identifier for the payment intent. |
header Parameters
version required | string <date> Example: 2022-04-07 API version with format yyyy-mm-dd. Current version is 2022-04-07. Today's date will always give you the latest version. |
Request Body schema: application/jsonrequired
emails required | Array of strings The list of email addresses to which the receipt should be sent. |
Responses
Request samples
- Payload
- Python + Python3
- Node + Request
- Shell + Curl
- Php + Curl
- Csharp + Restsharp
- Python + Requests
- Javascript + Jquery
- Javascript + Xhr
- Swift + Nsurlsession
- Ruby + Native
- Go + Native
- C + Libcurl
- Powershell + Webrequest
{- "emails": [
- "gabriel@dojo.com",
- "mari@dojo.com"
]
}
Response samples
- 400
- 401
- 404
{- "type": "string",
- "title": "string",
- "status": 0,
- "detail": "string",
- "traceId": "string",
- "errors": {
- "property1": null,
- "property2": null
}
}
Allows you to manage a refund for payments.
Documentation: Refunds
Create a refund
Creates a refund. Refund allows you to return a payment that has previously been created but not yet refunded. You can refund the full amount or a partial amount.
path Parameters
paymentIntentId required | string Unique identifier for the payment intent. |
header Parameters
version required | string <date> Example: 2022-04-07 API version with format yyyy-mm-dd. Current version is 2022-04-07. Today's date will always give you the latest version. |
idempotencyKey required | string <= 100 characters An idempotency key to recognize subsequent retries of the same request. How you generate the idempotency key is up to you. Must be unique for each new refund for the payment intent. |
Request Body schema: application/jsonrequired
amount required | integer <int64> The refund amount. |
refundReason | string or null <= 1024 characters The reason for the refund. |
notes | string or null <= 4096 characters The description of the refund. |
Responses
Response Schema: application/json
paymentIntentId | string or null Unique identifier for the payment intent. |
refundId | string or null Unique identifier for the refund. |
refundReason | string or null The reason for the refund. |
notes | string or null The description of the refund. |
Request samples
- Payload
- Python + Python3
- Node + Request
- Shell + Curl
- Php + Curl
- Csharp + Restsharp
- Python + Requests
- Javascript + Jquery
- Javascript + Xhr
- Swift + Nsurlsession
- Ruby + Native
- Go + Native
- C + Libcurl
- Powershell + Webrequest
{- "amount": 1000,
- "refundReason": "Demo refund"
}
Response samples
- 200
- 400
- 401
{- "paymentIntentId": "pi_sandbox_RBMHTJ4fIkmSppDILZVCGw",
- "refundId": "rfnd_127usj",
- "refundReason": "Demo refund",
- "notes": null
}
Retrieve a refund
Retrieves the details of a refund that has previously been created.
path Parameters
refundId required | string <= 50 characters Unique identifier for the refund. |
header Parameters
version required | string <date> Example: 2022-04-07 API version with format yyyy-mm-dd. Current version is 2022-04-07. Today's date will always give you the latest version. |
Responses
Response Schema: application/json
paymentIntentId | string or null Unique identifier for the payment intent. |
refundId | string or null Unique identifier for the refund. |
refundReason | string or null The reason for the refund. |
notes | string or null The description of the refund. |
Request samples
- Python + Python3
- Node + Request
- Shell + Curl
- Php + Curl
- Csharp + Restsharp
- Python + Requests
- Javascript + Jquery
- Javascript + Xhr
- Swift + Nsurlsession
- Ruby + Native
- Go + Native
- C + Libcurl
- Powershell + Webrequest
import http.client conn = http.client.HTTPSConnection("api.dojo.tech") headers = { 'version': "SOME_STRING_VALUE", 'Authorization': "REPLACE_KEY_VALUE" } conn.request("GET", "/payment-intents/refunds/%7BrefundId%7D", headers=headers) res = conn.getresponse() data = res.read() print(data.decode("utf-8"))
Response samples
- 200
- 400
- 401
{- "paymentIntentId": "pi_sandbox_RBMHTJ4fIkmSppDILZVCGw",
- "refundId": "rfnd_127usj",
- "refundReason": "Demo refund",
- "notes": null
}
Allows you to create a reversal for payments.
Documentation: Reversal
Create a reversal
Reverses a payment intent.
path Parameters
paymentIntentId required | string Unique identifier for the payment intent. |
header Parameters
version required | string <date> Example: 2022-04-07 API version with format yyyy-mm-dd. Current version is 2022-04-07. Today's date will always give you the latest version. |
Responses
Response Schema: application/json
message | string or null The description of the operation. |
reversalId | string or null Unique identifier for the reversal. |
Request samples
- Python + Python3
- Node + Request
- Shell + Curl
- Php + Curl
- Csharp + Restsharp
- Python + Requests
- Javascript + Jquery
- Javascript + Xhr
- Swift + Nsurlsession
- Ruby + Native
- Go + Native
- C + Libcurl
- Powershell + Webrequest
import http.client conn = http.client.HTTPSConnection("api.dojo.tech") headers = { 'version': "SOME_STRING_VALUE", 'Authorization': "REPLACE_KEY_VALUE" } conn.request("POST", "/payment-intents/%7BpaymentIntentId%7D/reversal", headers=headers) res = conn.getresponse() data = res.read() print(data.decode("utf-8"))
Response samples
- 200
- 400
- 401
- 409
{- "message": null,
- "reversalId": "rvs_127usj"
}
Allows you to capture the full payment amount or part of the amount.
Documentation: Captures
Captures a payment
Captures a payment intent that has previously been created but not yet refunded or reversed. You can capture the full amount or a partial amount.
path Parameters
paymentIntentId required | string Example: pi_sandbox_RBMHTJ4fIkmSppDILZVCGw Unique identifier for the payment intent. |
header Parameters
version required | string <date> Example: 2022-04-07 API version with format yyyy-mm-dd. Current version is 2022-04-07. Today's date will always give you the latest version. |
Request Body schema: application/jsonrequired
amount required | integer <int64> The amount to capture. You can capture the full amount or a partial amount. |
Responses
Response Schema: application/json
message | string or null The description of the operation. |
captureId | string or null Unique identifier for the capture. |
Request samples
- Payload
- Python + Python3
- Node + Request
- Shell + Curl
- Php + Curl
- Csharp + Restsharp
- Python + Requests
- Javascript + Jquery
- Javascript + Xhr
- Swift + Nsurlsession
- Ruby + Native
- Go + Native
- C + Libcurl
- Powershell + Webrequest
{- "amount": 1000
}
Response samples
- 200
- 400
- 401
- 409
{- "message": "Demo capture",
- "captureId": "cp_itIiJMEAvES3ynYF_Yhs2g"
}
Webhooks notify you when a specific event has occurred.
Documentation: Webhooks
List all events
Retrieves a list of all events.
header Parameters
version required | string <date> Example: 2022-04-07 API version with format yyyy-mm-dd. Current version is 2022-04-07. Today's date will always give you the latest version. |
Responses
Response Schema: application/json
model | string The webhook type. |
events | Array of strings The list of events. |
Request samples
- Python + Python3
- Node + Request
- Shell + Curl
- Php + Curl
- Csharp + Restsharp
- Python + Requests
- Javascript + Jquery
- Javascript + Xhr
- Swift + Nsurlsession
- Ruby + Native
- Go + Native
- C + Libcurl
- Powershell + Webrequest
import http.client conn = http.client.HTTPSConnection("api.dojo.tech") headers = { 'version': "SOME_STRING_VALUE", 'Authorization': "REPLACE_KEY_VALUE" } conn.request("GET", "/webhooks/events", headers=headers) res = conn.getresponse() data = res.read() print(data.decode("utf-8"))
Response samples
- 200
- 401
- 403
[- {
- "model": "PaymentIntent",
- "events": [
- "payment_intent.created",
- "payment_intent.updated"
]
}, - {
- "model": "Payment",
- "events": [
- "payment.successful"
]
}, - {
- "model": "Order",
- "events": [
- "order.created"
]
}
]
List all subscriptions
Retrieves a list of all subscriptions.
header Parameters
version required | string <date> Example: 2022-04-07 API version with format yyyy-mm-dd. Current version is 2022-04-07. Today's date will always give you the latest version. |
Responses
Response Schema: application/json
id | string Unique identifier for the subscription. |
accountId | string or null Unique identifier for the account. |
events | Array of strings The list of events. |
url | string <uri> non-empty ^https://*.+ The URL of your webhook endpoint. |
description | string or null The subscription description. |
Array of objects The list of subscription’s secrets, used to generate signatures. | |
createdAt | string <date-time> The timestamp of the create date, in ISO 8601 UTC format. |
updatedAt | string <date-time> The timestamp of the update date, in ISO 8601 UTC format. |
Request samples
- Python + Python3
- Node + Request
- Shell + Curl
- Php + Curl
- Csharp + Restsharp
- Python + Requests
- Javascript + Jquery
- Javascript + Xhr
- Swift + Nsurlsession
- Ruby + Native
- Go + Native
- C + Libcurl
- Powershell + Webrequest
import http.client conn = http.client.HTTPSConnection("api.dojo.tech") headers = { 'version': "SOME_STRING_VALUE", 'Authorization': "REPLACE_KEY_VALUE" } conn.request("GET", "/webhooks", headers=headers) res = conn.getresponse() data = res.read() print(data.decode("utf-8"))
Response samples
- 200
- 401
- 403
[- {
- "id": "string",
- "accountId": "string",
- "events": [
- "string"
], - "description": "string",
- "secrets": [
- {
- "id": "string",
- "value": "string",
- "createdAt": "2019-08-24T14:15:22Z",
- "isActive": true
}
], - "createdAt": "2019-08-24T14:15:22Z",
- "updatedAt": "2019-08-24T14:15:22Z"
}
]
Subscribe to an event
Creates a new subscription.
header Parameters
version required | string <date> Example: 2022-04-07 API version with format yyyy-mm-dd. Current version is 2022-04-07. Today's date will always give you the latest version. |
Request Body schema: application/jsonrequired
events required | Array of strings The list of events. |
url required | string <uri> non-empty ^https://*.+ The URL of your webhook endpoint. |
description | string or null The subscription description. |
Responses
Response Schema: application/json
id | string Unique identifier for the subscription. |
accountId | string or null Unique identifier for the account. |
events | Array of strings The list of events. |
url | string <uri> non-empty ^https://*.+ The URL of your webhook endpoint. |
description | string or null The subscription description. |
Array of objects The list of subscription’s secrets, used to generate signatures. | |
createdAt | string <date-time> The timestamp of the create date, in ISO 8601 UTC format. |
updatedAt | string <date-time> The timestamp of the update date, in ISO 8601 UTC format. |
Request samples
- Payload
- Python + Python3
- Node + Request
- Shell + Curl
- Php + Curl
- Csharp + Restsharp
- Python + Requests
- Javascript + Jquery
- Javascript + Xhr
- Swift + Nsurlsession
- Ruby + Native
- Go + Native
- C + Libcurl
- Powershell + Webrequest
{- "events": [
- "payment_intent.created",
- "payment.successful",
- "order.created"
],
}
Response samples
- 200
- 400
- 401
- 403
- 404
- 409
{- "id": "ws_aNkU6yob0vOMxUlghg2oynUw",
- "accountId": "acc_4z3k2xP17e1JQY",
- "events": [
- "payment_intent.created",
- "payment_intent.status_updated"
], - "description": "Demo webhooks",
- "secrets": [
- {
- "id": "sc_qNkU6yob0vOMxUlb2oynUw",
- "value": "U3Vic2NyaXB0aW9uUmVzcG9uc2VFeGFtcGxlIDogSUV4YW1wbGVQcm92aWRlcjxTdWJ",
- "createdAt": "2021-12-13T14:15:01",
- "lastUsedAt": "2021-12-16T13:44:03.3242202Z",
- "isActive": true
}
], - "createdAt": "2022-03-30T12:21:04.143Z",
- "updatedAt": "2022-03-30T12:21:04.143Z"
}
List all secrets
Retrieves a list of all secrets.
path Parameters
subscriptionId required | string Unique identifier for the subscription. |
header Parameters
version required | string <date> Example: 2022-04-07 API version with format yyyy-mm-dd. Current version is 2022-04-07. Today's date will always give you the latest version. |
Responses
Response Schema: application/json
id | string Unique identifier for the subscription. |
Array of objects The list of subscription’s secrets, used to generate signatures. |
Request samples
- Python + Python3
- Node + Request
- Shell + Curl
- Php + Curl
- Csharp + Restsharp
- Python + Requests
- Javascript + Jquery
- Javascript + Xhr
- Swift + Nsurlsession
- Ruby + Native
- Go + Native
- C + Libcurl
- Powershell + Webrequest
import http.client conn = http.client.HTTPSConnection("api.dojo.tech") headers = { 'version': "SOME_STRING_VALUE", 'Authorization': "REPLACE_KEY_VALUE" } conn.request("GET", "/webhooks/%7BsubscriptionId%7D/secrets", headers=headers) res = conn.getresponse() data = res.read() print(data.decode("utf-8"))
Response samples
- 200
- 401
- 403
- 404
{- "id": "ws_lgQzejyXb0SD8oIDE2zcqA",
- "secrets": [
- {
- "id": "sc_qNkU6yob0vOMxUlb2oynUw",
- "value": "U3Vic2NyaXB0aW9uUmVzcG9uc2VFeGFtcGxlIDogSUV4YW1wbGVQcm92aWRlcjxTdWJ",
- "createdAt": "2021-12-13T14:15:01",
- "lastUsedAt": "2021-12-16T13:44:03.3656144Z",
- "isActive": true
}, - {
- "id": "sc_zNkU6yob0vOMxUlb2oynUw",
- "value": "FGswesdsaXB0aW9uUmVzcG9wbGVQcm92aWRlcjxTdWJ",
- "createdAt": "2020-12-13T14:15:01",
- "lastUsedAt": "2021-12-02T13:58:03.3656159Z",
- "isActive": false
}
]
}
Generate a secret
Generates a new secret.
path Parameters
subscriptionId required | string Unique identifier for the subscription. |
header Parameters
version required | string <date> Example: 2022-04-07 API version with format yyyy-mm-dd. Current version is 2022-04-07. Today's date will always give you the latest version. |
Responses
Response Schema: application/json
id | string Unique identifier for the subscription. |
Array of objects The list of subscription’s secrets, used to generate signatures. |
Request samples
- Python + Python3
- Node + Request
- Shell + Curl
- Php + Curl
- Csharp + Restsharp
- Python + Requests
- Javascript + Jquery
- Javascript + Xhr
- Swift + Nsurlsession
- Ruby + Native
- Go + Native
- C + Libcurl
- Powershell + Webrequest
import http.client conn = http.client.HTTPSConnection("api.dojo.tech") headers = { 'version': "SOME_STRING_VALUE", 'Authorization': "REPLACE_KEY_VALUE" } conn.request("POST", "/webhooks/%7BsubscriptionId%7D/secrets", headers=headers) res = conn.getresponse() data = res.read() print(data.decode("utf-8"))
Response samples
- 200
- 401
- 403
- 404
- 409
{- "secrets": [
- {
- "id": "sc_qNkU6yob0vOMxUlb2oynUw",
- "value": "U3Vic2NyaXB0aW9uUmVzcG9uc2VFeGFtcGxlIDogSUV4YW1wbGVQcm92aWRlcjxTdWJ",
- "createdAt": "2021-12-13T14:15:01",
- "lastUsedAt": "2021-12-16T13:44:03.3683851Z",
- "isActive": true
}, - {
- "id": "sc_zNkU6yob0vOMxUlb2oynUw",
- "value": "FGswesdsaXB0aW9uUmVzcG9wbGVQcm92aWRlcjxTdWJ",
- "createdAt": "2020-12-13T14:15:01",
- "lastUsedAt": "2021-12-02T13:58:03.3683861Z",
- "isActive": false
}
]
}
Activate a secret
Activates a secret.
path Parameters
subscriptionId required | string Unique identifier for the subscription. |
secretId required | string Unique identifier for the secret. |
header Parameters
version required | string <date> Example: 2022-04-07 API version with format yyyy-mm-dd. Current version is 2022-04-07. Today's date will always give you the latest version. |
Responses
Request samples
- Python + Python3
- Node + Request
- Shell + Curl
- Php + Curl
- Csharp + Restsharp
- Python + Requests
- Javascript + Jquery
- Javascript + Xhr
- Swift + Nsurlsession
- Ruby + Native
- Go + Native
- C + Libcurl
- Powershell + Webrequest
import http.client conn = http.client.HTTPSConnection("api.dojo.tech") headers = { 'version': "SOME_STRING_VALUE", 'Authorization': "REPLACE_KEY_VALUE" } conn.request("PUT", "/webhooks/%7BsubscriptionId%7D/secrets/%7BsecretId%7D/activate", headers=headers) res = conn.getresponse() data = res.read() print(data.decode("utf-8"))
Response samples
- 401
- 403
- 404
{- "type": "string",
- "title": "string",
- "status": 0,
- "detail": "string",
- "traceId": "string",
- "errors": {
- "property1": null,
- "property2": null
}
}
Delete a secret
Deletes a secret.
path Parameters
subscriptionId required | string Unique identifier for the subscription. |
secretId required | string Unique identifier for the secret. |
header Parameters
version required | string <date> Example: 2022-04-07 API version with format yyyy-mm-dd. Current version is 2022-04-07. Today's date will always give you the latest version. |
Responses
Request samples
- Python + Python3
- Node + Request
- Shell + Curl
- Php + Curl
- Csharp + Restsharp
- Python + Requests
- Javascript + Jquery
- Javascript + Xhr
- Swift + Nsurlsession
- Ruby + Native
- Go + Native
- C + Libcurl
- Powershell + Webrequest
import http.client conn = http.client.HTTPSConnection("api.dojo.tech") headers = { 'version': "SOME_STRING_VALUE", 'Authorization': "REPLACE_KEY_VALUE" } conn.request("DELETE", "/webhooks/%7BsubscriptionId%7D/secrets/%7BsecretId%7D", headers=headers) res = conn.getresponse() data = res.read() print(data.decode("utf-8"))
Response samples
- 401
- 403
- 404
{- "type": "string",
- "title": "string",
- "status": 0,
- "detail": "string",
- "traceId": "string",
- "errors": {
- "property1": null,
- "property2": null
}
}
Update a subscription
Updates you subscription details. You can change the URL or the list of events.
path Parameters
subscriptionId required | string Unique identifier for the subscription. |
header Parameters
version required | string <date> Example: 2022-04-07 API version with format yyyy-mm-dd. Current version is 2022-04-07. Today's date will always give you the latest version. |
Request Body schema: application/jsonrequired
events | Array of strings or null The list of events. |
url | string or null <uri> ^https://*.+ The URL of your webhook endpoint. |
description | string or null The subscription description. |
Responses
Response Schema: application/json
id | string Unique identifier for the subscription. |
accountId | string or null Unique identifier for the account. |
events | Array of strings The list of events. |
url | string <uri> non-empty ^https://*.+ The URL of your webhook endpoint. |
description | string or null The subscription description. |
Array of objects The list of subscription’s secrets, used to generate signatures. | |
createdAt | string <date-time> The timestamp of the create date, in ISO 8601 UTC format. |
updatedAt | string <date-time> The timestamp of the update date, in ISO 8601 UTC format. |
Request samples
- Payload
- Python + Python3
- Node + Request
- Shell + Curl
- Php + Curl
- Csharp + Restsharp
- Python + Requests
- Javascript + Jquery
- Javascript + Xhr
- Swift + Nsurlsession
- Ruby + Native
- Go + Native
- C + Libcurl
- Powershell + Webrequest
{- "events": [
- "payment_intent.created",
- "order.created"
]
}
Response samples
- 200
- 400
- 401
- 403
- 404
- 409
{- "id": "ws_aNkU6yob0vOMxUlghg2oynUw",
- "accountId": "acc_4z3k2xP17e1JQY",
- "events": [
- "payment_intent.created",
- "payment_intent.status_updated"
], - "description": "Demo webhooks",
- "secrets": [
- {
- "id": "sc_qNkU6yob0vOMxUlb2oynUw",
- "value": "U3Vic2NyaXB0aW9uUmVzcG9uc2VFeGFtcGxlIDogSUV4YW1wbGVQcm92aWRlcjxTdWJ",
- "createdAt": "2021-12-13T14:15:01",
- "lastUsedAt": "2021-12-16T13:44:03.3242202Z",
- "isActive": true
}
], - "createdAt": "2022-03-30T12:21:04.143Z",
- "updatedAt": "2022-03-30T12:21:04.143Z"
}
Delete a subscription
Deletes a subscription.
path Parameters
subscriptionId required | string Unique identifier for the subscription. |
header Parameters
version required | string <date> Example: 2022-04-07 API version with format yyyy-mm-dd. Current version is 2022-04-07. Today's date will always give you the latest version. |
Responses
Request samples
- Python + Python3
- Node + Request
- Shell + Curl
- Php + Curl
- Csharp + Restsharp
- Python + Requests
- Javascript + Jquery
- Javascript + Xhr
- Swift + Nsurlsession
- Ruby + Native
- Go + Native
- C + Libcurl
- Powershell + Webrequest
import http.client conn = http.client.HTTPSConnection("api.dojo.tech") headers = { 'version': "SOME_STRING_VALUE", 'Authorization': "REPLACE_KEY_VALUE" } conn.request("DELETE", "/webhooks/%7BsubscriptionId%7D", headers=headers) res = conn.getresponse() data = res.read() print(data.decode("utf-8"))
Response samples
- 401
- 403
- 404
{- "type": "string",
- "title": "string",
- "status": 0,
- "detail": "string",
- "traceId": "string",
- "errors": {
- "property1": null,
- "property2": null
}
}
Create a customer
Creates a new customer.
header Parameters
version required | string <date> Example: 2022-04-07 API version with format yyyy-mm-dd. Current version is 2022-04-07. Today's date will always give you the latest version. |
Request Body schema: application/jsonrequired
name | string or null <= 100 characters The customer's name. |
(Address (object or null)) The address where to send the order. | |
(Address (object or null)) The address where to send the invoice. | |
emailAddress | string or null <= 254 characters The customer's email address. |
phoneNumber | string or null [ 5 .. 50 ] characters The customer's phone number. |
vatNumber | string or null <= 50 characters The VAT number of the customer. |
Responses
Response Schema: application/json
id | string or null Unique identifier of the customer. |
name | string or null The customer's name. |
(Address (object or null)) The address where to send the order. | |
(Address (object or null)) The address where to send the invoice. | |
emailAddress | string or null The customer's email address. |
phoneNumber | string or null The customer's phone number. |
vatNumber | string or null The VAT number of the customer. |
createdAt | string or null <date-time> The timestamp of the create date, in ISO 8601 UTC format. |
updatedAt | string or null <date-time> The timestamp of the update date, in ISO 8601 UTC format. |
documentVersion | integer <int32> The version of the customer's data, updated with every change. |
Request samples
- Payload
- Python + Python3
- Node + Request
- Shell + Curl
- Php + Curl
- Csharp + Restsharp
- Python + Requests
- Javascript + Jquery
- Javascript + Xhr
- Swift + Nsurlsession
- Ruby + Native
- Go + Native
- C + Libcurl
- Powershell + Webrequest
{- "name": "Alex",
- "emailAddress": "alex@dojo.com"
}
Response samples
- 200
- 400
- 401
{- "id": "cs_qNkU6yob0vOMxUlb2oynUw",
- "name": "Alex",
- "emailAddress": "alex@dojo.com",
- "documentVersion": 0,
- "createdAt": "2019-08-24T14:15:22Z"
}
Delete a customer
Deletes a customer.
path Parameters
customerId required | string <= 100 characters Example: cust_qNkU6yob0vOMxUlb2oynUw Unique identifier of the customer. |
header Parameters
version required | string <date> Example: 2022-04-07 API version with format yyyy-mm-dd. Current version is 2022-04-07. Today's date will always give you the latest version. |
Responses
Request samples
- Python + Python3
- Node + Request
- Shell + Curl
- Php + Curl
- Csharp + Restsharp
- Python + Requests
- Javascript + Jquery
- Javascript + Xhr
- Swift + Nsurlsession
- Ruby + Native
- Go + Native
- C + Libcurl
- Powershell + Webrequest
import http.client conn = http.client.HTTPSConnection("api.dojo.tech") headers = { 'version': "SOME_STRING_VALUE", 'Authorization': "REPLACE_KEY_VALUE" } conn.request("DELETE", "/customers/cust_qNkU6yob0vOMxUlb2oynUw", headers=headers) res = conn.getresponse() data = res.read() print(data.decode("utf-8"))
Response samples
- 400
- 401
- 404
{- "type": "string",
- "title": "string",
- "status": 0,
- "detail": "string",
- "traceId": "string",
- "errors": {
- "property1": null,
- "property2": null
}
}
Update information about a customer
Updates information about a customer.
path Parameters
customerId required | string Example: cs_qNkU6yob0vOMxUlb2oynUw Unique identifier of the customer. |
header Parameters
version required | string <date> Example: 2022-04-07 API version with format yyyy-mm-dd. Current version is 2022-04-07. Today's date will always give you the latest version. |
Request Body schema: application/jsonrequired
name | string or null <= 100 characters The customer's name. |
(Address (object or null)) The address where to send the invoice. | |
(Address (object or null)) The address where to send the order. | |
emailAddress | string or null <= 254 characters The customer's email address. |
phoneNumber | string or null [ 5 .. 50 ] characters The customer's phone number. |
vatNumber | string or null <= 50 characters The VAT number of the customer. |
Responses
Response Schema: application/json
id | string or null Unique identifier of the customer. |
name | string or null The customer's name. |
(Address (object or null)) The address where to send the order. | |
(Address (object or null)) The address where to send the invoice. | |
emailAddress | string or null The customer's email address. |
phoneNumber | string or null The customer's phone number. |
vatNumber | string or null The VAT number of the customer. |
createdAt | string or null <date-time> The timestamp of the create date, in ISO 8601 UTC format. |
updatedAt | string or null <date-time> The timestamp of the update date, in ISO 8601 UTC format. |
documentVersion | integer <int32> The version of the customer's data, updated with every change. |
Request samples
- Payload
- Python + Python3
- Node + Request
- Shell + Curl
- Php + Curl
- Csharp + Restsharp
- Python + Requests
- Javascript + Jquery
- Javascript + Xhr
- Swift + Nsurlsession
- Ruby + Native
- Go + Native
- C + Libcurl
- Powershell + Webrequest
{- "phoneNumber": "078976534161"
}
Response samples
- 200
- 400
- 401
- 404
{- "id": "cs_qNkU6yob0vOMxUlb2oynUw",
- "name": "Alex",
- "emailAddress": "alex@dojo.com",
- "phoneNumber": "078976534161",
- "documentVersion": 1,
- "createdAt": "2019-08-24T14:15:22Z",
- "updatedAt": "2021-07-24T14:15:22Z"
}
Retrieve a customer
Retrieves the details of a customer.
path Parameters
customerId required | string or null Unique identifiers for the customers you want to get information about, separated by commas. |
header Parameters
version required | string <date> Example: 2022-04-07 API version with format yyyy-mm-dd. Current version is 2022-04-07. Today's date will always give you the latest version. |
Responses
Response Schema: application/json
id | string or null Unique identifier of the customer. |
name | string or null The customer's name. |
(Address (object or null)) The address where to send the order. | |
(Address (object or null)) The address where to send the invoice. | |
emailAddress | string or null The customer's email address. |
phoneNumber | string or null The customer's phone number. |
vatNumber | string or null The VAT number of the customer. |
createdAt | string or null <date-time> The timestamp of the create date, in ISO 8601 UTC format. |
updatedAt | string or null <date-time> The timestamp of the update date, in ISO 8601 UTC format. |
documentVersion | integer <int32> The version of the customer's data, updated with every change. |
Request samples
- Python + Python3
- Node + Request
- Shell + Curl
- Php + Curl
- Csharp + Restsharp
- Python + Requests
- Javascript + Jquery
- Javascript + Xhr
- Swift + Nsurlsession
- Ruby + Native
- Go + Native
- C + Libcurl
- Powershell + Webrequest
import http.client conn = http.client.HTTPSConnection("api.dojo.tech") headers = { 'version': "SOME_STRING_VALUE", 'Authorization': "REPLACE_KEY_VALUE" } conn.request("GET", "/customers/%7BcustomerId%7D", headers=headers) res = conn.getresponse() data = res.read() print(data.decode("utf-8"))
Response samples
- 200
- 400
- 401
[- {
- "id": "cs_qNkU6yob0vOMxUlb2oynUw",
- "name": "Alex",
- "emailAddress": "alex@dojo.com",
- "documentVersion": 0,
- "createdAt": "2019-08-24T14:15:22Z"
}
]
Create a customer secret
Creates a unique customer secret key valid within a scope of time.
path Parameters
customerId required | string or null <= 100 characters Example: cust_qNkU6yob0vOMxUlb2oynUw Unique identifier of the customer. |
header Parameters
version required | string <date> Example: 2022-04-07 API version with format yyyy-mm-dd. Current version is 2022-04-07. Today's date will always give you the latest version. |
Request samples
- Python + Python3
- Node + Request
- Shell + Curl
- Php + Curl
- Csharp + Restsharp
- Python + Requests
- Javascript + Jquery
- Javascript + Xhr
- Swift + Nsurlsession
- Ruby + Native
- Go + Native
- C + Libcurl
- Powershell + Webrequest
import http.client conn = http.client.HTTPSConnection("api.dojo.tech") headers = { 'version': "SOME_STRING_VALUE", 'Authorization': "REPLACE_KEY_VALUE" } conn.request("POST", "/customers/cust_qNkU6yob0vOMxUlb2oynUw/create-secret", headers=headers) res = conn.getresponse() data = res.read() print(data.decode("utf-8"))
Response samples
- 200
- 400
- 401
- 404
{- "secret": "cs_qNkU6yob0vOMxUlb2oynUw",
- "createdAt": "2022-10-31T10:15:00Z",
- "expireAt": "2022-10-31T10:30:22Z"
}
Retrieve payment method
Retrieves available payment methods for a customer.
path Parameters
customerId required | string or null <= 100 characters Example: cust_qNkU6yob0vOMxUlb2oynUw Unique identifier of the customer. |
header Parameters
version required | string <date> Example: 2022-04-07 API version with format yyyy-mm-dd. Current version is 2022-04-07. Today's date will always give you the latest version. |
authorization required | string or null <= 500 characters Example: Authorization: Basic cs_generated-customer-secret Basic HTTP authentication to grant access to customer-owned resources.
|
Responses
Response Schema: application/json
customerId | string or null Unique identifier of the customer. |
merchantId | string or null Unique identifier of the merchant. |
Array of objects or null List of the customer saved payment methods. | |
(SupportedPaymentMethods (object or null)) Supported payment methods. |
Request samples
- Python + Python3
- Node + Request
- Shell + Curl
- Php + Curl
- Csharp + Restsharp
- Python + Requests
- Javascript + Jquery
- Javascript + Xhr
- Swift + Nsurlsession
- Ruby + Native
- Go + Native
- C + Libcurl
- Powershell + Webrequest
import http.client conn = http.client.HTTPSConnection("api.dojo.tech") headers = { 'version': "SOME_STRING_VALUE", 'authorization': "SOME_STRING_VALUE", 'Authorization': "REPLACE_KEY_VALUE" } conn.request("GET", "/customers/public/cust_qNkU6yob0vOMxUlb2oynUw/payment-methods", headers=headers) res = conn.getresponse() data = res.read() print(data.decode("utf-8"))
Response samples
- 200
- 400
- 401
- 404
{- "customerId": "cust_qNkU6yob0vOMxUlb2oy123",
- "merchantId": "123456789",
- "savedPaymentMethods": [
- {
- "id": "pm_12345",
- "cardDetails": {
- "pan": "52000000****0056",
- "expiryDate": "2024-12-31",
- "scheme": "MASTERCARD"
}
}
], - "supportedPaymentMethods": {
- "cardSchemes": [
- "VISA",
- "MASTERCARD",
- "MAESTRO",
- "DISCOVER",
- "DCI",
- "AMEX"
], - "wallets": [
- "APPLE_PAY",
- "GOOGLE_PAY"
]
}
}
Remove payment method
Delete a customer payment method.
path Parameters
customerId required | string or null <= 100 characters Example: cust_qNkU6yob0vOMxUlb2oynUw Unique identifier of the customer. |
paymentMethodId required | string or null <= 100 characters Example: pm_otRL98WURbaAKs0sdy7_5w Unique identifier of the customer payment method. |
header Parameters
version required | string <date> Example: 2022-04-07 API version with format yyyy-mm-dd. Current version is 2022-04-07. Today's date will always give you the latest version. |
authorization required | string or null <= 500 characters Example: Authorization: Basic cs_generated-customer-secret Basic HTTP authentication to grant access to customer-owned resources.
|
Responses
Request samples
- Python + Python3
- Node + Request
- Shell + Curl
- Php + Curl
- Csharp + Restsharp
- Python + Requests
- Javascript + Jquery
- Javascript + Xhr
- Swift + Nsurlsession
- Ruby + Native
- Go + Native
- C + Libcurl
- Powershell + Webrequest
import http.client conn = http.client.HTTPSConnection("api.dojo.tech") headers = { 'version': "SOME_STRING_VALUE", 'authorization': "SOME_STRING_VALUE", 'Authorization': "REPLACE_KEY_VALUE" } conn.request("DELETE", "/customers/public/cust_qNkU6yob0vOMxUlb2oynUw/payment-methods/pm_otRL98WURbaAKs0sdy7_5w", headers=headers) res = conn.getresponse() data = res.read() print(data.decode("utf-8"))
Response samples
- 400
- 401
- 404
{- "type": "string",
- "title": "string",
- "status": 0,
- "detail": "string",
- "traceId": "string",
- "errors": {
- "property1": null,
- "property2": null
}
}
List all customers
Retrieves a list of customers. Results are paginated, by default the method returns up to 50 customers.
header Parameters
version required | string <date> Example: 2022-04-07 API version with format yyyy-mm-dd. Current version is 2022-04-07. Today's date will always give you the latest version. |
Request Body schema: application/jsonrequired
limit | integer <int32> [ 1 .. 100 ] Default: 50 The maximum number of results to be returned in a single page. |
before | string or null <= 200 characters A cursor for use in pagination for the previous page. |
after | string or null <= 200 characters A cursor for use in pagination for the next page. |
Responses
Response Schema: application/json
Array of objects or null An array of customers. | |
before | string or null A cursor for use in pagination for the previous page. |
after | string or null A cursor for use in pagination for the next page. |
Request samples
- Payload
- Python + Python3
- Node + Request
- Shell + Curl
- Php + Curl
- Csharp + Restsharp
- Python + Requests
- Javascript + Jquery
- Javascript + Xhr
- Swift + Nsurlsession
- Ruby + Native
- Go + Native
- C + Libcurl
- Powershell + Webrequest
{ }
Response samples
- 200
- 400
- 401
{- "data": [
- {
- "id": "cs_qNkU6yob0vOMxUlb2oynUw",
- "name": "Alex",
- "emailAddress": "alex@dojo.com",
- "documentVersion": 0,
- "createdAt": "2019-08-24T14:15:22Z"
}
], - "before": "IjIwMjItMDYtMjJUMTQ6MTc6MjYuMDkyWiI=",
- "after": "IjIwMjItMDYtMjBUMTM6MzI6MjIuNDM1WiI="
}
Create a setup intent
Creates a setup intent.
header Parameters
version required | string <date> Example: 2022-04-07 API version with format yyyy-mm-dd. Current version is 2022-04-07. Today's date will always give you the latest version. |
Request Body schema: application/jsonrequired
reference required | string [ 1 .. 60 ] characters Details of the reference for the payment. |
description | string or null <= 4096 characters The payment description. |
expireAt | string or null <date-time> The timestamp and date of when a setup intent will be voided, in ISO 8601 UTC format. This occurs when a setup intent is created and not yet authorized. |
(Customer (object or null)) Details about the customer. | |
CaptureMode (string) The type of capture for the payment:
| |
paymentMethods | Array of strings or null Enum: "Card" "Wallet" The payment methods that customers can use to pay. |
(Address (object or null)) The address where to send the invoice. | |
(ShippingDetails (object or null)) The address where to send the order. | |
(PaymentIntentConfigRequest (object or null)) Details about the payment intent configuration. | |
object or null A set of key-value pairs that you can use for storing additional information. | |
required | object or null The amount intended to be collected by this setup intent. |
merchantInitiatedTransactionType required | string Enum: "NoShow" "Unscheduled" Details about the merchant initiated transaction type. |
terms required | string [ 1 .. 10240 ] characters The terms that customers are required to review before adding a card to setup intent. |
Responses
Response Schema: application/json
id | string or null Unique identifier for the setup intent. |
clientSessionSecret | string or null The client secret. |
clientSessionSecretExpirationDate | string <date-time> The expiration date of |
status | string Enum: "Created" "Authorized" "Canceled" "Completed" "Expired" "CardExpired" "Closed" Current status of the setup intent. |
paymentMethods | Array of strings or null Enum: "Card" "Wallet" The payment methods that customers can use to pay. |
(Customer (object or null)) Details about the customer. | |
(Address (object or null)) The address where to send the invoice. | |
(ShippingDetails (object or null)) The address where to send the order. | |
createdAt | string <date-time> The timestamp of the create date, in ISO 8601 UTC format. |
updatedAt | string <date-time> The timestamp of the update date, in ISO 8601 UTC format. |
expireAt | string or null <date-time> The timestamp and date of when a setup intent will be voided, in ISO 8601 UTC format. This occurs when a setup intent is created and not yet authorized. |
reference | string or null Details of the reference for the payment. |
description | string or null The payment description. |
(MerchantConfig (object or null)) Details of payment intent merchant configuration. | |
(PaymentIntentConfigResponse (object or null)) Details about the payment intent configuration. | |
object or null A set of key-value pairs that you can use for storing additional information. | |
object or null The amount intended to be collected by this setup intent. | |
merchantInitiatedTransactionType | string Enum: "NoShow" "Unscheduled" Details about the merchant initiated transaction type. |
terms | string or null The terms that customers are required to review before adding a card to setup intent. |
Array of objects or null Information of the setup intent. |
Request samples
- Payload
- Python + Python3
- Node + Request
- Shell + Curl
- Php + Curl
- Csharp + Restsharp
- Python + Requests
- Javascript + Jquery
- Javascript + Xhr
- Swift + Nsurlsession
- Ruby + Native
- Go + Native
- C + Libcurl
- Powershell + Webrequest
{- "reference": "string",
- "intendedAmount": {
- "value": 1000,
- "currencyCode": "GBP"
}, - "merchantInitiatedTransactionType": "NoShow",
- "terms": "string"
}
Response samples
- 200
- 400
- 401
{- "id": "string",
- "clientSessionSecret": "string",
- "clientSessionSecretExpirationDate": "2019-08-24T14:15:22Z",
- "status": "Created",
- "paymentMethods": [
- "Card"
], - "customer": {
- "emailAddress": "support@dojo.com",
- "phoneNumber": "+448000443550"
}, - "billingAddress": {
- "address1": "The Brunel Building",
- "address2": "2 Canalside Walk",
- "city": "London",
- "postcode": "W2 1DG",
- "countryCode": "GB",
- "county": "UK"
}, - "shippingDetails": {
- "name": "string",
- "deliveryNotes": "string",
- "address": {
- "address1": "The Brunel Building",
- "address2": "2 Canalside Walk",
- "city": "London",
- "postcode": "W2 1DG",
- "countryCode": "GB",
- "county": "UK"
}
}, - "createdAt": "2019-08-24T14:15:22Z",
- "updatedAt": "2019-08-24T14:15:22Z",
- "expireAt": "2019-08-24T14:15:22Z",
- "reference": "string",
- "description": "string",
- "merchantConfig": {
- "supportedPaymentMethods": {
- "cardSchemes": [
- "VISA"
], - "wallets": [
- "APPLE_PAY"
]
}
}, - "config": {
- "title": "string",
- "customerEmail": {
- "collectionRequired": false
}, - "details": {
- "showTotal": true,
- "showReference": true
}, - "billingAddress": {
- "collectionRequired": true
}, - "shippingDetails": {
- "collectionRequired": true
}, - "payment": {
- "customAmountAllowed": true,
- "tipsAllowed": true
}
}, - "metadata": {
- "property1": "string",
- "property2": "string"
}, - "intendedAmount": {
- "value": 1000,
- "currencyCode": "GBP"
}, - "merchantInitiatedTransactionType": "NoShow",
- "terms": "string",
- "setupEvents": [
- {
- "transactionId": "string",
- "transactionDateTime": "string",
- "eventType": "Created",
- "authCode": "string",
- "cardNumber": "string",
- "expiryDate": "string",
- "cardType": "string",
- "cardholderName": "string"
}
]
}
Retrieve a setup intent
Get a setup intent by ID.
path Parameters
setupIntentId required | string or null Unique identifier for the setup intent. |
header Parameters
version required | string <date> Example: 2022-04-07 API version with format yyyy-mm-dd. Current version is 2022-04-07. Today's date will always give you the latest version. |
Responses
Response Schema: application/json
id | string or null Unique identifier for the setup intent. |
clientSessionSecret | string or null The client secret. |
clientSessionSecretExpirationDate | string <date-time> The expiration date of |
status | string Enum: "Created" "Authorized" "Canceled" "Completed" "Expired" "CardExpired" "Closed" Current status of the setup intent. |
paymentMethods | Array of strings or null Enum: "Card" "Wallet" The payment methods that customers can use to pay. |
(Customer (object or null)) Details about the customer. | |
(Address (object or null)) The address where to send the invoice. | |
(ShippingDetails (object or null)) The address where to send the order. | |
createdAt | string <date-time> The timestamp of the create date, in ISO 8601 UTC format. |
updatedAt | string <date-time> The timestamp of the update date, in ISO 8601 UTC format. |
expireAt | string or null <date-time> The timestamp and date of when a setup intent will be voided, in ISO 8601 UTC format. This occurs when a setup intent is created and not yet authorized. |
reference | string or null Details of the reference for the payment. |
description | string or null The payment description. |
(MerchantConfig (object or null)) Details of payment intent merchant configuration. | |
(PaymentIntentConfigResponse (object or null)) Details about the payment intent configuration. | |
object or null A set of key-value pairs that you can use for storing additional information. | |
object or null The amount intended to be collected by this setup intent. | |
merchantInitiatedTransactionType | string Enum: "NoShow" "Unscheduled" Details about the merchant initiated transaction type. |
terms | string or null The terms that customers are required to review before adding a card to setup intent. |
Array of objects or null Information of the setup intent. |
Request samples
- Python + Python3
- Node + Request
- Shell + Curl
- Php + Curl
- Csharp + Restsharp
- Python + Requests
- Javascript + Jquery
- Javascript + Xhr
- Swift + Nsurlsession
- Ruby + Native
- Go + Native
- C + Libcurl
- Powershell + Webrequest
import http.client conn = http.client.HTTPSConnection("api.dojo.tech") headers = { 'version': "SOME_STRING_VALUE", 'Authorization': "REPLACE_KEY_VALUE" } conn.request("GET", "/setup-intents/%7BsetupIntentId%7D", headers=headers) res = conn.getresponse() data = res.read() print(data.decode("utf-8"))
Response samples
- 200
- 400
- 401
- 404
{- "id": "string",
- "clientSessionSecret": "string",
- "clientSessionSecretExpirationDate": "2019-08-24T14:15:22Z",
- "status": "Created",
- "paymentMethods": [
- "Card"
], - "customer": {
- "emailAddress": "support@dojo.com",
- "phoneNumber": "+448000443550"
}, - "billingAddress": {
- "address1": "The Brunel Building",
- "address2": "2 Canalside Walk",
- "city": "London",
- "postcode": "W2 1DG",
- "countryCode": "GB",
- "county": "UK"
}, - "shippingDetails": {
- "name": "string",
- "deliveryNotes": "string",
- "address": {
- "address1": "The Brunel Building",
- "address2": "2 Canalside Walk",
- "city": "London",
- "postcode": "W2 1DG",
- "countryCode": "GB",
- "county": "UK"
}
}, - "createdAt": "2019-08-24T14:15:22Z",
- "updatedAt": "2019-08-24T14:15:22Z",
- "expireAt": "2019-08-24T14:15:22Z",
- "reference": "string",
- "description": "string",
- "merchantConfig": {
- "supportedPaymentMethods": {
- "cardSchemes": [
- "VISA"
], - "wallets": [
- "APPLE_PAY"
]
}
}, - "config": {
- "title": "string",
- "customerEmail": {
- "collectionRequired": false
}, - "details": {
- "showTotal": true,
- "showReference": true
}, - "billingAddress": {
- "collectionRequired": true
}, - "shippingDetails": {
- "collectionRequired": true
}, - "payment": {
- "customAmountAllowed": true,
- "tipsAllowed": true
}
}, - "metadata": {
- "property1": "string",
- "property2": "string"
}, - "intendedAmount": {
- "value": 1000,
- "currencyCode": "GBP"
}, - "merchantInitiatedTransactionType": "NoShow",
- "terms": "string",
- "setupEvents": [
- {
- "transactionId": "string",
- "transactionDateTime": "string",
- "eventType": "Created",
- "authCode": "string",
- "cardNumber": "string",
- "expiryDate": "string",
- "cardType": "string",
- "cardholderName": "string"
}
]
}
Cancel a setup intent
Cancels a setup intent.
path Parameters
setupIntentId required | string or null <= 50 characters Unique identifier for the setup intent. |
query Parameters
includeAuthorized | boolean Default: |
header Parameters
version required | string <date> Example: 2022-04-07 API version with format yyyy-mm-dd. Current version is 2022-04-07. Today's date will always give you the latest version. |
Responses
Response Schema: application/json
id | string or null Unique identifier for the setup intent. |
clientSessionSecret | string or null The client secret. |
clientSessionSecretExpirationDate | string <date-time> The expiration date of |
status | string Enum: "Created" "Authorized" "Canceled" "Completed" "Expired" "CardExpired" "Closed" Current status of the setup intent. |
paymentMethods | Array of strings or null Enum: "Card" "Wallet" The payment methods that customers can use to pay. |
(Customer (object or null)) Details about the customer. | |
(Address (object or null)) The address where to send the invoice. | |
(ShippingDetails (object or null)) The address where to send the order. | |
createdAt | string <date-time> The timestamp of the create date, in ISO 8601 UTC format. |
updatedAt | string <date-time> The timestamp of the update date, in ISO 8601 UTC format. |
expireAt | string or null <date-time> The timestamp and date of when a setup intent will be voided, in ISO 8601 UTC format. This occurs when a setup intent is created and not yet authorized. |
reference | string or null Details of the reference for the payment. |
description | string or null The payment description. |
(MerchantConfig (object or null)) Details of payment intent merchant configuration. | |
(PaymentIntentConfigResponse (object or null)) Details about the payment intent configuration. | |
object or null A set of key-value pairs that you can use for storing additional information. | |
object or null The amount intended to be collected by this setup intent. | |
merchantInitiatedTransactionType | string Enum: "NoShow" "Unscheduled" Details about the merchant initiated transaction type. |
terms | string or null The terms that customers are required to review before adding a card to setup intent. |
Array of objects or null Information of the setup intent. |
Request samples
- Python + Python3
- Node + Request
- Shell + Curl
- Php + Curl
- Csharp + Restsharp
- Python + Requests
- Javascript + Jquery
- Javascript + Xhr
- Swift + Nsurlsession
- Ruby + Native
- Go + Native
- C + Libcurl
- Powershell + Webrequest
import http.client conn = http.client.HTTPSConnection("api.dojo.tech") headers = { 'version': "SOME_STRING_VALUE", 'Authorization': "REPLACE_KEY_VALUE" } conn.request("DELETE", "/setup-intents/%7BsetupIntentId%7D?includeAuthorized=SOME_BOOLEAN_VALUE", headers=headers) res = conn.getresponse() data = res.read() print(data.decode("utf-8"))
Response samples
- 200
- 400
- 401
- 404
{- "id": "string",
- "clientSessionSecret": "string",
- "clientSessionSecretExpirationDate": "2019-08-24T14:15:22Z",
- "status": "Created",
- "paymentMethods": [
- "Card"
], - "customer": {
- "emailAddress": "support@dojo.com",
- "phoneNumber": "+448000443550"
}, - "billingAddress": {
- "address1": "The Brunel Building",
- "address2": "2 Canalside Walk",
- "city": "London",
- "postcode": "W2 1DG",
- "countryCode": "GB",
- "county": "UK"
}, - "shippingDetails": {
- "name": "string",
- "deliveryNotes": "string",
- "address": {
- "address1": "The Brunel Building",
- "address2": "2 Canalside Walk",
- "city": "London",
- "postcode": "W2 1DG",
- "countryCode": "GB",
- "county": "UK"
}
}, - "createdAt": "2019-08-24T14:15:22Z",
- "updatedAt": "2019-08-24T14:15:22Z",
- "expireAt": "2019-08-24T14:15:22Z",
- "reference": "string",
- "description": "string",
- "merchantConfig": {
- "supportedPaymentMethods": {
- "cardSchemes": [
- "VISA"
], - "wallets": [
- "APPLE_PAY"
]
}
}, - "config": {
- "title": "string",
- "customerEmail": {
- "collectionRequired": false
}, - "details": {
- "showTotal": true,
- "showReference": true
}, - "billingAddress": {
- "collectionRequired": true
}, - "shippingDetails": {
- "collectionRequired": true
}, - "payment": {
- "customAmountAllowed": true,
- "tipsAllowed": true
}
}, - "metadata": {
- "property1": "string",
- "property2": "string"
}, - "intendedAmount": {
- "value": 1000,
- "currencyCode": "GBP"
}, - "merchantInitiatedTransactionType": "NoShow",
- "terms": "string",
- "setupEvents": [
- {
- "transactionId": "string",
- "transactionDateTime": "string",
- "eventType": "Created",
- "authCode": "string",
- "cardNumber": "string",
- "expiryDate": "string",
- "cardType": "string",
- "cardholderName": "string"
}
]
}
Retrieve a setup intent (no auth)
Get a setup intent by ID
path Parameters
setupIntentId required | string or null The unique ID of the setup intent. |
header Parameters
version required | string <date> Example: 2022-04-07 API version with format yyyy-mm-dd. Current version is 2022-04-07. Today's date will always give you the latest version. |
Responses
Response Schema: application/json
id | string or null Unique identifier for the setup intent. |
clientSessionSecret | string or null The client secret. |
clientSessionSecretExpirationDate | string <dat |