API docs by Redocly

BankiFi Custodian API (v1)

Download OpenAPI specification:Download

BankiFI support: support@bankifi.com URL: https://www.bankifi.com/contact

Custodian

Swagger for BankiFI Custodian API

Custodian

Swagger for BankiFI Custodian API

custodian api

custodian api

custom

payments

Create a single payment.

Create a single payment.

path Parameters
bank_id
required
string

Bank identifier.

header Parameters
x-bankifi-iam-header
required
string

JWT token with details of the authenticated user

Request Body schema: application/json
required

Setup a single payment

required
object (Amount3)
required
object (Account)

Provides the details to identify an account.

object (Account)

Provides the details to identify an account.

object (RemittanceInformation)

Information supplied to enable the matching of an entry with the items that the transfer is intended to settle, such as commercial invoices in an accounts' receivable system.

object (AdditionalData)
property name*
additional property
any

Responses

Request samples

Content type
application/json
{
  • "amount": {
    },
  • "creditAccount": {
    },
  • "debtorAccount": {
    },
  • "remittanceInformation": {
    },
  • "additionalData": {
    },
  • "property1": null,
  • "property2": null
}

Confirm Payment

Confirm Payment

path Parameters
consent_id
required
string

The consentId returned from the payment initiation

bank_id
required
string

Bank identifier.

query Parameters
authorizationCode
string

The authorization code obtained from the ASPSP.

header Parameters
x-bankifi-iam-header
required
string

JWT token with details of the authenticated user

Responses

Get a single payment.

Get a single payment.

path Parameters
bank_id
required
string

Bank identifier.

payment_id
required
string

Unique identification as assigned by PIS to uniquely identify the payment.

header Parameters
x-bankifi-iam-header
required
string

JWT token with details of the authenticated user/customer

Responses

beneficiaries

AIS

Account Information Services API

Retrieve the list of all the bank accounts the user has consented to.

Retrieve the list of all the bank accounts the user has consented to.

path Parameters
bank_id
required
string

Bank identifier.

header Parameters
x-bankifi-iam-header
required
string

JWT token with details of the authenticated user/customer (Bankifi token)

Authorization
required
string

JWT token with details of the authenticated user/customer (Finacle token)

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "links": {
    },
  • "meta": {
    }
}

Retrieve balances for all bank accounts an user has consented to.

Retrieve balances for all bank accounts an user has consented to.

path Parameters
bank_id
required
string

Bank identifier.

account_id
required
string

Bank identifier.

query Parameters
parent_account_type
required
string

Parent account type

header Parameters
x-bankifi-iam-header
required
string

JWT token with details of the authenticated user/customer (Bankifi token)

Authorization
required
string

JWT token with details of the authenticated user/customer (Finacle token)

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "links": {
    },
  • "meta": {
    }
}

Retrieve transactions for a bank account.

Retrieve transactions for a bank account.

path Parameters
bank_id
required
string

Bank identifier.

account_id
required
string

Bank account identifier.

query Parameters
parent_account_type
required
string

Parent account type

header Parameters
Authorization
required
string

JWT token with details of the authenticated user/customer (Finacle token)

x-bankifi-iam-header
required
string

JWT token with details of the authenticated user/customer (Bankifi token)

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "links": {
    },
  • "meta": {
    }
}

Custom

Custom Co-Op API

Retrieve Beneficiaries

Retrieve list of accessible beneficiaries

path Parameters
bank_id
required
string

Bank identifier.

header Parameters
x-bankifi-iam-header
required
string

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "links": {
    },
  • "meta": {
    }
}

Retrieve transactions

Retrieve transactions

path Parameters
bank_id
required
string

Bank identifier.

query Parameters
status
string
from
string <date-time>
to
string <date-time>
lastNTransaction
integer <int64>
accountId
string
header Parameters
x-bankifi-iam-header
required
string

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "links": {
    },
  • "meta": {
    }
}

Create Payment via OLB Finacle API

Create Payment via OLB Finacle API

path Parameters
bank_id
required
string

Bank identifier.

header Parameters
x-bankifi-iam-header
required
string
x-mobile-deviceid
required
string
Request Body schema: application/json
required
required
object (Amount1)
required
object (Account1)
required
object (Account1)
required
object (CreditorDetails1)
required
COPTransactionType (object) or INPTransactionType (object) or SLFTransactionType (object) (TransactionType)
required
ExistingPayeeCounterpartyType (object) or AdHocPayeeCounterpartyType (object) or InternalTransferCounterpartyType (object) (CounterpartyType)
required
COOPNetworkType (object) or FPSNetworkType (object) or WIBNetworkType (object) (NetworkType)
object (RemittanceInformation1)
object (AdhocPayeeDetails)
object (AdditionalCounterpartyDetails)

Responses

Request samples

Content type
application/json
{
  • "amount": {
    },
  • "creditAccount": {
    },
  • "debtorAccount": {
    },
  • "creditorDetails": {
    },
  • "transactionType": { },
  • "counterpartyType": { },
  • "networkType": { },
  • "remittanceInformation": {
    },
  • "adhocPayeeDetails": {
    },
  • "additionalCounterpartyDetails": {
    }
}

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "links": {
    },
  • "meta": {
    }
}

Validate user

Validate user

path Parameters
bank_id
required
string

Bank identifier.

Request Body schema: application/json
required
customerId
required
string
userId
required
string

Responses

Request samples

Content type
application/json
{
  • "customerId": "string",
  • "userId": "string"
}

Response samples

Content type
application/json
{
  • "errorCode": 0,
  • "errorMessage": "string",
  • "context": {
    }
}

Authenticate user

Authenticate user

path Parameters
bank_id
required
string

Bank identifier.

Request Body schema: application/json
required
customerId
required
string
userId
required
string
hardToken
required
string

Responses

Request samples

Content type
application/json
{
  • "customerId": "string",
  • "userId": "string",
  • "hardToken": "string"
}

Response samples

Content type
application/json
{
  • "sessionTransferCode": "string",
  • "codeVerifier": "string"
}

Get token

Get token

path Parameters
bank_id
required
string

Bank identifier.

Request Body schema: application/json
required
sessionTransferCode
required
string
codeVerifier
required
string

Responses

Request samples

Content type
application/json
{
  • "sessionTransferCode": "string",
  • "codeVerifier": "string"
}

Response samples

Content type
application/json
{
  • "accessToken": "string",
  • "refreshToken": "string",
  • "idToken": "string",
  • "expires": 0
}

Complete user registration

Complete user registration

path Parameters
bank_id
required
string

Bank identifier.

header Parameters
x-bankifi-iam-header
required
string
Request Body schema: application/json
required
required
object (TokenRequest)
required
object (Device)

Responses

Request samples

Content type
application/json
{
  • "tokenRequest": {
    },
  • "device": {
    }
}

Response samples

Content type
application/json
{
  • "accessToken": "string",
  • "refreshToken": "string",
  • "idToken": "string",
  • "expires": 0
}

Login user

Login user

path Parameters
bank_id
required
string

Bank identifier.

header Parameters
x-mobile-deviceid
required
string
x-refresh-token
required
string

Responses

Response samples

Content type
application/json
{
  • "tokenResponse": {
    },
  • "customerName": "string",
  • "userId": "string",
  • "corpId": "string"
}

Refresh token

Refresh token

path Parameters
bank_id
required
string

Bank identifier.

Request Body schema: application/x-www-form-urlencoded
required
customerId
required
string
userId
required
string
grant_type
required
string
refresh_token
required
string

Responses

Response samples

Content type
application/json
{
  • "accessToken": "string",
  • "refreshToken": "string",
  • "idToken": "string",
  • "expires": 0
}

Register device

Register device

path Parameters
bank_id
required
string

Bank identifier.

header Parameters
x-bankifi-iam-header
required
string
Request Body schema: application/json
required
deviceId
required
string
deviceType
string
operatingSystem
string
osVersion
string

Responses

Request samples

Content type
application/json
{
  • "deviceId": "string",
  • "deviceType": "string",
  • "operatingSystem": "string",
  • "osVersion": "string"
}

Response samples

Content type
application/json
{
  • "deviceId": "string",
  • "deviceType": "string",
  • "operatingSystem": "string",
  • "osVersion": "string"
}

Link channel

Link channel

path Parameters
bank_id
required
string

Bank identifier.

header Parameters
x-bankifi-iam-header
required
string

Responses

Response samples

Content type
application/json
{
  • "errorCode": 0,
  • "errorMessage": "string",
  • "context": {
    }
}

Retrieve list of corporate users

Retrieve list of corporate users

path Parameters
bank_id
required
string

Bank identifier.

header Parameters
x-bankifi-iam-header
required
string

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "links": {
    },
  • "meta": {
    }
}

Retrieve transaction debit accounts

Retrieve transaction debit accounts

path Parameters
bank_id
required
string

Bank identifier.

query Parameters
transaction_type
required
string
header Parameters
x-bankifi-iam-header
required
string

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "links": {
    },
  • "meta": {
    }
}

Retrieve transaction credit accounts

Retrieve transaction credit accounts

path Parameters
bank_id
required
string

Bank identifier.

query Parameters
transaction_type
required
string
header Parameters
x-bankifi-iam-header
required
string

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "links": {
    },
  • "meta": {
    }
}

Perform CoP check

Perform Confirmation Of Payee check

path Parameters
bank_id
required
string

Bank identifier.

header Parameters
x-bankifi-iam-header
required
string
Request Body schema: application/json
required
businessPayeeName
required
string
required
Business (object) or Personal (object) (AccountType)
accountIdentifier
required
string
payeeNickName
required
string

Responses

Request samples

Content type
application/json
{
  • "businessPayeeName": "string",
  • "accountType": { },
  • "accountIdentifier": "string",
  • "payeeNickName": "string"
}

Response samples

Content type
application/json
{
  • "copId": "string",
  • "status": { },
  • "reasonCode": "string",
  • "failedRequestsCount": 0,
  • "businessPayeeName": "string",
  • "respondingBankName": "string"
}

Create beneficiary

Create beneficiary

path Parameters
bank_id
required
string

Bank identifier.

header Parameters
x-bankifi-iam-header
required
string
Request Body schema: application/json
required
copId
string
Matched (object) or NoMatch (object) or None (object) (CoPCheckStatus)
businessName
required
string
required
Business (object) or Personal (object) (AccountType)
required
C (object) (PartyType)
beneficiaryNickname
required
string
Global (object) or Local (object) (AccessType)
required
B (object) (EntityType)
Array of objects (LinkedUserDetails)
required
object (BankDetails1)
accountId
required
string

Responses

Request samples

Content type
application/json
{
  • "copId": "string",
  • "copStatus": { },
  • "businessName": "string",
  • "accountType": { },
  • "partyType": { },
  • "beneficiaryNickname": "string",
  • "accessType": { },
  • "entityType": { },
  • "linkedUsers": [
    ],
  • "bankDetails": {
    },
  • "accountId": "string"
}

Response samples

Content type
application/json
{
  • "errorCode": 0,
  • "errorMessage": "string",
  • "context": {
    }
}

Validate Payment

Perform payment request validation

path Parameters
bank_id
required
string

Bank identifier.

header Parameters
x-bankifi-iam-header
required
string
x-mobile-deviceid
required
string
Request Body schema: application/json
required
required
object (Amount1)
required
object (Account1)
required
object (Account1)
required
object (CreditorDetails1)
required
COPTransactionType (object) or INPTransactionType (object) or SLFTransactionType (object) (TransactionType)
required
ExistingPayeeCounterpartyType (object) or AdHocPayeeCounterpartyType (object) or InternalTransferCounterpartyType (object) (CounterpartyType)
required
COOPNetworkType (object) or FPSNetworkType (object) or WIBNetworkType (object) (NetworkType)
object (RemittanceInformation1)
object (AdhocPayeeDetails)
object (AdditionalCounterpartyDetails)

Responses

Request samples

Content type
application/json
{
  • "amount": {
    },
  • "creditAccount": {
    },
  • "debtorAccount": {
    },
  • "creditorDetails": {
    },
  • "transactionType": { },
  • "counterpartyType": { },
  • "networkType": { },
  • "remittanceInformation": {
    },
  • "adhocPayeeDetails": {
    },
  • "additionalCounterpartyDetails": {
    }
}

Response samples

Content type
application/json
{
  • "errorCode": 0,
  • "errorMessage": "string",
  • "context": {
    }
}

Validate Sort Code

Perform sort code validation

path Parameters
bank_id
required
string

Bank identifier.

sortcode
required
string
header Parameters
x-bankifi-iam-header
required
string

Responses

Response samples

Content type
application/json
{
  • "bankDetails": {
    }
}

Login user

Login user

header Parameters
Authorization
required
string

JWT token with details of the authenticated user/customer (Finacle token)

x-mobile-deviceid
required
string
Request Body schema: application/x-www-form-urlencoded
required
customerId
required
string
userId
required
string
refresh_token
required
string

Responses

Response samples

Content type
application/json
{
  • "accessToken": "string",
  • "bankifiToken": "string",
  • "refreshToken": "string",
  • "idToken": "string",
  • "customerName": "string"
}

