Create credit card wallet | SchoolSet

curl -X POST https://app.schoolset.io/app/api/v1/wallet/create/creditcard \
     -H "Authorization: Bearer <token>" \
     -H "Content-Type: application/json" \
     -d '{
  "payer_id": 12345,
  "payer_type": "family",
  "merchant_account_id": 67890
}'

{
  "status": "success",
  "message": "Credit card wallet created successfully.",
  "data": {
    "id": 98765,
    "wallet_type": {
      "id": 2,
      "title": "Credit Card Wallet",
      "description": "Wallet for storing credit card payment methods.",
      "sys_name": "credit_card_wallet",
      "slug": "credit-card-wallet"
    },
    "wallet_data": {},
    "wallet_description": "Primary credit card wallet for family payments.",
    "merchant_account_type": {
      "id": 3,
      "name": "Visa Merchant Account",
      "description": "Merchant account supporting Visa credit card transactions.",
      "sys_name": "visa_merchant_account",
      "slug": "visa-merchant-account",
      "ach_enabled": false,
      "credit_card_enabled": true
    },
    "merchant_account_customer_info": {},
    "merchant_account_id": 67890,
    "active": 1,
    "wallet_status_id": 1,
    "alerts": {},
    "info": {},
    "payer_id": 12345,
    "payer_type": "family",
    "priority": "normal",
    "removed_on_gateway": false
  }
}

Creates a credit-card wallet for the selected payer and returns the created wallet.

Authentication

AuthorizationBearer

You can retrieve your token by visiting your dashboard and clicking Generate API token.

Request

This endpoint expects an object.

payer_iddoubleRequired

payer ID identifier.

payer_typeenumRequired

payer type value.

merchant_account_iddoubleRequired

merchant account ID identifier.

wallet_descriptionstring or nullOptional

wallet description value.

activeboolean or nullOptional

active flag.

card_tokenstring or nullOptional

card token value.

credit_card_numberdoubleOptional

This field is required when card_token is not present.

credit_card_exp_datestringOptional

This field is required when card_token is not present. Must be a valid date in the format Y-m.

credit_card_cvcdoubleOptional

This field is required when card_token is not present.

customer_billing_namestring or nullOptional

customer billing name display value.

customer_address_1string or nullOptional

customer address 1 value.

customer_address_2string or nullOptional

customer address 2 value.

customer_citystring or nullOptional

customer city value.

customer_statestring or nullOptional

customer state value.

customer_zipstring or nullOptional

customer zip value.

customer_countrystring or nullOptional

customer country value.

customer_phonestring or nullOptional

customer phone phone number.

customer_emailstring or nullOptional

customer email used for login, contact, or delivery flows.

Response

Successful POST response for /api/v1/wallet/create/creditcard.

statusstring

messagestring

dataobject