Skip to main content
Documentation Powered by Redocly

Partners Public APIs (1.3)

Download OpenAPI specification:Download

API documentation for Fena partners

Companies management

This module will allow you to manage your companies.

Create company

Create company

header Parameters
apisecret
required
string
Example: 123e4567-e89b-12d3-a456-426614174000

API key generated by the partner at https://partner.fena.co/settings/api-keys.

Request Body schema: application/json
name
required
string

Name of the company

countryCode
required
string

ISO country code where company is registered

industry
string

Scope of the company

type
required
string (CompanyType)
Enum: "solo_trader" "company"
identifier
required
string

Company reference number . If company type is solo trader/individual , please put UTR of company owner

"active" (string) or "banned" (string) or "pending_verification" (string) or "started_verification" (string) or "rejected_with_retry_allowed" (string) (CompanyStatus)
publicEmail
required
string

Public email of the company

publicWebsite
string

Public web-site of the company

privacyPolicy
string

Privacy policy of the company

supportPhone
required
string

Support phone of the company

taxNumber
string

Tax number of the company

contactName
required
string

Primary contact

object (BankAccount)
object (CreateIntegrationDuringCompanyCreate)

If bank account was specified , it will be connected to this integration by default

required
object (Address)
object (Address)
sendEmail
required
boolean

Ability to send an email with directors verification links to a specified publicEmail address. Requires email settings at https://partner.fena.co/settings/email

Responses

Request samples

Content type
application/json
{
  • "name": "Fena",
  • "industry": "Health and beauty",
  • "countryCode": "GB",
  • "type": "company",
  • "identifier": "12345678",
  • "publicEmail": "example@mail.com",
  • "contactName": "John Smith",
  • "supportPhone": "+447975777666",
  • "address": {
    },
  • "bankAccount": {
    },
  • "integration": {}
}

Response samples

Content type
application/json; charset=utf-8
{
  • "created": true,
  • "result": {
    }
}

Update company's data

Update company's data

path Parameters
companyId
required
string
Example: 63fd468f0137e28695d93b93

ID of company you're currently working with in a flow

header Parameters
apisecret
required
string
Example: 123e4567-e89b-12d3-a456-426614174000

API key generated by the partner at https://partner.fena.co/settings/api-keys.

Request Body schema: application/json
tradingName
string

Trading name of the company

"active" (string) or "banned" (string) or "pending_verification" (string) or "started_verification" (string) or "rejected_with_retry_allowed" (string) (CompanyStatus)
industry
string

Scope of the company

publicEmail
string

Public email of the company

publicWebsite
string

Public web-site of the company

privacyPolicy
string

Privacy policy of the company

supportPhone
string

Support phone of the company

taxNumber
string

Tax number of the company

object (Address)

Responses

Request samples

Content type
application/json
{
  • "tradingName": "string",
  • "status": "active",
  • "industry": "string",
  • "publicEmail": "string",
  • "publicWebsite": "string",
  • "privacyPolicy": "string",
  • "supportPhone": "string",
  • "taxNumber": "string",
  • "tradingAddress": {
    }
}

Response samples

Content type
application/json; charset=utf-8
{
  • "created": true,
  • "result": {
    }
}

Disable company from using service

Disable company from using service

path Parameters
companyId
required
string
Example: 63fd468f0137e28695d93b93

ID of company you're currently working with in a flow

header Parameters
apisecret
required
string
Example: 123e4567-e89b-12d3-a456-426614174000

API key generated by the partner at https://partner.fena.co/settings/api-keys.

Responses

Response samples

Content type
application/json; charset=utf-8
{
  • "updated": true,
  • "result": {
    }
}

Get list of all companies

Get list of all companies

header Parameters
apisecret
required
string
Example: 123e4567-e89b-12d3-a456-426614174000

API key generated by the partner at https://partner.fena.co/settings/api-keys.

Responses

Response samples

Content type
application/json; charset=utf-8
{
  • "succeed": true,
  • "result": [
    ]
}

Get company's data

Get company's data

path Parameters
companyId
required
string
Example: 63fd468f0137e28695d93b93

ID of company you're currently working with in a flow

