Sandbox

Simulate one signer's cosignature for a non-custodial sandbox payout

Sandbox-only endpoint that stamps a single signer’s vote against a non-custodial payout’s M-of-N signing quorum, bypassing the real passkey-approval flow. Each call advances the quorum by one vote: pass signerId to target a specific ACTIVE wallet signer, or omit it to auto-advance to the next signer with no recorded vote (so repeated calls walk 1 of N → 2 of N → completed). The verification completes ONLY when the M-th approval lands; intermediate approvals leave it PENDING. A single declined stamp terminalizes the whole quorum as declined. QA reads incremental progress via GET /v2/verifications/{token} (the quorum block). 404 if the payout does not belong to the org or is not a WITHDRAWAL. Replays (the cosign gate already cleared, or the payout never required cosign) return the payout at its current state. Returns the payout at its current state.

POST

sandbox

payouts

{id}

simulate

cosign

Simulate one signer's cosignature for a non-custodial sandbox payout

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

import requests

url = "https://api.sandbox.conduit.financial/v2/sandbox/payouts/{id}/simulate/cosign"

payload = {
    "reason": "<string>",
    "signerId": "<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>', signerId: '<string>'})
};

fetch('https://api.sandbox.conduit.financial/v2/sandbox/payouts/{id}/simulate/cosign', 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/payouts/{id}/simulate/cosign",
  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>',
    'signerId' => '<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/payouts/{id}/simulate/cosign"

	payload := strings.NewReader("{\n  \"reason\": \"<string>\",\n  \"signerId\": \"<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/payouts/{id}/simulate/cosign")
  .header("x-api-key", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"reason\": \"<string>\",\n  \"signerId\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.sandbox.conduit.financial/v2/sandbox/payouts/{id}/simulate/cosign")

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  \"signerId\": \"<string>\"\n}"

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

{
  "id": "<string>",
  "customerId": "<string>",
  "source": {
    "type": "wallet",
    "walletId": "<string>",
    "address": "<string>",
    "assetAmount": {
      "amount": "<string>"
    }
  },
  "destination": {
    "type": "wallet",
    "walletId": "<string>",
    "address": "<string>",
    "assetAmount": {
      "amount": "<string>"
    }
  },
  "fees": [
    {
      "type": "fixed",
      "assetAmount": {
        "amount": "<string>"
      }
    }
  ],
  "createdAt": "2026-01-15T09:30:00.000Z",
  "hasRfi": true,
  "type": "withdrawal",
  "requiresUserSignature": true,
  "customerName": "<string>",
  "clientReferenceId": "<string>",
  "completedAt": "2026-01-15T09:30:00.000Z",
  "failureMessage": "<string>",
  "cancelledAt": "2026-01-15T09:30:00.000Z",
  "linkedOrderId": "<string>",
  "rfiId": "<string>",
  "queuePosition": 4503599627370496
}

{
  "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": "PAYOUT_NOT_FOUND",
  "title": "Payout Not Found",
  "status": 404,
  "detail": "No payout exists with the specified ID, or the payout belongs to a different organization.",
  "resolution": "Verify the payout ID is correct. Use the list payouts endpoint to find valid payout IDs for your organization.",
  "docs": "https://conduit-v2.mintlify.app/errors#payout-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

outcome

enum<string>

required

Available options:

approved,

declined

reason

string

Maximum string length: 500

signerId

string

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

Response

Client-facing view of an outbound withdrawal (debit out of a customer VA/wallet).

string

required

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

customerId

string

required

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

status

enum<string>

required

Available options:

pending,

processing,

completed,

failed,

cancelled

source

object

required

One side (source or destination) of a transaction. Discriminated by type.

Show child attributes

destination

object

required

One side (source or destination) of a transaction. Discriminated by type.

Show child attributes

fees

object[]

required

Show child attributes

createdAt

string<date-time>

required

ISO 8601 timestamp

Example:

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

hasRfi

boolean

required

True when at least one published (non-draft, non-cancelled) RFI targets this transaction. Always present; derived at read time, no stored column.

type

enum<string>

required

Available options:

withdrawal

requiresUserSignature

boolean

required

customerName

string

Display name of the customer that owns the transaction: business legal name or individual full name. Same value on the transactions and payouts reads for the same row. Omitted when the customer's identity record hasn't resolved a name yet; per the public omit-don't-null convention, absence is never surfaced as null.

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}$

stage

enum<string>

Progress signal for a non-terminal transaction, informational only — it does not replace requiresUserSignature, hasRfi, or failureCode for deciding whether your integration needs to act. awaiting_signature: waiting on the required transaction signature (see requiresUserSignature). awaiting_customer_action: further input is needed from your customer — details arrive on the matching event (e.g. transaction.awaiting_sender_information); this is NOT an RFI, hasRfi does not cover it. under_review: compliance, document, or verification review of something already submitted is in progress — usually no action needed; check hasRfi if unsure. settling: funds movement or settlement is in progress, no customer action required — covers long-lived fiat rails like SWIFT that legitimately take days as well as any other non-blocked in-flight state. Omitted once status reaches a terminal value (completed / failed / cancelled). The set of values may grow over time — treat unrecognized values the same as processing.

Available options:

awaiting_signature,

awaiting_customer_action,

under_review,

settling

completedAt

string<date-time>

ISO 8601 timestamp

Example:

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

failureCode

enum<string>

Available options:

user_signature_timeout,

user_signature_expired,

user_signature_declined,

user_signature_rejected_by_provider,

crypto_wallet_misconfigured,

compliance_hold,

compliance_review_rejected,

compliance_rejected,

returned_by_sender,

rail_policy_rejected,

insufficient_funds,

insufficient_funds_at_settle,

rail_unavailable,

sender_info_timeout,

travel_rule_rejected,

provider_rejected,

chain_broadcast_failed,

roster_changed

failureMessage

string

Human-readable description of failureCode. Defaults to the public error catalog text for the code; sandbox-driven failures may carry the operator-supplied reason instead.

cancelledAt

string<date-time>

ISO-8601 timestamp when the transaction was cancelled. Present only on status: cancelled.

Example:

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

cancellationReason

enum<string>

Machine-readable cancellation reason. client_cancelled when the client called POST /v2/payouts/:id/cancel; expired is reserved. Omitted on non-cancelled rows. Mirrors orders.cancellationReason.

Available options:

expired,

client_cancelled

linkedOrderId

string

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

purpose

enum<string>

The business purpose declared at payout creation. Drives compliance gating: intercompany requires a whitelisted recipient; other values require supporting documentation.

Available options:

intercompany,

treasury_management,

payment_for_goods_or_services,

payroll,

investments,

other,

prefunding

rfiId

string

The most recently published such RFI. Omitted (never null) when hasRfi is false.

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

queuePosition

integer

Position in the per-(wallet, chain) signing queue. Only waiting payouts (position ≥ 1) expose this field; the active/head payout omits it. Absent when the payout is not on the user-signature path or has reached a terminal status.

Required range: 1 <= x <= 9007199254740991

⌘I

Simulate one signer's cosignature for a non-custodial sandbox payout

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

import requests

url = "https://api.sandbox.conduit.financial/v2/sandbox/payouts/{id}/simulate/cosign"

payload = {
    "reason": "<string>",
    "signerId": "<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>', signerId: '<string>'})
};

fetch('https://api.sandbox.conduit.financial/v2/sandbox/payouts/{id}/simulate/cosign', 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/payouts/{id}/simulate/cosign",
  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>',
    'signerId' => '<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/payouts/{id}/simulate/cosign"

	payload := strings.NewReader("{\n  \"reason\": \"<string>\",\n  \"signerId\": \"<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/payouts/{id}/simulate/cosign")
  .header("x-api-key", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"reason\": \"<string>\",\n  \"signerId\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.sandbox.conduit.financial/v2/sandbox/payouts/{id}/simulate/cosign")

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  \"signerId\": \"<string>\"\n}"

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

{
  "id": "<string>",
  "customerId": "<string>",
  "source": {
    "type": "wallet",
    "walletId": "<string>",
    "address": "<string>",
    "assetAmount": {
      "amount": "<string>"
    }
  },
  "destination": {
    "type": "wallet",
    "walletId": "<string>",
    "address": "<string>",
    "assetAmount": {
      "amount": "<string>"
    }
  },
  "fees": [
    {
      "type": "fixed",
      "assetAmount": {
        "amount": "<string>"
      }
    }
  ],
  "createdAt": "2026-01-15T09:30:00.000Z",
  "hasRfi": true,
  "type": "withdrawal",
  "requiresUserSignature": true,
  "customerName": "<string>",
  "clientReferenceId": "<string>",
  "completedAt": "2026-01-15T09:30:00.000Z",
  "failureMessage": "<string>",
  "cancelledAt": "2026-01-15T09:30:00.000Z",
  "linkedOrderId": "<string>",
  "rfiId": "<string>",
  "queuePosition": 4503599627370496
}

{
  "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": "PAYOUT_NOT_FOUND",
  "title": "Payout Not Found",
  "status": 404,
  "detail": "No payout exists with the specified ID, or the payout belongs to a different organization.",
  "resolution": "Verify the payout ID is correct. Use the list payouts endpoint to find valid payout IDs for your organization.",
  "docs": "https://conduit-v2.mintlify.app/errors#payout-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 one signer's cosignature for a non-custodial sandbox payout

Authorizations

Path Parameters

Body

Response