Create Pledge Payment Add | SchoolSet

curl -X POST https://app.schoolset.io/app/api/v1/public/fundraising/pledge/payment/add/school_id/hash \
     -H "Content-Type: application/json" \
     -d '{
  "payment_amount": 150
}'

{
  "status": "success",
  "message": "Payment information created successfully.",
  "data": {
    "id": 1024,
    "donor": {},
    "payer_id": 5678,
    "payer_type": "individual",
    "can_edit_payer": false,
    "fundraising": {},
    "batch_id": 202,
    "amount_payment": 150,
    "base_amount_payment": 150,
    "payment_date": "2024-06-15T10:30:00Z",
    "currency": {},
    "method": {},
    "type": {},
    "payment_type": {},
    "payment_type_id": 3,
    "status": {},
    "billing_info": {},
    "check_date": "2024-06-15",
    "payment_source": "online_portal",
    "paid_recurring_payments": [
      "recurring_2024_06"
    ],
    "paid_upcoming_payments": [
      "upcoming_2024_07"
    ],
    "paid_recurring_payment": {},
    "paid_upcoming_payment": {},
    "replaces_payment": {},
    "replaced_payments": [
      "payment_1019"
    ],
    "successful_repeated_payment": {},
    "balance_after_collected_payment": 500,
    "contract_fees_sorts_global_split": {},
    "notes": [
      {}
    ],
    "attachments": [
      {}
    ],
    "emails": [
      "donor@example.com"
    ],
    "sms": [
      "+1234567890"
    ],
    "voice": [
      "+1234567890"
    ],
    "fee_actual": 4.5,
    "fee_fixed": 0.3,
    "fee_percentage": 3,
    "credit_type": {},
    "credit_payment": {},
    "merchant_account_customer_info": {},
    "merchant_account_id": 12,
    "merchant_account_type": {},
    "contract_id": 789,
    "replaced_payment_id": 1019,
    "payment_recurring_id": 345,
    "payment_upcoming_id": 678,
    "parent_repayment_id": 0,
    "payment_split_id": 234,
    "payment_split": {},
    "contract_fees_type": {},
    "previous_contract": {},
    "wallet": {},
    "cc_not_save": false,
    "secondary_wallet": {},
    "grace_period": "7",
    "allocations": [
      {}
    ],
    "allocated_amount": 150,
    "unallocated_amount": 0,
    "note": "Donation for school fundraising event.",
    "family_student_pay": {},
    "fee_coverage": 5,
    "payment_settings": {}
  }
}

Creates or returns payment information for the selected fundraising pledge.

Path parameters

school_idstringRequired

hashstringRequired

Request

This endpoint expects an object.

payment_amountdoubleRequired

Must be at least 1.

amount_per_installmentdouble or nullOptional

Must be at least 1.

payment_recurring_period_idinteger or nullOptional

payment recurring period ID identifier.

payment_planlist of objectsOptional

payment plan list.

payment_datestring or nullOptional

Must be a valid date. Must be a valid date in the format Y-m-d\TH:i:sP.

wallet_idinteger or nullOptional

wallet ID identifier.

secondary_wallet_idinteger or nullOptional

secondary wallet ID identifier.

walletobjectOptional

This field is required when wallet_id is not present.

secondary_walletobject or nullOptional

secondary wallet object.

donation_type_idinteger or nullOptional

donation type ID type value.

messagestring or nullOptional

Must not be greater than 1000 characters.

groupenumOptional

This field is required when wallet_id is not present.

Allowed values:

payment_method_idinteger or nullOptional

payment method ID identifier.

fee_coverageboolean or nullOptional

fee coverage flag.

Response

Successful POST response for /api/v1/public/fundraising/pledge/payment/add/{school_id}/{hash}.

statusstring

messagestring

dataobject