Money · terra API

POST /v3/app/pay/wallet #

bearer driver_app beneficiary_app money.adjust device idempotency credential

Request body

Field	Type		Constraints
`wallet_id`	string (uuid)	required	—
`amount_minor`	integer	required	min 1 · max 100000000
`currency`	string	required	min length 3 · max length 3
`note`	string \| null	optional	max length 200
`pin`	string \| null	optional	max length 12
`category`	string \| null	optional	max length 64
`items`	object[]	optional	max items 50

Response

Returns { "data": WalletChargeReceipt }.

Field	Type		Constraints
`transaction_id`	string (uuid)	required	—
`type`	string	required	—
`state`	string	required	—
`customer`	any	required	—
`amount`	MoneyFormatted	required	—
`balance_after`	any	required	—

POST /v3/app/pos-category #

bearer driver_app beneficiary_app device credential

Request body

Field	Type		Constraints
`id`	string \| null	optional	—
`name`	string	required	max length 120
`active`	boolean \| null	optional	—
`color`	string \| null	optional	—

Response

Returns { "data": PosCategoryWrite }.

Field	Type		Constraints
`id`	string (uuid)	required	—
`name`	string	required	—
`active`	boolean	required	—
`color`	string \| null	required	—

POST /v3/app/pos-item #

bearer driver_app beneficiary_app device credential

Request body

Field	Type		Constraints
`id`	string \| null	optional	—
`name`	string	required	max length 120
`amount_minor`	integer	required	min 1 · max 100000000
`currency`	string	required	min length 3 · max length 3
`active`	boolean \| null	optional	—
`category_id`	string \| null	optional	—
`min_order_qty`	integer \| null	optional	min 1 · max 10000
`sku`	string \| null	optional	max length 64

Response

Returns { "data": PosItemWrite }.

Field	Type		Constraints
`id`	string (uuid)	required	—
`name`	string	required	—
`sku`	string \| null	required	—
`active`	boolean	required	—
`category_id`	string \| null	required	—
`beneficiary_wallet_id`	string \| null	required	—
`price`	MoneyFormatted	required	—
`min_order_qty`	integer	required	—

GET /v3/app/spending-profile #

bearer beneficiary_app parent_app device credential

Response

Returns { "data": [SpendingProfile] } with meta.next_cursor for the next page.

Field	Type		Constraints
`id`	string (uuid)	required	—
`name`	string	required	—
`description`	string \| null	optional	—
`daily_limit`	any	optional	—
`weekly_limit`	any	optional	—
`per_txn_limit`	any	optional	—
`allowed_zone_kinds`	string[]	optional	—
`time_windows`	object[]	optional	—

POST /v3/app/transfer #

bearer beneficiary_app parent_app device idempotency credential

Request body

Field	Type		Constraints
`from_wallet_id`	string (uuid)	required	—
`to_wallet_id`	string (uuid)	required	—
`amount_minor`	integer	required	min 1 · max -9223372036854775808
`currency`	string	required	min length 3 · max length 3
`note`	string \| null	optional	max length 255

Response

Returns { "data": … }; this endpoint's payload is not yet pinned to a named shape.

POST /v3/app/voucher/redeem #

bearer beneficiary_app parent_app device credential

Request body

Field	Type		Constraints
`code`	string	required	max length 32

Response

Returns { "data": … }; this endpoint's payload is not yet pinned to a named shape.

GET /v3/invoice #

bearer beneficiary_app parent_app device credential

Query parameters

Name	Type		Constraints
`status`	string \| null	optional	`draft` `open` `paid` `partially_paid` `overdue` `void`

Response

Returns { "data": … }; this endpoint's payload is not yet pinned to a named shape.

POST /v3/invoice/{id}/pay #

bearer beneficiary_app parent_app device idempotency credential

Path parameters

Name	Type	Notes
`id`	string

Request body

