List a family's saved payment wallets

GET

https://ssuccessv2.com/app/api/v1/family/:id/wallets

GET

/app/api/v1/family/:id/wallets

$ curl https://ssuccessv2.com/app/api/v1/family/2481/wallets \
>      -H "Authorization: Bearer <token>"

1 {
2   "status": "success",
3   "message": "",
4   "data": [
5     {
6       "id": 610,
7       "wallet_type": {
8         "id": 1,
9         "name": "Credit Card"
10       },
11       "wallet_data": {
12         "last4": "4242",
13         "brand": "Visa"
14       },
15       "wallet_description": "Family Visa ending in 4242",
16       "merchant_account_type": {},
17       "merchant_account_customer_info": {},
18       "merchant_account_id": 12,
19       "active": true,
20       "wallet_status_id": 1,
21       "alerts": [
22         {}
23       ],
24       "info": {},
25       "payer_id": 734,
26       "payer_type": "ParentStudent",
27       "payer_name": "Rachel Cohen",
28       "priority": 1,
29       "removed_on_gateway": false
30     }
31   ]
32 }

Returns the active and historical wallets associated with the family, including payer and gateway metadata.

Authentication

AuthorizationBearer

The signed-in SchoolSet user token sent by the frontend.

Path parameters

idlongRequired

Response

Wallets returned.

statusstring

messagestring

datalist of objects

Errors

401

Unauthorized Error

403

Forbidden Error

404

Not Found Error