Sandbox

Simulate an overall conversion failure for a sandbox order

Forces the order’s conversion to a failed terminal state. Safe to call at any point after order creation while the order is still pending: if the conversion is already running, it is driven to failed immediately; otherwise the failure is armed and applied as soon as the conversion starts. The order is driven to failed and a failure event is published. The optional reason body field is propagated to the public order.failed.failureMessage so QA / integrators can correlate the simulator call with the resulting webhook. Returns 404 if the order is not found in the org. Replay (caller asks for conversion-failed against an already-terminal order) returns 200 with the order at its current state. Returns the order at its current state.

POST

sandbox

orders

{id}

simulate

conversion-failed

Simulate an overall conversion failure for a sandbox order

curl --request POST \
  --url https://api.sandbox.conduit.financial/v2/sandbox/orders/{id}/simulate/conversion-failed \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "reason": "<string>"
}
'

import requests

url = "https://api.sandbox.conduit.financial/v2/sandbox/orders/{id}/simulate/conversion-failed"

payload = { "reason": "<string>" }
headers = {
    "x-api-key": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({reason: '<string>'})
};

fetch('https://api.sandbox.conduit.financial/v2/sandbox/orders/{id}/simulate/conversion-failed', 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://api.sandbox.conduit.financial/v2/sandbox/orders/{id}/simulate/conversion-failed",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'reason' => '<string>'
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "x-api-key: <api-key>"
  ],
]);

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

curl_close($curl);

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

package main

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

