Get a checkout by ID

Deprecated: use new /flow api instead.

GET /environments/{environmentId}/checkouts/{checkoutId}

Get a checkout by ID

cURL

curl --request GET \
  --url https://app.dynamicauth.com/api/v0/environments/{environmentId}/checkouts/{checkoutId} \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://app.dynamicauth.com/api/v0/environments/{environmentId}/checkouts/{checkoutId}"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://app.dynamicauth.com/api/v0/environments/{environmentId}/checkouts/{checkoutId}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://app.dynamicauth.com/api/v0/environments/{environmentId}/checkouts/{checkoutId}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://app.dynamicauth.com/api/v0/environments/{environmentId}/checkouts/{checkoutId}"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("https://app.dynamicauth.com/api/v0/environments/{environmentId}/checkouts/{checkoutId}")
  .header("Authorization", "Bearer <token>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://app.dynamicauth.com/api/v0/environments/{environmentId}/checkouts/{checkoutId}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

200

{
  "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": [
      {
        "type": "address",
        "identifier": "An example name"
      }
    ]
  },
  "depositConfig": {
    "minimum": "<string>",
    "presets": [
      "<string>"
    ]
  }
}

{
  "error": "No jwt provided!"
}

{
  "error": "Access Forbidden"
}

{
  "error": "Not Found",
  "code": "not_found"
}

{
  "error": "Internal Server Error"
}

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"

checkoutId · string · required

UUID of the checkout

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"

Response

200

application/json

Returns the checkout

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

Show child attributes

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

Show child attributes

depositConfig · object

Show child attributes