API Reference
  1. Benji Pays Partner API
  2. Partners

Get a specific partner by ID

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

Access: Requires DISTRIBUTOR actor type

Retrieves details for a specific Partner by its MongoDB ObjectId. Only returns partners that belong to the authenticated distributor (enforces isolation).

Note:

  • To search by externalId, use GET /v2/partners?externalId=xyz instead
  • Returns 404 if partner doesn't exist or doesn't belong to this distributor (prevents enumeration)

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

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required
^[0-9a-fA-F]{24}$

MongoDB ObjectId of the partner

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
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?