Receive a Wire

How to receive a wire with Synapse

To receive an incoming wire, issue an account/routing number for your Synapse account. Then send the account/routing instructions to the sender so they can wire funds from their bank.

Step 1. Create the Synapse Account

Here are additional resources on how to create a deposit account.

EXAMPLE REQUEST

POST /v3.1/users/594e0fa2838454002ea317a0/nodes HTTP/1.1
Host: uat-api.synapsefi.com
X-SP-USER-IP: 127.0.0.1
X-SP-USER: oauth_auVIbQ8WXC0pnLU9ivEs4tcHDejqFJlwoNrZ3fO1|e83cf6ddcf778e37bfe3d48fc78a6502062fc
Content-Type: application/json

{
  "type": "DEPOSIT-US",
  "info":{
      "nickname":"My Checking"
  }
}

EXAMPLE RESPONSE

{
    "error_code": "0",
    "http_code": "200",
    "limit": 20,
    "node_count": 1,
    "nodes": [
        {
            "_id": "594e65f712e17a002f2e357c",
            "_links": {
                "self": {
                    "href": "https://uat-api.synapsefi.com/v3.1/users/594e0fa2838454002ea317a0/nodes/594e65f712e17a002f2e357c"
                }
            },
            "allowed": "CREDIT-AND-DEBIT",
            "client": {
                "id": "589acd9ecb3cd400fa75ac06",
                "name": "Synapse"
            },
            "extra": {
                "other": {},
                "supp_id": ""
            },
            "info": {
                "balance": {
                    "amount": 0,
                    "currency": "USD"
                },
                "name_on_account": " ",
                "nickname": "My Checking"
            },
            "is_active": true,
            "timeline": [
                {
                    "date": 1498310135274,
                    "note": "Node created."
                }
            ],
            "type": "DEPOSIT-US",
            "user_id": "594e0fa2838454002ea317a0"
        }
    ],
    "page_count": 1,
    "success": true
}

Step 2. Create the Subnet

EXAMPLE REQUEST

POST /v3.1/users/59c9f69a89ec34002e1b4b2e/nodes/59c9f6a66d7d8a002f71b191/subnets HTTP/1.1
Host: uat-api.synapsefi.com
X-SP-USER-IP: 127.0.0.1
X-SP-USER: oauth_xEyuYzmPN6Rp120Kg08Ma3SdO4w5c9ZFBnWfbJer|e83cf6ddcf778e37bfe3d48fc78a6502062fc
Content-Type: application/json

{
  "nickname":"Test AC/RT"
}

EXAMPLE RESPONSE

{
    "_id": "59c9f77cd412960028b99d2b",
    "_links": {
        "self": {
            "href": "https://uat-api.synapsefi.com/v3.1/users/59c9f69a89ec34002e1b4b2e/nodes/59c9f6a66d7d8a002f71b191/subnets/59c9f77cd412960028b99d2b"
        }
    },
    "account_num": "692069247603874",
    "allowed": "CREDIT",
    "client": {
        "id": "589acd9ecb3cd400fa75ac06",
        "name": "Synapse"
    },
    "nickname": "Test AC/RT",
    "node_id": "59c9f6a66d7d8a002f71b191",
    "routing_num": {
        "ach": "084106768",
        "wire": "084106768"
    },
    "user_id": "59c9f69a89ec34002e1b4b2e"
}

Step 3. Receive the Wire

Once you receive a successful response from the previous step, an account and routing number will have been issued on the deposit account.

The next step would be to get the account_num and routing_number from the response. This account and routing number can then be used to receive funds. Then you go to your external bank to initiate a wire from there to your deposit account. For sending an international wire to your deposit account, reach out to your platform architect for additional wire instructions.

Wire Settlement Times

We settle wires as we receive them. These are only settled on business days, excluding bank holidays.

Example Timeline

You will see an incoming transaction from an EXTERNAL-US node. You do not have to create the EXTERNAL-US node. This is only used for tracking purposes.

Also note that banks send wires at different times. We will settle the wire as we receive it.

Description
Time
Transaction Status
status_id

User initiates a wire from their bank to the account/routing number associated with their Synapse managed account

Day 1, 4:20

CREATED

1

Wire instructions sent by the user's partner bank

Day 1, 4:20

PROCESSING-DEBIT

2

Wire instructions received by our partner bank

Day 1, 4:20

PROCESSING-CREDIT

3

Transaction posted by Synapse

Day 1, 4:20

SETTLED

4

Transaction Status

The following are different types of transaction statuses for Wires.

Status
status_id
Description

QUEUED-BY-SYNAPSE

-1

Transaction queued by Synapse. This is not cause for alarm.

QUEUED-BY-RECEIVER

0

Transaction queued by Client.

CREATED

1

Transaction Created

PROCESSING-DEBIT

2

Processing Debit

PROCESSING-CREDIT

3

Processing Credit

SETTLED

4

Transaction Settled

CANCELED

5

Transaction Canceled

RETURNED

6

Transaction Returned

QUEUED AND CANCELED TRANSACTIONS

See Transaction Codes for the full list of reasons a transaction can be queued or canceled.

To cancel a transaction yourself, DELETE transaction. Only transactions with a CREATED or QUEUED status can be canceled. Once a transaction is processing or settled you are unable to cancel it.

Returned Transactions

Returned Transactions will be marked as returned. When possible, we will propagate the reason along with the return.

Transaction Timeline

You can follow the transaction's timeline to see the stages of the transaction.

timeline: [
                date: {
                        $date : 1540998339542,
                },
                note : "Transaction Created.",
                status : "CREATED",
                status_id : "1",
                date: {
                        $date : 1540998345315,
                },
                note : "",
                status : "PROCESSING-DEBIT",
                status_id : "2",
                date: {
                        $date : 1540998345336,
                },
                note : "",
                status : "PROCESSING-CREDIT",
                status_id : "3",
                date: {
                        $date : 1540998345397,
                },
                note : "",
                status : "SETTLED",
                status_id : "4",        ]

Subscribe to Webhooks

We recommend that you subscribe to webhooks to stay updated on the status of transactions.

Receive a Wire


How to receive a wire with Synapse

Suggested Edits are limited on API Reference Pages

You can only suggest edits to Markdown body content, but not to the API spec.