Register user

Register user

Request Body schema: application/x-www-form-urlencoded

Request body depends on action field

One of
customerId
required
string
userId
required
string

Responses

Response samples

Content type
application/json
{
  • "errorCode": 0,
  • "errorMessage": "string",
  • "context": {
    }
}

Validate Beneficiary

Perform create beneficiary request validation

path Parameters
bank_id
required
string

Bank identifier.

header Parameters
x-bankifi-iam-header
required
string
Request Body schema: application/json
required
businessName
required
string
required
Business (object) or Personal (object) (AccountType)
required
C (object) (PartyType)
beneficiaryNickname
required
string
Global (object) or Local (object) (AccessType)
required
B (object) (EntityType)
Array of objects (LinkedUserDetails)
required
object (BankDetails1)
accountId
required
string

Responses

Request samples

Content type
application/json
{
  • "businessName": "string",
  • "accountType": { },
  • "partyType": { },
  • "beneficiaryNickname": "string",
  • "accessType": { },
  • "entityType": { },
  • "linkedUsers": [
    ],
  • "bankDetails": {
    },
  • "accountId": "string"
}

Response samples

Content type
application/json
{
  • "errorCode": 0,
  • "errorMessage": "string",
  • "context": {
    }
}

account-info

Access to bank account information

erp

Provides with ERP-based functionality

Change ERP settings

header Parameters
x-bankifi-iam-header
required
string
Request Body schema: application/json
required
orgId
string
customerId
required
string
currentErp
required
any (ErpId1)
Enum: "internal" "quickbooks" "sage" "xero"

Responses

Request samples

Content type
application/json
{
  • "orgId": "string",
  • "customerId": "string",
  • "currentErp": "internal"
}

Response samples

Content type
application/json
{
  • "orgId": "string",
  • "customerId": "string",
  • "currentErp": "internal"
}

Obtain ERP settings

path Parameters
username
required
string
header Parameters
x-bankifi-iam-header
required
string

Responses

Response samples

Content type
application/json
{
  • "orgId": "string",
  • "customerId": "string",
  • "currentErp": "internal"
}

contact

Manages Customer contact information

custodians

Retrieve a list of custodians by type.

Retrieve a list of supported custodians

query Parameters
custodian_type
string
Enum: "Bank" "AccountingPackage"

Custodian type

consent_status
string
Value: "Authorized"

Consent status

consent_type
string
Enum: "AccountInfo" "Payment"

Consent type

header Parameters
x-bankifi-iam-header
required
string

JWT token with details of the authenticated user

Responses

Response samples

Content type
{
  • "data": [
    ]
}

Retrieve custodian details by id.

Retrieve custodian details by id.

path Parameters
custodian_id
required
string

Custodian identifier.

header Parameters
x-bankifi-iam-header
required
string

JWT token with details of the authenticated user

Responses

Response samples

Content type
{
  • "data": [
    ]
}

Create a new custodian

Create a new custodian

header Parameters
x-bankifi-iam-header
required
string

JWT token with details of the authenticated user

Request Body schema: application/json

Custodian

id
required
string
type
required
string
Enum: "Bank" "AccountingPackage" "Gov"
shortName
required
string
fullName
string
features
Array of strings
Items Enum: "AccountInformation" "Balances" "Transactions" "SingleImmediatePayment"
status
string
Enum: "OK" "LimitedAvailability" "Unhealthy"
tags
Array of strings
description
string
country
string
website
string
logo
string
provider
string
test
boolean
property name*
additional property
any

Responses

Request samples

Content type
application/json
{
  • "id": "string",
  • "type": "Bank",
  • "shortName": "string",
  • "fullName": "string",
  • "features": [
    ],
  • "status": "OK",
  • "tags": [
    ],
  • "description": "string",
  • "country": "string",
  • "website": "string",
  • "logo": "string",
  • "provider": "string",
  • "test": true,
  • "property1": null,
  • "property2": null
}

Response samples

Content type
{
  • "data": [
    ]
}

Delete a custodian with the specified ID

Deletes the custodian with the specified ID

path Parameters
custodian_id
required
string

The id of the custodian to be deleted

Responses

Response samples

Content type
application/json; charset=utf-8
{
  • "errorCode": 0,
  • "errorMessage": "string"
}

Upsert custodian.

Update a custodian.

path Parameters
custodian_id
required
string

The id of the custodian to be deleted

header Parameters
x-bankifi-iam-header
required
string

JWT token with details of the authenticated user

Request Body schema: application/json

Custodian

id
required
string
type
required
string
Enum: "Bank" "AccountingPackage" "Gov"
shortName
required
string
fullName
string
features
Array of strings
Items Enum: "AccountInformation" "Balances" "Transactions" "SingleImmediatePayment"
status
string
Enum: "OK" "LimitedAvailability" "Unhealthy"
tags
Array of strings
description
string
country
string
website
string
logo
string
provider
string
test
boolean
property name*
additional property
any

Responses

Request samples

Content type
application/json
{
  • "id": "string",
  • "type": "Bank",
  • "shortName": "string",
  • "fullName": "string",
  • "features": [
    ],
  • "status": "OK",
  • "tags": [
    ],
  • "description": "string",
  • "country": "string",
  • "website": "string",
  • "logo": "string",
  • "provider": "string",
  • "test": true,
  • "property1": null,
  • "property2": null
}

Response samples

Content type
{
  • "data": [
    ]
}

Rtp Activity

Fetch the peek traffic period for Rtp Sending.

Return the total Rtp Sent grouped by sent datetime in hourly group. The service is paginated. For example:

/whd/rtp/peak-traffic?from=2020-02-02T00:00:00Z&to=2020-02-03T00:00:00Z&page=0;;;10

query Parameters
partner
Array of strings

List of the partners to filter the report

from
required
string <date-time>

Filter from fetching the report by sent datetime

to
required
string <date-time>

Filter until fetching the report by sent datetime

page
string

Pagination

header Parameters
x-bankifi-iam-header
required
string

JWT token with details of the authenticated user

Responses

Response samples

Content type
application/json; charset=utf-8
{
  • "data": [
    ],
  • "links": {
    },
  • "meta": {
    }
}

Fetch all the transactions Sent/Resent by Communication Channels.

query Parameters
partner
Array of strings

List of the partners to filter the report

channel
Array of strings

List of the channels to filter the report

group
string
Enum: "daily" "monthly" "weekly" "hourly"

How the transactions will be grouped. For example: daily,monthly,weekly,hourly

from
required
string <date-time>

Filter from fetching the report by event datetime

to
required
string <date-time>

Filter until fetching the report by event datetime

page
string
header Parameters
x-bankifi-iam-header
required
string

JWT token with details of the authenticated user

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "links": {
    },
  • "meta": {
    }
}

Fetch all the transactions Sent/Resent.

query Parameters
partner
Array of strings

List of the partners to filter the report

group
string
Enum: "daily" "monthly" "weekly" "hourly"

How the transactions will be grouped. For example: daily,monthly,weekly,hourly

from
required
string <date-time>

Filter from fetching the report by event datetime

to
required
string <date-time>

Filter until fetching the report by event datetime

page
string
header Parameters
x-bankifi-iam-header
required
string

JWT token with details of the authenticated user

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "links": {
    },
  • "meta": {
    }
}

Fetch all the transactions Declined.

query Parameters
group
string
Enum: "daily" "monthly" "weekly" "hourly"

How the transactions will be grouped. For example: daily,monthly,weekly,hourly

from
required
string <date-time>

Filter from fetching the report by event datetime

to
required
string <date-time>

Filter until fetching the report by event datetime

partner
Array of strings

List of the partners to filter the report

page
string
header Parameters
x-bankifi-iam-header
required
string

JWT token with details of the authenticated user

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "links": {
    },
  • "meta": {
    }
}

Users Registration

Fetch the users registered in the platform.

Return the total registered users in the period selected. The service is paginated. For example:

/whd/users/registered?from=2020-02-02T00:00:00Z&to=2020-02-03T00:00:00Z&bank=ozone&partner=Incomeing&page=0;;;10

query Parameters
bank
Array of strings

List of the banks to filter the report

partner
Array of strings

List of the partners to filter the report

from
required
string <date-time>

Filter from fetching the report by sent datetime

to
required
string <date-time>

Filter until fetching the report by sent datetime

page
string

Pagination

header Parameters
x-bankifi-iam-header
required
string

JWT token with details of the authenticated user

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "links": {
    },
  • "meta": {
    }
}

Fetch the users registered in the platform filtered by Erp.

Return the total registered users by Erp in the period selected. The service is paginated. For example:

/whd/users/registered-erp?from=2020-02-02T00:00:00Z&to=2020-02-03T00:00:00Z&erp=xero&partner=Incomeing&page=0;;;10

query Parameters
group
string
Enum: "daily" "monthly" "weekly"
erp
Array of strings

List of the Erps to filter the report

partner
Array of strings

List of the partners to filter the report

from
required
string <date-time>

Filter from fetching the report by sent datetime

to
required
string <date-time>

Filter until fetching the report by sent datetime

page
string

Pagination

header Parameters
x-bankifi-iam-header
required
string

JWT token with details of the authenticated user

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "links": {
    },
  • "meta": {
    }
}

Fetch the active users in the platform.

Return the total active users in the period selected. The service is paginated. For example:

/whd/users/active?from=2020-02-02T00:00:00Z&to=2020-02-03T00:00:00Z&partner=Incomeing&page=0;;;10

query Parameters
group
string
Enum: "daily" "monthly" "weekly"
partner
Array of strings

List of the partners to filter the report

from
required
string <date-time>

Filter from fetching the report by sent datetime

to
required
string <date-time>

Filter until fetching the report by sent datetime

page
string

Pagination

header Parameters
x-bankifi-iam-header
required
string

JWT token with details of the authenticated user

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "links": {
    },
  • "meta": {
    }
}

Fetch the deactive users in the platform.

Return the total deactive users in the period selected. The service is paginated. For example:

/whd/users/deactive?from=2020-02-02T00:00:00Z&to=2020-02-03T00:00:00Z&partner=Incomeing&page=0;;;10

query Parameters
group
string
Enum: "daily" "monthly" "weekly"
partner
Array of strings

List of the partners to filter the report

from
required
string <date-time>

Filter from fetching the report by sent datetime

to
required
string <date-time>

Filter until fetching the report by sent datetime

page
string

Pagination

header Parameters
x-bankifi-iam-header
required
string

JWT token with details of the authenticated user

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "links": {
    },
  • "meta": {
    }
}

Key Value

Get value based on the key id

path Parameters
key_id
required
any

The key for which we want to retrieve a value

header Parameters
x-bankifi-iam-header
required
any

JWT token with details of the authenticated user

Responses

Create a key value pair or update value for the given key if the pair already exists

header Parameters
x-bankifi-iam-header
required
any

JWT token with details of the authenticated user

Responses

Configs

Get Configuration values based on the name space

path Parameters
name_space
required
any

The name space for which we want to retrieve the configuration

header Parameters
x-bankifi-iam-header
required
any

JWT token with details of the authenticated user

Responses

Get Configuration value based on the name space and key id

path Parameters
name_space
required
any

The name space for which we want to retrieve the configuration

key_id
required
any

The key for which we want to retrieve a value

header Parameters
x-bankifi-iam-header
required
any

JWT token with details of the authenticated user

Responses

Invoice Facilitation

Create (and send) an rtp

Create (and send) an rtp based on the query param "action".

query Parameters
action
string
Enum: "Create" "CreateAndSend"

action to be done with the rtp. if no action set, by default is used CreateAndSend

messageType
string
Enum: "OverdueRtpMessage" "RtpMessage" "BillingRtpMessage" "BillingSuspendUserMessage" "DueRtpMessage"

messageType that should be used for the rtp notification. if no messageType set, by default is used RtpMessage

header Parameters
x-bankifi-iam-header
required
string

JWT token with details of the authenticated user

Request Body schema: application/json; charset=utf-8

Request body

One of
required
object (EntityDetails)
required
object (RtpSupplier)
required
object (BankDetails)
required
object (Contact)
scheduledDates
Array of strings <date> [ items <date > ]

dates when this request is scheduled to be sent automatically

object (Amount)
channel
required
string
Enum: "Email" "Sms"

The channel via which to send the encrypted payment request.

Array of objects (Reminder)

Can be used for setting automated reminders

cardPaymentProvider
string
rtpCreationUserZone
string

Responses

Request samples

Content type
application/json; charset=utf-8
Example
{
  • "details": {
    },
  • "supplier": {
    },
  • "supplierBankDetails": {
    },
  • "customer": {
    },
  • "scheduledDates": [
    ],
  • "amount": {
    },
  • "channel": "Email",
  • "reminders": [
    ],
  • "cardPaymentProvider": "string",
  • "rtpCreationUserZone": "string"
}

Response samples

Content type
application/json; charset=utf-8
{
  • "errorCode": 0,
  • "errorMessage": "string"
}

Initiate payment collection

Send a link via the specified channel to the payer with encoded payment collection data that correspondeds to a biller's supplied receivable

