Skip to main content

Documentation Index

Fetch the complete documentation index at: https://mintlify.com/blindpaylabs/blindpay-node/llms.txt

Use this file to discover all available pages before exploring further.

​
Get Instance Members

Retrieve a list of all members in your instance. 
const response = await blindpay.instances.getMembers();

​
Response

​
data
array
Array of instance member objects
{
  "data": [
    {
      "id": "mem_1234567890",
      "email": "john.doe@example.com",
      "first_name": "John",
      "middle_name": "",
      "last_name": "Doe",
      "image_url": "https://example.com/avatar.jpg",
      "created_at": "2024-01-15T10:30:00Z",
      "role": "admin"
    }
  ],
  "error": null
}

​
Update Instance

Update your instance settings. 
const response = await blindpay.instances.update({
  name: "My Company",
  receiver_invite_redirect_urL: "https://example.com/welcome"
});

​
Parameters

​
name
string
required
The name of your instance
​
receiver_invite_redirect_urL
string
URL to redirect receivers after they accept an invite

​
Response

Returns a success response with no data on successful update. 
{
  "data": null,
  "error": null
}

​
Delete Instance

Permanently delete your instance.
This action cannot be undone. All data associated with the instance will be permanently deleted.
const response = await blindpay.instances.delete();

​
Response

Returns a success response with no data on successful deletion. 
{
  "data": null,
  "error": null
}

​
Delete Instance Member

Remove a member from your instance. 
const response = await blindpay.instances.deleteMember("mem_1234567890");

​
Parameters

​
memberId
string
required
The ID of the member to remove

​
Response

Returns a success response with no data on successful deletion. 
{
  "data": null,
  "error": null
}

​
Update Member Role

Update a member’s role in the instance. 
const response = await blindpay.instances.updateMemberRole({
  memberId: "mem_1234567890",
  role: "developer"
});

​
Parameters

​
memberId
string
required
The ID of the member to update
​
role
string
required
The new role for the member. One of: owner, admin, finance, checker, operations, developer, viewer

​
Response

Returns a success response with no data on successful update. 
{
  "data": null,
  "error": null
}

​
Member Roles

The following roles are available for instance members:
  • owner - Full access to all features and settings
  • admin - Administrative access to manage the instance
  • finance - Access to financial operations and reporting
  • checker - Ability to review and approve transactions
  • operations - Access to operational features
  • developer - Access to API keys and developer tools
  • viewer - Read-only access to the instance