Field	Type		Constraints
`gateway`	string	required	`mpesa` `kasapay` `pawapay` `infinity` `pesapal` `bank` `cash` `internal` +1 more
`msisdn`	string	required	max length 20

Response

Returns { "data": … }; this endpoint's payload is not yet pinned to a named shape.

POST /v3/pay #

bearer driver_app beneficiary_app pass_app money.adjust device idempotency credential

Request body

Field	Type		Constraints
`band_serial`	string	required	max length 64
`amount_minor`	integer	required	min 1 · max 100000000
`currency`	string	required	min length 3 · max length 3
`device_id`	string (uuid)	required	—
`note`	string \| null	optional	max length 200
`pin`	string \| null	optional	max length 12
`category`	string \| null	optional	max length 64
`items`	object[]	optional	max items 50

Response

Returns { "data": PayReceipt }.

Field	Type		Constraints
`transaction_id`	string (uuid)	required	—
`type`	string	required	—
`state`	string	required	—
`student`	any	required	—
`balance_after`	any	required	—

GET /v3/payment-intent/{id} #

bearer beneficiary_app parent_app device credential

Path parameters

Name	Type	Notes
`id`	string

Response

Returns { "data": PaymentIntentDetail }.

Field	Type		Constraints
`payment_intent_id`	string (uuid)	required	—
`state`	string	required	—
`gateway`	string	required	—
`amount`	object	required	—
`amount.amount_minor`	integer	required	—
`amount.currency`	string	required	min length 3 · max length 3
`transaction_id`	string \| null	required	—
`provider_ref`	string \| null	required	—
`failure_reason`	string \| null	required	—

GET /v3/portal/account/{account}/wallet #

bearer admin_web device credential

the parent profile's Wallet tab (§11.14).

Path parameters

Name	Type	Notes
`account`	string

Response

Returns { "data": WebAccountWallet }.

Field	Type		Constraints
`account`	object	required	—
`account.id`	string (uuid)	required	—
`account.name`	string	required	—
`wallets`	object[]	required	—
`children`	object[]	required	—
`recent_transactions`	WebTransaction[]	required	—

GET /v3/portal/charge-rule #

bearer admin_web device credential

Response

Returns { "data": [ChargeRule] } with meta.next_cursor for the next page.

Field	Type		Constraints
`id`	string (uuid)	required	—
`name`	string	required	—
`note`	string \| null	required	—
`frequency`	string	required	—
`amount`	Money	required	—
`destination_wallet_id`	string (uuid)	required	—
`subject_scope`	string	required	—
`subjects`	object[]	required	—
`status`	string	required	—
`last_processed_at`	string \| null	required	—

POST /v3/portal/charge-rule #

bearer admin_web money.adjust device credential

Request body

Field	Type		Constraints
`name`	string	required	min length 2 · max length 120
`note`	string \| null	optional	max length 300
`frequency`	string	required	`hourly` `daily` `weekly` `monthly` `yearly`
`amount_minor`	integer	required	min 1 · max 100000000
`currency`	string	required	min length 3 · max length 3
`destination_wallet_id`	string (uuid)	required	—
`subject_scope`	string	required	`all` `custom`

Response

Returns { "data": … }; this endpoint's payload is not yet pinned to a named shape.

DELETE /v3/portal/charge-rule/{id} #

bearer admin_web money.adjust device credential

Path parameters

Name	Type	Notes
`id`	string

Response

Returns { "data": … }; this endpoint's payload is not yet pinned to a named shape.

PATCH /v3/portal/charge-rule/{id} #

bearer admin_web money.adjust device credential

Path parameters

Name	Type	Notes
`id`	string

Request body

Field	Type		Constraints
`name`	string	optional	min length 2 · max length 120
`note`	string \| null	optional	max length 300
`frequency`	string	optional	`hourly` `daily` `weekly` `monthly` `yearly`
`amount_minor`	integer	optional	min 1 · max 100000000
`status`	string	optional	`active` `suspended`
`subject_scope`	string	optional	`all` `custom`