header Parameters
x-bankifi-iam-header
required
string

JWT token with details of the authenticated user

Request Body schema: application/json; charset=utf-8

Request body

rtpId
required
string
messageType
string
Enum: "OverdueRtpMessage" "RtpMessage" "BillingDueRtpMessage" "BillingSuspendUserMessage" "DueRtpMessage"

the type of the message to be sent

channel
string
Enum: "Email" "Sms" "OwnSms" "WhatsApp" "FaceToFace"

the channel via which the rtp will be sent

Responses

Request samples

Content type
application/json; charset=utf-8
{
  • "rtpId": "string",
  • "messageType": "OverdueRtpMessage",
  • "channel": "Email"
}

Response samples

Content type
application/json; charset=utf-8
{
  • "errorCode": 0,
  • "errorMessage": "string"
}

RTP handling

Retrieve all existing payment requests filtered by passed params.

Retrieve all existing payment requests for a Customer filtered by passed params.

query Parameters
receivableId
string

Retrieves payment requests associated with specified receivable

erpId
string
Enum: "quickbooks" "xero" "sage" "internal"

Retrieves payment requests associated with specified a specific accounting package - supply the relevant ERP to retrieve

requestId
string

Retrieves payment requests associated with specified receivable

status
string

Retrieves payment requests filered by status. Multiple statuses possible, separated by comma.

dueDate
string

Retrieves payment requests filtered by due date type. Overdue or DueToday

sortBy
string

Retrieves payment requests sorted by param. Supported field atm is 'due_date'

sort_type
string

If sortBy set, sort asc or desc depending on sort_type. If not set, sort ascending.

header Parameters
x-bankifi-iam-header
required
string

JWT token with details of the authenticated user

Responses

Response samples

Content type
application/json; charset=utf-8
{
  • "data": [
    ],
  • "links": {},
  • "meta": {
    }
}

Retrieve all existing payment requests where customer is the logged user.

Retrieve all existing payment requests where customer is the logged user.

query Parameters
status
string

Retrieves payment requests filered by status. Multiple statuses possible, separated by comma.

header Parameters
x-bankifi-iam-header
required
string

JWT token with details of the authenticated user

Responses

Response samples

Content type
application/json; charset=utf-8
{
  • "data": [
    ],
  • "links": {},
  • "meta": {
    }
}

Retrieve all existing payment requests associated with specified customer

Retrieve all existing payment requests for a Customer

query Parameters
name
string

Retrieves payment requests associated with a specified customer name if email is not provided on it's own.

email
string

Retrieves payment requests associated with specified email only in case no customer name has not been provided.

phone
string

Retrieves payment requests associated with specified customer mobile or with no mobile if not provided.

header Parameters
x-bankifi-iam-header
required
string

JWT token with details of the authenticated user

Responses

Response samples

Content type
application/json; charset=utf-8
{
  • "data": [
    ],
  • "links": {},
  • "meta": {
    }
}

Retrieve all existing payment requests associated with an specific customer from a accounting package

Retrieve all existing payment requests associated with an specific customer from a accounting package

path Parameters
erp_id
required
string
Enum: "xero" "sage" "quickbooks" "internal"

Erp Identifier.

id
required
string

Customer Id used to identify a customer in an accounting package

query Parameters
sort_by
string

Retrieves payment requests sorted by param. Supported field atm is 'due_date', 'status'

sort_type
string

If sort_by set, sort asc or desc depending on sort_type. If not set, sort ascending.

header Parameters
x-bankifi-iam-header
required
string

JWT token with details of the authenticated user

Responses

Response samples

Content type
application/json; charset=utf-8
{
  • "data": [
    ],
  • "links": {},
  • "meta": {
    }
}

Trigger reconciliation of transactions and payment requests

Housekeeps receivables' payment statuses and payment request statuses after payments have been made

query Parameters
erpId
string
Enum: "xero" "sage" "quickbooks" "internal"

Id of ERP for which to reconciliate receivables for

header Parameters
x-bankifi-iam-header
required
string

JWT token with details of the authenticated user

Responses

Response samples

Content type
application/json; charset=utf-8
{
  • "errorCode": 0,
  • "errorMessage": "string"
}

Update the paymentId of an existing RTP

Update the paymentId of an existing payment request

path Parameters
requestId
required
string
header Parameters
x-bankifi-iam-header
required
string

JWT token with details of the authenticated user

Request Body schema: application/json
required
paymentId
required
string

Responses

Request samples

Content type
application/json
{
  • "paymentId": "string"
}

Response samples

Content type
application/json; charset=utf-8
{
  • "id": "string",
  • "details": {
    },
  • "supplier": {
    },
  • "supplierBankDetails": {
    },
  • "customer": {
    },
  • "status": "RequestMade",
  • "scheduledDates": [
    ],
  • "amount": {
    },
  • "channel": "Email",
  • "receivable": {
    },
  • "paymentId": "string",
  • "cardPaymentProvider": "string",
  • "deliveryDates": [
    ],
  • "reminders": [
    ],
  • "createdAt": "string",
  • "rtpCreationUserZone": "string",
  • "paymentLink": "string"
}

Admin RTP handling

Retrieve all existing payment requests

Retrieve all existing payment requests for a Customer.

Retrieve RTP’s for a given date range (by date). For example: /admin/request-to-pay/payment-requests?from=2020-02-02T00:00:00Z&to=2020-03-03T00:00:00Z&page=0;;;10&sort_by=issue_date

query Parameters
receivableId
string

Retrieves payment requests associated with specified receivable

source
string
Enum: "quickbooks" "xero" "sage" "internal"

Retrieves payment requests associated with specified a specific accounting package - supply the relevant ERP to retrieve

requestId
string

Retrieves payment requests associated with specified receivable

from
string

Retrieves RTP’s issued/created at or after a given date (a date-time with a time-zone). Time is ignored. Example '2022-01-01T00:00:00+01:00'

to
string

Retrieves RTP’s issued/created at or before a given date (a date-time with a time-zone). Time is ignored. Example '2022-01-01T00:00:00+01:00'. If this parameter is specified, then 'from' must be set too.

page
string

Pagination

sort_by
string

Retrieves payment requests sorted by param. Supported field atm is 'due_date', 'status'

header Parameters
x-bankifi-iam-header
required
string

JWT token with details of the authenticated user

Responses

Response samples

Content type
application/json; charset=utf-8
{
  • "data": [
    ],
  • "links": {},
  • "meta": {
    }
}

Update RTP status to InProgress

Update RTP status to InProgress

path Parameters
requestId
required
string
header Parameters
x-bankifi-iam-header
required
string

JWT token with details of the authenticated user

Responses

Response samples

Content type
application/json; charset=utf-8
{
  • "id": "string",
  • "details": {
    },
  • "supplier": {
    },
  • "supplierBankDetails": {
    },
  • "customer": {
    },
  • "status": "RequestMade",
  • "scheduledDates": [
    ],
  • "amount": {
    },
  • "channel": "Email",
  • "receivable": {
    },
  • "paymentId": "string",
  • "cardPaymentProvider": "string",
  • "deliveryDates": [
    ],
  • "reminders": [
    ],
  • "createdAt": "string",
  • "rtpCreationUserZone": "string",
  • "paymentLink": "string"
}

Update RTP status to Declined

Update RTP status to Declined

path Parameters
requestId
required
string
header Parameters
x-bankifi-iam-header
required
string

JWT token with details of the authenticated user

Responses

Response samples

Content type
application/json; charset=utf-8
{
  • "id": "string",
  • "details": {
    },
  • "supplier": {
    },
  • "supplierBankDetails": {
    },
  • "customer": {
    },
  • "status": "RequestMade",
  • "scheduledDates": [
    ],
  • "amount": {
    },
  • "channel": "Email",
  • "receivable": {
    },
  • "paymentId": "string",
  • "cardPaymentProvider": "string",
  • "deliveryDates": [
    ],
  • "reminders": [
    ],
  • "createdAt": "string",
  • "rtpCreationUserZone": "string",
  • "paymentLink": "string"
}

Update RTP status from InProgress to RequestMade

Update RTP status from InProgress to RequestMade

path Parameters
requestId
required
string
header Parameters
x-bankifi-iam-header
required
string

JWT token with details of the authenticated user

Responses

Response samples

Content type
application/json; charset=utf-8
{
  • "id": "string",
  • "details": {
    },
  • "supplier": {
    },
  • "supplierBankDetails": {
    },
  • "customer": {
    },
  • "status": "RequestMade",
  • "scheduledDates": [
    ],
  • "amount": {
    },
  • "channel": "Email",
  • "receivable": {
    },
  • "paymentId": "string",
  • "cardPaymentProvider": "string",
  • "deliveryDates": [
    ],
  • "reminders": [
    ],
  • "createdAt": "string",
  • "rtpCreationUserZone": "string",
  • "paymentLink": "string"
}

Admin Payer Side Handling

Get the invoice sender data for payer

header Parameters
x-bankifi-iam-header
required
string

JWT token with details of the authenticated user

Request Body schema: application/json
required
payload
required
string

Key or value of the encrypted resource

Responses

Request samples

Content type
application/json
{
  • "payload": "string"
}

Response samples

Content type
application/json; charset=utf-8
{
  • "name": "string",
  • "companyInfo": {
    }
}

Get the payment request for payer

header Parameters
x-bankifi-iam-header
required
string

JWT token with details of the authenticated user

Request Body schema: application/json
required
payload
required
string

Key or value of the encrypted resource

Responses

Request samples

Content type
application/json
{
  • "payload": "string"
}

Response samples

Content type
application/json; charset=utf-8
{
  • "paymentRequestId": "string",
  • "paymentDetails": {
    },
  • "payable": {
    }
}

RTP status

Update RTP status to PaymentReceived

Update RTP status to PaymentReceived

path Parameters
requestId
required
string

Id of the RTP which status you want to mark as paid

header Parameters
x-bankifi-iam-header
required
string

JWT token with details of the authenticated user

Responses

Response samples

Content type
application/json; charset=utf-8
{
  • "id": "string",
  • "details": {
    },
  • "supplier": {
    },
  • "supplierBankDetails": {
    },
  • "customer": {
    },
  • "status": "RequestMade",
  • "scheduledDates": [
    ],
  • "amount": {
    },
  • "channel": "Email",
  • "receivable": {
    },
  • "paymentId": "string",
  • "cardPaymentProvider": "string",
  • "deliveryDates": [
    ],
  • "reminders": [
    ],
  • "createdAt": "string",
  • "rtpCreationUserZone": "string",
  • "paymentLink": "string"
}

Update RTP status to Cancelled

Cancel an RTP that was not yet Sent

path Parameters
requestId
required
string

ID of the RTP that will be cancelled

header Parameters
x-bankifi-iam-header
required
string

JWT token with details of the authenticated user

Responses

Response samples

Content type
application/json; charset=utf-8
{
  • "id": "string",
  • "details": {
    },
  • "supplier": {
    },
  • "supplierBankDetails": {
    },
  • "customer": {
    },
  • "status": "RequestMade",
  • "scheduledDates": [
    ],
  • "amount": {
    },
  • "channel": "Email",
  • "receivable": {
    },
  • "paymentId": "string",
  • "cardPaymentProvider": "string",
  • "deliveryDates": [
    ],
  • "reminders": [
    ],
  • "createdAt": "string",
  • "rtpCreationUserZone": "string",
  • "paymentLink": "string"
}

getV1Request-to-payDelivery-records

header Parameters
x-bankifi-iam-header
required
string

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "links": {},
  • "meta": {
    }
}

Customer details

Details about the organisation, which on Praetura world is a customer.Based on the response, there is no data for this customer yet OR the customer has some data filled in but not submitted to Praetura OR the customer is already existing in Praetura.

header Parameters
x-bankifi-iam-header
required
string

JWT token with details of the authenticated user

Responses

Response samples

Content type
application/json
{
  • "status": "Draft",
  • "praeturaCustomerId": "string",
  • "registeredCompanyName": "string",
  • "tradingName": "string",
  • "companyType": "limited_liability_company",
  • "companyRegistrationNumber": "string",
  • "tradingFromDate": "2019-08-24",
  • "industry": "agriculture_forestry_and_fishing",
  • "sicCode": "string",
  • "website": "string",
  • "registeredAddress": {
    },
  • "tradingAddress": {
    },
  • "vatInformation": {
    },
  • "hasConsentedToCreditCheck": true,
  • "hasConsentedToPrivacyPolicy": true
}

Create or Update customer data on BankiFi database.

Allowed only if no customer submitted to Praetura for this organisation. No need providing a customerId for updating the current information, because the customer data is maximum 1 for one organisation. The organisationId is taken from the JWT.

header Parameters
x-bankifi-iam-header
required
string

JWT token with details of the authenticated user

Request Body schema: application/json
required
companyType
any
Enum: "LimitedCompany" "GeneralRegisteredCompany" "LimitedLiabilityPartnership" "SoleTrader" "OtherOrg" null

organisation type from BankiFi

