Skip to main content
PUT
https://staging-api.propaga.io/v1
/
transaction
/
{transactionId}
curl --location --request PUT 'https://staging-api.propaga.io/v1/transaction/{transactionId}' \
--header 'Authorization: <your_awesome_token>' \
--header 'Content-Type: application/json' \
--data '{
    "status": "cancel",
    "cancellationReason": ""
}'
{
    "success": true
}
You can only cancel a transaction if it has not yet been delivered. For additional details on how transaction statuses works, click this link
curl --location --request PUT 'https://staging-api.propaga.io/v1/transaction/{transactionId}' \
--header 'Authorization: <your_awesome_token>' \
--header 'Content-Type: application/json' \
--data '{
    "status": "cancel",
    "cancellationReason": ""
}'
{
    "success": true
}

Path parameters

transactionId
string
required
Propaga’s transaction id

Body

status
string
required
Transaction’s new status, in this case always had to be cancel
cancellationReason
string
Cancellation reason for this order.

Response

success
boolean

Error codes

Transaction not found (404)
{
    "errorCode": "TRANSACTION_NOT_FOUND",
    "errorMessage": "This transaction not found"
}
Transaction is not on a valid status to cancel (422)
{
    "errorCode": "TRANSACTION_STATUS_NOT_VALID_FOR_CANCELLATION",
    "errorMessage": "The status of this transaction is not valid for cancellation"
}