Response

Returns { "data": … }; this endpoint's payload is not yet pinned to a named shape.

PUT /v3/portal/charge-rule/{id}/subjects #

bearer admin_web money.adjust device credential

Replace the rule's custom-subject set wholesale (PUT semantics).

Path parameters

Name	Type	Notes
`id`	string

Request body

Field	Type		Constraints
`subjects`	object[]	required	max items 500

Response

Returns { "data": … }; this endpoint's payload is not yet pinned to a named shape.

GET /v3/portal/credits #

bearer admin_web device credential

Response

Returns { "data": Credits }.

Field	Type		Constraints
`wallet_id`	string (uuid)	required	—
`balance`	Money	required	—
`used`	Money	required	—

POST /v3/portal/credits/topup #

bearer admin_web money.credit device credential

Request body

Field	Type		Constraints
`amount_minor`	integer	required	min 100 · max 100000000
`currency`	string	required	min length 3 · max length 3
`msisdn`	string	required	—

Response

Returns { "data": … }; this endpoint's payload is not yet pinned to a named shape.

GET /v3/portal/loan #

bearer admin_web device credential

Response

Returns { "data": [WebLoan] } with meta.next_cursor for the next page.

Field	Type		Constraints
`id`	string (uuid)	required	—
`wallet_id`	string (uuid)	required	—
`borrower`	string \| null	required	—
`principal`	Money	required	—
`outstanding`	Money	required	—
`interest_rate_bps`	integer	required	—
`penalty_rate_bps`	integer	required	—
`interest_period`	string	required	—
`status`	string	required	—
`term_ends_on`	string \| null	required	—
`next_accrual_at`	string \| null	required	—
`paid_at`	string \| null	required	—

POST /v3/portal/loan #

bearer admin_web money.credit device credential

Request body

Field	Type		Constraints
`wallet_id`	string (uuid)	required	—
`principal_minor`	integer	required	min 1 · max 100000000
`currency`	string	required	min length 3 · max length 3
`interest_rate_bps`	integer	required	min 0 · max 10000
`penalty_rate_bps`	integer \| null	optional	min 0 · max 10000
`interest_period`	string \| null	optional	`1 day` `1 week` `1 month` `1 year`
`term_ends_on`	string \| null	optional	—

Response

Returns { "data": Written }.

Field	Type		Constraints
`id`	string (uuid)	required	—

POST /v3/portal/loan/{id}/repay #

bearer admin_web money.adjust device credential

Path parameters

Name	Type	Notes
`id`	string

Request body

Field	Type		Constraints
`amount_minor`	integer	required	min 1 · max 100000000
`currency`	string	required	min length 3 · max length 3

Response

Returns { "data": … }; this endpoint's payload is not yet pinned to a named shape.

GET /v3/portal/payout #

bearer admin_web device credential

Query parameters

Name	Type		Constraints
`from`	string	required	—
`to`	string	required	—
`state`	string \| null	optional	`created` `processing` `succeeded` `failed` `expired` `reversed`
`cursor`	string \| null	optional	max length 200
`per_page`	integer \| null	optional	min 1 · max 500

Response

Returns { "data": … }; this endpoint's payload is not yet pinned to a named shape.

POST /v3/portal/payout #

bearer admin_web money.payout device credential

Request body

Field	Type		Constraints
`wallet_id`	string (uuid)	required	—
`amount_minor`	integer	required	min 1 · max 100000000
`currency`	string	required	min length 3 · max length 3
`msisdn`	string	required	—
`gateway`	string	required	`mpesa` `kasapay` `pawapay` `infinity` `pesapal` `bank` `cash` `internal` +1 more

Response

Returns { "data": … }; this endpoint's payload is not yet pinned to a named shape.

GET /v3/portal/payout/{id} #

bearer admin_web device credential

Path parameters

Name	Type	Notes
`id`	string