registeredCompanyName
string
object (BankifiAddress1)
companyRegistrationNumber
string
tradingName
string
object (BankifiAddress1)
tradingFromDate
string <date>
industry
any
Enum: "agriculture_forestry_and_fishing" "architecture_and_engineering" "business_support_services" "car_dealers_garages_and_mechanics" "cleaning_landscaping_and_gardening" "construction" "education_and_training" "finance_and_insurance" "health_and_care" "hotels_restaurants_and_pubs" "it_and_communications" "leisure_and_other_services" "manufacturing_food_processing_and_printing" "professional_services" "property_and_real_estate" "publishing_film_and_media_production" "retail" "recruitment_agencies" "transport_and_logistics" "wholesale" "other"

organisation industry

sicCode
string
website
string
object (VatInformation)
hasConsentedToCreditCheck
boolean
hasConsentedToPrivacyPolicy
boolean

Responses

Request samples

Content type
application/json
{
  • "companyType": "LimitedCompany",
  • "registeredCompanyName": "string",
  • "registeredAddress": {
    },
  • "companyRegistrationNumber": "string",
  • "tradingName": "string",
  • "tradingAddress": {
    },
  • "tradingFromDate": "2019-08-24",
  • "industry": "agriculture_forestry_and_fishing",
  • "sicCode": "string",
  • "website": "string",
  • "vatInformation": {
    },
  • "hasConsentedToCreditCheck": true,
  • "hasConsentedToPrivacyPolicy": true
}

Response samples

Content type
application/json
{
  • "errorCode": 0,
  • "errorMessage": "string"
}

Submit customer to Praetura

Submit customer to Praetura

header Parameters
x-bankifi-iam-header
required
string

JWT token with details of the authenticated user

Responses

Response samples

Content type
application/json
{
  • "errorCode": 0,
  • "errorMessage": "string"
}

Summary of all the applications for a specific status.

query Parameters
status
string

Draft or Submitted. If not provided, both draft and submitted applications will be provided.

header Parameters
x-bankifi-iam-header
required
string

JWT token with details of the authenticated user

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "links": {
    },
  • "meta": {
    }
}

Create new application

header Parameters
x-bankifi-iam-header
required
string

JWT token with details of the authenticated user

Request Body schema: application/json
required
object (AssetFinance)
object (CommercialLoan)
object (InvoiceFinance)
detailedFundingPurpose
string
urgency
any
Enum: "Asap" "InTheFollowingWeeks" "InTheFollowingMonths" "Other"
object (Introducer)
Array of objects (Applicant)
partyToContact
any
Enum: "Applicant" "Introducer"
object (FormStage)

Responses

Request samples

Content type
application/json
{
  • "assetFinanceRequest": {
    },
  • "invoiceFinanceRequest": {
    },
  • "commercialLoanRequest": {
    },
  • "detailedFundingPurpose": "string",
  • "urgency": "Asap",
  • "introducer": {
    },
  • "applicants": [
    ],
  • "partyToContact": "Applicant",
  • "formStage": {
    }
}

Response samples

Content type
application/json
"string"

Application Details

path Parameters
applicationId
required
string
header Parameters
x-bankifi-iam-header
required
string

JWT token with details of the authenticated user

Responses

Response samples

Content type
application/json
{
  • "assetFinanceRequest": {
    },
  • "invoiceFinanceRequest": {
    },
  • "commercialLoanRequest": {
    },
  • "detailedFundingPurpose": "string",
  • "urgency": "Asap",
  • "introducer": {
    },
  • "applicants": [
    ],
  • "partyToContact": "Applicant",
  • "formStage": {
    },
  • "applicationId": "string"
}

Update application details

path Parameters
applicationId
required
string
header Parameters
x-bankifi-iam-header
required
string

JWT token with details of the authenticated user

Request Body schema: application/json
required
object (AssetFinance)
object (CommercialLoan)
object (InvoiceFinance)
detailedFundingPurpose
string
urgency
any
Enum: "Asap" "InTheFollowingWeeks" "InTheFollowingMonths" "Other"
object (Introducer)
Array of objects (Applicant)
partyToContact
any
Enum: "Applicant" "Introducer"
object (FormStage)

Responses

Request samples

Content type
application/json
{
  • "assetFinanceRequest": {
    },
  • "invoiceFinanceRequest": {
    },
  • "commercialLoanRequest": {
    },
  • "detailedFundingPurpose": "string",
  • "urgency": "Asap",
  • "introducer": {
    },
  • "applicants": [
    ],
  • "partyToContact": "Applicant",
  • "formStage": {
    }
}

Response samples

Content type
application/json
{
  • "assetFinanceRequest": {
    },
  • "invoiceFinanceRequest": {
    },
  • "commercialLoanRequest": {
    },
  • "detailedFundingPurpose": "string",
  • "urgency": "Asap",
  • "introducer": {
    },
  • "applicants": [
    ],
  • "partyToContact": "Applicant",
  • "formStage": {
    },
  • "applicationId": "string"
}

Get documents for this application

path Parameters
applicationId
required
string
header Parameters
x-bankifi-iam-header
required
string

JWT token with details of the authenticated user

Responses

Response samples

Content type
application/json
{
  • "documents": [
    ]
}

Upload document

path Parameters
applicationId
required
string
header Parameters
x-bankifi-iam-header
required
string

JWT token with details of the authenticated user

Request Body schema: multipart/form-data
required

The file to upload

string <binary>

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "name": "string",
  • "type": null
}

Delete a document

path Parameters
applicationId
required
string
documentId
required
string
header Parameters
x-bankifi-iam-header
required
string

JWT token with details of the authenticated user

Responses

Response samples

Content type
application/json
{
  • "errorCode": 0,
  • "errorMessage": "string"
}

Submit application to Praetura

Submit application to Praetura

path Parameters
applicationId
required
string
header Parameters
x-bankifi-iam-header
required
string

JWT token with details of the authenticated user

Responses

Response samples

Content type
application/json
{
  • "errorCode": 0,
  • "errorMessage": "string"
}

postV1AnalyticsLogin

Authorizations:
apiKeyAuth
Request Body schema: application/json
required
required
Biometrics (object) or Credentials (object) or PIN (object) (LoginMethod)
required
Mobile (object) or Web (object) (AppInfo)
deviceInfo
string
operatingSystemInfo
required
string

Responses

Request samples

Content type
application/json
{
  • "loginMethod": { },
  • "appInfo": { },
  • "deviceInfo": "string",
  • "operatingSystemInfo": "string"
}

Response samples

Content type
application/json
{
  • "errorCode": 0,
  • "errorMessage": "string",
  • "context": [
    ]
}

postV1CardsSquareConsent

Authorizations:
apiKeyAuth
query Parameters
redirectUrl
required
string

Responses

Response samples

Content type
application/json
{
  • "redirectUrl": "string",
  • "consentId": "string"
}

postV1CardsSquareConsentConsentidAuthorize

Authorizations:
apiKeyAuth
path Parameters
consentId
required
string
query Parameters
code
required
string
redirectUrl
required
string

Responses

Response samples

Content type
application/json
{
  • "consentId": "string",
  • "context": {
    },
  • "consentBody": "string",
  • "meta": [
    ]
}

postV1CardsSquarePayments

Initiates a Square payment.

Authorizations:
apiKeyAuth
Request Body schema: application/json
required
required
object (CustomerId)

Responses

Request samples

Content type
application/json
{
  • "customerId": {
    }
}

Response samples

Content type
application/json
{
  • "consentId": "string"
}

postV1CardsSquarePaymentsConsentidConfirm

Confirms a Square payment.

Authorizations:
apiKeyAuth
path Parameters
consentId
required
string
Request Body schema: application/json
required
paymentToken
required
string
required
object (Amount_PaymentAmount)
required
object (CustomerId)
required
object (RtpId)
required
object (EntityDetails1)

Responses

Request samples

Content type
application/json
{
  • "paymentToken": "string",
  • "amount": {
    },
  • "customerId": {
    },
  • "rtpId": {
    },
  • "invoiceDetails": {
    }
}

getV1CardsSettings

Get card provider settings.

Authorizations:
apiKeyAuth

Responses

Response samples

Content type
application/json
{
  • "providers": [
    ],
  • "default": {
    }
}

postV1CardsSquareEnable

Enable Square card provider.

Authorizations:
apiKeyAuth

Responses

Response samples

Content type
application/json
{
  • "providers": [
    ],
  • "default": {
    }
}

postV1CardsSquareDisable

Disable Square card provider.

Authorizations:
apiKeyAuth

Responses

Response samples

Content type
application/json
{
  • "providers": [
    ],
  • "default": {
    }
}

postV1CardsSquareDefault

Set Square as default card provider.

Authorizations:
apiKeyAuth

Responses

Response samples

Content type
application/json
{
  • "providers": [
    ],
  • "default": {
    }
}

postV1CardsSquareConsent1

Authorizations:
apiKeyAuth
query Parameters
redirectUrl
required
string

Responses

Response samples

Content type
application/json
{
  • "redirectUrl": "string",
  • "consentId": "string"
}

postV1CardsSquareConsentConsentidAuthorize1

Authorizations:
apiKeyAuth
path Parameters
consentId
required
string
query Parameters
code
required
string
redirectUrl
required
string

Responses

Response samples

Content type
application/json
{
  • "consentId": "string",
  • "context": {
    },
  • "consentBody": "string",
  • "meta": [
    ]
}

postV1CardsSquarePayments1

Initiates a Square payment.

Authorizations:
apiKeyAuth
Request Body schema: application/json
required
orgId
required
string (OrgId)
customerId
required
string (CustomerId1)

Responses

Request samples

Content type
application/json
{
  • "orgId": "string",
  • "customerId": "string"
}

Response samples

Content type
application/json
{
  • "consentId": "string"
}

postV1CardsSquarePaymentsConsentidConfirm1

Confirms a Square payment.

Authorizations:
apiKeyAuth
path Parameters
consentId
required
string
Request Body schema: application/json
required
paymentToken
required
string
required
object (Amount_PaymentAmount1)
orgId
required
string (OrgId)
customerId
required
string (CustomerId1)
rtpId
required
string (RtpId1)
required
object (EntityDetails2)

Responses

Request samples

Content type
application/json
{
  • "paymentToken": "string",
  • "amount": {
    },
  • "orgId": "string",
  • "customerId": "string",
  • "rtpId": "string",
  • "invoiceDetails": {
    }
}

getV1CardsSettings1

Get card provider settings.

Authorizations:
apiKeyAuth

Responses

Response samples

Content type
application/json
{
  • "providers": [
    ],
  • "default": "string"
}

postV1CardsSquareEnable1

Enable Square card provider.

Authorizations:
apiKeyAuth

Responses

Response samples

Content type
application/json
{
  • "providers": [
    ],
  • "default": "string"
}

postV1CardsSquareDisable1

Disable Square card provider.

Authorizations:
apiKeyAuth

Responses

Response samples

Content type
application/json
{
  • "providers": [
    ],
  • "default": "string"
}

postV1CardsSquareDefault1

Set Square as default card provider.

Authorizations:
apiKeyAuth

Responses

Response samples

Content type
application/json
{
  • "providers": [
    ],
  • "default": "string"
}

getV1Subscriptions

header Parameters
x-bankifi-iam-header
required
string

Responses

Response samples

Content type
application/json
Example
{
  • "id": "string",
  • "orgId": "string",
  • "planId": "string",
  • "status": { },
  • "freeTrialEndDate": "2019-08-24",
  • "billingDate": "2019-08-24",
  • "subscribedOn": "2019-08-24",
  • "price": {
    },
  • "toBeCancelled": true
}

getV1SubscriptionsPlans

header Parameters
x-bankifi-iam-header
required
string

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "links": {
    },
  • "meta": { }
}

postV1SubscriptionsPlans

header Parameters
x-bankifi-iam-header
required
string
Request Body schema: application/json
required
One of
required
object (NonEmptyList_BankId)

Responses

Request samples

Content type
application/json
Example
{
  • "bankIds": {
    }
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "freeTrialDays": 0,
  • "periodDays": 0,
  • "price": {
    }
}

postV1SubscriptionsPlanid

path Parameters
planId
required
string
header Parameters
x-bankifi-iam-header
required
string

Responses

Response samples

Content type
application/json
Example
{
  • "id": "string",
  • "orgId": "string",
  • "planId": "string",
  • "status": { },
  • "freeTrialEndDate": "2019-08-24",
  • "billingDate": "2019-08-24",
  • "subscribedOn": "2019-08-24",
  • "price": {
    },
  • "toBeCancelled": true
}

deleteV1SubscriptionsSubscriptionid

path Parameters
subscriptionId
required
string
header Parameters
x-bankifi-iam-header
required
string

Responses

Response samples

Content type
application/json
Example
{
  • "id": "string",
  • "orgId": "string",
  • "planId": "string",
  • "status": { },
  • "freeTrialEndDate": "2019-08-24",
  • "billingDate": "2019-08-24",
  • "subscribedOn": "2019-08-24",
  • "price": {
    },
  • "toBeCancelled": true
}

postV1OnboardingRegister

Request Body schema: application/x-www-form-urlencoded
required

Form to execute the different registration steps.

