> 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.

# Add a payment for a payer

POST https://ssuccessv2.com/app/api/v2/payment/add
Content-Type: application/json

Creates or applies a SchoolSet payment using the payer, payment method, allocations, and optional gateway details sent by the payment form.

Reference: https://docs.schoolset.io/api-reference/school-set-api/payments/add-v-2-payment

## Authentication

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

## Request

### Body (application/json)

This endpoint expects an object.

- `payer_id` (integer, required)
- `payer_type` (enum, required)
  - Allowed values: `family`, `parent`, `student`, `donor`, `entity`
- `payment_amount` (double, required)
- `payment_method_id` (integer, required)
- `group` (enum, required)
  - Allowed values: `chargeNow`, `recurring`, `upcoming`, `manual`
- `payment_date` (datetime, optional, nullable)
- `payment_type_id` (integer, optional, nullable)
- `payment_status_id` (integer, optional, nullable)
- `note` (string, optional, nullable)
- `credit_type_id` (integer, optional, nullable)
- `fundraising_fund_id` (integer, optional, nullable)
- `fundraising_id` (integer, optional, nullable)
- `allocations` (list of ApiV2PaymentAddPostRequestBodyContentApplicationJsonSchemaAllocationsItems, optional)
- `fee_coverage` (boolean, optional, nullable)
- `fee_coverage_apply_to` (list of enum, optional)
  - Allowed values: `tuition`, `fundraising`
- `grace_period` (integer, optional, nullable)
- `secondary_wallet_id` (integer, optional, nullable)
- `payment_recurring_period_id` (integer, optional, nullable)
- `of_installments` (integer, optional, nullable)
- `payment_plan` (list of ApiV2PaymentAddPostRequestBodyContentApplicationJsonSchemaPaymentPlanItems, optional, nullable)
- `payment_data` (map from string to any, optional, nullable)
- `wallet_id` (integer, optional, nullable)
- `payment_id` (integer, optional, nullable)
- `method` (enum, optional, nullable)
  - Allowed values: `new`, `pay`, `replace`
- `scheduled_applications` (list of ApiV2PaymentAddPostRequestBodyContentApplicationJsonSchemaScheduledApplicationsItems, optional, nullable)
- `merchant_account_id` (integer, optional, nullable)
- `card_token` (string, optional, nullable)
- `credit_card_number` (double, optional, nullable)
- `credit_card_exp_date` (string, optional, nullable)
- `credit_card_cvc` (integer, optional, nullable)
- `customer_billing_name` (string, optional, nullable)
- `customer_address_1` (string, optional, nullable)
- `customer_address_2` (string, optional, nullable)
- `customer_city` (string, optional, nullable)
- `customer_state` (string, optional, nullable)
- `customer_zip` (string, optional, nullable)
- `customer_country` (string, optional, nullable)
- `customer_phone` (string, optional, nullable)
- `customer_email` (string, optional, nullable)
- `routing_number` (string, optional, nullable)
- `account_number` (string, optional, nullable)
- `name_on_account` (string, optional, nullable)
- `bank_name` (string, optional, nullable)
- `account_type` (enum, optional, nullable)
  - Allowed values: `checking`, `savings`, `businessChecking`

## Response

### 200

Payment accepted or scheduled

- `status` (string, optional)
- `message` (string, optional)
- `data` (map from string to any, optional)

## Errors

### 400 Bad Request Error

Invalid allocation

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

### 401 Unauthorized Error

Authentication is required

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

### 403 Forbidden Error

SchoolSet permission or scope denied

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

### 404 Not Found Error

Payer or payment method was not found

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

### 422 Unprocessable Entity Error

Request validation failed

- `message` (string, required)
- `errors` (map from string to list of string, required)

## Types

### ApiV2PaymentAddPostRequestBodyContentApplicationJsonSchemaAllocationsItems

- `amount` (double, required)
- `id` (integer, optional, nullable)
- `fee_id` (integer, optional, nullable)
- `independent_fee_id` (integer, optional, nullable)
- `pledge_id` (integer, optional, nullable)

### ApiV2PaymentAddPostRequestBodyContentApplicationJsonSchemaPaymentPlanItems

### ApiV2PaymentAddPostRequestBodyContentApplicationJsonSchemaScheduledApplicationsItems

## Examples

**Request**

```json
{
  "payer_id": 1842,
  "payer_type": "family",
  "payment_amount": 425.5,
  "payment_method_id": 1,
  "group": "chargeNow"
}
```

**Response**

```json
{
  "status": "success",
  "message": "Payment accepted",
  "data": {}
}
```

**SDK Code**

```python
import requests

url = "https://ssuccessv2.com/app/api/v2/payment/add"

payload = {
    "payer_id": 1842,
    "payer_type": "family",
    "payment_amount": 425.5,
    "payment_method_id": 1,
    "group": "chargeNow"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.json())
```

```javascript
const url = 'https://ssuccessv2.com/app/api/v2/payment/add';
const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: '{"payer_id":1842,"payer_type":"family","payment_amount":425.5,"payment_method_id":1,"group":"chargeNow"}'
};

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"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://ssuccessv2.com/app/api/v2/payment/add"

	payload := strings.NewReader("{\n  \"payer_id\": 1842,\n  \"payer_type\": \"family\",\n  \"payment_amount\": 425.5,\n  \"payment_method_id\": 1,\n  \"group\": \"chargeNow\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	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/v2/payment/add")

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

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"payer_id\": 1842,\n  \"payer_type\": \"family\",\n  \"payment_amount\": 425.5,\n  \"payment_method_id\": 1,\n  \"group\": \"chargeNow\"\n}"

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.post("https://ssuccessv2.com/app/api/v2/payment/add")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"payer_id\": 1842,\n  \"payer_type\": \"family\",\n  \"payment_amount\": 425.5,\n  \"payment_method_id\": 1,\n  \"group\": \"chargeNow\"\n}")
  .asString();
```

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

$client = new \GuzzleHttp\Client();

$response = $client->request('POST', 'https://ssuccessv2.com/app/api/v2/payment/add', [
  'body' => '{
  "payer_id": 1842,
  "payer_type": "family",
  "payment_amount": 425.5,
  "payment_method_id": 1,
  "group": "chargeNow"
}',
  'headers' => [
    'Authorization' => 'Bearer <token>',
    'Content-Type' => 'application/json',
  ],
]);

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

```csharp
using RestSharp;

var client = new RestClient("https://ssuccessv2.com/app/api/v2/payment/add");
var request = new RestRequest(Method.POST);
request.AddHeader("Authorization", "Bearer <token>");
request.AddHeader("Content-Type", "application/json");
request.AddParameter("application/json", "{\n  \"payer_id\": 1842,\n  \"payer_type\": \"family\",\n  \"payment_amount\": 425.5,\n  \"payment_method_id\": 1,\n  \"group\": \"chargeNow\"\n}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);
```

```swift
import Foundation

let headers = [
  "Authorization": "Bearer <token>",
  "Content-Type": "application/json"
]
let parameters = [
  "payer_id": 1842,
  "payer_type": "family",
  "payment_amount": 425.5,
  "payment_method_id": 1,
  "group": "chargeNow"
] as [String : Any]

let postData = JSONSerialization.data(withJSONObject: parameters, options: [])

let request = NSMutableURLRequest(url: NSURL(string: "https://ssuccessv2.com/app/api/v2/payment/add")! as URL,
                                        cachePolicy: .useProtocolCachePolicy,
                                    timeoutInterval: 10.0)
request.httpMethod = "POST"
request.allHTTPHeaderFields = headers
request.httpBody = postData as Data

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()
```