Response

Returns { "data": … }; this endpoint's payload is not yet pinned to a named shape.

DELETE /v3/portal/pos-category/{id} #

bearer admin_web settings.manage device credential

Path parameters

Name	Type	Notes
`id`	string

Response

Returns { "data": PosCategoryAdmin }.

Field	Type		Constraints
`id`	string (uuid)	required	—
`name`	string	required	—
`active`	boolean	required	—
`color`	string \| null	required	—
`photo`	any	required	—
`created_at`	string (date-time)	required	—
`updated_at`	string (date-time)	required	—

POST /v3/portal/pos-item/copy #

bearer admin_web settings.manage device credential

PCE-2b: copy items onto other beneficiaries — an upsert per (item, target).

Request body

Field	Type		Constraints
`item_ids`	string (uuid)[]	required	min items 1 · max items 200
`beneficiary_wallet_ids`	string (uuid)[]	required	min items 1 · max items 50

Response

Returns { "data": PosItemCopyReceipt }.

Field	Type		Constraints
`targets`	integer	required	—
`created`	integer	required	—
`updated`	integer	required	—

GET /v3/portal/spending-profile #

bearer admin_web device credential

Response

Returns { "data": [WebSpendingProfile] } with meta.next_cursor for the next page.

Field	Type		Constraints
`id`	string (uuid)	required	—
`name`	string	required	—
`description`	string \| null	required	—
`daily_limit_minor`	integer \| null	required	—
`weekly_limit_minor`	integer \| null	required	—
`per_txn_limit_minor`	integer \| null	required	—
`daily_txn_limit`	integer \| null	required	—
`weekly_txn_limit`	integer \| null	required	—
`allowed_zone_kinds`	array \| null	required	—
`time_windows`	array	required	—
`wallets`	integer	required	—

POST /v3/portal/spending-profile #

bearer admin_web money.adjust device credential

Request body

Field	Type		Constraints
`name`	string	required	min length 2 · max length 80
`description`	string \| null	optional	max length 300
`daily_limit_minor`	integer \| null	optional	min 0
`weekly_limit_minor`	integer \| null	optional	min 0
`per_txn_limit_minor`	integer \| null	optional	min 0
`allowed_zone_kinds`	array \| null	optional	max items 10
`time_windows`	object[]	optional	max items 10

Response

Returns { "data": … }; this endpoint's payload is not yet pinned to a named shape.

DELETE /v3/portal/spending-profile/{id} #

bearer admin_web money.adjust device credential

Path parameters

Name	Type	Notes
`id`	string

Response

Returns { "data": … }; this endpoint's payload is not yet pinned to a named shape.

PATCH /v3/portal/spending-profile/{id} #

bearer admin_web money.adjust device credential

Path parameters

Name	Type	Notes
`id`	string

Request body

Field	Type		Constraints
`name`	string	optional	min length 2 · max length 80
`description`	string \| null	optional	max length 300
`daily_limit_minor`	integer \| null	optional	min 0
`weekly_limit_minor`	integer \| null	optional	min 0
`per_txn_limit_minor`	integer \| null	optional	min 0
`allowed_zone_kinds`	array \| null	optional	max items 10
`time_windows`	object[]	optional	max items 10

Response

Returns { "data": … }; this endpoint's payload is not yet pinned to a named shape.

GET /v3/portal/transaction #

bearer admin_web device credential

Query parameters

Name	Type		Constraints
`from`	string	required	—
`to`	string	required	—
`type`	string \| null	optional	max length 40
`wallet_id`	string \| null	optional	—
`cursor`	string \| null	optional	max length 200
`per_page`	integer \| null	optional	min 1 · max 500

Response

Returns { "data": [WebTransaction] } with meta.next_cursor for the next page.

