Edit transaction

This endpoint is used to edit a specific transaction for a user in the escrow system.

Edit transaction

PATCH v2/escrow/transaction/edit/:transaction_id/:user_id

Params

Name	Type	Description
transaction_id	String	The ID of the transaction to be edited
user_id	String	The ID of the user

Headers

Name	Type	Description
Accept*	string	application/json
V-PRIVATE-KEY*	string	your vesicash private key
V-PUBLIC-KEY*	String	your vesicash public key

Request body

The request should include a JSON payload with the following parameters:

• title (string, optional): The new title for the transaction.

• description (string, optional): The new description for the transaction.

• dashboard_url (string, optional): The new dashboard URL for the transaction.

{
    "title": "first transaction with changed tittle",
    "description": "description",
    "dashboard_url":"https://vesicash.com"
}

Response

Upon successful execution, the endpoint returns a status code of 200 and a JSON response with the following structure:

200: OK

{
    "status": "success",
    "code": 200,
    "message": "success",
    "data": {
        "bank_account": {
            "account_name": "Chi H",
            "account_number": "1234567890",
            "bank_code": "VE000",
            "bank_name": "Vesicash"
        },
        "created_at": "2024-07-15T14:00:22.711256Z",
        "email": "[email protected]",
        "first_name": "Ade",
        "has_accepted": true,
        "id": 264,
        "is_initiator": false,
        "last_name": "Tolu",
        "percentage": 0,
        "phone": "[phone]",
        "role": "buyer",
        "role_description": "service seller",
        "transaction_id": "tr50fa18ad05e647b8b910",
        "transaction_party_id": "a97abd76ff8745e3b7b0",
        "updated_at": "2024-07-15T14:38:25.08535343Z",
        "user_id": "9226511842"
    }
}

For example, you can make a PATCH request to the endpoint above and pass in the raw json data below to edit party.

{
    "email": "[email protected]",
    "first_name": "Ade",
    "last_name": "Tolu",
    "phone": "[phone]",
    "is_initiator": false,
    "role_description": "service seller",
    "bank_account": {
        "bank_name": "Vesicash",
        "bank_code": "VE000",
        "account_number": "",
        "account_name": "Chi H"
    }
}