---
agentTools:
  projectIndex: https://dev.fitbank.com.br/llms.txt
---

# Recharge Merchant Account

In this API it is possible to top up the merchant account, where the money goes from the arrangement account to the merchant account.

# OpenAPI definition

```json
{
  "openapi": "3.0.0",
  "info": {
    "title": "FitBank Closed Loop API",
    "description": "Requests related to ApiRest.",
    "termsOfService": "https://www.fitbank.com.br/",
    "contact": {
      "name": "Fitbank",
      "url": "https://www.fitbank.com.br/",
      "email": "contato@fitbank.com.br"
    },
    "license": {
      "name": "Apache 2.0",
      "url": "http://www.apache.org/licenses/LICENSE-2.0.html"
    },
    "version": "1.4.1"
  },
  "servers": [
    {
      "url": "https://sandboxapi.fitbank.com.gt/main/execute"
    }
  ],
  "paths": {
    "/RechargeLockerAccount": {
      "post": {
        "tags": [
          "Merchant"
        ],
        "summary": "Recharge Merchant Account",
        "description": "In this API it is possible to top up the merchant account, where the money goes from the arrangement account to the merchant account.\n",
        "requestBody": {
          "$ref": "#/components/requestBodies/RechargeLockerAccount"
        },
        "responses": {
          "200": {
            "$ref": "#/components/responses/RechargeLockerAccountResponse"
          }
        },
        "security": [
          {
            "BASE64-username.password": []
          }
        ]
      }
    }
  },
  "components": {
    "schemas": {
      "Success": {
        "type": "boolean",
        "description": "True or False",
        "example": true
      },
      "Message": {
        "type": "string",
        "description": "Returned message",
        "example": "Purchase generated successfully"
      },
      "DocumentNumber": {
        "type": "integer",
        "description": "Transaction id",
        "example": 656
      },
      "BusinessUnitId": {
        "type": "integer",
        "description": "Number Of The BusinessUnit",
        "example": 4548
      },
      "PartnerId": {
        "type": "integer",
        "description": "Number Of The Partner",
        "example": 4548
      },
      "RechargeValue": {
        "type": "number",
        "description": "Value Of The Transaction",
        "example": 2.95
      },
      "Identifier": {
        "type": "string",
        "description": "Identifier Of The Transaction",
        "example": "PurchaseTest1106new4"
      },
      "OriginAccount": {
        "type": "string",
        "description": "Arrangement Account Key",
        "example": "378320-014700-0146333-1"
      },
      "LockerAccount": {
        "type": "string",
        "description": "Merchant Account Identifier",
        "example": "498191-209911-9590853-5"
      },
      "RechargeLockerAccount": {
        "type": "object",
        "properties": {
          "Success": {
            "$ref": "#/components/schemas/Success"
          },
          "Message": {
            "$ref": "#/components/schemas/Message"
          },
          "DocumentNumber": {
            "$ref": "#/components/schemas/DocumentNumber"
          }
        }
      }
    },
    "responses": {
      "RechargeLockerAccountResponse": {
        "description": "Recharge Locker Account",
        "content": {
          "application/json": {
            "schema": {
              "$ref": "#/components/schemas/RechargeLockerAccount"
            },
            "examples": {
              "OK - RechargeLockerAccount": {
                "description": "Successfully Recharge Locker Account",
                "value": {
                  "Success": "true",
                  "Message": "Recharge request registered successfully",
                  "DocumentNumber": 548
                }
              },
              "ERROR - RechargeLockerAccount with the Arrangement Account without Balance": {
                "description": "RechargeLockerAccount with the Arrangement Account without Balance",
                "value": {
                  "Success": "false",
                  "Message": "Error in recharge Request",
                  "DocumentNumber": 484
                }
              },
              "ERROR - RechargeLockerAccount with invalid Merchant AccountKey": {
                "description": "RechargeLockerAccount with invalid Merchant AccountKey",
                "value": {
                  "Success": "false",
                  "Message": "The locker account is invalid",
                  "Validation": []
                }
              }
            }
          }
        }
      }
    },
    "requestBodies": {
      "RechargeLockerAccount": {
        "content": {
          "application/json": {
            "schema": {
              "required": [
                "BusinessUnitId",
                "Description",
                "Identifier",
                "LockerAccount",
                "Method",
                "OriginAccount",
                "PartnerId",
                "RechargeValue"
              ],
              "type": "object",
              "properties": {
                "Method": {
                  "type": "string",
                  "description": "Text Containing The Name Of The Method",
                  "example": "RechargeLockerAccount"
                },
                "PartnerId": {
                  "$ref": "#/components/schemas/PartnerId"
                },
                "BusinessUnitId": {
                  "$ref": "#/components/schemas/BusinessUnitId"
                },
                "RechargeValue": {
                  "$ref": "#/components/schemas/RechargeValue"
                },
                "Identifier": {
                  "$ref": "#/components/schemas/Identifier"
                },
                "OriginAccount": {
                  "$ref": "#/components/schemas/OriginAccount"
                },
                "LockerAccount": {
                  "$ref": "#/components/schemas/LockerAccount"
                },
                "Description": {
                  "type": "string",
                  "description": "Description/Explanation of the transaction",
                  "example": "Store 24 account recharge transaction"
                }
              }
            },
            "examples": {
              "OK - RechargeLockerAccount": {
                "description": "Successful recharge of store account",
                "value": {
                  "Method": "RechargeLockerAccount",
                  "BusinessUnitId": 30472,
                  "PartnerId": 10409,
                  "RechargeValue": 50,
                  "Identifier": "TRA16525a8c-ce83-4e4f-af48-e992ea19cd63TRA",
                  "OriginAccount": "378320-014700-0146333-1",
                  "LockerAccount": "498191-209911-9590853-5",
                  "Description": "Store 24 account recharge transaction"
                }
              },
              "ERROR - RechargeLockerAccount with the Arrangement Account without Balance": {
                "description": "RechargeLockerAccount with the Arrangement Account without Balance",
                "value": {
                  "Method": "RechargeLockerAccount",
                  "BusinessUnitId": 30472,
                  "PartnerId": 10409,
                  "RechargeValue": 50,
                  "Identifier": "TRA16525a8c-ce83-4e4f-af48-e992ea19cd63TRA",
                  "OriginAccount": "378320-014700-0146333-1",
                  "LockerAccount": "498191-209911-9590853-5",
                  "Description": "Store 24 account recharge transaction"
                }
              },
              "ERROR - RechargeLockerAccount with invalid Merchant AccountKey": {
                "description": "RechargeLockerAccount with invalid Merchant AccountKey",
                "value": {
                  "Method": "RechargeLockerAccount",
                  "BusinessUnitId": 30472,
                  "PartnerId": 10409,
                  "RechargeValue": 50,
                  "Identifier": "TRA16525a8c-ce83-4e4f-af48-e992ea19cd63TRA",
                  "OriginAccount": "378320-014700-0146333-1",
                  "LockerAccount": "498191-209911-9590853-8",
                  "Description": "Store 24 account recharge transaction"
                }
              }
            }
          }
        }
      }
    },
    "securitySchemes": {
      "BASE64-username.password": {
        "type": "http",
        "scheme": "basic"
      }
    }
  },
  "x-readme": {
    "explorer-enabled": true,
    "proxy-enabled": true
  },
  "_id": {
    "buffer": {
      "0": 102,
      "1": 172,
      "2": 81,
      "3": 3,
      "4": 44,
      "5": 192,
      "6": 38,
      "7": 0,
      "8": 89,
      "9": 11,
      "10": 147,
      "11": 76
    }
  }
}
```