Field	Type		Constraints
`id`	string (uuid)	required	—
`type`	string	required	—
`state`	string	required	—
`amount`	Money	required	—
`description`	string \| null	required	—
`reverses_transaction_id`	string \| null	required	—
`school_id`	string \| null	required	—
`school_name`	string \| null	required	—
`created_at`	string (date-time)	required	—

POST /v3/portal/transaction/{id}/refund #

bearer admin_web money.refund device credential

Path parameters

Name	Type	Notes
`id`	string

Response

Returns { "data": … }; this endpoint's payload is not yet pinned to a named shape.

GET /v3/portal/voucher #

bearer admin_web device credential

Query parameters

Name	Type		Constraints
`status`	string \| null	optional	`active` `redeemed` `voided` `expired`
`cursor`	string \| null	optional	max length 200
`per_page`	integer \| null	optional	min 1 · max 500

Response

Returns { "data": [WebVoucher] } with meta.next_cursor for the next page.

Field	Type		Constraints
`id`	string (uuid)	required	—
`code`	string	required	—
`amount`	Money	required	—
`status`	string	required	—
`state`	string	required	—
`merchant_wallet_id`	string (uuid)	required	—
`issued_to_wallet_id`	string \| null	required	—
`issued_to`	any	required	—
`redeemed`	boolean	required	—
`expires_at`	string (date-time)	required	—
`created_at`	string (date-time)	required	—

POST /v3/portal/voucher #

bearer admin_web money.adjust device credential

Request body

Field	Type		Constraints
`amount_minor`	integer	required	min 1 · max 100000000
`currency`	string	required	min length 3 · max length 3
`merchant_wallet_id`	string (uuid)	required	—
`issued_to_wallet_id`	string \| null	optional	—
`expires_at`	string (date-time)	required	—
`count`	integer \| null	optional	min 1 · max 1000

Response

Returns { "data": VoucherCodes }.

Field	Type		Constraints
`codes`	string[]	required	—

POST /v3/portal/voucher/{id}/void #

bearer admin_web money.void device credential

Path parameters

Name	Type	Notes
`id`	string

Response

Returns { "data": … }; this endpoint's payload is not yet pinned to a named shape.

GET /v3/portal/wallet-type #

bearer admin_web device credential

Response

Returns { "data": [WalletType] } with meta.next_cursor for the next page.

Field	Type		Constraints
`id`	string (uuid)	required	—
`name`	string	required	—
`kind`	string	required	—
`currency`	string	required	—
`is_default`	boolean	required	—
`allow_negative`	boolean	required	—
`status`	string	required	—
`wallets`	integer	required	—

GET /v3/portal/wallet/{id} #

bearer admin_web device credential

Path parameters

Name	Type	Notes
`id`	string

Response

Returns { "data": WebWalletDetail }.

Field	Type		Constraints
`id`	string (uuid)	required	—
`holder`	string	required	—
`type`	object	required	—
`type.id`	string (uuid)	required	—
`type.name`	string	required	—
`type.kind`	string	required	—
`balance`	Money	required	—
`status`	string	required	—
`student`	any	required	—
`account`	any	required	—
`spending_profile`	any	required	—
`created_at`	string (date-time)	required	—

POST /v3/portal/wallet/{id}/charge #

bearer admin_web money.adjust device credential

Path parameters

Name	Type	Notes
`id`	string

Request body

Field	Type		Constraints
`amount_minor`	integer	required	min 1 · max 100000000
`currency`	string	required	min length 3 · max length 3
`reason`	string	required	min length 3 · max length 200

Response

Returns { "data": … }; this endpoint's payload is not yet pinned to a named shape.

GET /v3/pos-category #

bearer pass_web admin_web device credential

Response

Returns { "data": [PosCategoryAdmin] } with meta.next_cursor for the next page.

Field	Type		Constraints
`id`	string (uuid)	required	—
`name`	string	required	—
`active`	boolean	required	—
`color`	string \| null	required	—
`photo`	any	required	—
`created_at`	string (date-time)	required	—
`updated_at`	string (date-time)	required	—