action
required
string
email
string
phone
string
code
string
referralCode
string

Responses

Request samples

Content type
application/x-www-form-urlencoded
Example
action=register_email&email=test%40example.com&referralCode=123456

Response samples

Content type
application/json
Example
{
  • "email": "test@email.com",
  • "verified": true
}

postV1OnboardingSend_verification_emailEmail

path Parameters
email
required
string

Responses

Response samples

Content type
application/json
{
  • "errorCode": 0,
  • "errorMessage": "string",
  • "context": [
    ]
}

postV1OnboardingUsers

Request Body schema: application/json
required
email
required
string
phone
required
string
password
required
string
termsAndConditionsAccepted
required
boolean

Responses

Request samples

Content type
application/json
{
  • "email": "string",
  • "phone": "string",
  • "password": "string",
  • "termsAndConditionsAccepted": true
}

Response samples

Content type
application/json
{
  • "errorCode": 0,
  • "errorMessage": "string",
  • "context": [
    ]
}

postV1OnboardingOrganisation

Request Body schema: application/json
required
One of
companyName
required
string
companyNumber
required
string
vatNumber
string
LimitedCompany (object) or SoleTrader (object) or OtherOrg (object) (OrgType)

If organisation type is GeneralRegisteredCompany it means we know it is a registered company and not a SoleTrader but we don't know what type of company it is.

Responses

Request samples

Content type
application/json
Example
{
  • "companyName": "string",
  • "companyNumber": "string",
  • "vatNumber": "string",
  • "orgType": { }
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "name": "string",
  • "companyInfo": {
    },
  • "primaryContact": {
    },
  • "otherContacts": [
    ],
  • "taxInfo": {
    },
  • "SIC": [
    ],
  • "logo": "string",
  • "orgType": { },
  • "personsSC": [
    ],
  • "officers": [
    ]
}

postV1OnboardingPassword_reset

Request Body schema: application/json
required
username
required
string

Responses

Request samples

Content type
application/json
{
  • "username": "string"
}

Response samples

Content type
application/json
{
  • "sent": true
}

postV1OnboardingPassword_resetCheck_code

query Parameters
code
required
string

Responses

Response samples

Content type
application/json
{
  • "errorCode": 0,
  • "errorMessage": "string",
  • "context": [
    ]
}

postV1OnboardingPassword_resetConfirm

query Parameters
code
required
string
Request Body schema: application/json
required
password
required
string

Responses

Request samples

Content type
application/json
{
  • "password": "string"
}

Response samples

Content type
application/json
{
  • "errorCode": 0,
  • "errorMessage": "string",
  • "context": [
    ]
}

postV1OnboardingUsersTermsAndConditions

path Parameters
email
required
string

Responses

Response samples

Content type
application/json
{
  • "errorCode": 0,
  • "errorMessage": "string",
  • "context": [
    ]
}

getV1User-mgmtPublicCompaniesCompany_profileCompanynumber

path Parameters
companyNumber
required
string

Responses

Response samples

Content type
application/json
{
  • "accounts": {
    },
  • "company_name": "string",
  • "company_number": "string",
  • "company_status": "string",
  • "external_registration_number": "string",
  • "registered_office_address": {
    },
  • "sic_codes": [
    ]
}

getV1User-mgmtPublicCompaniesSearchCompany

path Parameters
company
required
string

Responses

Response samples

Content type
application/json
{
  • "etag": "string",
  • "items": [
    ],
  • "total_results": 0
}

getV1User-mgmtPublicCompaniesCompanynumberDirectors

path Parameters
companyNumber
required
string

Responses

Response samples

Content type
application/json
{
  • "active_count": 0,
  • "inactive_count": 0,
  • "total_results": 0,
  • "items": [
    ]
}

postV1User-mgmtPublicLogin

Request Body schema: application/json
required

Request object used for authentication

username
required
string
password
required
string

Responses

Request samples

Content type
application/json
{
  • "username": "string",
  • "password": "string"
}

Response samples

Content type
application/json
{
  • "token": "string",
  • "emailVerified": true,
  • "phoneVerified": true
}

getV1User-mgmtUsersId

path Parameters
id
required
string
header Parameters
x-bankifi-iam-header
required
string

Responses

Response samples

Content type
application/json
{
  • "username": "string",
  • "customerId": "string",
  • "orgId": "string",
  • "orgName": "string",
  • "status": "string",
  • "roles": [
    ],
  • "phone": "string",
  • "meta": {
    }
}

getV1User-mgmtUserinfo

header Parameters
x-bankifi-iam-header
required
string

Responses

Response samples

Content type
application/json
{
  • "username": "string",
  • "orgName": "string",
  • "roles": [
    ],
  • "org": {
    },
  • "phone": "string",
  • "emailVerified": true,
  • "termsAndConditionsAccepted": true
}

getV1User-mgmtToken_refresh

header Parameters
x-bankifi-iam-header
required
string

Responses

Response samples

Content type
application/json
{
  • "token": "string",
  • "emailVerified": true,
  • "phoneVerified": true
}

getV1User-mgmtUsers

header Parameters
x-bankifi-iam-header
required
string

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

postV1User-mgmtUsers

header Parameters
x-bankifi-iam-header
required
string
Request Body schema: application/json
required
username
required
string

Bankifi username

password
string

Bankifi user password

customerId
required
string

Bankifi user customer identifier

orgId
required
string

Bankifi user organisation identifier

orgName
string

Bankifi user organisation name

roles
Array of strings

Bankifi user roles

phone
string

Bankifi user phone

Responses

Request samples

Content type
application/json
{
  • "username": "string",
  • "password": "string",
  • "customerId": "string",
  • "orgId": "string",
  • "orgName": "string",
  • "roles": [
    ],
  • "phone": "string"
}

Response samples

Content type
application/json
{
  • "errorCode": 0,
  • "errorMessage": "string",
  • "context": [
    ]
}

getV1User-mgmtOrganisations

header Parameters
x-bankifi-iam-header
required
string

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

postV1User-mgmtOrganisations

header Parameters
x-bankifi-iam-header
required
string
Request Body schema: application/json
required
id
string
name
required
string
required
object (BankifiContact2)
required
object (BankifiContact2)
Array of objects (BankifiContact2)
required
object (BankifiTaxInfo2)
status
required
string or null (OrgStatus)
Enum: "Active" "Blocked"

Status of the organisation

SIC
Array of strings
logo
string
orgType
string or null (OrgType1)
Enum: "LimitedCompany" "OtherOrg" "SoleTrader" null

Organisation type

pricingPlan
string or null (PricingPlan)
Enum: "Default" "Promo" null
Array of objects (PersonWithSignificantControl1)
Array of objects (Officer1)
object (BusinessContact)
website
string

Responses

Request samples

Content type
application/json
{
  • "id": "string",
  • "name": "string",
  • "companyInfo": {
    },
  • "primaryContact": {
    },
  • "otherContacts": [
    ],
  • "taxInfo": {
    },
  • "status": "Active",
  • "SIC": [
    ],
  • "logo": "string",
  • "orgType": "LimitedCompany",
  • "pricingPlan": "Default",
  • "personsSC": [
    ],
  • "officers": [
    ],
  • "businessContact": {
    },
  • "website": "string"
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "name": "string",
  • "companyInfo": {
    },
  • "primaryContact": {
    },
  • "otherContacts": [
    ],
  • "taxInfo": {
    },
  • "status": "Active",
  • "SIC": [
    ],
  • "logo": "string",
  • "orgType": "LimitedCompany",
  • "pricingPlan": "Default",
  • "personsSC": [
    ],
  • "officers": [
    ],
  • "businessContact": {
    },
  • "website": "string"
}

getV1User-mgmtOrganisationsId

path Parameters
id
required
string
header Parameters
x-bankifi-iam-header
required
string

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "name": "string",
  • "companyInfo": {
    },
  • "primaryContact": {
    },
  • "otherContacts": [
    ],
  • "taxInfo": {
    },
  • "status": "Active",
  • "SIC": [
    ],
  • "logo": "string",
  • "orgType": "LimitedCompany",
  • "pricingPlan": "Default",
  • "personsSC": [
    ],
  • "officers": [
    ],
  • "businessContact": {
    },
  • "website": "string"
}

putV1User-mgmtOrganisationsId

path Parameters
id
required
string
header Parameters
x-bankifi-iam-header
required
string
Request Body schema: application/json
required
id
string
name
required
string
required
object (BankifiContact2)
required
object (BankifiContact2)
Array of objects (BankifiContact2)
required
object (BankifiTaxInfo2)
status
required
string or null (OrgStatus)
Enum: "Active" "Blocked"

Status of the organisation

SIC
Array of strings
logo
string
orgType
string or null (OrgType1)
Enum: "LimitedCompany" "OtherOrg" "SoleTrader" null

Organisation type

pricingPlan
string or null (PricingPlan)
Enum: "Default" "Promo" null
Array of objects (PersonWithSignificantControl1)
Array of objects (Officer1)
object (BusinessContact)
website
string

Responses

Request samples

Content type
application/json
{
  • "id": "string",
  • "name": "string",
  • "companyInfo": {
    },
  • "primaryContact": {
    },
  • "otherContacts": [
    ],
  • "taxInfo": {
    },
  • "status": "Active",
  • "SIC": [
    ],
  • "logo": "string",
  • "orgType": "LimitedCompany",
  • "pricingPlan": "Default",
  • "personsSC": [
    ],
  • "officers": [
    ],
  • "businessContact": {
    },
  • "website": "string"
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "name": "string",
  • "companyInfo": {
    },
  • "primaryContact": {
    },
  • "otherContacts": [
    ],
  • "taxInfo": {
    },
  • "status": "Active",
  • "SIC": [
    ],
  • "logo": "string",
  • "orgType": "LimitedCompany",
  • "pricingPlan": "Default",
  • "personsSC": [
    ],
  • "officers": [
    ],
  • "businessContact": {
    },
  • "website": "string"
}

getV1User-mgmtPublicOrganisationsVerifyEmail

path Parameters
email
required
string
orgId
required
string

Responses

Response samples

Content type
application/json
{
  • "email": "string",
  • "verified": true
}

getV1User-mgmtOrganisationsContactStatus

path Parameters
orgId
required
string
header Parameters
x-bankifi-iam-header
required
string

Responses

Response samples

Content type
application/json
{
  • "email": "string",
  • "verified": true
}

putV1User-mgmtOrganisationsIdContact

path Parameters
id
required
string
header Parameters
x-bankifi-iam-header
required
string
Request Body schema: application/json
required
name
required
string
email
required
string
telephone
required
string

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "email": "string",
  • "telephone": "string"
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "name": "string",
  • "companyInfo": {
    },
  • "primaryContact": {
    },
  • "otherContacts": [
    ],
  • "taxInfo": {
    },
  • "status": "Active",
  • "SIC": [
    ],
  • "logo": "string",
  • "orgType": "LimitedCompany",
  • "pricingPlan": "Default",
  • "personsSC": [
    ],
  • "officers": [
    ],
  • "businessContact": {
    },
  • "website": "string"
}

getV1User-mgmtOrganisationsResend_verification_email

path Parameters
orgId
required
string
header Parameters
x-bankifi-iam-header
required
string

Responses

Response samples

Content type
application/json
{
  • "errorCode": 0,
  • "errorMessage": "string",
  • "context": [
    ]
}

postV1User-mgmtOrgs

header Parameters
x-bankifi-iam-header
required
string
Request Body schema: application/json
required
email
required
string

Email of the new user

role
required
any (Role)
Enum: "Administrator" "User"

List of Roles user can have.

Responses

Request samples

Content type
application/json
{
  • "email": "string",
  • "role": "Administrator"
}

Response samples

Content type
application/json
{
  • "errorCode": 0,
  • "errorMessage": "string",
  • "context": [
    ]
}

getV1User-mgmtOrgs

query Parameters
page
string

Pagination with format 'offset;;;size'

header Parameters
x-bankifi-iam-header
required
string

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "links": {
    },
  • "meta": {
    }
}

putV1User-mgmtOrgs

header Parameters
x-bankifi-iam-header
required
string
Request Body schema: application/json
required
Array
email
required
string

Email of the new user

role
any (Role)
Enum: "Administrator" "User"

List of Roles user can have.

status
any (Status)
Enum: "Active" "Pending" "Blocked" "Locked"

List of User Status.

Responses

Request samples

Content type
application/json
[
  • {
    }
]

Response samples

Content type
application/json
{
  • "errors": [
    ],
  • "updated": [
    ]
}

postV1ActivateUser-mgmtOrgs

query Parameters
code
required
string

Encrypted Code to verify the request is valid

Request Body schema: application/json
required
password
required
string

Password for the activated user

Responses

Request samples

Content type
application/json
{
  • "password": "string"
}

Response samples

Content type
application/json
{
  • "errorCode": 0,
  • "errorMessage": "string",
  • "context": [
    ]
}

postV1UsesInvitation-mgmtOrgs

path Parameters
email
required
string
header Parameters
x-bankifi-iam-header
required
string

Responses

Response samples

Content type
application/json
{
  • "errorCode": 0,
  • "errorMessage": "string",
  • "context": [
    ]
}

