Cancel Transaction

Transaction

DELETE https://api.synapsefi.com/v3.1/users/:user_id/nodes/:node_id/trans/:tran_id

This endpoint allows you to cancel a specific transaction.

Path Parameters

Name	Type	Description
tran_id	string	ID of the transaction.
node_id	string	ID of the node.
user_id	string	ID of the user.

Headers

Name	Type	Description
X-SP-USER	string	User's OAuth key and device fingerprint, separated by a pipe.
X-SP-USER-IP	string	IP address of your device.
X-SP-GATEWAY	string	Your Client ID and Secret, separated by a pipe.

200 Subnet successfully retrieved.

{
    "_id": "5fea5b8438707c7ccff0781a",
    "_links": {
        "self": {
            "href": "https://uat-api.synapsefi.com/v3.1/users/5fe50a777562960078d3a5c6/nodes/5fe96562c54d7b7bcda9b9da/trans/5fea5b8438707c7ccff0781a"
        }
    },
    "_v": 2,
    "amount": {
        "amount": 500.1,
        "currency": "USD"
    },
    "client": {
        "id": "589acd9ecb3cd400fa75ac06",
        "name": "SynapseFi"
    },
    "extra": {
        "asset": null,
        "created_on": 1609194372664,
        "group_id": null,
        "ip": "255.127.79.76",
        "latlon": "unknown,unknown",
        "location": {
            "address_city": null,
            "address_country_code": null,
            "address_postal_code": null,
            "address_subdivision": null,
            "lat": 0,
            "lon": 0
        },
        "note": "Test transaction",
        "other": {
            "affect_limits": true,
            "attachments": [],
            "chargeback_disputed": false,
            "dispute_form": null,
            "dispute_meta": {},
            "dispute_reason": null,
            "disputed": false,
            "is_provisional_credit": false
        },
        "process_on": 1609194372664,
        "rate": null,
        "rate_limit": null,
        "same_day": false,
        "settlement_delay": 0,
        "supp_id": "",
        "tracking_number": null
    },
    "fees": [
        {
            "fee": 0.5,
            "note": "Synapse Facilitator Fee",
            "to": {
                "id": "55b3f8c686c2732b4c4e9df6"
            }
        }
    ],
    "from": {
        "id": null,
        "meta": {
            "account_number": "",
            "amount": "",
            "back_signature": false,
            "check_back": "",
            "check_front": "",
            "check_number": "",
            "check_quality_bucket_num": null,
            "front_signature": false,
            "is_check": true,
            "is_endorsed": false,
            "name": "",
            "original_check_back": "https://cdn.synapsepay.com/uploads/2020/12/28/kTrgd5zYO7FG6vJs930VnlC4SW1jfRqKPwy8hEUuIbaxXeiZoA.gif",
            "original_check_front": "https://cdn.synapsepay.com/uploads/2020/12/28/298icQTUVyrxwkM0CvG5hdZf0YoKHBJX4abNzjEPFulSAD7m3I.gif",
            "routing_number": ""
        },
        "nickname": null,
        "type": "RDC",
        "user": {
            "_id": null,
            "legal_names": []
        }
    },
    "recent_status": {
        "date": 1609194375618,
        "note": "Transaction Canceled.",
        "status": "CANCELED",
        "status_id": "5"
    },
    "timeline": [
        {
            "date": 1609194372664,
            "note": "Transaction Created.",
            "status": "CREATED",
            "status_id": "1"
        },
        {
            "date": 1609194375618,
            "note": "Transaction Canceled.",
            "status": "CANCELED",
            "status_id": "5"
        }
    ],
    "to": {
        "id": "5fe96562c54d7b7bcda9b9da",
        "nickname": "My Deposit Account",
        "type": "DEPOSIT-US",
        "user": {
            "_id": "5fe50a777562960078d3a5c6",
            "legal_names": [
                "Test User"
            ]
        }
    }
}

400 Query failing

{
    "error": {
        "code": "missing_user_ip",
        "en": "User IP is missing from the request."
    },
    "error_code": "200",
    "http_code": "400",
    "success": false
}

Example Request

To cancel a transaction en route to the recipient, the transaction must not have been batched already. For example, to cancel transactions between native Synapse accounts (ex: Deposit Accounts), they need to have status CREATED or QUEUED-BY-SYNAPSE.While a transaction leaving a Deposit Account, to an ACH-US account can be canceled with status CREATED, QUEUED-BY-SYNAPSE orPROCESSING-DEBIT (because outgoing ACH is batched during PROCESSING-CREDIT). You cannot cancel an already settled transaction, with the exception of Reversals for Interchange Pull transactions. If a cancelation fails, you will receive a 400 Bad Request response with error.code:cannot_cancel_transaction. Go to Possible Transaction Statues to learn more.

HTTP

DELETE /v3.1/users/5fe50a777562960078d3a5c6/nodes/5fe96562c54d7b7bcda9b9da/trans/5fea5b8438707c7ccff0781a HTTP/1.1
Host: uat-api.synapsefi.com
X-SP-USER-IP: 255.127.79.76
X-SP-USER: oauth_ohpVj1iwMQgqHR0ATzbGEU4fBuXOJ0FWZk28y7cD|e83cf6ddcf778e37bfe3d48fc78a6502062fc
Content-Type: application/json

cURL

curl --location --request DELETE 'https://uat-api.synapsefi.com/v3.1/users/5fe50a777562960078d3a5c6/nodes/5fe96562c54d7b7bcda9b9da/trans/5fea5b8438707c7ccff0781a' \
--header 'X-SP-USER-IP: 255.127.79.76' \
--header 'X-SP-USER: oauth_ohpVj1iwMQgqHR0ATzbGEU4fBuXOJ0FWZk28y7cD|e83cf6ddcf778e37bfe3d48fc78a6502062fc' \
--header 'Content-Type: application/json'

Python

//

JS

//

PHP

//

GO

//