> For clean Markdown of any page, append .md to the page URL.
> For a complete documentation index, see https://docs.schoolset.io/llms.txt.
> For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://docs.schoolset.io/_mcp/server.

# Get parent payment details

GET https://ssuccessv2.com/app/api/v1/portal/pay/payment/details

Returns the active contract's statement balances, used contracts, currency, payment settings, merchant accounts, and payer processing-fee flags for the signed-in parent.

Reference: https://docs.schoolset.io/api-reference/school-set-api/parent-portal-payments/get-portal-payment-details

## Authentication

- `Authorization` header (bearer token, required) — The signed-in SchoolSet user token sent by the frontend.

## Response

### 200

Payment details returned.

- `status` (string, required)
- `message` (string, required)
- `data` (ApiV1PortalPayPaymentDetailsGetResponsesContentApplicationJsonSchemaData, required)

## Errors

### 400 Bad Request Error

Parent family or contract not found.

- `status` (string, required)
- `message` (string, required)
- `data` (any, optional, nullable)

### 401 Unauthorized Error

Unauthenticated.

- `status` (string, required)
- `message` (string, required)
- `data` (any, optional, nullable)

### 403 Forbidden Error

Missing create-payment-portal permission.

- `status` (string, required)
- `message` (string, required)
- `data` (any, optional, nullable)

## Types

### ApiV1PortalPayPaymentDetailsGetResponsesContentApplicationJsonSchemaData

- `contract_id` (integer, optional)
- `hash` (string, optional, nullable)
- `currency` (string, optional)
- `statement_total_due` (double, optional)
- `statement_current_due` (double, optional)
- `used_contracts` (list of map from string to any, optional)
- `merchant_account` (map from string to any, optional)
- `payment_settings` (map from string to any, optional, nullable)

## Examples

**Response**

```json
{
  "status": "success",
  "message": "",
  "data": {
    "contract_id": 731,
    "hash": null,
    "currency": "USD",
    "statement_total_due": 850,
    "statement_current_due": 850,
    "used_contracts": [],
    "merchant_account": {
      "cc": {
        "id": 5,
        "name": "School card account"
      },
      "ach": null
    },
    "payment_settings": {
      "fee_coverage_enabled": true
    }
  }
}
```

**SDK Code**

```python
import requests

url = "https://ssuccessv2.com/app/api/v1/portal/pay/payment/details"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.json())
```

```javascript
const url = 'https://ssuccessv2.com/app/api/v1/portal/pay/payment/details';
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}
```

```go
package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://ssuccessv2.com/app/api/v1/portal/pay/payment/details"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}
```

```ruby
require 'uri'
require 'net/http'

url = URI("https://ssuccessv2.com/app/api/v1/portal/pay/payment/details")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body
```

```java
import com.mashape.unirest.http.HttpResponse;
import com.mashape.unirest.http.Unirest;

HttpResponse<String> response = Unirest.get("https://ssuccessv2.com/app/api/v1/portal/pay/payment/details")
  .header("Authorization", "Bearer <token>")
  .asString();
```

```php
<?php
require_once('vendor/autoload.php');

$client = new \GuzzleHttp\Client();

$response = $client->request('GET', 'https://ssuccessv2.com/app/api/v1/portal/pay/payment/details', [
  'headers' => [
    'Authorization' => 'Bearer <token>',
  ],
]);

echo $response->getBody();
```

```csharp
using RestSharp;

var client = new RestClient("https://ssuccessv2.com/app/api/v1/portal/pay/payment/details");
var request = new RestRequest(Method.GET);
request.AddHeader("Authorization", "Bearer <token>");
IRestResponse response = client.Execute(request);
```

```swift
import Foundation

let headers = ["Authorization": "Bearer <token>"]

let request = NSMutableURLRequest(url: NSURL(string: "https://ssuccessv2.com/app/api/v1/portal/pay/payment/details")! as URL,
                                        cachePolicy: .useProtocolCachePolicy,
                                    timeoutInterval: 10.0)
request.httpMethod = "GET"
request.allHTTPHeaderFields = headers

let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
  if (error != nil) {
    print(error as Any)
  } else {
    let httpResponse = response as? HTTPURLResponse
    print(httpResponse)
  }
})

dataTask.resume()
```