# Save Refunds

Save Refunds

Endpoint: POST /rest/2.0/REFUND
Version: 1.0
Security: JWT

## Header parameters:

  - `sessionId` (string, required)

## Request fields (application/json; charset=utf-8):

  - `brmObjects` (object)

  - `brmObjects.Note` (string, required)
    Refund Notes

  - `brmObjects.AccountingPeriodId` (integer)
    Accounting Period

  - `brmObjects.VoidFlag` (string)
    Voided

  - `brmObjects.Id` (string, required)
    Refund Item ID

  - `brmObjects.VoidedRefundId` (integer)
    Voided To

  - `brmObjects.Created` (string)
    System controlled field: Date and time the record was created

  - `brmObjects.VoidRefundItemId` (integer)
    Voided By

  - `brmObjects.RefundType` (string, required)
    Refund Type

  - `brmObjects.GatewayTransactionId` (string)
    Gateway Transaction Id

  - `brmObjects.gatewayResponseCode` (string)
    Gateway Response Code

  - `brmObjects.Status` (string, required)
    Status

  - `brmObjects.PaymentItemId` (integer)
    PaymentItemId

  - `brmObjects.CreatedUserId` (string)
    System controlled field: Id of the user that created the record

  - `brmObjects.UpdatedUserId` (string)
    System controlled field: Id of the last user that updated the record

  - `brmObjects.Updated` (string)
    System controlled field: Date and time the record was last updated

  - `brmObjects.gatewayResponseMessage` (string)
    Gateway Response Message

## Response 200 fields (application/json):

  - `retrieveResponse` (object)

  - `retrieveResponse.Note` (string)
    Refund Notes

  - `retrieveResponse.AccountingPeriodId` (integer)
    Accounting Period

  - `retrieveResponse.VoidFlag` (string)
    Voided

  - `retrieveResponse.Id` (string)
    Refund Item ID

  - `retrieveResponse.VoidedRefundId` (integer)
    Voided To

  - `retrieveResponse.Created` (string)
    System controlled field: Date and time the record was created

  - `retrieveResponse.VoidRefundItemId` (integer)
    Voided By

  - `retrieveResponse.RefundType` (string)
    Refund Type

  - `retrieveResponse.GatewayTransactionId` (string)
    Gateway Transaction Id

  - `retrieveResponse.gatewayResponseCode` (string)
    Gateway Response Code

  - `retrieveResponse.Status` (string)
    Status

  - `retrieveResponse.PaymentItemId` (integer)
    PaymentItemId

  - `retrieveResponse.CreatedUserId` (string)
    System controlled field: Id of the user that created the record

  - `retrieveResponse.UpdatedUserId` (string)
    System controlled field: Id of the last user that updated the record

  - `retrieveResponse.Updated` (string)
    System controlled field: Date and time the record was last updated

  - `retrieveResponse.gatewayResponseMessage` (string)
    Gateway Response Message

## Response 400 fields (application/json):

  - `error` (string)
    Bad request

  - `message` (string)
    Bad request

## Response 401 fields (application/json):

  - `error` (string)
    Unauthorized

  - `message` (string)
    Unauthorized

## Response 404 fields (application/json):

  - `error` (string)
    Not found

  - `message` (string)
    Not found

## Response 429 fields (application/json):

  - `error` (string)
    Too many requests

  - `message` (string)
    Too many requests

## Response 500 fields (application/json):

  - `error` (string)
    Internal error

  - `message` (string)
    Internal error