POST /v3/pos-category #

bearer pass_web admin_web settings.manage device credential

Request body

Field	Type		Constraints
`name`	string	required	max length 120
`active`	boolean \| null	optional	—
`color`	string \| null	optional	—

Response

Returns { "data": PosCategoryAdmin }.

Field	Type		Constraints
`id`	string (uuid)	required	—
`name`	string	required	—
`active`	boolean	required	—
`color`	string \| null	required	—
`photo`	any	required	—
`created_at`	string (date-time)	required	—
`updated_at`	string (date-time)	required	—

PATCH /v3/pos-category/{id} #

bearer pass_web admin_web settings.manage device credential

Path parameters

Name	Type	Notes
`id`	string

Request body

Field	Type		Constraints
`name`	string	optional	max length 120
`active`	boolean	optional	—
`color`	string \| null	optional	—

Response

Returns { "data": PosCategoryAdmin }.

Field	Type		Constraints
`id`	string (uuid)	required	—
`name`	string	required	—
`active`	boolean	required	—
`color`	string \| null	required	—
`photo`	any	required	—
`created_at`	string (date-time)	required	—
`updated_at`	string (date-time)	required	—

GET /v3/pos-item #

bearer pass_web admin_web device credential

Query parameters

Name	Type		Constraints
`active`	string \| null	optional	`true` `false`
`beneficiary`	string \| null	optional	max length 64
`cursor`	string \| null	optional	max length 200
`per_page`	integer \| null	optional	min 1 · max 500

Response

Returns { "data": [PosItemAdmin] } with meta.next_cursor for the next page.

Field	Type		Constraints
`id`	string (uuid)	required	—
`name`	string	required	—
`sku`	string \| null	required	—
`active`	boolean	required	—
`category_id`	string \| null	required	—
`beneficiary_wallet_id`	string \| null	required	—
`price`	MoneyFormatted	required	—
`min_order_qty`	integer	required	—
`cost_price`	any	required	—
`photo`	any	required	—
`created_at`	string (date-time)	required	—
`updated_at`	string (date-time)	required	—

POST /v3/pos-item #

bearer pass_web admin_web settings.manage device credential

Request body

Field	Type		Constraints
`name`	string	required	max length 120
`amount_minor`	integer	required	min 1 · max 100000000
`cost_price_minor`	integer \| null	optional	min 1 · max 100000000
`currency`	string	required	min length 3 · max length 3
`active`	boolean \| null	optional	—
`category_id`	string \| null	optional	—
`min_order_qty`	integer \| null	optional	min 1 · max 10000
`beneficiary_wallet_id`	string \| null	optional	—
`sku`	string \| null	optional	max length 64

Response

Returns { "data": PosItemAdmin }.

Field	Type		Constraints
`id`	string (uuid)	required	—
`name`	string	required	—
`sku`	string \| null	required	—
`active`	boolean	required	—
`category_id`	string \| null	required	—
`beneficiary_wallet_id`	string \| null	required	—
`price`	MoneyFormatted	required	—
`min_order_qty`	integer	required	—
`cost_price`	any	required	—
`photo`	any	required	—
`created_at`	string (date-time)	required	—
`updated_at`	string (date-time)	required	—

DELETE /v3/pos-item/{id} #

bearer pass_web admin_web settings.manage device credential

Path parameters

Name	Type	Notes
`id`	string

Response

Returns { "data": PosItemAdmin }.

Field	Type		Constraints
`id`	string (uuid)	required	—
`name`	string	required	—
`sku`	string \| null	required	—
`active`	boolean	required	—
`category_id`	string \| null	required	—
`beneficiary_wallet_id`	string \| null	required	—
`price`	MoneyFormatted	required	—
`min_order_qty`	integer	required	—
`cost_price`	any	required	—
`photo`	any	required	—
`created_at`	string (date-time)	required	—
`updated_at`	string (date-time)	required	—

