API Reference
  1. Benji Pays Partner API
  2. Organizations

Create a new Organization

post
https://api.benjipays.com/v2/organizations

Access: Requires DISTRIBUTOR or PARTNER actor type.

Creates an Organization (Benji Pays company). Supports three flows:

  • Distributor direct (no partnerId in body) — org owned directly by distributor
  • Partner direct (caller is a partner) — org owned by the calling partner
  • Distributor on behalf of partner (partnerId in body) — org owned by the specified partner

Requires JWT authentication and partners:organizations:create scope.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params

Request body for creating an organization

string
required
length between 1 and 255

Organization/company name

string
required
^[0-9a-fA-F]{24}$

Plan ID (MongoDB ObjectId) for billing

string
required
length between 1 and 100
^[a-zA-Z0-9_-]+$

External ID from distributor's system (for reconciliation)

string
^[0-9a-fA-F]{24}$

Partner MongoDB ObjectId — required when a distributor creates on behalf of a partner. Ignored when the caller is a partner.

admin
object
required

Admin contact information

Headers
uuid

Optional client-supplied unique ID for one request. The server generates a UUID v4 if omitted and always echoes the value in the response.

uuid

Optional ID that flows across service boundaries for distributed tracing. The server generates a UUID v4 if omitted and always echoes the value in the response.

string
length between 1 and 255
^[a-zA-Z0-9]+$

Optional client-supplied key that makes retries safe for POST/PATCH/PUT. Scoped per actor; cached for 24 hours. Replays return the cached response with X-Idempotency-Replayed: true. Same key with a different body returns 409. In-flight duplicates return 429 with Retry-After. See the Idempotency section in the API overview.

string
enum
Defaults to application/json

Generated from available response content types

Allowed:
Responses

Updated about 1 month ago

Did this page help you?
Language
Credentials
Bearer
JWT
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json
application/problem+json

Updated about 1 month ago

Did this page help you?