header Parameters
apisecret
required
string
Example: 123e4567-e89b-12d3-a456-426614174000

API key generated by the partner at https://partner.fena.co/settings/api-keys.

Responses

Response samples

Content type
application/json; charset=utf-8
{
  • "succeed": true,
  • "result": {
    }
}

Bank accounts

This module will allow you to manage a company bank accounts, which can later be used to receive payments.

Create new bank account for a company

Create new bank account for a company

path Parameters
companyId
required
string
Example: 63fd468f0137e28695d93b93

ID of company you're currently working with in a flow

header Parameters
apisecret
required
string
Example: 123e4567-e89b-12d3-a456-426614174000

API key generated by the partner at https://partner.fena.co/settings/api-keys.

Request Body schema: multipart/form-data
providerExternalId
required
string

Name of provider. List of available providers can be found here https://docs.fena.co/provider/limitations

externalAccountId
required
string 8 characters ^[0-9]+$

Bank account number

identification
required
string 6 characters ^[0-9]+$

Sort code of bank account

name
required
string

Name (alias) of bank account

file
file

Bank statement file. Only the following formats are accepted: .pdf, .png, .gif, .jpg, .doc/docx, .xls/xlsx, .csv, .rtf, .txt

"pending" (string) or "disabled" (string) or "verified" (string) (BankAccountStatus)

Responses

Response samples

Content type
application/json; charset=utf-8
{
  • "created": true,
  • "result": {
    }
}

Edit bank account name

Edit bank account name

path Parameters
companyId
required
string
Example: 63fd468f0137e28695d93b93

ID of company you're currently working with in a flow

id
required
string

Id of bank account

header Parameters
apisecret
required
string
Example: 123e4567-e89b-12d3-a456-426614174000

API key generated by the partner at https://partner.fena.co/settings/api-keys.

Request Body schema: application/json
string

Name of bank account

Responses

Request samples

Content type
application/json
"string"

Response samples

Content type
application/json; charset=utf-8
{
  • "created": true,
  • "result": {
    }
}

Get list of company's bank accounts

Get list of company's bank accounts

path Parameters
companyId
required
string
Example: 63fd468f0137e28695d93b93

ID of company you're currently working with in a flow

header Parameters
apisecret
required
string
Example: 123e4567-e89b-12d3-a456-426614174000

API key generated by the partner at https://partner.fena.co/settings/api-keys.

Responses

Response samples

Content type
application/json; charset=utf-8
{
  • "succeed": true,
  • "result": [
    ]
}

Get company's bank account

Get company's bank account

path Parameters
companyId
required
string
Example: 63fd468f0137e28695d93b93

ID of company you're currently working with in a flow

id
required
string

Bank account ID

header Parameters
apisecret
required
string
Example: 123e4567-e89b-12d3-a456-426614174000

API key generated by the partner at https://partner.fena.co/settings/api-keys.

Responses

Response samples

Content type
application/json; charset=utf-8
{
  • "succeed": true,
  • "result": {
    }
}

Get a link leading to the bank account authorizati

Get a link leading to the bank account authorization service

path Parameters
companyId
required
string
Example: 63fd468f0137e28695d93b93

ID of company you're currently working with in a flow

header Parameters
apisecret
required
string
Example: 123e4567-e89b-12d3-a456-426614174000

API key generated by the partner at https://partner.fena.co/settings/api-keys.

Responses

Response samples

Content type
application/json; charset=utf-8
{}

Integrations

This module will allow you to manage integrations. Integrations are used to set up custom redirect URL and webhook URL . In order for the integration to work, you need to add a previously created bank account to it, after which this integration can be used when creating payments. When initializing payments, users will be redirected to the specified URL redirect, and payment status data will be sent to the specified webhook.

Get list of company's integrations

Get list of company's integrations

path Parameters
companyId
required
string
Example: 63fd468f0137e28695d93b93

ID of company you're currently working with in a flow

header Parameters
apisecret
required
string
Example: 123e4567-e89b-12d3-a456-426614174000

API key generated by the partner at https://partner.fena.co/settings/api-keys.

Responses

Response samples

Content type
application/json; charset=utf-8
{}

Get company's integration data

Get company's integration data

