Create a new Partner

post

https://api.benjipays.com/v2/partners

Access: Requires DISTRIBUTOR actor type

Creates a Partner entity (MSP, accountant, ISO) under the authenticated distributor. The authenticated distributor's external ID becomes the distributorExternalId for the new Partner.

Important:

externalId must be unique per distributor
Status is automatically set to 'active'
Returns 409 Conflict if externalId already exists

Requires JWT authentication and 'partners:accounts:create' scope.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

Create partner request body

name

string

required

length between 1 and 255

Company/partner name

externalId

string

required

length between 1 and 100

^[a-zA-Z0-9_-]+$

External ID from distributor's system (must be unique per distributor)

country

string

length between 2 and 2

^[A-Za-z]{2}$

ISO 3166-1 alpha-2 country code (e.g., CA, US, GB)

contact

object

Primary contact information

Headers

X-Request-ID

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.

X-Correlation-ID

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.

Idempotency-Key

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

201Partner created successfully

400Bad Request - Validation error

401Unauthorized - Invalid or missing authentication token

403Forbidden - Wrong actor type or missing scope

409Conflict - ExternalId already exists for this distributor

429Too Many Requests - Rate limit exceeded