func main() {

	url := "https://api.sandbox.conduit.financial/v2/sandbox/orders/{id}/simulate/conversion-failed"

	payload := strings.NewReader("{\n  \"reason\": \"<string>\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("x-api-key", "<api-key>")
	req.Header.Add("Content-Type", "application/json")

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

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

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.sandbox.conduit.financial/v2/sandbox/orders/{id}/simulate/conversion-failed")
  .header("x-api-key", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"reason\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.sandbox.conduit.financial/v2/sandbox/orders/{id}/simulate/conversion-failed")

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

request = Net::HTTP::Post.new(url)
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"reason\": \"<string>\"\n}"

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

{
  "id": "<string>",
  "customerId": "<string>",
  "destination": {
    "type": "wallet",
    "id": "<string>"
  },
  "sourceAsset": {
    "amount": "<string>"
  },
  "destinationAsset": {
    "amount": "<string>"
  },
  "rate": {
    "referenceRate": "<string>",
    "totalSpreadBps": "<string>",
    "endUserRate": "<string>"
  },
  "fees": [
    {
      "type": "fixed",
      "assetAmount": {
        "amount": "<string>"
      }
    }
  ],
  "totalDebit": {
    "amount": "<string>"
  },
  "lockExpiresAt": "2026-01-15T09:30:00.000Z",
  "createdAt": "2026-01-15T09:30:00.000Z",
  "autoExecute": true,
  "linkedTransactionIds": [
    "<string>"
  ],
  "clientReferenceId": "<string>",
  "source": {
    "type": "wallet",
    "id": "<string>"
  },
  "autoPayout": {
    "recipient": {
      "rail": "us",
      "accountNumber": "<string>",
      "routingNumber": "<string>",
      "bankAddress": {
        "addressLine1": "<string>",
        "city": "<string>",
        "country": "<string>",
        "addressLine2": "<string>",
        "state": "<string>",
        "postalCode": "<string>"
      },
      "type": "individual",
      "firstName": "<string>",
      "lastName": "<string>",
      "postalAddress": {
        "addressLine1": "<string>",
        "city": "<string>",
        "country": "<string>",
        "addressLine2": "<string>",
        "state": "<string>",
        "postalCode": "<string>"
      },
      "bankName": "<string>",
      "phone": "<string>",
      "dateOfBirth": "2023-12-25",
      "countryOfCitizenship": "<string>"
    },
    "ach": {},
    "swift": {
      "purposeOfPayment": "<string>"
    },
    "instant": {},
    "remittance": {
      "reference": "<string>",
      "description": "<string>"
    }
  },
  "executedAt": "2026-01-15T09:30:00.000Z",
  "cancelledAt": "2026-01-15T09:30:00.000Z",
  "failureMessage": "<string>",
  "depositInstructions": [
    {
      "type": "crypto_address",
      "address": "<string>",
      "expiresAt": "2026-01-15T09:30:00.000Z"
    }
  ],
  "fundedBy": [
    {
      "transactionId": "<string>",
      "amount": {
        "amount": "<string>"
      }
    }
  ]
}

{
  "type": "INVALID_OID_FORMAT",
  "title": "Invalid Object ID Format",
  "status": 400,
  "detail": "A path or query parameter expected a valid object identifier but received a value that does not match the expected format.",
  "resolution": "Verify that all IDs in the request URL and query parameters are correctly formatted. IDs are typically prefixed strings like 'cus_...', 'app_...', or 'doc_...'.",
  "docs": "https://conduit-v2.mintlify.app/errors#invalid-oid-format",
  "instance": "/v2/...",
  "correlationId": "req_a1b2c3d4",
  "timestamp": "2026-01-15T09:30:00.000Z"
}

{
  "type": "API_KEY_MISSING",
  "title": "API Key Missing",
  "status": 401,
  "detail": "The request did not include an API key. All API requests must be authenticated.",
  "resolution": "Include your API key in the 'x-api-key' header with every request.",
  "docs": "https://conduit-v2.mintlify.app/errors#api-key-missing",
  "instance": "/v2/...",
  "correlationId": "req_a1b2c3d4",
  "timestamp": "2026-01-15T09:30:00.000Z"
}

{
  "type": "API_KEY_READ_ONLY",
  "title": "API Key Is Read-Only",
  "status": 403,
  "detail": "This API key has read-only access and cannot perform write operations. Read-only keys may make read requests (GET, HEAD, OPTIONS) only.",
  "resolution": "Use a read-write API key for this request, or have an organization admin mint one from the dashboard.",
  "docs": "https://conduit-v2.mintlify.app/errors#api-key-read-only",
  "instance": "/v2/...",
  "correlationId": "req_a1b2c3d4",
  "timestamp": "2026-01-15T09:30:00.000Z"
}

{
  "type": "ORDER_NOT_FOUND",
  "title": "Order Not Found",
  "status": 404,
  "detail": "No order exists with the specified ID, or the order has expired.",
  "resolution": "Verify the order ID is correct. Orders have a limited validity period; create a new order if the previous one has expired.",
  "docs": "https://conduit-v2.mintlify.app/errors#order-not-found",
  "instance": "/v2/...",
  "correlationId": "req_a1b2c3d4",
  "timestamp": "2026-01-15T09:30:00.000Z"
}

{
  "type": "UNSUPPORTED_MEDIA_TYPE",
  "title": "Unsupported Media Type",
  "status": 415,
  "detail": "The request carries a body with a Content-Type this endpoint cannot parse. JSON endpoints accept 'application/json'; a body with no Content-Type header at all is assumed to be JSON. File-upload endpoints accept only 'multipart/form-data' — JSON or undeclared bodies are rejected there.",
  "resolution": "Send the request body with the 'Content-Type: application/json' header. For file uploads, use 'Content-Type: multipart/form-data' — upload endpoints accept no other body type.",
  "docs": "https://conduit-v2.mintlify.app/errors#unsupported-media-type",
  "instance": "/v2/...",
  "correlationId": "req_a1b2c3d4",
  "timestamp": "2026-01-15T09:30:00.000Z"
}

{
  "type": "RATE_LIMITED",
  "title": "Rate Limited",
  "status": 429,
  "detail": "Too many requests. This error is returned by three independent checks: the per-organization bucket applied to every authenticated API request; the per-IP bucket applied to unauthenticated traffic before an API key is validated; and the per-IP bucket applied when repeated invalid API keys are submitted from the same address. Honor the Retry-After header (also exposed as retryAfterSeconds in the body) before retrying. Current limits and remaining budget are visible in X-RateLimit-Limit, X-RateLimit-Remaining, and X-RateLimit-Reset on rate-limited route responses.",
  "resolution": "Sleep until Retry-After seconds have elapsed, then retry. For sustained workloads exceeding the per-organization defaults, request a rate-limit increase through your support contact.",
  "docs": "https://conduit-v2.mintlify.app/errors#rate-limited",
  "instance": "/v2/...",
  "correlationId": "req_a1b2c3d4",
  "timestamp": "2026-01-15T09:30:00.000Z",
  "retryAfterSeconds": 3
}

{
  "type": "INTERNAL_ERROR",
  "title": "Internal Error",
  "status": 500,
  "detail": "An unexpected error occurred while processing your request.",
  "resolution": "Retry the request after a brief delay. If the error persists, contact support and include the correlationId from the error response for investigation.",
  "docs": "https://conduit-v2.mintlify.app/errors#internal-error",
  "instance": "/v2/...",
  "correlationId": "req_a1b2c3d4",
  "timestamp": "2026-01-15T09:30:00.000Z"
}

Authorizations

x-api-key

string

header

required

Path Parameters

string

required

Body

application/json

reason

string

Optional free-text reason surfaced as failureMessage on the order.failed webhook and the polled GET /v2/orders/:id response.

Maximum string length: 500

Response

string

required

Pattern: ^ord_[0-9A-Za-z]{22}$

customerId

string | null

required

Pattern: ^cus_[0-9A-Za-z]{22}$

status

enum<string>

required

Available options:

pending,

succeeded,

failed,

cancelled

type

enum<string>

required

Available options:

onramp,

offramp,

conversion

destination

object

required

Option 1
Option 2

Show child attributes

sourceAsset

object

required

Show child attributes

destinationAsset

object

required

Show child attributes

lockSide

enum<string>

required

Available options:

source,

destination

rate

object

required

Show child attributes

fees

object[]

required

Show child attributes

totalDebit

object

required

Show child attributes

lockExpiresAt

string<date-time>

required

ISO 8601 timestamp

Example:

"2026-01-15T09:30:00.000Z"

createdAt

string<date-time>

required

ISO 8601 timestamp

Example:

"2026-01-15T09:30:00.000Z"

autoExecute

boolean

required

linkedTransactionIds

string[]

required

Pattern: ^txn_[0-9A-Za-z]{22}$

clientReferenceId

string

Client-supplied reference, unique per resource within your organization. 1-255 characters from A-Za-z, 0-9, underscore, hyphen, colon, and period — no spaces.

Pattern: ^[A-Za-z0-9_\-:.]{1,255}$

source

object

The funding resource, when the order named one. Omitted entirely on a deposit-funded order (created without a source): the funding wallet is Conduit-managed infrastructure with no client-resolvable id, and depositInstructions carries the address to fund at instead. The presence of depositInstructions is the discriminator.

Option 1
Option 2

Show child attributes

autoPayout

object

AutoPayout payload. Crypto recipients omit rail/ach/swift/instant/remittance; fiat (us|swift) recipients require rail and may carry the matching per-rail context block.

Show child attributes

executedAt

string<date-time>

ISO 8601 timestamp

Example:

"2026-01-15T09:30:00.000Z"

executionTrigger

enum<string>

Available options:

client,

auto

cancelledAt

string<date-time>

ISO 8601 timestamp

Example:

"2026-01-15T09:30:00.000Z"

cancellationReason

enum<string>

Available options:

expired,

client_cancelled

failureCode

enum<string>

Available options:

insufficient_funds,

provider_unavailable,

provider_rejected,

internal_error,

cancelled

failureMessage

string

depositInstructions

object[]

Where to send funds to fund this order. Exactly one crypto_address block.

Required array length: 1 element

Show child attributes

fundedBy

object[]

Transfers that funded this order, with how much of each it draws. Present on the order detail read for an order funded at a Conduit funding address; omitted on the list read and on an order that names its own source.

Show child attributes

⌘I

Simulate an overall conversion failure for a sandbox order

curl --request POST \
  --url https://api.sandbox.conduit.financial/v2/sandbox/orders/{id}/simulate/conversion-failed \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "reason": "<string>"
}
'

import requests

url = "https://api.sandbox.conduit.financial/v2/sandbox/orders/{id}/simulate/conversion-failed"

payload = { "reason": "<string>" }
headers = {
    "x-api-key": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({reason: '<string>'})
};

fetch('https://api.sandbox.conduit.financial/v2/sandbox/orders/{id}/simulate/conversion-failed', 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://api.sandbox.conduit.financial/v2/sandbox/orders/{id}/simulate/conversion-failed",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'reason' => '<string>'
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "x-api-key: <api-key>"
  ],
]);

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

