Change Payment Node

Modify the payment account

To change the payment node, you just need to do a PATCH on the node. The payment_node_id can be the node ID of the end user or your platform's if you are using a third-party for collecting loan payments.

API ENDPOINT

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

PATH PARAMETERS

user_id :
string

The user ID of the user

BODY PARAMETERS

info.payment_node_id:
string

node ID of where we will collect payments from

EXAMPLE REQUEST

PATCH /v3.1/users/5bee109fc256c334c5348d09/nodes/5bee11e7bab47500bc84a552 HTTP/1.1
Host: https://uat-api.synapsefi.com
X-SP-USER-IP: 255.127.79.76
X-SP-USER: oauth_HBb0adELTAFlgYvX3Zn8QmKjMIk4tCN5uDqRce2U|e83cf6ddcf778e37bfe3d48fc78a6502062fc
Content-Type: application/json

{
  "payment_node_id":"5bee114e192dde00ac622d8f"
}
loan_id= "5bee11e7bab47500bc84a552"
body= {
  "payment_node_id":"5bee114e192dde00ac622d8f"
}

user.update_node(loan_id, body)
const loanNodeID = "5bee11e7bab47500bc84a552";
const body = {
  "payment_node_id":"5bee114e192dde00ac622d8f"
};

user.updateNode(loanNodeID, body);
loan_id= "5bee11e7bab47500bc84a552"
body= {
  "payment_node_id":"5bee114e192dde00ac622d8f"
}

user.update_node(node_id: loan_id, payload: body)
$nodeid = '5bee11e7bab47500bc84a552';
$body = (object)[
   "payment_node_id" => "5bee114e192dde00ac622d8f"
];
$user->update_node($nodeid, $body);
nodeID := "5bee11e7bab47500bc84a552"
body := `{
  "payment_node_id":"5bee114e192dde00ac622d8f"
}`

data, err := user.UpdateNode(nodeID, body)

EXAMPLE RESPONSE

{
    "_id": "5bee11e7bab47500bc84a552",
    "_links": {
        "self": {
            "href": "https://uat-api.synapsefi.com/v3.1/users/5bee109fc256c334c5348d09/nodes/5bee11e7bab47500bc84a552"
        }
    },
    "allowed": "CREDIT",
    "client": {
        "id": "589acd9ecb3cd400fa75ac06",
        "name": "SynapseFI"
    },
    "extra": {
        "note": "Z5YPLajV78",
        "other": {},
        "supp_id": "xx123c"
    },
    "info": {
        "agreements": [
            {
                "type": "LOAN_AGREEMENT",
                "url": "https://cdn.synapsepay.com/uploads/2018/11/16/djTatABslJK6LSkcrMb51wz7CNxFyfDRX4nmvq03PuGOHpUgVE.pdf"
            }
        ],
        "balance": {
            "amount": -500.2,
            "currency": "USD"
        },
        "credit_limit": {
            "amount": 500.2,
            "currency": "USD"
        },
        "disbursement_node_id": "5b970a27d6ef6d00be32b09f",
        "document_id": "2a4a5957a3a62aaac1a0dd0edcae96ea2cdee688ec6337b20745eed8869e3ac8",
        "installment_amount": 52.53,
        "interest": {
            "accrued": 0,
            "apr": 10,
            "cap": 25.01
        },
        "loan_type": "ONE-TIME",
        "name_on_account": " ",
        "next_payment": 1553560801456,
        "nickname": "My Loan",
        "num_payments": 10,
        "payment_node_id": "5bee114e192dde00ac622d8f",
        "remaining_payments": 10,
        "schedule": "MONTHLY"
    },
    "is_active": true,
    "timeline": [
        {
            "date": 1542328801456,
            "note": "Node created."
        },
        {
            "date": 1542329469216,
            "note": "next_payment updated."
        },
        {
            "date": 1542329616729,
            "note": "payment_node_id updated."
        }
    ],
    "type": "LOAN-US",
    "user_id": "5bee109fc256c334c5348d09"
}

Toggle Auto-Pay On/Off

To toggle auto-pay off, just supply null for the payment_node_id.

Change Payment Node


Modify the payment account

Suggested Edits are limited on API Reference Pages

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