Miracle Docs
Financial statements

Get financial statement by ID

Returns the full details of a single financial statement, including aggregated volumes, fee breakdown, rolling reserve, recurrent fees, and net amounts. Returns 404 if the statement does not exist or is not visible to the caller.

GET
/v1/financial-statements/{id}
AuthorizationBearer <token>

In: header

Path Parameters

id*string

Response Body

application/json

curl -X GET "https://api.miracle.com/v1/financial-statements/string"
{
  "data": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "tenantId": "f97df110-f4de-492e-8849-4a6af68026b0",
    "livemode": true,
    "merchantId": "c3073b9d-edd0-49f2-a28d-b7ded8ff9a8b",
    "terminalId": "57e69e1b-2c00-4a26-b5e3-44617c6cc659",
    "currency": "string",
    "period": {
      "from": "string",
      "to": "string"
    },
    "volumes": {
      "payinCount": 0,
      "payinVolume": {
        "currency": "string",
        "valueMinor": 0
      },
      "refundCount": 0,
      "refundVolume": {
        "currency": "string",
        "valueMinor": 0
      },
      "chargebackCount": 0,
      "chargebackVolume": {
        "currency": "string",
        "valueMinor": 0
      },
      "withdrawalCount": 0,
      "withdrawalVolume": {
        "currency": "string",
        "valueMinor": 0
      },
      "payoutCount": 0,
      "payoutVolume": {
        "currency": "string",
        "valueMinor": 0
      }
    },
    "fees": {
      "merchantFee": {
        "currency": "string",
        "valueMinor": 0
      },
      "feeBreakdown": {
        "providerFee": {
          "currency": "string",
          "valueMinor": 0
        },
        "platformFee": {
          "currency": "string",
          "valueMinor": 0
        },
        "tenantFee": {
          "currency": "string",
          "valueMinor": 0
        },
        "partnerCommission": {
          "currency": "string",
          "valueMinor": 0
        }
      }
    },
    "rollingReserve": {
      "held": {
        "currency": "string",
        "valueMinor": 0
      },
      "released": {
        "currency": "string",
        "valueMinor": 0
      },
      "netReserve": {
        "currency": "string",
        "valueMinor": 0
      }
    },
    "recurrentFees": {
      "currency": "string",
      "valueMinor": 0
    },
    "netToMerchant": {
      "currency": "string",
      "valueMinor": 0
    },
    "netToProvider": {
      "currency": "string",
      "valueMinor": 0
    },
    "status": "unpaid",
    "settlementId": "b4887549-5aec-4adc-bf32-5fb69ede72ea",
    "createdAt": "string",
    "generatedAt": "string",
    "updatedAt": "string",
    "paidAt": "string",
    "deletedAt": "string"
  }
}
Empty

On this page