Skip to main content
POST
/
environments
/
{environmentId}
/
checkouts
Create a checkout
curl --request POST \
  --url https://app.dynamicauth.com/api/v0/environments/{environmentId}/checkouts \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "settlementConfig": {
    "settlements": [
      {
        "tokenAddress": "An example name",
        "chainId": "An example name",
        "symbol": "An example name",
        "tokenDecimals": 18,
        "isNative": true
      }
    ]
  },
  "destinationConfig": {
    "destinations": [
      {
        "identifier": "An example name"
      }
    ]
  },
  "depositConfig": {
    "minimum": "<string>",
    "presets": [
      "<string>"
    ]
  },
  "enableOrchestration": true
}
'
{
  "id": "95b11417-f18f-457f-8804-68e361f9164f",
  "settlementConfig": {
    "settlements": [
      {
        "tokenAddress": "An example name",
        "chainId": "An example name",
        "symbol": "An example name",
        "tokenDecimals": 18,
        "isNative": true
      }
    ]
  },
  "enableOrchestration": true,
  "createdAt": "2023-11-07T05:31:56Z",
  "updatedAt": "2023-11-07T05:31:56Z",
  "destinationConfig": {
    "destinations": [
      {
        "identifier": "An example name"
      }
    ]
  },
  "depositConfig": {
    "minimum": "<string>",
    "presets": [
      "<string>"
    ]
  }
}

Documentation Index

Fetch the complete documentation index at: https://docs.dynamic.xyz/docs/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

​
environmentId
string
required

ID of the environment

Required string length: 36
Pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$
Example:

"95b11417-f18f-457f-8804-68e361f9164f"

Body

application/json
​
mode
enum<string>
required
Available options:
payment,
deposit
​
settlementConfig
object
required
​
destinationConfig
object
required
​
depositConfig
object
​
enableOrchestration
boolean
default:true

Response

Checkout created successfully

​
id
string
required
Required string length: 36
Pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$
Example:

"95b11417-f18f-457f-8804-68e361f9164f"

​
mode
enum<string>
required
Available options:
payment,
deposit
​
settlementConfig
object
required
​
enableOrchestration
boolean
default:true
required

Whether Dynamic handles quote optimization, fee collection, and fund settlement automatically

​
createdAt
string<date-time>
required

ISO 8601 timestamp of when the checkout was created

​
updatedAt
string<date-time>
required

ISO 8601 timestamp of when the checkout was last updated

​
destinationConfig
object
​
depositConfig
object