You can process full or partial cancellations after a transaction is pending but before it’s settled. The cancellation can also be associated with specific line items. If the cancellation amount and line items are not specified, all items and the entire transaction amount will be cancelled.
| Arguments | Description | Required | Location |
|---|---|---|---|
| :tx-id | Identifier of the transaction to be retrieved | Yes | Request Parameter |
| type | "cancel" should be the value of the type provided in the request body | Yes | Request Body |
| lineItems | Array of line item types you want to associate with the authorization | No | Request Body |
| amount | The amount to cancel, which must be less than or equal to the original amount | No | Request Body |
POST https://api.getbread.com/transactions/actions/:tx-id
{
"type": "cancel",
"amount": 3200, //optional
"lineItems": [{ //optional
"sku": "product-sku-1",
"quantity": 1
},
{
"sku": "product-sku-2",
"quantity": 2
}]
}
curl -u <api-key>:<secret-key> -X POST -H 'Content-Type: application/json' \
https://api.getbread.com/transactions/actions/caf8afac-1a6f-4f55-a6d8-fd46763e8cb3 \
-d '{"type":"cancel", "amount":3200}'