API Reference

Build bots, integrations, or your own in-app payment system on top of Neouid.

Authentication

Authorization: Bearer nk_your_key_here

Your key acts with exactly the same permissions your account has — a regular member's key can transfer funds and redeem vouchers; an owner's key can also manage members, products, and vouchers.

Plans & rate limits

Free

Read-only · 100 req/day

Pro

Full access · 10,000 req/day

Enterprise

Full access · 100,000 req/day

View full pricing →

Example request

curl -H "Authorization: Bearer nk_your_key" \
  https://neouid.com/api/v1/banks

Banks

GET/api/v1/banks

List banks you belong to

Response

{ "banks": [{ "role": "owner", "banks": { "id", "name", "slug", "tier", ... } }] }

POST/api/v1/join/{slug}

Join a public bank

Response

{ "bank_id": "uuid" }

Balance & Transactions

GET/api/v1/banks/{slug}/balance

Get your balance in a bank

Response

{ "balance": 42.50 }

GET/api/v1/banks/{slug}/transactions

List your transaction history

Response

{ "transactions": [...] }

POST/api/v1/banks/{slug}/transferPro/Enterprise

Transfer funds to another member

Request body

{ "recipient_id": "uuid", "amount": 10, "memo": "optional" }

Response

{ "transaction_id": "uuid" }

Vouchers

POST/api/v1/banks/{slug}/redeem-voucherPro/Enterprise

Redeem a voucher code

Request body

{ "code": "WELCOME50" }

Response

{ "amount_redeemed": 50 }

POST/api/v1/banks/{slug}/vouchersPro/Enterprise

Create a voucher (admin)

Request body

{ "code": "SUMMER25", "amount": 25, "max_uses": 100 }

Response

{ "voucher_id": "uuid" }

Shop

GET/api/v1/banks/{slug}/products

List active products

Response

{ "products": [...] }

POST/api/v1/banks/{slug}/productsPro/Enterprise

Create a product (admin)

Request body

{ "name": "T-Shirt", "price": 15, "stock": 50 }

Response

{ "product_id": "uuid" }

POST/api/v1/banks/{slug}/purchasePro/Enterprise

Purchase a product

Request body

{ "product_id": "uuid", "quantity": 1 }

Response

{ "order_id": "uuid" }

GET/api/v1/banks/{slug}/orders

List your orders

Response

{ "orders": [...] }

PATCH/api/v1/orders/{orderId}/statusPro/Enterprise

Update an order's status (admin)

Request body

{ "status": "shipped" }

Response

{ "success": true }

Members (admin)

GET/api/v1/banks/{slug}/members

List bank members

Response

{ "members": [...] }

POST/api/v1/banks/{slug}/depositPro/Enterprise

Deposit funds to a member

Request body

{ "recipient_id": "uuid", "amount": 20, "memo": "bonus" }

Response

{ "transaction_id": "uuid" }

POST/api/v1/banks/{slug}/withdrawPro/Enterprise

Deduct funds from a member

Request body

{ "user_id": "uuid", "amount": 5, "memo": "correction" }

Response

{ "transaction_id": "uuid" }

POST/api/v1/banks/{slug}/members/{userId}/kickPro/Enterprise

Remove a member

Request body

{ "reason": "..." }

Response

{ "success": true }

POST/api/v1/banks/{slug}/members/{userId}/banPro/Enterprise

Ban a member

Request body

{ "reason": "..." }

Response

{ "success": true }