Skip to main content

Members

Members (buyers/recipients) for payments. (node_id, external_id) must be unique per node.

Authentication: Bearer token required.


Create Member

Endpoint: POST /api/v1/members

Request Body

FieldTypeRequiredValidationDescription
node_idstringYesUUIDNode UUID
external_idstringYes1–255 charsExternal identifier (unique per node)
namestringYes1–255 charsMember name
surnamestringNomax 255Surname
emailstringNomax 255, emailEmail
phonestringNomax 50Phone
identity_numberstringNomax 50Identity number
tax_officestringNomax 255Tax office
tax_numberstringNomax 50Tax number
addressstringNoAddress
districtstringNomax 255District
citystringNomax 255City
countrystringNomax 10Country
contact_namestringNomax 255Contact name
localestringNomax 10Locale

Response — 201 Created

Returns full member object including id, created_at.

StatusDescription
404Node not found
409Member with node_id+external_id already exists

List Members

Endpoint: GET /api/v1/members

Query Parameters

ParameterTypeRequiredDefaultDescription
node_idstringYesNode UUID
pageintNo1Page number
per_pageintNo10Items per page (max 100)

Response — 200 OK

Paginated list with items, page, per_page, total.


Get Member by ID

Endpoint: GET /api/v1/members/{id}

Path Parameters

ParameterTypeRequiredDescription
idstringYesMember UUID

Response — 200 OK

Full member object including updated_at.

StatusDescription
404Member not found

Update Member

Endpoint: PUT /api/v1/members/{id}

Only provided fields are updated. External ID and node are immutable.

Path Parameters

ParameterTypeRequiredDescription
idstringYesMember UUID

Request Body

Same fields as Create (all optional except id in path).

Response — 200 OK

Returns updated member object.

StatusDescription
404Member not found

Delete Member

Endpoint: DELETE /api/v1/members/{id}

Soft-deletes a member.

Path Parameters

ParameterTypeRequiredDescription
idstringYesMember UUID

Response — 204 No Content

StatusDescription
404Member not found