Facilitator Fee's for Transactions

Handling facilitator fee's

By default, all Synapse fees are deducted from the fund recipient. This means that if you send $1, the fund recipient will get $1 minus the per transaction fee.

However, if you want your customer to receive 100% of the funds, you can cover the cost yourself. You can also charge an additional fee to users that will be deducted from the transaction amount.

1. Pre-Fund a DEPOSIT-US Node

This is the node where the transaction fees will be deducted from. You will need to keep enough funds in the deposit account to cover all fees. We recommend setting up webhooks to keep track of the balance for this node. More information on setting that up can be found here Subscription Resources

2. Create the transaction

Set the facilitator fee to -0.2 (or whatever your per transaction fee is). Set your pre-funded DEPOSIT-US node as your fee's "to" node.

Charging an additional fee: To charge an additional fee you will create a second fee object with the fee you're charging designated as a positive integer value with the "to" node set to where those funds would be deposited.

Example Request

POST /v3.1/users/5bd7544f3ee0a932f2caa931/nodes/5bdba018389f2400b9b119fe/trans HTTP/1.1
Host: https://uat-api.synapsefi.com
X-SP-USER-IP: 255.127.79.76
X-SP-USER: oauth_CyQGXNFT8IKWi7na3PZVAEJYv0hdg52M0qrwBLsR|e83cf6ddcf778e37bfe3d48fc78a6502062fc
Content-Type: application/json
cache-control: no-cache
Postman-Token: dac83765-a169-4c53-bdd0-c654ec44eb75
{
  "to": {
    "type": "DEPOSIT-US",
    "id": "5bdba176389f2400abb00a63"
  },
  "amount": {
    "amount": 300,
    "currency": "USD"
  },
  "extra": {
    "ip": "255.127.79.76",
    "note": "Test transaction"
  },
  "fees":[{
  	"fee":-0.2,
  	"note":"Facilitator Fee",
  	"to":{
  		"id":"5bdba176389f2400abb00a63"
  	}
  }]
}
POST /v3.1/users/5bd7544f3ee0a932f2caa931/nodes/5bdba018389f2400b9b119fe/trans HTTP/1.1
Host: https://uat-api.synapsefi.com
X-SP-USER-IP: 255.127.79.76
X-SP-USER: oauth_CyQGXNFT8IKWi7na3PZVAEJYv0hdg52M0qrwBLsR|e83cf6ddcf778e37bfe3d48fc78a6502062fc
Content-Type: application/json
cache-control: no-cache
Postman-Token: dac83765-a169-4c53-bdd0-c654ec44eb75
{
  "to": {
    "type": "DEPOSIT-US",
    "id": "5bdba176389f2400abb00a63"
  },
  "amount": {
    "amount": 300,
    "currency": "USD"
  },
  "extra": {
    "ip": "255.127.79.76",
    "note": "Test transaction"
  },
  "fees":[
  {
    "fee":-0.2,
    "note":"Facilitator Fee",
    "to":{
      "id":"5bdba176389f2400abb00a63"
      }
   },
  {
  "fee":2.12,
  "note":"Additional Platform Fee",
  "to":{
      "id":"5ddca154189f2400abb83a89"
    }
  }]
}

RESPONSE

{
    "error_code": "0",
    "http_code": "200",
    "limit": 20,
    "node_count": 1,
    "nodes": [
        {
            "_id": "5bdba176389f2400abb00a63",
            "_links": {
                "self": {
                    "href": "https://uat-api.synapsefi.com/v3.1/users/5bd7544f3ee0a932f2caa931/nodes/5bdba176389f2400abb00a63"
                }
            },
            "allowed": "CREDIT-AND-DEBIT",
            "client": {
                "id": "589acd9ecb3cd400fa75ac06",
                "name": "SynapseFI"
            },
            "extra": {
                "note": null,
                "other": {},
                "supp_id": ""
            },
            "info": {
                "balance": {
                    "amount": 0,
                    "currency": "USD"
                },
                "document_id": "2a4a5957a3a62aaac1a0dd0edcae96ea2cdee688ec6337b20745eed8869e3ac8",
                "name_on_account": " ",
                "nickname": "My Deposit Account"
            },
            "is_active": true,
            "timeline": [
                {
                    "date": 1541120374412,
                    "note": "Node created."
                }
            ],
            "type": "DEPOSIT-US",
            "user_id": "5bd7544f3ee0a932f2caa931"
        }
    ],
    "page_count": 1,
    "success": true
}

3. View all Fees

You will see two fees when you GET the transaction (after the transaction has settled). One positive & one negative. These correspond with our DEPOSIT-US node & your DEPOSIT-US node respectively. In the case of an additional fee you'll see three different fees.

 "fees": [
        {
            "fee": 0.2,
            "note": "Synapse Facilitator Fee", #Node that the fee is credited to
            "to": {
                "id": "55b3f8c686c2732b4c4e9df6"
            }
        },
        {
            "fee": -0.2,
            "note": "Facilitator Fee", #Node that the fee is debited from
            "to": {
                "id": "5bdba176389f2400abb00a63"
            }
        }
 "fees": [
        {
            "fee": 0.2,
            "note": "Synapse Facilitator Fee", #Node that the fee is credited to
            "to": {
                "id": "55b3f8c686c2732b4c4e9df6"
            }
        },
        {
            "fee": -0.2,
            "note": "Facilitator Fee", #Node that the fee is debited from
            "to": {
                "id": "5bdba176389f2400abb00a63"
            },
           {
            "fee": 2.12,
            "note": "Additional Platform Fee", #Node that the fee is credited from
            "to": {
                "id": "5ddca154189f2400abb83a89"
            }
        }

That's it! The recipient should get 100% of the funds