path Parameters
companyId
required
string
Example: 63fd468f0137e28695d93b93

ID of company you're currently working with in a flow

id
required
string

Mongoose Object ID of integration

header Parameters
apisecret
required
string
Example: 123e4567-e89b-12d3-a456-426614174000

API key generated by the partner at https://partner.fena.co/settings/api-keys.

Responses

Response samples

Content type
application/json; charset=utf-8
{}

Create new integration for a company

Create new integration for a company

path Parameters
companyId
required
string
Example: 63fd468f0137e28695d93b93

ID of company you're currently working with in a flow

header Parameters
apisecret
required
string
Example: 123e4567-e89b-12d3-a456-426614174000

API key generated by the partner at https://partner.fena.co/settings/api-keys.

Request Body schema: application/json
name
required
string

Website / App Name

webhookUrl
required
string

Webhook / Payment Notification URL

redirectUrl
required
string

redirect URL

bankAccount
required
string

id of bank account which will be used for receiving payments

isSandbox
boolean

Responses

Request samples

Content type
application/json
{}

Response samples

Content type
application/json; charset=utf-8
{}

Update existing integration data

Update existing integration data

path Parameters
companyId
required
string
Example: 63fd468f0137e28695d93b93

ID of company you're currently working with in a flow

id
required
string

Mongoose Object ID of integration

header Parameters
apisecret
required
string
Example: 123e4567-e89b-12d3-a456-426614174000

API key generated by the partner at https://partner.fena.co/settings/api-keys.

Request Body schema: application/json
name
required
string

Website / App Name

webhookUrl
required
string

Webhook / Payment Notification URL

redirectUrl
required
string

redirect URL

bankAccount
required
string

id of bank account which will be used for receiving payments

isSandbox
boolean

Responses

Request samples

Content type
application/json
{}

Response samples

Content type
application/json; charset=utf-8
{}

Payments

This module will allow you to manage company's payments.

Create and process payment

Create and process payment

path Parameters
companyId
required
string
Example: 63fd468f0137e28695d93b93

ID of company you're currently working with in a flow

header Parameters
apisecret
required
string
Example: 123e4567-e89b-12d3-a456-426614174000

API key generated by the partner at https://partner.fena.co/settings/api-keys.

Request Body schema: application/json
One of
invoiceRefNumber
required
string

Reference number of payment request

amount
required
string^[0-9]*.[0-9]{2}$

Amount of money to pay

bankAccount
required
string

id of bank account

customerName
string

The name of the client to whom it will be sent

dueDate
object

Payment request due date. JavaScript Date Object.

customerEmail
string

Email of the customer to whom payment request will be sent

customerEmailCC
Array of strings

EmailCC of the customer

type
string (PaymentTypes)
Enum: "link" "qr" "mobile"

Responses

Request samples

Content type
application/json
Example
{
  • "invoiceRefNumber": "#024",
  • "amount": "123.45",
  • "customerName": "John",
  • "dueDate": "2022-03-26T00:00:00.000Z",
  • "customerEmail": "example@gmail.com",
  • "customerEmailCC": [
    ],
  • "bankAccount": "63630c54c07af6f56cbd959c"
}

Response samples

Content type
application/json; charset=utf-8
{
  • "created": true,
  • "result": {
    }
}

Get payment data

Get payment data

path Parameters
id
required
string

Payment ID

companyId
required
string
Example: 63fd468f0137e28695d93b93

ID of company you're currently working with in a flow

header Parameters
apisecret
required
string
Example: 123e4567-e89b-12d3-a456-426614174000

API key generated by the partner at https://partner.fena.co/settings/api-keys.

Responses

Response samples

Content type
application/json; charset=utf-8
{
  • "created": true,
  • "result": {
    }
}

Get list of all payments

Get list of all payments

path Parameters
companyId
required
string
Example: 63fd468f0137e28695d93b93

ID of company you're currently working with in a flow

header Parameters
apisecret
required
string
Example: 123e4567-e89b-12d3-a456-426614174000

API key generated by the partner at https://partner.fena.co/settings/api-keys.

Responses

Response samples

Content type
application/json; charset=utf-8
[
  • {
    }
]

Edit payment data

Edit payment data

