Fund Card

POST Transaction using one of our Payment methods

To fund the debit card, transfer funds from the user's DEPOSIT-US node to their CARD-US node.

API ENDPOINT

https://uat-api.synapsefi.com/v3.1/users/:user_id/nodes/:node_id/trans

PATH PARAMETERS

user_id:
required
string

ID of sender (user)

node_id:
required
string

ID of sending node

BODY PARAMETER

to.type:
required
string

Receiving node type

to.id:
required
string

Receiving node ID

amount.amount:
required
double

Amount user wishes to send

amount.currency:
required
string

Currency of the transaction amount

extra.ip:
required
string

IP address of the user device while creating transaction

extra.supp_id:
string

ID supplied to the transaction

extra.group_id:
string

Group ID supplied to the transaction

extra.note:
string

Memo tagged with the transaction

extra.process_on:
integer0

When the transaction should be processed. The value is the delta value. Which means when 1 is supplied it means that the transaction will be processed tomorrow.

extra.other.attachments:
array of strings

Array of padded base64 of attachments

fees[fee]:
double

Fee associated with the transaction

fees[note]:
string

Reason for the fee

fees[to].id:
string

Node ID where the fee would be credited when the transaction settled. Fee node has to be DEPOSIT-US type always

EXAMPLE REQUEST

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

{
  "to": {
    "type": "CARD-US",
    "id": "5ba05ed620b3aa005882c52a"
  },
  "amount": {
    "amount": 50.0,
    "currency": "USD"
  },
  "extra": {
    "ip": "127.0.0.1",
    "note": "Test transaction"
  }
}

EXAMPLE RESPONSE

{
    "_id": "5bb311309936a000c7881ff4",
    "_links": {
        "self": {
            "href": "https://uat-api.synapsefi.com/v3.1/users/594e0fa2838454002ea317a0/nodes/594e65f712e17a002f2e357c/trans/5bb311309936a000c7881ff4"
        }
    },
    "_v": 2,
    "amount": {
        "amount": 50,
        "currency": "USD"
    },
    "client": {
        "id": "589acd9ecb3cd400fa75ac06",
        "name": "SynapseFI"
    },
    "extra": {
        "asset": null,
        "created_on": 1538462000367,
        "encrypted_note": "",
        "group_id": null,
        "ip": "127.0.0.1",
        "latlon": "0,0",
        "note": "Test transaction",
        "process_on": 1538462000367,
        "same_day": false,
        "supp_id": ""
    },
    "fees": [
        {
            "fee": 0,
            "note": "Facilitator Fee",
            "to": {
                "id": "None"
            }
        }
    ],
    "from": {
        "id": "594e65f712e17a002f2e357c",
        "nickname": "My Deposit Account",
        "type": "DEPOSIT-US",
        "user": {
            "_id": "594e0fa2838454002ea317a0",
            "legal_names": [
                "Test User"
            ]
        }
    },
    "recent_status": {
        "date": 1538462000367,
        "note": "Transaction Created.",
        "status": "CREATED",
        "status_id": "1"
    },
    "timeline": [
        {
            "date": 1538462000367,
            "note": "Transaction Created.",
            "status": "CREATED",
            "status_id": "1"
        }
    ],
    "to": {
        "id": "5ba05ed620b3aa005882c52a",
        "nickname": "My Debit Card",
        "type": "CARD-US",
        "user": {
            "_id": "594e0fa2838454002ea317a0",
            "legal_names": [
                "Test User"
            ]
        }
    }
}

You can also fund your CARD-US node by:

Failed Transactions

If a transaction fails upon swiping the card (ex: user input incorrect pin at point of sale), the transaction will move immediately from SETTLED to RETURNED. We encourage you to check whether the transaction returned before you send success notifications to your users.

Recommended: Set up Direct Deposit

We highly recommend encouraging your users to immediately set up direct deposit for payroll (when applicable). We have seen that users who set up direct deposit from their payroll have lower rates of churn.

Subscribe to Webhooks

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