Stop Check

Stop a check payment after delivery

Funds will remain debited from deposit account until payee cashes the check. If a check is not deposited after 90 days, the money will be credited back to the user's deposit account since the check will be void after 90 days of when the transaction was created.

To cancel a sent check, you can "Delete" check transactions in every stage except SETTLED.

API ENDPOINT

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

PATH PARAMETER

user_id :
required
string

The user ID of the user

node_id :
required
string

The node ID of the node

trans_id :
required
string

The transaction ID

To cancel the check, you will make a call to delete the transaction. The endpoint is users/:user_id/nodes/:node_id/trans/:trans_id.

The user_id and node_id belong to the sender and their deposit node. The trans_id is the id returned during the transaction POST call in the previous step. Checks can only be canceled before the transaction has SETTLED.

EXAMPLE REQUEST

DELETE /v3.1/users/5bd33f4c4f6b884efb436567/nodes/5bd33fa4dc00d566582598be/trans/5bd3409bf61d8700e3eb1396 HTTP/1.1
Host: uat-api.synapsefi.com
X-SP-USER-IP: 127.0.0.1
X-SP-USER: oauth_uFozlr0Z8A9UnWyHM7fL6qBcgPRXxmDOjh3JQTw4|n38dj3h8NE393bv24ovoRY34kd62
Content-Type: application/json
check_node_id = '594e606212e17a002f2e3251'
check_trans_id = '594e72124599e8002fe62e4f'
user.cancel_trans(check_node_id, check_trans_id)
const checkNodeID = '594e606212e17a002f2e3251';
const checkTransID = '594e72124599e8002fe62e4f';

user.deleteTransaction(checkNodeID, checkTransID);
Node_id: “5bd33fa4dc00d566582598be”
check_transaction_id: “5bd3409bf61d8700e3eb1396”
user.cancel_transaction(node_id:, trans_id: check_transaction_id)
$nodeid = '5c3d416f7b08ab0066ee8cae';
$transid = '5c6490e3fe8c6b00679f52a7';
$user->delete_transaction($nodeid, $transid);
nodeID := “5bd33fa4dc00d566582598be”
transactionID := “5bd3409bf61d8700e3eb1396”

data, err := user.CancelTransaction(nodeID, transactionID)

EXAMPLE RESPONSE

{
    "_id": "5bd3409bf61d8700e3eb1396",
    "_links": {
        "self": {
            "href": "https://uat-api.synapsefi.com/v3.1/users/5bd33f4c4f6b884efb436567/nodes/5bd33fa4dc00d566582598be/trans/5bd3409bf61d8700e3eb1396"
        }
    },
    "_v": 2,
    "amount": {
        "amount": 103,
        "currency": "USD"
    },
    "client": {
        "id": "5ade26b4567a900029e2afd2",
        "name": "YY Test Account"
    },
    "extra": {
        "asset": null,
        "created_on": 1540571291151,
        "encrypted_note": "",
        "group_id": null,
        "ip": "127.0.0.1",
        "latlon": "0,0",
        "note": "Test transaction",
        "process_on": 1540571291151,
        "same_day": false,
        "supp_id": ""
    },
    "fees": [
        {
            "fee": 0,
            "note": "Synapse Facilitator Fee",
            "to": {
                "id": "55b3f8c686c2732b4c4e9df6"
            }
        }
    ],
    "from": {
        "id": "5bd33f75dc00d566582598a8",
        "nickname": "My Deposit Account",
        "type": "DEPOSIT-US",
        "user": {
            "_id": "5bd33f4c4f6b884efb436567",
            "legal_names": [
                "Test User"
            ]
        }
    },
    "recent_status": {
        "date": 1540571309123,
        "note": "[Returned on Credit] Stop Payment",
        "status": "RETURNED",
        "status_id": "6"
    },
    "timeline": [
        {
            "date": 1540571291151,
            "note": "Transaction Created.",
            "status": "CREATED",
            "status_id": "1"
        },
        {
            "date": 1540571299939,
            "note": "transaction status updated.",
            "status": "PROCESSING-DEBIT",
            "status_id": "2"
        },
        {
            "date": 1540571309123,
            "note": "[Returned on Credit] Stop Payment",
            "status": "RETURNED",
            "status_id": "6"
        }
    ],
    "to": {
        "id": "5bd33fa4dc00d566582598be",
        "nickname": "My Checking",
        "type": "CHECK-US",
        "user": {
            "_id": "5bd33f4c4f6b884efb436567",
            "legal_names": [
                "Test User"
            ]
        }
    }
}