sFOX API
Sign InOpen Account
Connect API
Connect API
  • Introduction
    • Welcome
    • Getting Started
    • Resources
      • Terminology
      • Systems & Operations
      • Integration Options
    • Guides
      • End User Onboarding & KYC
        • Individuals
        • Businesses
        • Enhanced Due Diligence
  • REST API
    • REST Endpoints
    • Authentication
    • End Users
      • Create End User Account
      • Request Verification Code
      • Confirm Verification Code
      • Create User Auth Token(s)
      • Get End User(s)
      • Get EDD Requests
      • Get EDD Prompts
      • Create EDD Responses
        • Uploading Files as Responses
      • Submit Documents
      • Deactivate User
    • Payments
      • Create Bank Account (Plaid)
      • Create Bank Account
      • Get Bank Account
      • Get Plaid Processors
      • Amend Plaid Processors
      • Verify Bank Account
      • Delete Bank Account
      • Get Wire Instructions
      • Get ACH Agreement Status
      • Request ACH Onboarding
      • Get ACH Deposit Limit
    • Withdrawals
      • Confirm Withdrawal
      • Resend Confirmation Code
      • Cancel Withdrawal
    • Transfers
      • Create Transfer
      • Confirm Transfer
      • Resend Confirmation Code
      • Cancel Transfer
      • Get Transfer Permissions
      • Get Transfer History
    • Monetization
      • Create Setting
      • Update Setting
      • Delete Setting
      • Get Settings
      • Get Permissions
      • Get Monetization History
  • WebSocket API
    • Connecting
    • Authentication
    • Subscribing & Unsubscribing
    • Message Format
    • End Users
      • Onboarding
      • Balances
      • Orders
      • Trades
    • Market Data
      • Order Book
      • Trades
      • Ticker
  • Single Sign-On
    • Overview
      • IdP Initiated SSO
    • IdP Data
    • SAML Response Data
  • Errors
    • Error Codes
Powered by GitBook
  1. REST API
  2. Withdrawals

Confirm Withdrawal

PreviousWithdrawalsNextResend Confirmation Code

Last updated 8 months ago

POST https://api.sfox.com/v1/user/withdraw/confirm

Confirm a user's withdrawal request.

Once a withdrawal is initiated, a 6-digit code will be sent to the user's email address. Collect this code from the user and submit it along with the ID of the withdrawal using this request to confirm the user's withdrawal. Once confirmed, the withdrawal will begin processing.

Authentication: This endpoint requires a for authentication. Requests using your Connect API Key will be rejected.

Body Parameters

Name
Type
Description

otp required

string

The 6-digit OTP code sent to the user's email

atx_id required

number

The transaction ID (atx_id) of the withdrawal you are confirming

Response Body

Key
Description

success

Whether the request for a new confirmation code was successful or not

atx_id

The transaction ID of the withdrawal you are requesting a code for

tx_status

The transaction status of the withdrawal

Responses

200 OK
{
    "data": {
        "success": true,
        "atx_id": 1525624,
        "tx_status": 1160
    }
}
curl -X POST \
  -H 'Content-type: application/json' \
  -H "Authorization: Bearer ${USER_AUTH_TOKEN}" \
  --data '{ "otp": "123456",
          "atx_id": 987654 }'  \
'https://api.sfox.com/v1/user/withdraw/confirm'
const axios = require('axios');

const config = {
  method: 'post',
  url: 'https://api.sfox.com/v1/user/withdraw/confirm',
  headers: {
    'Content-Type': 'application/json',
    'Authorization': `Bearer {process.env.USER_AUTH_TOKEN}`
  },
  data: {
   otp: '123456',
   atx_id: 987654
  }
}

axios(config)
  .then(response => {
    console.log(response.status);
    console.log(respones.data);
  })
  .catch(err => {
    console.error(err.response.status);
    console.error(err.respones.data);
  });
import requests
import os

data = requests.post(
  "https://api.sfox.com/v1/user/withdraw/confirm",
  headers={
    "Authorization": f"Bearer {os.environ['ENTERPRISE_API_KEY']}"
  },
  json={
    "otp": "123456",
    "atx_id": 987654
  }
)
print(data.status_code)
print(data.json())

User Auth Token