Cancel a transaction

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
}

PUT

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

string

required

Propaga’s transaction id

Body

string

required

Transaction’s new status, in this case always had to be cancel

string

Cancellation reason for this order.

Show Reasons

  DAMAGED_PRODUCT
  NEVER_RECEIVED
  MISSING_ITEMS_FROM_ORDER
  WRONG_PRODUCT
  CANCELLED_BY_USER

Response

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"
}

Notify transaction delivery Create a transaction simulation

Overview

Getting started

API Reference

Path parameters

Body

Response

Error codes

​Path parameters

​Body

​Response

​Error codes

Path parameters

Body

Response

Error codes