Integrations (1.0)
Download OpenAPI specification:Download
API requests specification for integrations with partners
Create a new integration
Create a new integration
path Parameters
companyId required | string Example: 62b48adf6ba2cd6a040b1eec Mongoose Object ID of the target managed company |
header Parameters
terminal-secret required | string <uuid> Example: 3858f642-e92f-431c-9d38-46d15efb7fba |
terminal-id required | string Example: 62b48adf6ba2cd6a040b1eec |
Request Body schema: application/json
name required | string (Name) The name of the integration/app |
webhookUrl required | string <uri> (WebhookUrl) The URL to send the webhook to |
redirectUrl required | string (RedirectUrl) The URL to redirect the user to after the integration is complete |
fenaPaymentPageRedirectEnabled required | boolean (FenaPaymentPageRedirectEnabled) Control whether your customer will be redirected to a Fena page before being redirected to your website, specified in the redirect URL, after processing a payment. If set to false, the customer will be redirected directly to your website after processing a payment. If set to true, the customer will be redirected to a Fena page before being redirected to your website. |
isRetryWebhookEnabled | boolean (IsRetryWebhookEnabled) Default: false Control whether the webhook will be retried in case of 5xx or network errors. If set to true,3 retries will be attempted with an interval of 30, 60, and 120 seconds respectively |
Responses
Request samples
- Payload
{- "name": "your-app",
- "fenaPaymentPageRedirectEnabled": true,
- "isRetryWebhookEnabled": true
}
Response samples
- 200
- 401
- 403
- 404
- 500
{- "created": true,
- "result": {
- "id": "62b48c5b6ba2cd6a040b20a8",
- "name": "your-app",
- "fenaPaymentPageRedirectEnabled": true,
- "isRetryWebhookEnabled": true
}
}
Get a list of integrations
Get a list of integrations
path Parameters
companyId required | string Example: 62b48adf6ba2cd6a040b1eec Mongoose Object ID of the target managed company |
query Parameters
page | integer Default: 1 Example: page=4 Current page number |
limit | integer Default: 25 Example: limit=10 Number of items per page |
header Parameters
terminal-secret required | string <uuid> Example: 3858f642-e92f-431c-9d38-46d15efb7fba |
terminal-id required | string Example: 62b48adf6ba2cd6a040b1eec |
Responses
Response samples
- 200
- 401
- 403
- 404
- 500
{- "data": {
- "page": 1,
- "totalDocs": 100,
- "totalPages": 5,
- "limit": 25,
- "hasNextPage": true,
- "docs": [
- {
- "id": "62b48c5b6ba2cd6a040b20a8",
- "name": "your-app",
- "fenaPaymentPageRedirectEnabled": true,
- "isRetryWebhookEnabled": true
}
]
}
}
Get a integration by ID
Get a integration by ID
path Parameters
companyId required | string Example: 62b48adf6ba2cd6a040b1eec Mongoose Object ID of the target managed company |
id required | string Example: 62b48c5b6ba2cd6a040b20a8 Mongoose Object ID of the target entity |
header Parameters
terminal-secret required | string <uuid> Example: 3858f642-e92f-431c-9d38-46d15efb7fba |
terminal-id required | string Example: 62b48adf6ba2cd6a040b1eec |
Responses
Response samples
- 200
- 401
- 403
- 404
- 500
{- "data": {
- "id": "62b48c5b6ba2cd6a040b20a8",
- "name": "your-app",
- "fenaPaymentPageRedirectEnabled": true,
- "isRetryWebhookEnabled": true
}
}
Edit a integration by ID
Edit a integration by ID
path Parameters
companyId required | string Example: 62b48adf6ba2cd6a040b1eec Mongoose Object ID of the target managed company |
id required | string Example: 62b48c5b6ba2cd6a040b20a8 Mongoose Object ID of the target entity |
header Parameters
terminal-secret required | string <uuid> Example: 3858f642-e92f-431c-9d38-46d15efb7fba |
terminal-id required | string Example: 62b48adf6ba2cd6a040b1eec |
Request Body schema: application/json
name required | string (Name) The name of the integration/app |
webhookUrl required | string <uri> (WebhookUrl) The URL to send the webhook to |
redirectUrl required | string (RedirectUrl) The URL to redirect the user to after the integration is complete |
fenaPaymentPageRedirectEnabled required | boolean (FenaPaymentPageRedirectEnabled) Control whether your customer will be redirected to a Fena page before being redirected to your website, specified in the redirect URL, after processing a payment. If set to false, the customer will be redirected directly to your website after processing a payment. If set to true, the customer will be redirected to a Fena page before being redirected to your website. |
isRetryWebhookEnabled | boolean (IsRetryWebhookEnabled) Default: false Control whether the webhook will be retried in case of 5xx or network errors. If set to true,3 retries will be attempted with an interval of 30, 60, and 120 seconds respectively |
Responses
Request samples
- Payload
{- "name": "your-app",
- "fenaPaymentPageRedirectEnabled": true,
- "isRetryWebhookEnabled": true
}
Response samples
- 200
- 401
- 403
- 404
- 500
{- "id": "62b48c5b6ba2cd6a040b20a8",
- "name": "your-app",
- "fenaPaymentPageRedirectEnabled": true,
- "isRetryWebhookEnabled": true
}
Delete a integration by ID
Delete a integration by ID
path Parameters
companyId required | string Example: 62b48adf6ba2cd6a040b1eec Mongoose Object ID of the target managed company |
id required | string Example: 62b48c5b6ba2cd6a040b20a8 Mongoose Object ID of the target entity |
header Parameters
terminal-secret required | string <uuid> Example: 3858f642-e92f-431c-9d38-46d15efb7fba |
terminal-id required | string Example: 62b48adf6ba2cd6a040b1eec |
Responses
Response samples
- 200
- 401
- 403
- 404
- 500
{- "deleted": true
}