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
On this page
  • Request
  • Example Request
  • Response
  • Response Body
  • Responses
  1. REST API
  2. Payments

Get Wire Instructions

PreviousDelete Bank AccountNextGet ACH Agreement Status

Last updated 1 day ago

GET

https://api.sfox.com/v1/user/wire-instructions

Returns wire instructions for depositing USD to the sFOX account.


WARNING: Your user MUST specify their User Reference ID (sfox_user_ref_id) in their wire transfer field when submitting a wire transfer to their sFOX account. This field is typically a "Memo" or "Special Instructions" field in banks' portals. Failure to include the User Reference ID will result in delays in funds being credited to the user's account.

Request

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

Example Request

curl -H "Authorization: Bearer ${USER_AUTH_TOKEN}" \
 'https://api.sfox.com/v1/user/wire-instructions'
const axios = require('axios');

const config = {
  method: 'get',
  url: 'https://api.sfox.com/v1/user/wire-instructions',
  headers: {
    'Content-Type': 'application/json',
    'Authorization': 'Bearer <USER_AUTH_TOKEN>'
  }
}

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

data = requests.get(
  "https://api.sfox.com/v1/user/wire-instructions",
  headers={
    "Authorization": f"Bearer {os.environ['USER_AUTH_TOKEN']}"
  }
)
print(data.status_code)
print(data.json())

Response

Response Body

Key
Description

bank_name

Name of the bank

bank_address

Bank address

beneficiary_name

Name of the beneficiary

beneficiary_address

Address of the beneficiary

bank_routing_number

Routing number of the bank for domestic bank wires

bank_routing_swift

SWIFT number of the bank for international bank wires

bank_account_number

Account number of the bank

sfox_user_ref_id

sFOX User Reference ID. Required: End user must include the user-reference ID in the wire memo in order for the transfer to be properly credited to their account

Responses

200: OK
{
    "data": {
        "bank_name": "MVB Bank",
        "bank_address": "301 Virginia Avenue Fairmont, West Virginia 26554",
        "beneficiary_name": "sFOX",
        "beneficiary_address": "400 Continental Blvd, 6th Floor, El Segundo, CA 90245",
        "bank_routing_number": "51504597",
        "bank_routing_swift": "PNCCUS33",
        "bank_account_number": "136379",
        "sfox_user_ref_id": "XpvdE"
    }
}
User Auth Token