Retrieve Mass Payout Balance

Retrieve Mass Payout Balance

get

https://api.iyzipay.comhttps://sandbox-api.iyzipay.com

/v1/mass/payout/balance

Displays the mass payout balance of the merchant.

Query parameters

localestring · enumRequired

Response language.

Possible values:

Header parameters

AuthorizationstringRequired

Authorization header; a signed hash value that starts with IYZWSv2 and is generated in Base64 format.

Example: IYZWSv2 aXBzaWduYXR1cmU...

Content-TypestringRequired

Content-Type value.

Example: application/json

Responses

200

Successful

application/json

Merchant mass payout balance response.

statusstring · enumOptionalPossible values:

systemTimeintegerOptional

balancedecimalOptional

Available balance amount for mass payout transactions.

get

/v1/mass/payout/balance

HTTPcURL

GET /v1/mass/payout/balance?locale=en HTTP/1.1
Host: api.iyzipay.com
Authorization: IYZWSv2 aXBzaWduYXR1cmU...
Content-Type: application/json

200

Successful

{
  "status": "success",
  "systemTime": 1759158319395,
  "balance": "25399393.5"
}