External Spring Boot Application

Client Portal

Supported APIs

Encryption API: All calls to the API must use this route.
- https://devportal.dev1.fondybank.io/encryption-api
Identity API: To create an identity in the Fondy System.
- https://devportal.dev1.fondybank.io/identity-api
SplitAccount API: To manage/interact with your specific split account(s).
- https://devportal.dev1.fondybank.io/splitaccount-api
  - This must use the Encryption route to send the messages. Please see the Jar/Experimental Springboot Application for easy to use solutions.
  - When creating a wallet, a compliance profile UUID must be provided.
Core Banking API: To use the system in the same manner that the UI does.
- https://devportal.dev1.fondybank.io/core-api

Downloads

For more details and to download the provided Jar files, please visit the dev portal site.

JAR

VERSION	RELEASE	Download Link
2.0.0	16-08-2023	fondy-client-jar-2.0.0.zip

Experimental SpringBoot Application

For now this is only to be used in Dev/Test environments.
This must be inside your "ring-fence" and with no direct calls from users

e.g.

User (UI) → your webservice (processes) → then calls this application

Download

Version	Link	Date
2.2.0	ExperimentalSpringBoot.zip	06-03-2024
2.1.0	ExperimentalSpringBoot.zip	11-10-2023
2.0.0	ExperimentalSpringBoot.zip	16-08-2023

Client Values Note

The values for:

"username": "FONDY TO PROVIDE FOR DEV",
"splitAccountRef": "FONDY TO PROVIDE",
"clientRef": "FONDY TO PROVIDE",

Will be emailed to you, as these are different per client/environment.

Application Note:

This application was created over a short time period and has been lightly tested.
It is currently considered a possible tool, and we welcome feedback.
If useful, we plan to productionize the stack for broader use. P
lease note that there could well be bugs in the stack, etc.

C:\\tools\\jdk-15\\bin\\java -Dspring.application.json='{
  "username": "FONDY TO PROVIDE FOR DEV",
  "environment": "dev",
  "url": "https://api.dev1.fondybank.io/clientapi/example/",
  "splitAccountRef": "FONDY TO PROVIDE",
  "clientRef": "FONDY TO PROVIDE",
  "fondyPublic": "",
  "yourPrivate": ""
}' -jar FCSpringboot-0.0.1-SNAPSHOT.jar io.fondybank.client.springboot.StandAloneSbApplication

All of the above values are correct and will grant you access to the Fondy development environment. For the endpoint provided, the "fondyPublic" and "yourPrivate" fields are not required.

Setup Instructions

The path C:\\tools\\jdk-15\\bin\\java is provided as an example. Please update this to the location of your JDK environment on your machine.
If you don't have JDK or need to update, we recommend downloading JDK version 15 from this page. Direct download link for Windows: JDK 15.0.2.
Extract the JDK archive into a directory such as c:\tools\jdk…. Rename the extracted folder to jdk-15 to match the path in the batch file.

Assuming the above setup is complete, running the batch file should result in the application starting up successfully. You will know it is ready when you see a specific output (represented as here) and the system is available on http://localhost:8080.

Example URLs

To utilize the application, you can call the endpoints listed on the portal page using GET/POST methods along with the appropriate ID/Payloads as needed.

Below are example UUIDs for testing purposes. If the stack is running correctly, you will see appropriate error messages or other responses, indicating that the API calls to and from Fondy are functioning properly.

Usage

To use:

Windows CMD:

When you will extract .zip file you will need 3 files: config.json, RUNWEBSERVERWINDOWSCMD.bat and the FCSpringboot-0.0.1-SNAPSHOT.jar file.

Open the config.json file and input your values (see client values note) and save the file.
Edit RUNWEBSERVERWINDOWSCMD.bat and replace java path with your machine path to java (see image below).
Open a Windows terminal in the current folder and run RUNWEBSERVERWINDOWSCMD.bat.

When you extract the .zip file, you will need 2 files: RUNWEBSERVER.bat and the FCSpringboot-0.0.1-SNAPSHOT.jar file.

Edit the RUNWEBSERVER.bat and input your values (see client values note) and save the file. Also, make sure that you change the Java path according to the path to Java on your local machine (see image below).
Run RUNWEBSERVER.bat by opening a Windows terminal in the current folder and executing the batch file.

Example URLs

To use the application, call the endpoints with GET or POST methods as needed, using the appropriate ID/Payloads. Below are example UUIDs; if the stack is running correctly, you should see appropriate error messages, indicating the API is functioning with calls to and from Fondy.

Split Accounts

Get a wallet
- Method: GET
- URL: http://localhost:8080/fondy/splitaccount/1612fbd2-3c38-4fd2-b2ab-65c54282b99a
Get all wallets
- Method: GET
- URL: http://localhost:8080/fondy/splitaccount/wallet
Create a wallet
- Method: POST
- URL: http://localhost:8080/fondy/splitaccount/wallet
Get All payments for a wallet
- Method: GET
- URL: http://localhost:8080/fondy/splitaccount/wallet/1612fbd2-3c38-4fd2-b2ab-65c54282b99a/payment
Create a payment
- Method: POST
- URL: http://localhost:8080/fondy/splitaccount/1612fbd2-3c38-4fd2-b2ab-65c54282b99a/payment
Get a payment
- Method: GET
- URL: http://localhost:8080/fondy/splitaccount/1612fbd2-3c38-4fd2-b2ab-65c54282b99a/payment/1612fbd2-3c38-4fd2-b2ab-65c54282b99a