curl_close($curl);

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

package main

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

func main() {

	url := "https://api.sandbox.conduit.financial/v2/sandbox/orders/{id}/simulate/conversion-failed"

	payload := strings.NewReader("{\n  \"reason\": \"<string>\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("x-api-key", "<api-key>")
	req.Header.Add("Content-Type", "application/json")

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

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

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.sandbox.conduit.financial/v2/sandbox/orders/{id}/simulate/conversion-failed")
  .header("x-api-key", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"reason\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.sandbox.conduit.financial/v2/sandbox/orders/{id}/simulate/conversion-failed")

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

request = Net::HTTP::Post.new(url)
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"reason\": \"<string>\"\n}"

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

{
  "id": "<string>",
  "customerId": "<string>",
  "destination": {
    "type": "wallet",
    "id": "<string>"
  },
  "sourceAsset": {
    "amount": "<string>"
  },
  "destinationAsset": {
    "amount": "<string>"
  },
  "rate": {
    "referenceRate": "<string>",
    "totalSpreadBps": "<string>",
    "endUserRate": "<string>"
  },
  "fees": [
    {
      "type": "fixed",
      "assetAmount": {
        "amount": "<string>"
      }
    }
  ],
  "totalDebit": {
    "amount": "<string>"
  },
  "lockExpiresAt": "2026-01-15T09:30:00.000Z",
  "createdAt": "2026-01-15T09:30:00.000Z",
  "autoExecute": true,
  "linkedTransactionIds": [
    "<string>"
  ],
  "clientReferenceId": "<string>",
  "source": {
    "type": "wallet",
    "id": "<string>"
  },
  "autoPayout": {
    "recipient": {
      "rail": "us",
      "accountNumber": "<string>",
      "routingNumber": "<string>",
      "bankAddress": {
        "addressLine1": "<string>",
        "city": "<string>",
        "country": "<string>",
        "addressLine2": "<string>",
        "state": "<string>",
        "postalCode": "<string>"
      },
      "type": "individual",
      "firstName": "<string>",
      "lastName": "<string>",
      "postalAddress": {
        "addressLine1": "<string>",
        "city": "<string>",
        "country": "<string>",
        "addressLine2": "<string>",
        "state": "<string>",
        "postalCode": "<string>"
      },
      "bankName": "<string>",
      "phone": "<string>",
      "dateOfBirth": "2023-12-25",
      "countryOfCitizenship": "<string>"
    },
    "ach": {},
    "swift": {
      "purposeOfPayment": "<string>"
    },
    "instant": {},
    "remittance": {
      "reference": "<string>",
      "description": "<string>"
    }
  },
  "executedAt": "2026-01-15T09:30:00.000Z",
  "cancelledAt": "2026-01-15T09:30:00.000Z",
  "failureMessage": "<string>",
  "depositInstructions": [
    {
      "type": "crypto_address",
      "address": "<string>",
      "expiresAt": "2026-01-15T09:30:00.000Z"
    }
  ],
  "fundedBy": [
    {
      "transactionId": "<string>",
      "amount": {
        "amount": "<string>"
      }
    }
  ]
}

{
  "type": "INVALID_OID_FORMAT",
  "title": "Invalid Object ID Format",
  "status": 400,
  "detail": "A path or query parameter expected a valid object identifier but received a value that does not match the expected format.",
  "resolution": "Verify that all IDs in the request URL and query parameters are correctly formatted. IDs are typically prefixed strings like 'cus_...', 'app_...', or 'doc_...'.",
  "docs": "https://conduit-v2.mintlify.app/errors#invalid-oid-format",
  "instance": "/v2/...",
  "correlationId": "req_a1b2c3d4",
  "timestamp": "2026-01-15T09:30:00.000Z"
}

{
  "type": "API_KEY_MISSING",
  "title": "API Key Missing",
  "status": 401,
  "detail": "The request did not include an API key. All API requests must be authenticated.",
  "resolution": "Include your API key in the 'x-api-key' header with every request.",
  "docs": "https://conduit-v2.mintlify.app/errors#api-key-missing",
  "instance": "/v2/...",
  "correlationId": "req_a1b2c3d4",
  "timestamp": "2026-01-15T09:30:00.000Z"
}

{
  "type": "API_KEY_READ_ONLY",
  "title": "API Key Is Read-Only",
  "status": 403,
  "detail": "This API key has read-only access and cannot perform write operations. Read-only keys may make read requests (GET, HEAD, OPTIONS) only.",
  "resolution": "Use a read-write API key for this request, or have an organization admin mint one from the dashboard.",
  "docs": "https://conduit-v2.mintlify.app/errors#api-key-read-only",
  "instance": "/v2/...",
  "correlationId": "req_a1b2c3d4",
  "timestamp": "2026-01-15T09:30:00.000Z"
}

{
  "type": "ORDER_NOT_FOUND",
  "title": "Order Not Found",
  "status": 404,
  "detail": "No order exists with the specified ID, or the order has expired.",
  "resolution": "Verify the order ID is correct. Orders have a limited validity period; create a new order if the previous one has expired.",
  "docs": "https://conduit-v2.mintlify.app/errors#order-not-found",
  "instance": "/v2/...",
  "correlationId": "req_a1b2c3d4",
  "timestamp": "2026-01-15T09:30:00.000Z"
}

{
  "type": "UNSUPPORTED_MEDIA_TYPE",
  "title": "Unsupported Media Type",
  "status": 415,
  "detail": "The request carries a body with a Content-Type this endpoint cannot parse. JSON endpoints accept 'application/json'; a body with no Content-Type header at all is assumed to be JSON. File-upload endpoints accept only 'multipart/form-data' — JSON or undeclared bodies are rejected there.",
  "resolution": "Send the request body with the 'Content-Type: application/json' header. For file uploads, use 'Content-Type: multipart/form-data' — upload endpoints accept no other body type.",
  "docs": "https://conduit-v2.mintlify.app/errors#unsupported-media-type",
  "instance": "/v2/...",
  "correlationId": "req_a1b2c3d4",
  "timestamp": "2026-01-15T09:30:00.000Z"
}

{
  "type": "RATE_LIMITED",
  "title": "Rate Limited",
  "status": 429,
  "detail": "Too many requests. This error is returned by three independent checks: the per-organization bucket applied to every authenticated API request; the per-IP bucket applied to unauthenticated traffic before an API key is validated; and the per-IP bucket applied when repeated invalid API keys are submitted from the same address. Honor the Retry-After header (also exposed as retryAfterSeconds in the body) before retrying. Current limits and remaining budget are visible in X-RateLimit-Limit, X-RateLimit-Remaining, and X-RateLimit-Reset on rate-limited route responses.",
  "resolution": "Sleep until Retry-After seconds have elapsed, then retry. For sustained workloads exceeding the per-organization defaults, request a rate-limit increase through your support contact.",
  "docs": "https://conduit-v2.mintlify.app/errors#rate-limited",
  "instance": "/v2/...",
  "correlationId": "req_a1b2c3d4",
  "timestamp": "2026-01-15T09:30:00.000Z",
  "retryAfterSeconds": 3
}

{
  "type": "INTERNAL_ERROR",
  "title": "Internal Error",
  "status": 500,
  "detail": "An unexpected error occurred while processing your request.",
  "resolution": "Retry the request after a brief delay. If the error persists, contact support and include the correlationId from the error response for investigation.",
  "docs": "https://conduit-v2.mintlify.app/errors#internal-error",
  "instance": "/v2/...",
  "correlationId": "req_a1b2c3d4",
  "timestamp": "2026-01-15T09:30:00.000Z"
}

Overview

Errors

Customers

Registered Addresses

Wallets

Wallet Signers

Signing Quorum

Virtual Accounts

Applications

Documents

Verifications

Signing Requests

Transactions

Payouts

Whitelist Recipients

Orders

RFIs

Webhook Endpoints

Webhook Deliveries

Webhook Event Types

Features

Customer Onboarding

Sandbox

Simulate an overall conversion failure for a sandbox order

Authorizations

Path Parameters

Body

Response