postV1T&C-mgmt

header Parameters
x-bankifi-iam-header
required
string

Responses

Response samples

Content type
application/json
{
  • "errorCode": 0,
  • "errorMessage": "string",
  • "context": [
    ]
}

getV1User-mgmtAdminUsersSearch

query Parameters
username
string
orgname
string
phone
string
from
string <date-time>
to
string <date-time>
page
string
sort_by
any (UserSortField)
Enum: "username" "org_name" "phone" "created_at"
sort_type
any (SortType)
Enum: "asc" "desc"

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "links": {
    },
  • "meta": {
    }
}

getV1User-mgmtAdminOrganisationsSearch

query Parameters
orgname
string
from
string <date-time>
to
string <date-time>
page
string
sort_by
any (OrgSortField)
Enum: "org_name" "status" "created_at" "subscription_status"
sort_type
any (SortType)
Enum: "asc" "desc"

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "links": {
    },
  • "meta": {
    }
}

postV1User-mgmtAdminOrganisationBlocked

Request Body schema: application/json
required
orgId
required
string

Responses

Request samples

Content type
application/json
{
  • "orgId": "string"
}

Response samples

Content type
application/json
{
  • "errorCode": 0,
  • "errorMessage": "string"
}

deleteV1User-mgmtAdminOrganisationBlocked

Request Body schema: application/json
required
orgId
required
string

Responses

Request samples

Content type
application/json
{
  • "orgId": "string"
}

Response samples

Content type
application/json
{
  • "errorCode": 0,
  • "errorMessage": "string"
}

putV1User-mgmtAdminSync-permissions

Responses

Response samples

Content type
application/json
{
  • "orgResults": [
    ]
}

getV1User-mgmtPublicCompaniesSearchCompany1

path Parameters
company
required
string

Responses

Response samples

Content type
application/json
{
  • "etag": "string",
  • "items": [
    ],
  • "totalResults": 0
}

getV1User-mgmtPublicCompaniesCompanynumberDirectors1

path Parameters
companyNumber
required
string

Responses

Response samples

Content type
application/json
{
  • "activeCount": 0,
  • "resignedCount": 0,
  • "items": [
    ],
  • "itemsPerPage": 0,
  • "startIndex": 0,
  • "totalResults": 0
}

getV1BanksMetroAccounts

Authorizations:
apiKeyAuth

Responses

Response samples

Content type
application/json
{
  • "customerName": "string",
  • "accountNumber": {
    },
  • "sortCode": {
    }
}

postV1BanksMetroAccounts

Authorizations:
apiKeyAuth
Request Body schema: application/json
required
accountHolderName
required
string
required
object (AccountNumber)
required
object (SortCode)

Responses

Request samples

Content type
application/json
{
  • "accountHolderName": "string",
  • "accountNumber": {
    },
  • "sortCode": {
    }
}

deleteV1BanksMetroAccounts

Authorizations:
apiKeyAuth

Responses

putV1BanksMetroAccountsEnable

Authorizations:
apiKeyAuth
Request Body schema: application/json
required
required
object (CustomerId)

Responses

Request samples

Content type
application/json
{
  • "customerId": {
    }
}

putV1BanksMetroAccountsDisable

Authorizations:
apiKeyAuth
Request Body schema: application/json
required
required
object (CustomerId)

Responses

Request samples

Content type
application/json
{
  • "customerId": {
    }
}

postV1BanksBankIdPayments

Authorizations:
apiKeyAuth
path Parameters
bankId
required
string

Responses

Response samples

Content type
application/json
{
  • "redirectUrl": "string"
}

Create a new outbound payment

Create a new outbound payment.

header Parameters
x-bankifi-iam-header
required
string

JWT token with details of the authenticated user

Request Body schema: application/json
required
One of
type
required
string
Value: "SupplierPayment"
required
object (EntityDetails3)
reference
string
required
object (Amount_PaymentAmount2)
required
IbanBankAccount (object) or PanBankAccount (object) or SortCodeAccountNumberBankAccount (object) (BankAccount)
required
IbanBankAccount (object) or PanBankAccount (object) or SortCodeAccountNumberBankAccount (object) (BankAccount)

Responses

Request samples

Content type
application/json
Example
{
  • "type": "SupplierPayment",
  • "invoiceId": {
    },
  • "reference": "string",
  • "amount": {
    },
  • "payerBankAccount": {
    },
  • "beneficiaryBankAccount": {
    }
}

Response samples

Content type
application/json
{
  • "id": "string"
}

Retrieve all existing outbound payments for an organisation

Retrieve all existing outbound payments for an organisation.

Retrieve Outbound Payment’s ordering by different fields. For example: /outbound-payments?page=0;;;10&orderBy=status%orderType=asc

query Parameters
page
string

Pagination

sortBy
string
Enum: "BeneficiaryName" "PaymentDate" "DueDate" "Status"

Sorted by param.

sortType
string
Enum: "Desc" "Asc"

Sorted Type - Asc or Desc

header Parameters
x-bankifi-iam-header
required
string

JWT token with details of the authenticated user

Responses

Response samples

Content type
application/json; charset=utf-8
{
  • "data": [
    ],
  • "links": {},
  • "meta": {
    }
}

/erp/{erp_id}/consent

path Parameters
erp_id
required
string

Erp Identifier.

query Parameters
consent_status
string
header Parameters
x-bankifi-iam-header
required
string

JWT token with details of the authenticated user

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "links": {
    },
  • "meta": {
    }
}

/erp/{erp_id}/consent

path Parameters
erp_id
required
string

Erp Identifier.

header Parameters
x-bankifi-iam-header
required
string

JWT token with details of the authenticated user

Responses

Response samples

Content type
application/json
{
  • "redirectUrl": "string"
}

/erp/{erp_id}/consent/{consent_id}/authorize

path Parameters
erp_id
required
string

Erp Identifier.

consent_id
required
any

Consent identifier.

query Parameters
code
required
string

The authorization code obtained from the ASPSP.

header Parameters
x-bankifi-iam-header
required
string

JWT token with details of the authenticated user

Responses

Response samples

Content type
application/json
{
  • "consentId": "string",
  • "context": {
    },
  • "consentBody": "string",
  • "meta": [
    ]
}

/erp/{erp_id}/consent/{consent_id}

path Parameters
erp_id
required
string

Erp Identifier.

consent_id
required
string

consent identifier

query Parameters
delete_data
boolean
header Parameters
x-bankifi-iam-header
required
string

JWT token with details of the authenticated user

Responses

Response samples

Content type
application/json
{
  • "errorCode": 0,
  • "errorMessage": "string"
}

/erp/{erp_id}/organisation/{org_id}

path Parameters
erp_id
required
string

Erp Identifier.

org_id
required
string
header Parameters
x-bankifi-iam-header
required
string

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "links": {
    },
  • "meta": {
    }
}

/erp/{erp_id}/organisation

path Parameters
erp_id
required
string

Erp Identifier.

header Parameters
x-bankifi-iam-header
required
string

JWT token with details of the authenticated user

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "links": {
    },
  • "meta": {
    }
}

/erp/{erp_id}/organisation

path Parameters
erp_id
required
string

Erp Identifier.

header Parameters
x-bankifi-iam-header
required
string
Request Body schema: application/json
required
required
object (EntityDetails4)
name
required
string
legalName
string
baseCurrency
string
companyNumber
string
vatNumber
string
object (Address3)
industryCode
string
object (Contact1)
Array of objects (Contact1)
bankAccount
string
object (FinancialData)
organisationType
any (OrganizationType)
Enum: "GeneralRegisteredCompany" "LimitedCompany" "LimitedLiabilityPartnership" "SoleTrader" "OtherOrg"
organisationNumber
string

Responses

Request samples

Content type
application/json
{
  • "entityDetails": {
    },
  • "name": "string",
  • "legalName": "string",
  • "baseCurrency": "string",
  • "companyNumber": "string",
  • "vatNumber": "string",
  • "address": {
    },
  • "industryCode": "string",
  • "contact": {
    },
  • "otherContacts": [
    ],
  • "bankAccount": "string",
  • "financialData": {
    },
  • "organisationType": "GeneralRegisteredCompany",
  • "organisationNumber": "string"
}

Response samples

Content type
application/json
{
  • "entityDetails": {
    },
  • "name": "string",
  • "legalName": "string",
  • "baseCurrency": "string",
  • "companyNumber": "string",
  • "vatNumber": "string",
  • "address": {
    },
  • "industryCode": "string",
  • "contact": {
    },
  • "otherContacts": [
    ],
  • "bankAccount": "string",
  • "financialData": {
    },
  • "organisationType": "GeneralRegisteredCompany",
  • "organisationNumber": "string"
}

/erp/{erp_id}/suppliers/{supplier_id}

path Parameters
erp_id
required
string

Erp Identifier.

supplier_id
required
string
header Parameters
x-bankifi-iam-header
required
string

JWT token with details of the authenticated user

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "links": {
    },
  • "meta": {
    }
}

/erp/{erp_id}/suppliers

path Parameters
erp_id
required
string

Erp Identifier.

header Parameters
x-bankifi-iam-header
required
string

JWT token with details of the authenticated user

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "links": {
    },
  • "meta": {
    }
}

/erp/{erp_id}/ledgers/clearing

path Parameters
erp_id
required
any

Erp Identifier.

header Parameters
x-bankifi-iam-header
required
any

Responses

Response samples

Content type
application/json
{
  • "errorCode": 0,
  • "errorMessage": "string"
}

/erp/{erp_id}/ledgers/clearing

path Parameters
erp_id
required
any

Erp Identifier.

header Parameters
x-bankifi-iam-header
required
any

Responses

Response samples

Content type
application/json
{
  • "ledgerId": "string",
  • "bankDetails": {
    },
  • "description": "string"
}

/erp/{erp_id}/ledgers

path Parameters
erp_id
required
string

Erp Identifier.

query Parameters
invoiceType
string
header Parameters
x-bankifi-iam-header
required
string

JWT token with details of the authenticated user

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "links": {
    },
  • "meta": {
    }
}

/erp/{erp_id}/ledgers/linked-default

path Parameters
erp_id
required
string

Erp Identifier.

query Parameters
ledgerType
string
header Parameters
x-bankifi-iam-header
required
string

JWT token with details of the authenticated user

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "links": {
    },
  • "meta": {
    }
}

/erp/{erp_id}/ledgers/check-bank-details

path Parameters
erp_id
required
string

Erp Identifier.

header Parameters
x-bankifi-iam-header
required
string
Request Body schema: application/json
required
scheme
required
any (AccountScheme1)
Enum: "IBAN" "PAN" "SortCodeAccountNumber"
accountNumber
required
string
bankId
string

Responses

Request samples

Content type
application/json
{
  • "scheme": "IBAN",
  • "accountNumber": "string",
  • "bankId": "string"
}

Response samples

Content type
application/json
{
  • "errorCode": 0,
  • "errorMessage": "string"
}

/erp/{erp_id}/customers

path Parameters
erp_id
required
string

Erp Identifier.

header Parameters
x-bankifi-iam-header
required
string

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "links": {
    },
  • "meta": {
    }
}

/erp/{erp_id}/customers

path Parameters
erp_id
required
string

Erp Identifier.

header Parameters
x-bankifi-iam-header
required
string

JWT token with details of the authenticated user

Request Body schema: application/json
required
object (EntityDetails4)
name
required
string
email
string
object (Address3)
object (Address3)
vatRate
string
mobile
string
vatNumber
string
object (Account2)

Responses

Request samples

Content type
application/json
{
  • "id": {
    },
  • "name": "string",
  • "email": "string",
  • "billingAddress": {
    },
  • "shippingAddress": {
    },
  • "vatRate": "string",
  • "mobile": "string",
  • "vatNumber": "string",
  • "bankDetails": {
    }
}

Response samples

Content type
application/json
{
  • "id": {
    },
  • "entityContact": {
    },
  • "personContact": {
    },
  • "vatNumber": "string",
  • "companyNumber": "string",
  • "blocked": true
}

/erp/{erp_id}/customers/{customer_id}/block

path Parameters
erp_id
required
string

Erp Identifier.

customer_id
required
string

customer identifier.

header Parameters
x-bankifi-iam-header
required
string

JWT token with details of the authenticated user

Responses

Response samples

Content type
application/json
{
  • "id": {
    },
  • "entityContact": {
    },
  • "personContact": {
    },
  • "vatNumber": "string",
  • "companyNumber": "string",
  • "blocked": true
}

/erp/{erp_id}/customers/{customer_id}

path Parameters
erp_id
required
string

Erp Identifier.

customer_id
required
string
header Parameters
x-bankifi-iam-header
required
string

JWT token with details of the authenticated user

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "links": {
    },
  • "meta": {
    }
}

/erp/{erp_id}/customers/{customer_id}

path Parameters
erp_id
required
string

Erp Identifier.

customer_id
required
string
header Parameters
x-bankifi-iam-header
required
string

JWT token with details of the authenticated user

Request Body schema: application/json
required
email
string
mobile
string

Responses

Request samples