path Parameters
id
required
string

Payment ID

companyId
required
string
Example: 63fd468f0137e28695d93b93

ID of company you're currently working with in a flow

header Parameters
apisecret
required
string
Example: 123e4567-e89b-12d3-a456-426614174000

API key generated by the partner at https://partner.fena.co/settings/api-keys.

Request Body schema: application/json
_id
required
string

Mongoose Object ID

invoiceRefNumber
required
string

Reference number of payment request

amount
required
string^[0-9]*.[0-9]{2}$

Amount of money to pay

customerName
string

The name of the client to whom it will be sent

dueDate
object

JavaScript Date Object

customerEmail
string

Email of the customer to whom payment request will be sent

customerEmailCC
string

EmailCC of the customer

Responses

Request samples

Content type
application/json
{
  • "invoiceRefNumber": "#024",
  • "amount": "123.45",
  • "customerName": "John",
  • "dueDate": "2022-03-26T00:00:00.000Z",
  • "customerEmail": "example@gmail.com",
  • "customerEmailCC": [
    ]
}

Response samples

Content type
application/json; charset=utf-8
{
  • "saved": true,
  • "result": {
    }
}

Process draft payment

Process draft payment

path Parameters
id
required
string

Payment ID

companyId
required
string
Example: 63fd468f0137e28695d93b93

ID of company you're currently working with in a flow

header Parameters
apisecret
required
string
Example: 123e4567-e89b-12d3-a456-426614174000

API key generated by the partner at https://partner.fena.co/settings/api-keys.

Responses

Response samples

Content type
application/json; charset=utf-8
{
  • "saved": true,
  • "result": {
    }
}

Cancel payment

Cancel payment

path Parameters
id
required
string

Payment ID

companyId
required
string
Example: 63fd468f0137e28695d93b93

ID of company you're currently working with in a flow

header Parameters
apisecret
required
string
Example: 123e4567-e89b-12d3-a456-426614174000

API key generated by the partner at https://partner.fena.co/settings/api-keys.

Responses

Response samples

Content type
application/json; charset=utf-8
{
  • "saved": true
}

Refund payment

Refund payment

path Parameters
companyId
required
string
Example: 63fd468f0137e28695d93b93

ID of company you're currently working with in a flow

id
required
string
Example: 62b48c5b6ba2cd6a040b20a8

ID of the payment

header Parameters
apisecret
required
string
Example: 123e4567-e89b-12d3-a456-426614174000

API key generated by the partner at https://partner.fena.co/settings/api-keys.

Request Body schema: application/json
amount
string

Override refund amount

object

Responses

Request samples

Content type
application/json
{
  • "amount": "string",
  • "payeeAccountInfo": {
    }
}

Response samples

Content type
application/json; charset=utf-8
{
  • "saved": true,
  • "result": {
    }
}

Recurring payments

This module will allow you to manage company's recurring payments.

Create recurring payments

Create recurring payments

path Parameters
companyId
required
string
Example: 63fd468f0137e28695d93b93

ID of company you're currently working with in a flow

header Parameters
apisecret
required
string
Example: 123e4567-e89b-12d3-a456-426614174000

API key generated by the partner at https://partner.fena.co/settings/api-keys.

Request Body schema: application/json
One of
reference
required
string <= 12 characters ^[a-z0-9-]+$
recurringAmount
required
string^[0-9]*.[0-9]{2}$

The amount of money that will come to your bank account from the client during the active period of regular payments

recurringPaymentDate
required
string

Javascript date. First payment date of recurring payment. Note: Due to banks requirements , the first payment date must be 3 working days in the future.

numberOfPayments
required
integer

Expected number of payments. Set 0 for indefinite

frequency
required
string
Enum: "one_week" "one_month" "three_months" "one_year"

Time interval between payments.

bankAccount
string

ID of the bank account to which the money will be sent

initialPaymentAmount
string^[0-9]*.[0-9]{2}$

Set if you want to request single immediate payment

customerName
string
customerEmail
string
customerEmailCC
Array of strings

Responses

Request samples

