Cancel a Transaction Intent

Cancel a Transaction Intent

POST /service/v1.1/transaction_intents/:intentId/cancel

You can cancel a transaction intent as long as it has the status "NEEDS_CONFIRMATION". This will immediately release the funds back into the giftcard.

Path Parameters

Name	Type	Description
intentId	string	Unique ID of the transaction intent.

200 The transaction intent, cancelled.Example

{
    "expiresAt": "20171127T052256Z",
    "statementDescriptor": "MegaStore",
    "retailerId": "15h3k83g45anfnwibyie",
    "amount": 200,
    "giftcardId": "18jja4mf08fn08f7gp9l",
    "id": "18k78hj3e2j65686vhipw560u6sm",
    "status": "CANCELLED",
    "createdAt": "20171127T045256Z",
    "currency": "EUR",
    "metadata": {
        "store": "megastore-filiale-holzweg",
        "receiptNumber": "Bon 2017-79732"
    }
}

Example Request

cURL

curl -X POST https://posapi.zmyledemo.de/service/v1.1/transaction_intents/18k78hj3e2j65686vhipw560u6sm/cancel \
  -u {api_key}:{api_secret}

Response Error Codes

error code	reason
api:io:malformedId	The transaction intent ID is not right.
api:biz:noSuchTransactionIntent	The API could not find the transaction intent.
api:biz:transactionIntentStatus	This transaction intent cannot be cancelled b/c its status does not allow cancellation.