Skip to main content

Partners Public APIs (1.1)

Download OpenAPI specification:Download

Partners Public APIs

Create merchant

Create merchant

header Parameters
apisecret
string
Example: 123e4567-e89b-12d3-a456-426614174000
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

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)
required
object (Address)
object (Address)
sendEmail
required
boolean

WIP. Ability to send an email with directors verification links to a specified publicEmail address

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",
  • "bankAccount": {
    },
  • "address": {
    }
}

Response samples

Content type
application/json; charset=utf-8
No sample

Update company's data

Update company's data

path Parameters
companyId
required
string

Mongoose Object ID

header Parameters
apisecret
string
Example: 123e4567-e89b-12d3-a456-426614174000
Request Body schema: application/json
tradingName
string

Trading name of the company

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",
  • "industry": "string",
  • "publicEmail": "string",
  • "publicWebsite": "string",
  • "privacyPolicy": "string",
  • "supportPhone": "string",
  • "taxNumber": "string",
  • "tradingAddress": {
    }
}

Response samples

Content type
application/json; charset=utf-8
No sample

Disable company from using service

Disable company from using service

path Parameters
companyId
required
string

Mongoose Object ID

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

Responses

Response samples

Content type
application/json; charset=utf-8
No sample

Create new bank account or replace the exiting one

Create new bank account or replace the exiting one

path Parameters
companyId
required
string

Mongoose Object ID

header Parameters
apisecret
string
Example: 123e4567-e89b-12d3-a456-426614174000
Request Body schema: application/json
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

Responses

Request samples

Content type
application/json
{
  • "providerExternalId": "ob-bos-business",
  • "externalAccountId": "12345678",
  • "identification": "123456",
  • "name": "string"
}

Response samples

Content type
application/json; charset=utf-8
No sample

Edit bank account name

Edit bank account name

path Parameters
companyId
required
string

Mongoose Object ID

header Parameters
apisecret
string
Example: 123e4567-e89b-12d3-a456-426614174000
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
No sample

Create and process payment

Create and process payment

path Parameters
companyId
required
string

Mongoose Object ID

header Parameters
apisecret
required
string
Example: 123e4567-e89b-12d3-a456-426614174000
Request Body schema: application/json
invoiceRefNumber
required
string unique

Unique 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

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
{
  • "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
No sample

Get payment data

Get payment data

path Parameters
id
required
string

Mongoose Object ID

companyId
required
string

Mongoose Object ID

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

Responses

Response samples

Content type
application/json; charset=utf-8
No sample

Get list of all payments

Get list of all payments

path Parameters
companyId
required
string

Mongoose Object ID

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

Responses

Response samples

Content type
application/json; charset=utf-8
No sample

Edit payment data

Edit payment data

path Parameters
id
required
string

Mongoose Object ID

companyId
required
string

Mongoose Object ID

header Parameters
apisecret
required
string
Example: 123e4567-e89b-12d3-a456-426614174000
Request Body schema: application/json
_id
required
string

Mongoose Object ID

invoiceRefNumber
required
string

Unique 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
No sample

Process payment

Process payment

path Parameters
id
required
string

Mongoose Object ID

companyId
required
string

Mongoose Object ID

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

Responses

Response samples

Content type
application/json; charset=utf-8
No sample

Delete payment

Delete payment

path Parameters
id
required
string

Mongoose Object ID

companyId
required
string

Mongoose Object ID

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

Responses

Response samples

Content type
application/json; charset=utf-8
No sample

Save and send invoice

Save and send invoice

path Parameters
companyId
required
string

Mongoose Object ID

header Parameters
apisecret
required
string
Example: 123e4567-e89b-12d3-a456-426614174000
Request Body schema: application/json
invoiceRefNumber
required
string

Unique reference number of invoice 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
No sample

Get invoice data

Get invoice data

path Parameters
id
required
string

Mongoose Object ID

companyId
required
string

Mongoose Object ID

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

Responses

Response samples

Content type
application/json; charset=utf-8
No sample

Get list of all payments

Get list of all payments

path Parameters
companyId
required
string

Mongoose Object ID

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

Responses

Response samples

Content type
application/json; charset=utf-8
No sample

Edit payment

Edit payment

path Parameters
id
required
string

Mongoose Object ID

companyId
required
string

Mongoose Object ID

header Parameters
apisecret
required
string
Example: 123e4567-e89b-12d3-a456-426614174000
Request Body schema: application/json
invoiceRefNumber
required
string

Unique reference number of invoice 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
No sample

Send invoice

Send invoice

path Parameters
id
required
string

Mongoose Object ID

companyId
required
string

Mongoose Object ID

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

Responses

Response samples

Content type
application/json; charset=utf-8
No sample

Delete invoice

Delete invoice

path Parameters
id
required
string

Mongoose Object ID

companyId
required
string

Mongoose Object ID

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

Responses

Response samples

Content type
application/json; charset=utf-8
No sample

Get payment data

Get payment data

path Parameters
id
required
string

Mongoose Object ID of integration

companyId
required
string

Mongoose Object ID

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

Responses

Response samples

Content type
application/json; charset=utf-8
No sample