Please note, the endpoints marked in red can return large volumes of data and should not be called frequently.

CoreBanking

Get Accounts
- Method: GET
- URL: http://localhost:8080/fondy/banking/accounts/
Get Account
- Method: GET
- URL: http://localhost:8080/fondy/banking/accounts/31bb95a3-8605-4730-880a-4a0fb206cf88/
Get Accounts Transactions
- Method: GET
- URL: http://localhost:8080/fondy/banking/accounts/31bb95a3-8605-4730-880a-4a0fb206cf88/transactions
Get All payments
- Method: GET
- URL: http://localhost:8080/fondy/banking/accounts/31bb95a3-8605-4730-880a-4a0fb206cf88/payments/
Create a payment
- Method: POST
- URL: http://localhost:8080/fondy/banking/accounts/31bb95a3-8605-4730-880a-4a0fb206cf88/payments/
Get a payment
- Method: GET
- URL: http://localhost:8080/fondy/banking/accounts/31bb95a3-8605-4730-880a-4a0fb206cf88/payments/0d099451-d2ef-4d82-8c20-28e5c1aa4442

Compliance

Create an identity (self AML/DD only)
- Method: POST
- URL: http://localhost:8080/fondy/compliance/identity
Get an identity
- Method: GET
- URL: http://localhost:8080/fondy/compliance/identity/1612fbd2-3c38-4fd2-b2ab-65c54282b99a
Create a profile
- Method: POST
- URL: http://localhost:8080/fondy/compliance/profile
Get a profile
- Method: GET
- URL: http://localhost:8080/fondy/compliance/profile/1612fbd2-3c38-4fd2-b2ab-65c54282b99a

Example Payloads

Core Banking

Accounts (GET)

URL: http://localhost:8080/fondy/banking/accounts/31bb95a3-8605-4730-880a-4a0fb206cf88

{
  "id": "31bb95a3-8605-4730-880a-4a0fb206cf88",
  "account_details": {
    "bic": "TEIAMLH1",
    "iban": "XK567152264070910047",
    "id": null,
    "name": "Account Holder name",
    "account_number": "12513879",
    "sort_code": "950260"
  },
  "master_account_id": null,
  "wallet_account_id": null,
  "wallet_business_reference": null,
  "account_alias": "First test",
  "account_type": "STANDARD",
  "account_balance": {
    "currency": "GBP",
    "amount": 22700
  },
  "external_id": null,
  "status": "ACTIVE",
  "classification": null,
  "account_currency": "GBP",
  "created_date_time": "2022-05-09T09:26:30.619137",
  "updated_date_time": null,
  "default_wallet": null
}

Payments (GET)

URL: http://localhost:8080/fondy/banking/accounts/31bb95a3-8605-4730-880a-4a0fb206cf88/payments/0d099451-d2ef-4d82-8c20-28e5c1aa4442

{
  "applyDateTime": null,
  "id": "0d099451-d2ef-4d82-8c20-28e5c1aa4442",
  "external_id": null,
  "account_details": null,
  "counterparty": {
    "bic": null,
    "iban": null,
    "id": null,
    "name": "Barclays",
    "account_number": "55555555",
    "sort_code": "202015"
  },
  "settlement_date_time": "2024-01-16T14:35:31.413",
  "created_date_time": "2024-01-22T10:11:47.234585",
  "payment_references": null,
  "requested_amount": {
    "currency": "GBP",
    "amount": 2000
  },
  "fee": {
    "currency": null,
    "amount": null
  },
  "scheme": "CHAPS",
  "payment_type": null,
  "rejection_details": {
    "reason_code": null,
    "external_id": null,
    "reason_text": null,
    "origin_payment_id": null
  },
  "status": "SETTLED",
  "payment_direction": "INBOUND"
}

Payments (POST)

URL: http://localhost:8080/fondy/banking/accounts/31bb95a3-8605-4730-880a-4a0fb206cf88/payments

{
  "counterparty": {
    "name": "Barclays",
    "account_number": "55555555",
    "sort_code": "202015"
  },
  "payment_references": {
    " payment_reference": "BUSINESSREF123"
  },
  "requested_amount": {
    "currency": "GBP",
    "amount": "200"
  }
}

Transactions (GET ALL only)

URL: http://localhost:8080/fondy/banking/accounts/31bb95a3-8605-4730-880a-4a0fb206cf88/transactions

[
  {
    "id": "7636cb7e-3b60-4bea-a7ff-c11da7f2cb47",
    "account_id": "31bb95a3-8605-4730-880a-4a0fb206cf88",
    "account_type": null,
    "payment_id": "fd0917f3-3d9b-4f1b-969b-195f5e2d4418",
    "payment_scheme": "CHAPS",
    "transaction_amount": {
      "currency": "GBP",
      "amount": 200
    },
    "account_opening_balance": {
      "currency": "GBP",
      "amount": 22500
    },
    "account_closing_balance": {
      "currency": "GBP",
      "amount": 22700
    },
    "is_fee": false,
    "debit_credit_code": "Credit",
    "counterparty": {
      "bic": null,
      "iban": "GB33BUKB20201555555555",
      "id": null,
      "name": "Barclays",
      "account_number": "55555555",
      "sort_code": "202015"
    },
    "transaction_reference": "FPS",
    "record_created_date": "2024-01-25T12:39:36.585865",
    "value_date": null,
    "booking_date": "2024-01-25T12:39:35.29618"
  }
]