Integrations (1.0)

Download OpenAPI specification:Download

API requests specification for integrations with partners

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	boolean (FenaPaymentPageRedirectEnabled) Default: true 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.

Responses

Request samples

Payload

Content type

application/json

{"name": "your-app",
"webhookUrl": "https://your-app.com/webhook",
"redirectUrl": "https://your-app.com/redirect",
"fenaPaymentPageRedirectEnabled": true
}

Response samples

200
401
403
404
500

Content type

application/json; charset=utf-8

{"id": "62b48c5b6ba2cd6a040b20a8",
"name": "your-app",
"webhookUrl": "https://your-app.com/webhook",
"redirectUrl": "https://your-app.com/redirect",
"fenaPaymentPageRedirectEnabled": true
}

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

Content type

application/json; charset=utf-8

{"data": {"page": 1,
"totalDocs": 100,
"totalPages": 5,
"limit": 25,
"hasNextPage": true,
"docs": [{"id": "62b48c5b6ba2cd6a040b20a8",
"name": "your-app",
"webhookUrl": "https://your-app.com/webhook",
"redirectUrl": "https://your-app.com/redirect",
"fenaPaymentPageRedirectEnabled": true
}
]
}
}

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

Content type

application/json; charset=utf-8

{"id": "62b48c5b6ba2cd6a040b20a8",
"sortCode": "123456",
"accountNumber": "12345678",
"name": "Default account",
"provider": "other",
"isDefault": true,
"status": "verified",
"connectionType": "manual",
"createdAt": "2022-12-24T00:00:00Z",
"bankStatementAttachmentURL": "string",
"bankConsentExpired": "day-30"
}

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	boolean (FenaPaymentPageRedirectEnabled) Default: true 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.

Responses

Request samples

Payload

Content type

application/json

{"name": "your-app",
"webhookUrl": "https://your-app.com/webhook",
"redirectUrl": "https://your-app.com/redirect",
"fenaPaymentPageRedirectEnabled": true
}

Response samples

200
401
403
404
500

Content type

application/json; charset=utf-8

{"id": "62b48c5b6ba2cd6a040b20a8",
"name": "your-app",
"webhookUrl": "https://your-app.com/webhook",
"redirectUrl": "https://your-app.com/redirect",
"fenaPaymentPageRedirectEnabled": true
}

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

Content type

application/json; charset=utf-8

{"deleted": true
}