kamiPay LogokamiPay Docs

Account Administration

How stores, checkouts and wallets fit together, and where each charge settles.

A merchant has stores (branches), a store has checkouts (registers), and each checkout settles to one wallet. store_id is numbered per merchant, and checkout_id per store.

  • A new store has no checkout. Create one (Create Checkout) before charging there: it gets checkout_id: 1, the default in QR Code Creation.
  • Where a charge settles: to its checkout's wallet. QR Code Creation's response doesn't name it: read the checkout's wallet_id (List Checkouts) and that wallet's address (Wallets). Once the charge is paid, the webhook's address_out confirms it.
  • Moving a checkout to another wallet: Update Checkout, one call per checkout. It applies to every payment processed afterwards, pending QRs included.
  • Adding a wallet: not through the API; contact support.
  • A store's address (Create Store) is its street address. It has nothing to do with wallets.
  • Permissions: every Account Administration endpoint needs credentials with the pay-in scope (the ones kamiPay gives you have it) and a user with a management role, which they normally have; otherwise 401 without the scope, or 403 without the role, so contact support.
  • Printed QRs: to charge through a printed QR at a checkout, see Printed Dynamic QRs.