---
updatedAt: 2026-06-09T10:10:07.000Z
agentTools:
  projectIndex: https://www.payretailers.dev/llms.txt
---

# Get Merchant Balance

Use this call to retrieves your shop’s balance at any time.

# OpenAPI definition

```json
{
  "openapi": "3.1.0",
  "info": {
    "title": "transaction",
    "version": "3.3"
  },
  "servers": [
    {
      "url": "https://api-sandbox.payretailers.com/payments/v2"
    }
  ],
  "components": {
    "securitySchemes": {
      "sec0": {
        "type": "http",
        "scheme": "basic"
      }
    }
  },
  "security": [
    {
      "sec0": []
    }
  ],
  "paths": {
    "/shop-balance": {
      "get": {
        "summary": "Get Merchant Balance",
        "description": "Use this call to retrieves your shop’s balance at any time.",
        "operationId": "get-merchant-balance",
        "parameters": [
          {
            "name": "Ocp-Apim-Subscription-Key",
            "in": "header",
            "description": "The subscription key has a length of 32 characters and will be provided within the API keys. Will be available for new integrations from July 24th onwards.",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "200",
            "content": {
              "application/json": {
                "examples": {
                  "Result": {
                    "value": "{\n  \"transactionsBalance\": 0,\n  \"payoutsLocalBalance\": 18.24,\n  \"adjustmentMovementsBalance\": 705.23,\n  \"lastUpdateDate\": \"2020-08-19T14:14:47.517\",\n  \"balance\": 686.99,\n  \"payInBalance\": 705.23\n}"
                  }
                },
                "schema": {
                  "type": "object",
                  "properties": {
                    "transactionsBalance": {
                      "type": "integer",
                      "example": 0,
                      "default": 0
                    },
                    "payoutsLocalBalance": {
                      "type": "number",
                      "example": 18.24,
                      "default": 0
                    },
                    "adjustmentMovementsBalance": {
                      "type": "number",
                      "example": 705.23,
                      "default": 0
                    },
                    "lastUpdateDate": {
                      "type": "string",
                      "example": "2020-08-19T14:14:47.517"
                    },
                    "balance": {
                      "type": "number",
                      "example": 686.99,
                      "default": 0
                    },
                    "payInBalance": {
                      "type": "number",
                      "example": 705.23,
                      "default": 0
                    }
                  }
                }
              }
            }
          },
          "401": {
            "description": "401",
            "content": {
              "application/json": {
                "examples": {
                  "Result": {
                    "value": "{\n\t\"type\": \"https://tools.ietf.org/html/rfc7235#section-3.1\",\n\t\"title\": \"Unauthorized\",\n\t\"status\": 401,\n\t\"traceId\": \"00-53906d01ec2d7f44803c28e73e0777c3-5af0f714cae8a744-00\"\n}"
                  }
                },
                "schema": {
                  "type": "object",
                  "properties": {
                    "type": {
                      "type": "string",
                      "example": "https://tools.ietf.org/html/rfc7235#section-3.1"
                    },
                    "title": {
                      "type": "string",
                      "example": "Unauthorized"
                    },
                    "status": {
                      "type": "integer",
                      "example": 401,
                      "default": 0
                    },
                    "traceId": {
                      "type": "string",
                      "example": "00-53906d01ec2d7f44803c28e73e0777c3-5af0f714cae8a744-00"
                    }
                  }
                }
              }
            }
          }
        },
        "deprecated": false
      }
    }
  },
  "x-readme": {
    "headers": [
      {
        "key": "Content-Type",
        "value": "application/json"
      }
    ],
    "explorer-enabled": true,
    "proxy-enabled": true
  },
  "x-readme-fauxas": true
}
```