Content type
application/json
{
  • "email": "string",
  • "mobile": "string"
}

Response samples

Content type
application/json
{
  • "id": {
    },
  • "entityContact": {
    },
  • "personContact": {
    },
  • "vatNumber": "string",
  • "companyNumber": "string",
  • "blocked": true
}

/erp/{erp_id}/customers/{customer_id}

path Parameters
erp_id
required
string

Erp Identifier.

customer_id
required
string
header Parameters
x-bankifi-iam-header
required
string

JWT token with details of the authenticated user

Responses

Response samples

Content type
application/json
{
  • "errorCode": 0,
  • "errorMessage": "string"
}

/erp/{erp_id}/payables

path Parameters
erp_id
required
string

Erp Identifier.

header Parameters
x-bankifi-iam-header
required
string

JWT token with details of the authenticated user

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "links": {
    },
  • "meta": {
    }
}

/erp/{erp_id}/payables

path Parameters
erp_id
required
string

Erp Identifier.

header Parameters
x-bankifi-iam-header
required
string

JWT token with details of the authenticated user

Request Body schema: application/json
required
required
object (Contact1)
Array of objects (LineItemRequest)
dateTimeIssued
required
string <datetime>
dueDateTime
required
string <datetime>
object (BankDetails2)
name
string
description
string
reference
string

Responses

Request samples

Content type
application/json
{
  • "supplier": {
    },
  • "lineItems": [
    ],
  • "dateTimeIssued": "string",
  • "dueDateTime": "string",
  • "bankDetails": {
    },
  • "name": "string",
  • "description": "string",
  • "reference": "string"
}

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "links": {
    },
  • "meta": {
    }
}

/erp/{erp_id}/payables/{payable_id}

path Parameters
erp_id
required
string

Erp Identifier.

payable_id
required
string
header Parameters
x-bankifi-iam-header
required
string

JWT token with details of the authenticated user

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "links": {
    },
  • "meta": {
    }
}

/erp/{erp_id}/payables/{payable_id}

path Parameters
erp_id
required
string

Erp Identifier.

payable_id
required
string

receivable identifier

header Parameters
x-bankifi-iam-header
required
string

JWT token with details of the authenticated user

Request Body schema: application/json
required
required
object (Contact1)
Array of objects (LineItemRequest)
dateTimeIssued
required
string <datetime>
dueDateTime
required
string <datetime>
object (BankDetails2)
name
string
description
string
reference
string

Responses

Request samples

Content type
application/json
{
  • "supplier": {
    },
  • "lineItems": [
    ],
  • "dateTimeIssued": "string",
  • "dueDateTime": "string",
  • "bankDetails": {
    },
  • "name": "string",
  • "description": "string",
  • "reference": "string"
}

Response samples

Content type
application/json
{
  • "entityDetails": {
    },
  • "lineItems": [
    ],
  • "dateTimeIssued": "string",
  • "dueDateTime": "string",
  • "supplierContact": {
    },
  • "totalAmountTaxExclusive": {
    },
  • "totalAmountTaxInclusive": {
    },
  • "debtorContact": {
    },
  • "reference": "string",
  • "paidDate": "2019-08-24",
  • "plannedPaymentDate": "2019-08-24",
  • "status": "Approved",
  • "invoiceType": "Payable",
  • "notes": [
    ],
  • "name": "string",
  • "description": "string",
  • "remainingAmountTaxExclusive": {
    },
  • "remainingAmountTaxInclusive": {
    },
  • "attachments": [
    ]
}

/erp/{erp_id}/payables/{payable_id}/status

path Parameters
erp_id
required
string

Erp Identifier.

payable_id
required
string

receivable identifier

header Parameters
x-bankifi-iam-header
required
string

JWT token with details of the authenticated user

Request Body schema: application/json
required
status
required
any (InvoiceStatus)
Enum: "Approved" "Draft" "Paid" "PartiallyPaid" "PartiallySettled" "Sent" "Settled" "Void"

Responses

Request samples

Content type
application/json
{
  • "status": "Approved"
}

Response samples

Content type
application/json
{
  • "errorCode": 0,
  • "errorMessage": "string"
}

/erp/{erp_id}/payables/{payable_id}/paid

path Parameters
erp_id
required
string

Erp Identifier.

payable_id
required
string

payable identifier.

header Parameters
x-bankifi-iam-header
required
string

JWT token with details of the authenticated user

Responses

Response samples

Content type
application/json
{
  • "entityDetails": {
    },
  • "lineItems": [
    ],
  • "dateTimeIssued": "string",
  • "dueDateTime": "string",
  • "supplierContact": {
    },
  • "totalAmountTaxExclusive": {
    },
  • "totalAmountTaxInclusive": {
    },
  • "debtorContact": {
    },
  • "reference": "string",
  • "paidDate": "2019-08-24",
  • "plannedPaymentDate": "2019-08-24",
  • "status": "Approved",
  • "invoiceType": "Payable",
  • "notes": [
    ],
  • "name": "string",
  • "description": "string",
  • "remainingAmountTaxExclusive": {
    },
  • "remainingAmountTaxInclusive": {
    },
  • "attachments": [
    ]
}

/erp/{erp_id}/receivables

path Parameters
erp_id
required
string

Erp Identifier.

header Parameters
x-bankifi-iam-header
required
string

JWT token with details of the authenticated user

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "links": {
    },
  • "meta": {
    }
}

/erp/{erp_id}/receivables

path Parameters
erp_id
required
string

Erp Identifier.

header Parameters
x-bankifi-iam-header
required
string
Request Body schema: application/json
required
required
object (Contact1)
Array of objects (LineItemRequest)
dateTimeIssued
required
string <datetime>
dueDateTime
required
string <datetime>
object (BankDetails2)
name
string
description
string
reference
string
features
Array of any (ErpFeature)
Items Value: "Native"

Responses

Request samples

Content type
application/json
{
  • "customer": {
    },
  • "lineItems": [
    ],
  • "dateTimeIssued": "string",
  • "dueDateTime": "string",
  • "bankDetails": {
    },
  • "name": "string",
  • "description": "string",
  • "reference": "string",
  • "features": [
    ]
}

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "links": {
    },
  • "meta": {
    }
}

/erp/{erp_id}/receivables/{receivable_id}

path Parameters
erp_id
required
string

Erp Identifier.

receivable_id
required
string
header Parameters
x-bankifi-iam-header
required
string

JWT token with details of the authenticated user

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "links": {
    },
  • "meta": {
    }
}

/erp/{erp_id}/receivables/{receivable_id}

path Parameters
erp_id
required
string

Erp Identifier.

receivable_id
required
string

receivable identifier.

header Parameters
x-bankifi-iam-header
required
string

JWT token with details of the authenticated user

Request Body schema: application/json
required
required
object (Contact1)
Array of objects (LineItemRequest)
dateTimeIssued
required
string <datetime>
dueDateTime
required
string <datetime>
object (BankDetails2)
name
string
description
string
reference
string
features
Array of any (ErpFeature)
Items Value: "Native"

Responses

Request samples

Content type
application/json
{
  • "customer": {
    },
  • "lineItems": [
    ],
  • "dateTimeIssued": "string",
  • "dueDateTime": "string",
  • "bankDetails": {
    },
  • "name": "string",
  • "description": "string",
  • "reference": "string",
  • "features": [
    ]
}

Response samples

Content type
application/json
{
  • "entityDetails": {
    },
  • "lineItems": [
    ],
  • "dateTimeIssued": "string",
  • "dueDateTime": "string",
  • "customerContact": {
    },
  • "totalAmountTaxExclusive": {
    },
  • "totalAmountTaxInclusive": {
    },
  • "reference": "string",
  • "remainingAmountTaxExclusive": {
    },
  • "remainingAmountTaxInclusive": {
    },
  • "paidDate": "2019-08-24",
  • "status": "Approved",
  • "invoiceType": "Payable",
  • "notes": [
    ],
  • "name": "string",
  • "description": "string",
  • "attachments": [
    ],
  • "taxCategories": [
    ],
  • "countryCode": "US",
  • "features": [
    ]
}

/erp/{erp_id}/receivables/{receivable_id}/status

path Parameters
erp_id
required
string

Erp Identifier.

receivable_id
required
string

receivable identifier.

header Parameters
x-bankifi-iam-header
required
string

JWT token with details of the authenticated user

Request Body schema: application/json
required
status
required
any (InvoiceStatus)
Enum: "Approved" "Draft" "Paid" "PartiallyPaid" "PartiallySettled" "Sent" "Settled" "Void"

Responses

Request samples

Content type
application/json
{
  • "status": "Approved"
}

Response samples

Content type
application/json
{
  • "errorCode": 0,
  • "errorMessage": "string"
}

/erp/{erp_id}/receivables/{receivable_id}/paid

path Parameters
erp_id
required
string

Erp Identifier.

receivable_id
required
string

receivable identifier.

header Parameters
x-bankifi-iam-header
required
string

JWT token with details of the authenticated user

Responses

Response samples

Content type
application/json
{
  • "entityDetails": {
    },
  • "lineItems": [
    ],
  • "dateTimeIssued": "string",
  • "dueDateTime": "string",
  • "customerContact": {
    },
  • "totalAmountTaxExclusive": {
    },
  • "totalAmountTaxInclusive": {
    },
  • "reference": "string",
  • "remainingAmountTaxExclusive": {
    },
  • "remainingAmountTaxInclusive": {
    },
  • "paidDate": "2019-08-24",
  • "status": "Approved",
  • "invoiceType": "Payable",
  • "notes": [
    ],
  • "name": "string",
  • "description": "string",
  • "attachments": [
    ],
  • "taxCategories": [
    ],
  • "countryCode": "US",
  • "features": [
    ]
}

/erp/{erp_id}/receivables/{receivable_id}/payment-received

path Parameters
erp_id
required
string

Erp Identifier.

receivable_id
required
string

receivable identifier.

header Parameters
x-bankifi-iam-header
required
string
Request Body schema: application/json
required
required
object (Amount5)
date
required
string <date>
dateTime
string <datetime>
reference
string
paymentType
any (PaymentType)
Enum: "BankTransfer" "Card" "Cash" "Cheque" "PIS"
object (BankAccount1)

Responses

Request samples

Content type
application/json
{
  • "amount": {
    },
  • "date": "2019-08-24",
  • "dateTime": "string",
  • "reference": "string",
  • "paymentType": "BankTransfer",
  • "bankAccountPaidInfo": {
    }
}

Response samples

Content type
application/json
{
  • "amount": {
    },
  • "date": "2019-08-24",
  • "dateTime": "string",
  • "reference": "string",
  • "paymentType": "BankTransfer",
  • "bankAccountPaidInfo": {
    }
}

/erp/{erp_id}/summary

path Parameters
erp_id
required
string

Erp Identifier.

query Parameters
from
required
string
to
required
string
header Parameters
x-bankifi-iam-header
required
string

JWT token with details of the authenticated user

Responses

Response samples

Content type
application/json
{
  • "from": "2019-08-24",
  • "to": "2019-08-24",
  • "payables": {
    },
  • "receivables": {
    }
}

/erp/{erp_id}/bank_accounts

path Parameters
erp_id
required
string

Erp Identifier.

header Parameters
x-bankifi-iam-header
required
string

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "links": {
    },
  • "meta": {
    }
}

/erp/{erp_id}/receivables/{invoice_id}/pdf

path Parameters
erp_id
required
string

Erp Identifier.

invoice_id
required
string
header Parameters
x-bankifi-iam-header
required
string

JWT token with details of the authenticated user

Responses

Response samples

Content type
application/json
{
  • "uri": "string"
}

/segment/{segment}

path Parameters
segment
required
string

Responses

/erp/{erp_id}/vat-rates

path Parameters
erp_id
required
string

Erp Identifier.

query Parameters
invoiceType
string
header Parameters
x-bankifi-iam-header
required
string

JWT token with details of the authenticated user

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "links": {
    },
  • "meta": {
    }
}

/erp/{erp_id}/preferences

path Parameters
erp_id
required
string

Erp Identifier.

header Parameters
x-bankifi-iam-header
required
string

JWT token with details of the authenticated user

Responses

Response samples

Content type
application/json
{
  • "erpId": "string",
  • "automatedSalesTax": true
}

/erp/{erp_id}/items

path Parameters
erp_id
required
string

Erp Identifier.

query Parameters
invoiceType
string

add the invoice type for which the items should be taken. Receivable or Payable. With no filter, all of them will be retrieved BUT the user can't use a payable item when creating a receivable.

header Parameters
x-bankifi-iam-header
required
string

JWT token with details of the authenticated user

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "links": {
    },
  • "meta": {
    }
}

/erp/{erp_id}/plan

path Parameters
erp_id
required
string

Erp Identifier.

header Parameters
x-bankifi-iam-header
required
string

JWT token with details of the authenticated user

Responses

Response samples

Content type
application/json
"start"

Create Payment

Custom Create Payment

Custom endpoint to create a payment

path Parameters
bank_id
required
any

Bank identifier.

header Parameters
x-bankifi-iam-header
required
any

JWT token with details of the authenticated user

