Skip to main content
POST
/
integrations
/
workspace
Create Workspace Integration
curl --request POST \
  --url https://api.royalti.io/integrations/workspace \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "workspaceId": "workspace-123",
  "type": "vertofx",
  "settings": {
    "apiKey": "your-api-key-here",
    "region": "US"
  }
}
'
{
  "success": true,
  "data": {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "name": "vertofx",
    "enabled": true,
    "settings": {
      "apiKey": "your-api-key-here",
      "region": "US"
    },
    "metadata": {
      "customField": "custom-value"
    },
    "memo": "Integration for VertoFX payments",
    "TenantId": "123e4567-e89b-12d3-a456-426614174000",
    "IntegrationId": "123e4567-e89b-12d3-a456-426614174000",
    "createdAt": "2023-01-01T00:00:00Z",
    "updatedAt": "2023-01-01T00:00:00Z"
  }
}
This endpoint requires authentication. Include your Bearer token in the Authorization header.

​
Description

Endpoint: /integrations/workspace
Method: POST Request Body:
FieldTypeRequiredDescription
workspaceIdstringYesWorkspace ID
typestringYesIntegration type
settingsobjectYesIntegration settings

​
Code Examples

const response = await fetch('https://api.royalti.io/integrations/workspace', {
  method: 'POST',
  headers: {
    'Authorization': `Bearer ${token}`,
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    "workspaceId": "workspace-123",
    "type": "vertofx",
    "settings": {
      "apiKey": "your-api-key-here",
      "region": "US"
    }
  })
});

const data = await response.json();
console.log(data);

Authorizations

​
Authorization
string
header
required

JWT Authorization header using the Bearer scheme. Format: "Bearer {token}"

Body

application/json
​
workspaceId
string
required

Workspace ID

Example:

"workspace-123"

​
type
string
required

Integration type

Example:

"vertofx"

​
settings
object
required

Integration settings

Example:
{
  "apiKey": "your-api-key-here",
  "region": "US"
}

Response

Workspace integration created

​
success
boolean
Example:

true

​
data
object