PATCH /v3/pos-item/{id} #

bearer pass_web admin_web settings.manage device credential

Path parameters

Name	Type	Notes
`id`	string

Request body

Field	Type		Constraints
`name`	string	optional	max length 120
`amount_minor`	integer	optional	min 1 · max 100000000
`cost_price_minor`	integer \| null	optional	min 1 · max 100000000
`active`	boolean	optional	—
`min_order_qty`	integer	optional	min 1 · max 10000
`beneficiary_wallet_id`	string \| null	optional	—
`sku`	string \| null	optional	max length 64
`category_id`	string \| null	optional	—

Response

Returns { "data": PosItemAdmin }.

Field	Type		Constraints
`id`	string (uuid)	required	—
`name`	string	required	—
`sku`	string \| null	required	—
`active`	boolean	required	—
`category_id`	string \| null	required	—
`beneficiary_wallet_id`	string \| null	required	—
`price`	MoneyFormatted	required	—
`min_order_qty`	integer	required	—
`cost_price`	any	required	—
`photo`	any	required	—
`created_at`	string (date-time)	required	—
`updated_at`	string (date-time)	required	—

POST /v3/topup #

bearer beneficiary_app parent_app device idempotency credential

Request body

Field	Type		Constraints
`wallet_id`	string (uuid)	required	—
`amount_minor`	integer	required	min 1 · max -9223372036854775808
`currency`	string	required	min length 3 · max length 3
`gateway`	string	required	—
`msisdn`	string	required	max length 20

Response

Returns { "data": PaymentIntent }.

Field	Type		Constraints
`payment_intent_id`	string (uuid)	required	—
`state`	string	required	—
`gateway`	string	required	—
`amount`	object	required	—
`amount.amount_minor`	integer	required	—
`amount.currency`	string	required	min length 3 · max length 3
`instructions`	string	optional	—

GET /v3/waas/pos-item #

public credential

Query parameters

Name	Type		Constraints
`active`	string \| null	optional	`true` `false`
`beneficiary`	string \| null	optional	max length 64
`cursor`	string \| null	optional	max length 200
`per_page`	integer \| null	optional	min 1 · max 500

Response

Returns { "data": … }; this endpoint's payload is not yet pinned to a named shape.

POST /v3/waas/pos-item #

public credential

Request body

Field	Type		Constraints
`name`	string	required	max length 120
`amount_minor`	integer	required	min 1 · max 100000000
`cost_price_minor`	integer \| null	optional	min 1 · max 100000000
`currency`	string	required	min length 3 · max length 3
`active`	boolean \| null	optional	—
`category_id`	string \| null	optional	—
`min_order_qty`	integer \| null	optional	min 1 · max 10000
`beneficiary_wallet_id`	string \| null	optional	—
`sku`	string \| null	optional	max length 64

Response

Returns { "data": … }; this endpoint's payload is not yet pinned to a named shape.

POST /v3/waas/pos-item/copy #

public credential

PCE-2b: copy items onto other beneficiaries — an upsert per (item, target).

Request body

Field	Type		Constraints
`item_ids`	string (uuid)[]	required	min items 1 · max items 200
`beneficiary_wallet_ids`	string (uuid)[]	required	min items 1 · max items 50

Response

Returns { "data": … }; this endpoint's payload is not yet pinned to a named shape.

DELETE /v3/waas/pos-item/{id} #

public credential

Path parameters

Name	Type	Notes
`id`	string

Response

Returns { "data": … }; this endpoint's payload is not yet pinned to a named shape.

PATCH /v3/waas/pos-item/{id} #

public credential

Path parameters

Name	Type	Notes
`id`	string

Request body

Field	Type		Constraints
`name`	string	optional	max length 120
`amount_minor`	integer	optional	min 1 · max 100000000
`cost_price_minor`	integer \| null	optional	min 1 · max 100000000
`active`	boolean	optional	—
`min_order_qty`	integer	optional	min 1 · max 10000
`beneficiary_wallet_id`	string \| null	optional	—
`sku`	string \| null	optional	max length 64
`category_id`	string \| null	optional	—

