--- updatedAt: 2026-07-09T19:39:10.000Z agentTools: projectIndex: https://developer.i-payout.com/llms.txt --- # Get merchant's balance history The API provides information about the merchant's balance history # OpenAPI definition ```json { "openapi": "3.0.1", "info": { "title": "IPS Portal Rest API - V1", "description": "i-payout API", "contact": { "name": "i-payout tech support", "email": "techsupport@i-payout.com" }, "license": { "name": "i-payout API", "url": "http://www.i-payout.com" }, "version": "v1" }, "paths": { "/api/v1/merchants/balance-histories/{type}/{currency-code}": { "get": { "tags": [ "Merchant" ], "summary": "Get merchant's balance history", "description": "The API provides information about the merchant's balance history", "operationId": "get-merchant-balance-history", "parameters": [ { "name": "type", "in": "path", "description": "Specifies the balance type. Available values : eWallet Invoice Balance = 1, Funding Return Balance = 2, Public Invoice Balance = 3, Instant Bank Transfer Balance = 4 and eWallet Balance = 5", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "currency-code", "in": "path", "description": "Three-letter alphabetic codes that represent the various currencies used throughout the world", "required": true, "schema": { "type": "string" } }, { "name": "startDate", "in": "query", "description": "Start Date is in the yyyy-MM-dd format and follows ISO 8601 date format", "schema": { "type": "string" } }, { "name": "endDate", "in": "query", "description": "End Date is in the yyyy-MM-dd format and follows ISO 8601 date format", "schema": { "type": "string" } }, { "name": "pageNumber", "in": "query", "description": "Current page number", "schema": { "type": "integer", "format": "int32", "default": 1 } }, { "name": "pageSize", "in": "query", "description": "Number of records per page", "schema": { "type": "integer", "format": "int32", "default": 100 } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResponseMerchantHistory" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResponseMerchantHistory" } } } }, "500": { "description": "Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResponse" } } } } }, "security": [ { "Bearer": [], "X-MerchantId": [] } ] } } }, "components": { "schemas": { "ApiResponse": { "type": "object", "properties": { "isSuccess": { "type": "boolean", "description": "Indicates if the API call was successful or not." }, "message": { "type": "string", "description": "A human readable status message that may be used for debugging.", "nullable": true }, "statusCode": { "$ref": "#/components/schemas/StatusConstants" }, "logIdentifier": { "type": "string", "description": "Utilized for support, a log identifier to provide to i-payout when requesting technical support.", "nullable": true } }, "additionalProperties": false, "description": "Standard API Response object." }, "ApiResponseMerchantHistory": { "type": "object", "properties": { "isSuccess": { "type": "boolean", "description": "Indicates if the API call was successful or not." }, "message": { "type": "string", "description": "A human readable status message that may be used for debugging.", "nullable": true }, "statusCode": { "$ref": "#/components/schemas/StatusConstants" }, "logIdentifier": { "type": "string", "description": "Utilized for support, a log identifier to provide to i-payout when requesting technical support.", "nullable": true }, "data": { "$ref": "#/components/schemas/MerchantHistoryDetailsDto" } }, "additionalProperties": false }, "MerchantHistoryDetailsDto": { "type": "object", "properties": { "totalCount": { "type": "integer", "description": "Total number of items on all pages", "format": "int32" }, "pageNumber": { "type": "integer", "description": "Current page number", "format": "int32" }, "pageSize": { "type": "integer", "description": "Number of records per page", "format": "int32" }, "pageCount": { "type": "integer", "description": "Total number of pages", "format": "int32" }, "merchantHistory": { "type": "array", "items": { "$ref": "#/components/schemas/MerchantHistoryDto" }, "description": "List which contains Merchant's history details", "nullable": true } }, "additionalProperties": false }, "MerchantHistoryDto": { "type": "object", "properties": { "amount": { "type": "number", "description": "Amount", "format": "double" }, "balance": { "type": "number", "description": "Merchant balance amount", "format": "double" }, "balanceType": { "type": "string", "description": "Balance type", "nullable": true }, "comments": { "type": "string", "description": "Comments", "nullable": true }, "currency": { "type": "string", "description": "Currency Code", "nullable": true }, "transactionDate": { "type": "string", "description": "Transaction Date", "format": "date-time" }, "holdAmount": { "type": "number", "description": "The amount on hold", "format": "double" }, "holdBalance": { "type": "number", "description": "The balance on hold after the transaction", "format": "double" }, "holdExpirationDate": { "type": "string", "description": "Hold expiration date", "format": "date-time", "nullable": true }, "holdReleasedDate": { "type": "string", "description": "Hold released date", "format": "date-time", "nullable": true }, "entity": { "type": "string", "description": "The entity involved in the transaction", "nullable": true }, "fee": { "type": "number", "description": "The fee associated with the transaction", "format": "double" }, "isDebited": { "type": "boolean", "description": "Indicates if the transaction is debited" }, "isHoldReleased": { "type": "boolean", "description": "Indicates if the hold is released" }, "runningBalance": { "type": "number", "description": "The running balance after the transaction.", "format": "double" }, "status": { "type": "string", "description": "Status", "nullable": true }, "transactionID": { "type": "integer", "description": "The unique identifier of the transaction", "format": "int64" }, "transactionType": { "type": "string", "description": "Transaction type", "nullable": true }, "userName": { "type": "string", "description": "User name", "nullable": true }, "recordID": { "type": "integer", "description": "The unique identifier of the record", "format": "int64" }, "transactionGUID": { "type": "string", "description": "The unique GUID of the transaction", "format": "uuid" } }, "additionalProperties": false }, "StatusConstants": { "enum": [ "NO_ERROR", "EMAIL_ADDRESS_EXISTS", "CAPTCHA_FAILED", "INVALID_REFERENCEID", "INVALID_OPERATION", "INVALID_TIN_VALIDATION_STATUS", "RECORD_NOT_FOUND", "Already_Exist", "Batch_Closed", "IP_BLACKLISTED", "CREDIT_CARD_PROCESSOR_ISSUE", "FEES_NOT_ACCEPTED", "PAYOUT_CAPABILITIES_DISABLED", "INVALID_RECURRING_PAYMENT_STATUS", "INVOICE_CAPABILITIES_DISABLED", "INVALID_EWALLET_REGISTRATION", "PRIVATE_KEY_ISSUE", "FILE_NOT_EXISTS", "OLDUSER_NEWUSER_MISMATCH", "USER_CANNOT_CREATED", "CANNOT_CREATE_NEW_BATCH", "REFERENCEID_ALREADY_EXISTS", "DELETE_RECORD_ERROR", "FX_ConversionRate_Issue", "RATE_LIMIT_EXCEEDED", "IP_NOT_ALLOWED", "COUNTRY_NOT_ALLOWED", "INVALID_FIELD_VALUE_LENGTH", "UNAUTHORIZED_API_CALL", "FEE_VALUE_NOT_FOUND_FOR_CUSTOMER", "IPADDRESS_GENERATION_ISSUE", "MERCHANT_NOT_FOUND", "INVALID_PARAMS", "Missing_HEADER_PARAMS", "INVALID_URL", "INVALID_AMOUNT", "INVALID_CURRENCY", "REQUIRED_PARAMETER", "INVALID_REQUEST_PARAM", "INVALID_REQUEST_RESPONSE_PARAM", "INVALID_SERVER_CONFIG", "ACCESS_DENIED", "INVALID_COUNTRY_CODE", "PROCESSING", "PENDING", "NO_RECORDS_FOUND", "INVALID_MERCHANT", "PAL_INVALID_EMAIL", "INVALID_CARD_NUMBER", "INSUFFICIENT_FUNDS", "USERNAME_EXISTS", "USER_NOT_LOGGED_IN", "INVALID_CLIENT_CREDENTIALS", "ACCOUNT_NOT_FOUND", "GENERAL_ERROR", "CUSTOMER_NOT_FOUND", "INTERNAL_ERROR" ], "type": "string", "description": "Api response status code. For possible values, see Status Code Values ." } }, "securitySchemes": { "basic": { "type": "http", "description": "Use API username and password to get the dynamic bearer token which can be used to access all other API, Example: 'Basic 12345adfad'", "scheme": "basic" }, "Bearer": { "type": "apiKey", "description": "JWT Authorization header using the Bearer scheme.Enter 'Bearer' [space] and then your token in the text input below. Example: 'Bearer 12345abcdef'", "name": "Authorization", "in": "header" }, "X-MerchantId": { "type": "apiKey", "description": "Merchant Identifier (GUID)", "name": "X-MerchantId", "in": "header" } } }, "security": [ { "Bearer": [], "basic": [], "X-MerchantId": [] } ] } ```