Get a student's fee account

• Authorizationstringheaderrequired

  Your secret key as a bearer token, in the form Bearer ks_live_sk_... or Bearer ks_test_sk_.... Keep it on your server. A test key gets the documented example and touches no school data.

• studentIdstringpathrequired

  Example: 305

• sessionIdintegerquery

  Example: 3

200, application/json

• dataobjectrequired

  Show child attributesHide child attributes

  • idnumberrequired

  • studentIdnumberrequired

  • studentCodestringrequired

  • studentNamestringrequired

  • academicSessionIdnumberrequired

  • totalDuenumberrequired

    Major units of the school currency (naira for NGN), not kobo.

  • totalPaidnumberrequired

    Major units of the school currency (naira for NGN), not kobo.

  • totalDiscountnumberrequired

    Major units of the school currency (naira for NGN), not kobo. Waivers and discounts.

  • carriedForwardnumberrequired

    Major units of the school currency (naira for NGN), not kobo.

  • balancenumberrequired

    Major units of the school currency (naira for NGN), not kobo. Outstanding on the account.

  • feeItemsobject[]required

    Show child attributes of each itemHide child attributes of each item

    • idnumberrequired

      The fee structure id.

    • namestringrequired

    • categorystringrequired

    • amountnumberrequired

      Major units of the school currency (naira for NGN), not kobo.

    • paidnumberrequired

      Major units of the school currency (naira for NGN), not kobo.

    • balancenumberrequired

      Major units of the school currency (naira for NGN), not kobo. What is still settleable on this item: the account-level waiver or discount is apportioned across the items, so the item balances never sum past the account balance.

    • isMandatorybooleanrequired

• metaobjectrequired

  Show child attributesHide child attributes

  • request_idstringrequired

    Also returned in the X-Request-ID header.

  • paginationobject

    Show child attributesHide child attributes

    • limitintegerrequired

      Required range: x <= 100

    • has_morebooleanrequired

    • next_cursorstring or nullrequired

      Send this back as cursor for the next page. Opaque: never parse it.

• 401invalid_api_keyNo key was presented, or the key is not valid.
• 402insufficient_balanceThe school's service wallet cannot cover this call.
• 403insufficient_scopeThe app does not hold the scope this endpoint needs.
• 404endpoint_not_exposedThis endpoint is not part of the API.
• 429rate_limitedThe rate limit was reached. Retry after the Retry-After header says.
• 503platform_unavailableThe API is not available for this school right now.

What each code means, and what to do about it, is in the errors guide.

This call triggers no webhook event.