List wallets for a payer

POST

https://ssuccessv2.com/app/api/v1/wallet/payer

POST

/app/api/v1/wallet/payer

$ curl -X POST https://ssuccessv2.com/app/api/v1/wallet/payer \
>      -H "Authorization: Bearer <token>" \
>      -H "Content-Type: application/json" \
>      -d '{
>   "payer_id": 284,
>   "payer_type": "family_student"
> }'

1 {
2   "status": "success",
3   "message": "",
4   "data": [
5     {
6       "id": 913,
7       "wallet_type": {
8         "id": 1,
9         "name": "Credit Card"
10       },
11       "wallet_data": {
12         "cc_last_four": "4242",
13         "cc_exp_date": "2027-09"
14       },
15       "wallet_description": "Family Visa",
16       "merchant_account_type": {
17         "id": 1,
18         "name": "Stripe"
19       },
20       "merchant_account_customer_info": {
21         "customer_id": "cus_schoolset_284"
22       },
23       "merchant_account_id": 4,
24       "active": true,
25       "wallet_status_id": 1,
26       "alerts": [],
27       "info": {},
28       "payer_id": 284,
29       "payer_type": "family_student",
30       "payer_name": "Cohen Family",
31       "priority": "primary",
32       "removed_on_gateway": false
33     }
34   ]
35 }

Returns the active school's payment wallets for the payer identified by the submitted type and identifier.

Authentication

AuthorizationBearer

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

Request

This endpoint expects an object.

payer_idintegerRequired>=1

payer_typestringRequired

Response

Payer wallets returned as wallet resource records.

statusstringOptional

messagestringOptional

datalist of objectsOptional

Errors

401

Unauthorized Error

403

Forbidden Error

404

Not Found Error

422

Unprocessable Entity Error