You can process full or partial refunds after a transaction is settled. The refund can also be associated with specific line items. If a non 0 refund amount and line items are not specified, all items and the entire transaction amount will be refunded.

ArgumentsDescriptionRequiredLocation
:tx-idIdentifier of the transaction to be retrievedYesRequest Parameter
type"refund" should be the value of the type provided in the request bodyYesRequest Body
lineItemsArray of line item types you want to associate with the authorizationNoRequest Body
amountThe amount to refund, which must be less than or equal to the original amountNoRequest Body
POST https://api.getbread.com/transactions/actions/:tx-id
{
  "type": "refund",
  "amount": 5000,
  "lineItems": [{ //optional
    "sku": "product-sku-1",
    "quantity": 1
  },
  {
    "sku": "product-sku-2",
    "quantity": 3
  }],
}
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":"refund", "amount":3200}'