Create a flow

Create a flow (payment, deposit, or withdraw) for the environment.

POST /server/{environmentId}/flow/{mode}

Create a flow

cURL

curl --request POST \
  --url https://app.dynamicauth.com/api/v0/server/{environmentId}/flow/{mode} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "amount": "<string>",
  "currency": "An example name",
  "settlementConfig": {
    "settlements": [
      {
        "tokenAddress": "An example name",
        "chainId": "An example name",
        "symbol": "An example name",
        "tokenDecimals": 18,
        "isNative": true
      }
    ]
  },
  "destinationConfig": {
    "destinations": [
      {
        "type": "address",
        "identifier": "An example name"
      }
    ]
  },
  "memo": {},
  "expiresIn": 123,
  "pegStablecoins": true,
  "disableSwaps": true,
  "uiConfig": {
    "returnUrl": "<string>"
  }
}
'

201

{
  "flow": {
    "id": "95b11417-f18f-457f-8804-68e361f9164f",
    "mode": "payment",
    "amount": "<string>",
    "currency": "An example name",
    "executionState": "initiated",
    "settlementState": "none",
    "riskState": "unknown",
    "quoteVersion": 123,
    "createdAt": "2023-11-07T05:31:56Z",
    "updatedAt": "2023-11-07T05:31:56Z",
    "memo": {},
    "userId": "95b11417-f18f-457f-8804-68e361f9164f",
    "sourceType": "wallet",
    "fromAddress": "0xbF394748301603f18d953C90F0b087CBEC0E1834",
    "fromChainId": "An example name",
    "fromChainName": "ETH",
    "fromToken": "An example name",
    "toAddress": "0xbF394748301603f18d953C90F0b087CBEC0E1834",
    "toChainId": "An example name",
    "toChainName": "ETH",
    "toToken": "An example name",
    "quote": {
      "version": 123,
      "fromAmount": "<string>",
      "toAmount": "<string>",
      "createdAt": "2023-11-07T05:31:56Z",
      "expiresAt": "2023-11-07T05:31:56Z",
      "fees": {
        "totalFeeUsd": "<string>",
        "gasEstimate": {
          "usdValue": "<string>",
          "nativeValue": "<string>",
          "nativeSymbol": "<string>"
        }
      },
      "estimatedTimeSec": 123,
      "signingPayload": {
        "chainName": "ETH",
        "chainId": "<string>",
        "evmTransaction": {
          "to": "<string>",
          "data": "<string>",
          "value": "<string>",
          "gasLimit": "<string>",
          "gasPrice": "<string>",
          "maxFeePerGas": "<string>",
          "maxPriorityFeePerGas": "<string>",
          "nonce": 123
        },
        "evmApproval": {
          "tokenAddress": "<string>",
          "spenderAddress": "<string>",
          "amount": "<string>"
        },
        "serializedTransaction": "<string>",
        "psbt": "<string>",
        "tronTransaction": {
          "rawDataHex": "<string>",
          "to": "<string>",
          "value": "<string>"
        }
      },
      "fromTokenInfo": {
        "symbol": "<string>",
        "decimals": 123,
        "name": "<string>",
        "logoURI": "<string>"
      },
      "toTokenInfo": {
        "symbol": "<string>",
        "decimals": 123,
        "name": "<string>",
        "logoURI": "<string>"
      }
    },
    "txHash": "<string>",
    "settlementTxHash": "<string>",
    "broadcastedAt": "2023-11-07T05:31:56Z",
    "sourceConfirmedAt": "2023-11-07T05:31:56Z",
    "confirmations": 123,
    "settlement": {
      "toChainId": "An example name",
      "toToken": "An example name",
      "toAddress": "0xbF394748301603f18d953C90F0b087CBEC0E1834",
      "completedAt": "2023-11-07T05:31:56Z"
    },
    "completedAt": "2023-11-07T05:31:56Z",
    "failure": {
      "code": "An example name",
      "message": "<string>",
      "category": "An example name",
      "stage": "An example name",
      "retryable": true,
      "details": {}
    },
    "expiresAt": "2023-11-07T05:31:56Z",
    "depositAddress": "0xbF394748301603f18d953C90F0b087CBEC0E1834",
    "exchangeSource": {
      "exchangeId": "95b11417-f18f-457f-8804-68e361f9164f",
      "metadata": {}
    },
    "pegStablecoins": true,
    "disableSwaps": true,
    "uiConfig": {
      "returnUrl": "<string>"
    },
    "settlementConfig": {
      "strategy": "cheapest",
      "settlements": [
        {
          "chainName": "ETH",
          "tokenAddress": "An example name",
          "chainId": "An example name",
          "symbol": "An example name",
          "tokenDecimals": 18,
          "isNative": true
        }
      ]
    },
    "destinationConfig": {
      "destinations": [
        {
          "chainName": "ETH",
          "type": "address",
          "identifier": "An example name"
        }
      ]
    }
  }
}

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"

mode · enum<string> · required

The flow mode — determines which lifecycle the flow follows. The lifecycle a flow follows — payment, deposit, or withdraw.

Available options: payment, deposit, withdraw

Body

application/json

Create-time payload for a flow. amount, currency, settlementConfig and destinationConfig are written once here (by a trusted API-key caller) and are accepted by no later endpoint. mode is supplied in the URL path.

amount · string · required

Amount in the specified currency

currency · string · required

Maximum string length: 50

Pattern: ^(?=\S)[\p{L}\p{N}a-zA-Z _.,:!?&%@\/+\-'|]+(?<=\S)$

Example:

"An example name"

settlementConfig · object · required

Show child attributes

destinationConfig · object · required

Show child attributes

memo · object

Arbitrary metadata attached to the flow

feeConfig · object

Fee collection configuration specifying recipients and their shares.

Show child attributes

expiresIn · integer

Seconds until the flow expires (default 3600, clamped server-side)

pegStablecoins · boolean

When true, known stablecoins (USDC, USDT, DAI, etc.) in the settlement config are pegged 1:1 to the flow currency at quote time, skipping market-price lookup. Defaults to false.

disableSwaps · boolean

When true, this flow will not be quoted through swap providers; the payer must supply a token/chain already accepted by the settlement config. Defaults to false.

uiConfig · object

Payer-facing UI config for a flow, set once at creation. Not part of the execution/settlement record.

Show child attributes

Response

201

application/json

Flow created

Response returned when a flow is created.

flow · object · required

A single payment, deposit, or withdraw flow. Collapses the former Checkout and CheckoutTransaction into one resource.

Show child attributes