Response

Returns { "data": … }; this endpoint's payload is not yet pinned to a named shape.

GET /v3/wallet #

bearer pass_web admin_web device credential

the tenant's wallet register, whichever console (lego L1b). The pass console's flat twin merged into this richer read: indexed search arms, typed Money, joined student/account names, plus the phone and wallet age the help desk was already reading on the pass side.

Query parameters

Name	Type		Constraints
`holder`	string \| null	optional	`account` `student` `zone` `tenant` `agent` `system`
`q`	string \| null	optional	max length 120

Response

Returns { "data": [WebWallet] } with meta.next_cursor for the next page.

Field	Type		Constraints
`id`	string (uuid)	required	—
`holder`	string	required	—
`type`	object	required	—
`type.name`	string	required	—
`type.kind`	string	required	—
`balance`	Money	required	—
`status`	string	required	—
`student`	any	required	—
`account`	any	required	—
`spending_profile_id`	string \| null	required	—
`holder_phone`	string \| null	required	—
`created_at`	string (date-time)	required	—

GET /v3/wallet/{id}/balance #

bearer beneficiary_app parent_app pass_web admin_web device credential

Path parameters

Name	Type	Notes
`id`	string

Response

Returns { "data": WalletBalance }.

Field	Type		Constraints
`wallet_id`	string (uuid)	required	—
`balance`	MoneyFormatted	required	—

PATCH /v3/wallet/{id}/spending-profile #

bearer beneficiary_app parent_app device credential

Path parameters

Name	Type	Notes
`id`	string

Request body

Field	Type		Constraints
`spending_profile_id`	string \| null	optional	—

Response

Returns { "data": SpendingProfileAssignment }.

Field	Type		Constraints
`wallet_id`	string (uuid)	required	—
`spending_profile_id`	string \| null	required	—

GET /v3/wallet/{id}/statement #

bearer beneficiary_app parent_app pass_web admin_web device credential

Path parameters

Name	Type	Notes
`id`	string

Query parameters

Name	Type		Constraints
`from`	string \| null	optional	—
`to`	string \| null	optional	—

Response

Returns { "data": [WalletStatementRow] } with meta.next_cursor for the next page.

Field	Type		Constraints
`id`	string (uuid)	required	—
`type`	string	required	—
`state`	string	required	—
`direction`	string \| null	optional	—
`amount`	MoneyFormatted	required	—
`balance_after`	MoneyFormatted	required	—
`description`	string \| null	optional	—
`student`	any	optional	—
`created_at`	string (date-time)	required	—

GET /v3/wallet/{id}/statement/summary #

bearer beneficiary_app parent_app pass_web admin_web device credential

Path parameters

Name	Type	Notes
`id`	string

Query parameters

Name	Type		Constraints
`from`	string	required	—
`to`	string	required	—

Response

Returns { "data": WalletStatementSummary }.

Field	Type		Constraints
`currency`	string	required	—
`totals`	object	required	—
`net_minor`	integer	required	—
`opening_minor`	integer	required	—
`closing_minor`	integer	required	—

POST /v3/wallet/{id}/topup #

bearer pass_web admin_web money.adjust device credential

Path parameters

Name	Type	Notes
`id`	string

Request body

Field	Type		Constraints
`amount_minor`	integer	required	min 1 · max 100000000
`currency`	string	required	min length 3 · max length 3
`reason`	string	required	min length 3 · max length 200

Response

Returns { "data": … }; this endpoint's payload is not yet pinned to a named shape.

POST /v3/webhook/payment/{gateway} #

public 120,1

Path parameters

Name	Type	Notes
`gateway`	string

Response

Returns { "data": … }; this endpoint's payload is not yet pinned to a named shape.