Content type
application/json
Example
{
  • "reference": "12345abc",
  • "recurringAmount": "0.50",
  • "recurringPaymentDate": "2022-12-24T00:00:00Z",
  • "numberOfPayments": 0,
  • "frequency": "one_week",
  • "bankAccount": "63eb772c27bfe15a04550cd6",
  • "initialPaymentAmount": "0.50",
  • "customerName": "string",
  • "customerEmail": "string",
  • "customerEmailCC": [
    ]
}

Response samples

Content type
application/json; charset=utf-8
{
  • "created": true,
  • "result": {
    }
}

Save and send recurring payments

Save and send recurring payments

path Parameters
companyId
required
string
Example: 63fd468f0137e28695d93b93

ID of company you're currently working with in a flow

header Parameters
apisecret
required
string
Example: 123e4567-e89b-12d3-a456-426614174000

API key generated by the partner at https://partner.fena.co/settings/api-keys.

Request Body schema: application/json
One of
reference
required
string <= 12 characters ^[a-z0-9-]+$
recurringAmount
required
string^[0-9]*.[0-9]{2}$

The amount of money that will come to your bank account from the client during the active period of regular payments

recurringPaymentDate
required
string

Javascript date. First payment date of recurring payment. Note: Due to banks requirements , the first payment date must be 3 working days in the future.

numberOfPayments
required
integer

Expected number of payments. Set 0 for indefinite

frequency
required
string
Enum: "one_week" "one_month" "three_months" "one_year"

Time interval between payments.

bankAccount
string

ID of the bank account to which the money will be sent

initialPaymentAmount
string^[0-9]*.[0-9]{2}$

Set if you want to request single immediate payment

customerName
string
customerEmail
string
customerEmailCC
Array of strings

Responses

Request samples

Content type
application/json
Example
{
  • "reference": "12345abc",
  • "recurringAmount": "0.50",
  • "recurringPaymentDate": "2022-12-24T00:00:00Z",
  • "numberOfPayments": 0,
  • "frequency": "one_week",
  • "bankAccount": "63eb772c27bfe15a04550cd6",
  • "initialPaymentAmount": "0.50",
  • "customerName": "string",
  • "customerEmail": "string",
  • "customerEmailCC": [
    ]
}

Response samples

Content type
application/json; charset=utf-8
{
  • "result": {
    }
}

Get recurring payments data

Get recurring payments data

path Parameters
companyId
required
string
Example: 63fd468f0137e28695d93b93

ID of company you're currently working with in a flow

id
required
string

Recurring payment ID

header Parameters
apisecret
required
string
Example: 123e4567-e89b-12d3-a456-426614174000

API key generated by the partner at https://partner.fena.co/settings/api-keys.

Responses

Response samples

Content type
application/json; charset=utf-8
{
  • "succeed": true,
  • "result": {
    }
}

Get list of all recurring payments

Get list of all recurring payments

path Parameters
companyId
required
string
Example: 63fd468f0137e28695d93b93

ID of company you're currently working with in a flow

header Parameters
apisecret
required
string
Example: 123e4567-e89b-12d3-a456-426614174000

API key generated by the partner at https://partner.fena.co/settings/api-keys.

Responses

Response samples

Content type
application/json; charset=utf-8
[ ]

Only draft and overdue recurring payment can be edited

Edit recurring payments

path Parameters
companyId
required
string
Example: 63fd468f0137e28695d93b93

ID of company you're currently working with in a flow

id
required
string

Recurring payment ID

header Parameters
apisecret
required
string
Example: 123e4567-e89b-12d3-a456-426614174000

API key generated by the partner at https://partner.fena.co/settings/api-keys.

Request Body schema: application/json
One of
reference
required
string <= 12 characters ^[a-z0-9-]+$
recurringAmount
required
string^[0-9]*.[0-9]{2}$

The amount of money that will come to your bank account from the client during the active period of regular payments

recurringPaymentDate
required
string

Javascript date. First payment date of recurring payment. Note: Due to banks requirements , the first payment date must be 3 working days in the future.

numberOfPayments
required
integer

Expected number of payments. Set 0 for indefinite

frequency
required
string
Enum: "one_week" "one_month" "three_months" "one_year"

Time interval between payments.

bankAccount
string

ID of the bank account to which the money will be sent

