# Save Surcharges ＆ Incentives

Save Surcharges ＆ Incentives

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

## Header parameters:

  - `sessionId` (string, required)

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

  - `brmObjects` (object)

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

  - `brmObjects.Value` (string)
    Value: Each payment record created in the system will be evaluated against the formula defined. If the formula calculates a surcharge for a payment, that surcharge amount will be added to the payment prior to being sent to a payment gateway

  - `brmObjects.DebitType` (string, required)
    Surcharge Debit Memo Type

  - `brmObjects.CreditType` (string, required)
    Surcharge Credit Memo Type

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

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

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

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

  - `brmObjects.Id` (string, required)
    Id: Primary key

## Response 200 fields (application/json):

  - `retrieveResponse` (object)

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

  - `retrieveResponse.Value` (string)
    Value: Each payment record created in the system will be evaluated against the formula defined. If the formula calculates a surcharge for a payment, that surcharge amount will be added to the payment prior to being sent to a payment gateway

  - `retrieveResponse.DebitType` (string)
    Surcharge Debit Memo Type

  - `retrieveResponse.CreditType` (string)
    Surcharge Credit Memo Type

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

  - `retrieveResponse.Status` (string)
    Status

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

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

  - `retrieveResponse.Id` (string)
    Id: Primary key

## 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