Responses

Get Beneficiaries

Get the custom beneficiaries

Custom endpoint to get the beneficiaries

path Parameters
bank_id
required
any

Bank identifier.

account_id
required
any

Account identifier

header Parameters
x-bankifi-iam-header
required
any

JWT token with details of the authenticated user

Responses

Create Beneficiaries

Custom Create Beneficiaries

Custom endpoint to create a beneficiary

path Parameters
bank_id
required
any

Bank identifier.

account_id
required
any

Account identifier

header Parameters
x-bankifi-iam-header
required
any

JWT token with details of the authenticated user

Responses

Cash Flow Forecasting

Initiate calculating a forecast.

Initiate calculating a forecast.

query Parameters
to_date
required
string <date>

Sets the final date for forecasting

header Parameters
x-bankifi-iam-header
required
string

JWT token with details of the authenticated user

Responses

Response samples

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

Get input data (balances, unpaid invoices, bills) and forecast data.

path Parameters
forecast_id
required
string

Forecast ID

header Parameters
x-bankifi-iam-header
required
string

JWT token with details of the authenticated user

Responses

Response samples

Content type
application/json
{
  • "balances": {
    },
  • "unpaidInvoices": {
    },
  • "unpaidBills": {
    },
  • "forecast": [
    ]
}

Refine forecast

path Parameters
forecast_id
required
string

Forecast ID

header Parameters
x-bankifi-iam-header
required
string

JWT token with details of the authenticated user

Request Body schema: application/json
required
manualBalance
number <double>
Array of objects (ManualTx)
object (IdFilter)
object (IdFilter)

Responses

Request samples

Content type
application/json
{
  • "manualBalance": 0.1,
  • "manualTxs": [
    ],
  • "payablesFilter": {
    },
  • "receivablesFilter": {
    }
}

Response samples

Content type
application/json
{
  • "forecast": [
    ]
}

Custom data operations

Retrieve Accounts.

Retrieve list of AISP Accounts

Authorizations:
None
header Parameters
x-bankifi-iam-header
required
string

JWT token with details of the authenticated user/customer (Bankifi token)

Authorization
required
string

JWT token with details of the authenticated user/customer (Finacle token)

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "links": {
    },
  • "meta": {
    }
}

Retrieve Account balances.

Retrieve list of AISP Account balances.

Authorizations:
None
header Parameters
x-bankifi-iam-header
required
string

JWT token with details of the authenticated user/customer (Bankifi token)

Authorization
required
string

JWT token with details of the authenticated user/customer (Finacle token)

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "links": {
    },
  • "meta": {
    }
}

Retrieve consent details.

Retrieve consent details.

Authorizations:
None
query Parameters
requestId
required
string
header Parameters
x-bankifi-iam-header
required
string

JWT token with details of the authenticated user/customer (Bankifi token)

Authorization
required
string

JWT token with details of the authenticated user/customer (Finacle token)

Responses

Response samples

Content type
application/json
{
  • "tppRefId": "string",
  • "tppName": "string",
  • "consentDescription": "string",
  • "tppCallbackUrl": "string",
  • "requestType": "string",
  • "resourceTypeAccessList": [
    ]
}

Create consent.

Create consent for a new user.

Authorizations:
None
header Parameters
x-bankifi-iam-header
required
string

JWT token with details of the authenticated user/customer (Bankifi token)

Authorization
required
string

JWT token with details of the authenticated user/customer (Finacle token)

Request Body schema: application/json
required
requestId
required
string
consentType
required
string
object (ListResponse_AccountDetailsForConsentCreation)

Responses

Request samples

Content type
application/json
{
  • "requestId": "string",
  • "consentType": "string",
  • "accountList": {
    }
}

Response samples

Content type
application/json
{
  • "tppCallbackUrl": "string",
  • "consentRequestId": "string",
  • "consentId": "string"
}

Credit card table API.

API to get list of credit cards along with balances.

Authorizations:
None
header Parameters
x-bankifi-iam-header
required
string

JWT token with details of the authenticated user/customer (Bankifi token)

Authorization
required
string

JWT token with details of the authenticated user/customer (Finacle token)

Responses

Response samples

Content type
application/json
{
  • "commonDetails": {
    },
  • "cardsList": [
    ]
}

Request Finacle for /transactionsrequests v2

Request Finacle for /transactionsrequests v2

Authorizations:
None
query Parameters
counterpartyType
string
transactionDate
string <date-time>
counterpartyAccount
string
limit
integer <int64>
header Parameters
x-bankifi-iam-header
required
string

JWT token with details of the authenticated user/customer (Bankifi token)

Authorization
required
string

JWT token with details of the authenticated user/customer (Finacle token)

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "links": {
    },
  • "meta": {
    }
}

accounts

Retrieve the list of all the bank accounts the user has consented to.

Retrieve the list of all the bank accounts the user has consented to.

header Parameters
x-bankifi-iam-header
required
string

JWT token with details of the authenticated user/customer

Responses

Retrieve a list of bank accounts.

Retrieve a list of bank accounts.

path Parameters
bank_id
required
string

Bank identifier.

header Parameters
x-bankifi-iam-header
required
string

JWT token with details of the authenticated user/customer

Responses

Retrieve a bank account.

Retrieve a bank account.

path Parameters
bank_id
required
string

Bank identifier.

account_id
required
string

Bank account identifier.

header Parameters
x-bankifi-iam-header
required
string

JWT token with details of the authenticated user/customer

Responses

Retrieve transactions for a bank account.

Retrieve transactions for a bank account.

path Parameters
bank_id
required
string

Bank identifier.

account_id
required
string

Bank account identifier.

header Parameters
x-bankifi-iam-header
required
string

JWT token with details of the authenticated user/customer

Responses

Get consent resource

Get consent resource

path Parameters
bank_id
required
string

Bank identifier.

header Parameters
x-bankifi-iam-header
required
string

JWT token with details of the authenticated user

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "links": {},
  • "property1": null,
  • "property2": null
}

Create consent resource

Create consent resource

path Parameters
bank_id
required
string

Bank identifier.

header Parameters
x-bankifi-iam-header
required
string

JWT token with details of the authenticated user

Responses

Authorize consent

Authorize consent

path Parameters
bank_id
required
string

Bank identifier.

consent_id
required
string

Consent identifier.

query Parameters
code
required
string

The authorization code obtained from the ASPSP.

header Parameters
x-bankifi-iam-header
required
string

JWT token with details of the authenticated user

Responses

Delete consent resource

Delete consent resource

path Parameters
bank_id
required
string

Bank identifier.

consent_id
required
string

consent identifier

header Parameters
x-bankifi-iam-header
required
string

JWT token with details of the authenticated user

Responses

Response samples

Content type
application/json
{
  • "errorCode": 0,
  • "errorMessage": "string"
}

reconsent

Retrieve a list of bank connection consents that require renewal by the user

Retrieve a list of bank connection consents that require renewal by the user

header Parameters
x-bankifi-iam-header
required
string

JWT token with details of the authenticated user/customer

Responses

Response samples

Content type
application/json
{}

Extend the given connection's expiration period by 90 days

Extend the given connection's expiration period by 90 days

header Parameters
x-bankifi-iam-header
required
string

JWT token with details of the authenticated user/customer

Request Body schema: application/json
required
connectionIds
required
Array of strings

Responses

Request samples

Content type
application/json
{
  • "connectionIds": [
    ]
}

Response samples

Content type
application/json
{
  • "errorCode": 0,
  • "errorMessage": "string"
}

Delete consents

Delete consents and associated connections

header Parameters
x-bankifi-iam-header
required
string

JWT token with details of the authenticated user/customer

Request Body schema: application/json
required
consentIds
required
Array of strings

Responses

Request samples

Content type
application/json
{
  • "consentIds": [
    ]
}

Response samples

Content type
application/json
{
  • "errorCode": 0,
  • "errorMessage": "string"
}

User Checks

getV1AuthzUsers

Check User Endpoint

Authorizations:
apiKeyAuth
query Parameters
user
required
string non-empty
organization
required
string non-empty
resource
required
string (ResourceObject)
Enum: "group" "user" "organisation" "rtp" "invoice" "contact" "payment" "bank_account" "accounting_package" "bank_ledger" "clearing_ledger"
action
required
string (Action)
Enum: "create" "view" "update" "delete"

Responses

Response samples

Content type
application/json
"Authorized"

Subscriptions

getV1AuthzStatus

Check Subscription Status Endpoint

Authorizations:
apiKeyAuth
query Parameters
organization
required
string non-empty

Responses

Response samples

Content type
application/json
Example
{ }

Roles

getV1AuthzRoles

Get Roles for User in Organization

Authorizations:
apiKeyAuth
query Parameters
user
required
string non-empty
organization
required
string non-empty

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Policies

postV1AuthzPoliciesGroup

Authorizations:
apiKeyAuth
Request Body schema: application/json
required

Group to add

required
object (UserGroup)
required
object (Domain)
required
AccountingPackage (object) or BankAccount2 (object) or BankLedger (object) or ClearingLedger1 (object) or Contact2 (object) or Group1 (object) or Invoice (object) or Organisation1 (object) or Payment (object) or RTP1 (object) or User (object) (ResourceObject1)
required
Create (object) or Delete (object) or Update (object) or View (object) (Action1)

Responses

Request samples

Content type
application/json
{
  • "group": {
    },
  • "domain": {
    },
  • "resource": { },
  • "action": { }
}

deleteV1AuthzPoliciesGroup

Authorizations:
apiKeyAuth
Request Body schema: application/json
required

Group to remove

required
object (UserGroup)
required
object (Domain)
required
AccountingPackage (object) or BankAccount2 (object) or BankLedger (object) or ClearingLedger1 (object) or Contact2 (object) or Group1 (object) or Invoice (object) or Organisation1 (object) or Payment (object) or RTP1 (object) or User (object) (ResourceObject1)
required
Create (object) or Delete (object) or Update (object) or View (object) (Action1)

Responses

Request samples

Content type
application/json
{
  • "group": {
    },
  • "domain": {
    },
  • "resource": { },
  • "action": { }
}

postV1AuthzPoliciesGroups

Authorizations:
apiKeyAuth
Request Body schema: application/json
optional

Groups to add

Array
required
object (UserGroup)
required
object (Domain)
required
AccountingPackage (object) or BankAccount2 (object) or BankLedger (object) or ClearingLedger1 (object) or Contact2 (object) or Group1 (object) or Invoice (object) or Organisation1 (object) or Payment (object) or RTP1 (object) or User (object) (ResourceObject1)
required
Create (object) or Delete (object) or Update (object) or View (object) (Action1)

Responses

Request samples

Content type
application/json
[
  • {
    }
]

deleteV1AuthzPoliciesGroups

Authorizations:
apiKeyAuth
Request Body schema: application/json
optional

Groups to remove

Array
required
object (UserGroup)
required
object (Domain)
required
AccountingPackage (object) or BankAccount2 (object) or BankLedger (object) or ClearingLedger1 (object) or Contact2 (object) or Group1 (object) or Invoice (object) or Organisation1 (object) or Payment (object) or RTP1 (object) or User (object) (ResourceObject1)
required
Create (object) or Delete (object) or Update (object) or View (object) (Action1)

Responses

Request samples

Content type
application/json
[
  • {
    }
]

postV1AuthzPoliciesUser

Authorizations:
apiKeyAuth
Request Body schema: application/json
required

User to add

required
object (User1)
required
object (UserGroup)
required
object (Domain)

Responses

Request samples

Content type
application/json
{
  • "user": {
    },
  • "group": {
    },
  • "domain": {
    }
}

deleteV1AuthzPoliciesUser

Authorizations:
apiKeyAuth
Request Body schema: application/json
required

User to remove

required
object (User1)
required
object (UserGroup)
required
object (Domain)

Responses

Request samples

Content type
application/json
{
  • "user": {
    },
  • "group": {
    },
  • "domain": {
    }
}

postV1AuthzPoliciesUsers

Authorizations:
apiKeyAuth
Request Body schema: application/json
optional

Users to add

Array
required
object (User1)
required
object (UserGroup)
required
object (Domain)

Responses

Request samples

Content type
application/json
[
  • {
    }
]

deleteV1AuthzPoliciesUsers

Authorizations:
apiKeyAuth
Request Body schema: application/json
optional

Users to remove

Array
required
object (User1)
required
object (UserGroup)
required
object (Domain)

Responses

Request samples

Content type
application/json
[
  • {
    }
]

push

Token for Push notifications

Configures the token required to send push notifications.

header Parameters
x-mobile-deviceid
required
string
Request Body schema: application/json
required
string

Responses

Request samples

Content type
application/json
"string"

Response samples

Content type
application/json
{
  • "username": "string",
  • "deviceId": "string",
  • "pushToken": "string"
}

token

Token for Push notifications

Configures the token required to send push notifications.

header Parameters
x-mobile-deviceid
required
string
Request Body schema: application/json
required
string

Responses

Request samples

Content type
application/json
"string"

Response samples

Content type
application/json
{
  • "username": "string",
  • "deviceId": "string",
  • "pushToken": "string"
}