initialPaymentAmount
string^[0-9]*.[0-9]{2}$

Set if you want to request single immediate payment

customerName
string
customerEmail
string
customerEmailCC
Array of strings

Responses

Request samples

Content type
application/json
Example
{
  • "reference": "12345abc",
  • "recurringAmount": "0.50",
  • "recurringPaymentDate": "2022-12-24T00:00:00Z",
  • "numberOfPayments": 0,
  • "frequency": "one_week",
  • "bankAccount": "63eb772c27bfe15a04550cd6",
  • "initialPaymentAmount": "0.50",
  • "customerName": "string",
  • "customerEmail": "string",
  • "customerEmailCC": [
    ]
}

Response samples

Content type
application/json; charset=utf-8
{
  • "saved": true,
  • "result": {
    }
}

Send recurring payment

Send recurring payment

path Parameters
companyId
required
string
Example: 63fd468f0137e28695d93b93

ID of company you're currently working with in a flow

id
required
string

Recurring payment ID

header Parameters
apisecret
required
string
Example: 123e4567-e89b-12d3-a456-426614174000

API key generated by the partner at https://partner.fena.co/settings/api-keys.

Responses

Response samples

Content type
application/json; charset=utf-8
{
  • "saved": true,
  • "result": {
    }
}

Delete recurring payment

Delete recurring payment

path Parameters
companyId
required
string
Example: 63fd468f0137e28695d93b93

ID of company you're currently working with in a flow

id
required
string

Recurring payment ID

header Parameters
apisecret
required
string
Example: 123e4567-e89b-12d3-a456-426614174000

API key generated by the partner at https://partner.fena.co/settings/api-keys.

Responses

Response samples

Content type
application/json; charset=utf-8
{
  • "deleted": true
}

Get list of all transactions of recurring payment

Get list of all transactions of recurring payment if exist.

path Parameters
companyId
required
string
Example: 63fd468f0137e28695d93b93

ID of company you're currently working with in a flow

id
required
string

Recurring payment ID

header Parameters
apisecret
required
string
Example: 123e4567-e89b-12d3-a456-426614174000

API key generated by the partner at https://partner.fena.co/settings/api-keys.

Responses

Response samples

Content type
application/json; charset=utf-8
{
  • "succeed": true,
  • "result": [
    ]
}

Transactions

This module will alow you to see details about transactions

Get list of all transaction

Get list of all transaction

path Parameters
companyId
required
string
Example: 63fd468f0137e28695d93b93

ID of company you're currently working with in a flow

query Parameters
filter
string
Example: filter=isSandbox

Filter by sandbox

filterValue
string
Example: filterValue=true
header Parameters
apisecret
required
string
Example: 123e4567-e89b-12d3-a456-426614174000

API key generated by the partner at https://partner.fena.co/settings/api-keys.

Responses

Response samples

Content type
application/json; charset=utf-8
{
  • "succeed": true,
  • "result": {
    }
}

Get single transaction

Get single transaction

path Parameters
companyId
required
string
Example: 63fd468f0137e28695d93b93

ID of company you're currently working with in a flow

id
required
string

Transaction ID

header Parameters
apisecret
required
string
Example: 123e4567-e89b-12d3-a456-426614174000

API key generated by the partner at https://partner.fena.co/settings/api-keys.

Responses

Response samples

Content type
application/json; charset=utf-8
{
  • "succeed": true,
  • "result": {
    }
}

Get completed transactions statistic

Get completed transactions statistic

path Parameters
companyId
required
string
Example: 63fd468f0137e28695d93b93

ID of company you're currently working with in a flow

query Parameters
dateFrom
string
Example: dateFrom=2023-04-09T00:00:00Z

Filter by completed date from

dateTo
string
Example: dateTo=2023-04-11T00:00:00Z

Filter by completed date to

isSandbox
string
Example: isSandbox=false

Filter by isSandbox value. Default: false

header Parameters
apisecret
required
string
Example: 123e4567-e89b-12d3-a456-426614174000

API key generated by the partner at https://partner.fena.co/settings/api-keys.

Responses

Response samples

Content type
application/json; charset=utf-8
{
  • "succeed": true,
  • "result": {
    }
}