Credit/Refund Transaction

Use this endpoint to credit an item, items or shipping cost.

Post a transaction refund

POST https://apis.sandbox.flexshopper.com/v3/transactions/:id/refund

Communicate credits that will reconciled with transaction invoices.

Path Parameters

Name	Type	Description
id	string	ID of transaction (order).

Headers

Name	Type	Description
Authorization	string	API auth token.

Request Body

Name	Type	Description
items.lineNumber*	integer	PO line number identifier.
items.sku*	string	Identifier for which item to apply the credit.
items.itemCredit	number	Amount to refund to apply to the cost of the item. Should be the full cost of the item.
items.shippingCredit	number	Amount to refund for shipping costs related to a specific item.
items	array	Array of items in a single transaction.

200 Credit successfully applied.

}
  "data": {
    "refunded": [
      {
        "sku": "ABC123",
        "lineNumber": 1
      }
    ]
  }
}

404 No transaction associated with this merchant with the provided ID.

{
  "error": {
    "statusCode": 404,
    "code": "TransactionNotFound",
    "message": "The transaction requested was not found",
    "data": {}
  }
}