Open Banking is now released for our customers via API. Open Banking Consent

GET /open-banking/{openBankingCode}/consents/{id}
{
	"workflow": {},
	"data": {
		"consent": {
			"id": "00000000-0000-0000-0000-000000000000",
			"thirdPartyProvider": {
				"name": "Example TPP Company Limited",
				"website": "https://example.com",
				"applicationName": "Example Third Party Application",
				"applicationDescription": "Test harness app for integration environment",
				"applicationWebsite": "https://example.com"
			},
			"status": "authorised",
			"content": {
				"scope": "accounts"
			},
			"requestCreatedDateTime": "2023-05-11T09:17:59",
			"requestExpiryDateTime": "2023-05-11T09:27:59",
			"grantedDateTime": "2023-05-11T09:18:53",
			"expiryDateTime": "2023-08-09T09:18:53"
		}
	},
	"connect": {},
	"metadata": {}
}
PATCH /open-banking/{openBankingCode}/consents/{id}
{
  "workflow": {
    "code": "direct"
  },
  "data": {
    "consent": {
        "action": "revoke"   
    }
  },
  "connect": {},
  "metadata": {}
}
  • Added accountHolderIdentityType to the account JSON object. Accounts

Generic Transaction API changes:

  • Added creationDateTimeFrom and creationDateTimeTo to the generic transaction query parameter. This feature is added to enable filtering by date for Generic Transaction API. List Generic Transaction

Account API changes:

  • Added payableBalance to the account JSON object. This feature is added to show a payable balance of client accounts. Accounts

Client API changes:

  • Added fullname instead of title to client and client relation JSON objects for get and list API response body. List Clients

This release includes API changes to the Client API. Below, you'll find details about the modifications that have been included in this release.

Client API changes:

  • email was added to the client and client relation profile JSON objects. Clients

This release includes Provisioned Account Credit API. Below, you'll find the details about the changes and new additions that have been included in this release.

This release includes API changes to Outgoing Transfer. Below, you will find details about the modifications made to the Outgoing Transfer API.

Outgoing Transfer API changes:

GET /outgoing-transfers/{id}
{
  "workflow": {},
  "data": {
    "outgoingTransfer": {
      "id": "00000000-0000-0000-0000-000000000000",
      "transactionNumber": "20210419-000000",
      "clientId": "00000000-0000-0000-0000-000000000000",
      "transferDate": "2021-04-19",
      "status": "pending",
      "currency": "GBP",
      "amount": 100,
      "feeCurrency": "GBP",
      "feeAmount": 12,
      "description": "API dryRun",
      "transferReasonId": "00000000-0000-0000-0000-000000000000",
      "transferCustomReason": null,
      "originalTransferDate": "2021-04-19",
      "cutOffDateTime": "2021-04-19T09:00:00",
      "rollCount": 0,
      "totalAmount": 112,
      "ownerType": "client",
      "scheme": "sepa",
      "scope": "external",
      "destination": {
        "type": "beneficiary-bank-account",
        "beneficiaryBankAccountId": "00000000-0000-0000-0000-000000000000"
      },
      "source": {
        "type": "client-account",
        "accountId": "00000000-0000-0000-0000-000000000000"
      },
      "beneficiary": {
        "identity": {
          "type": "corporate",
          "country": "IN",
          "identificationNumbers": null,
          "identifications": null,
          "legalName": "Dalsim Limited",
          "incorporationDate": null,
          "corporationType": null
        },
        "address": {
          "country": "IN",
          "city": "Mumbai",
          "street": "Line1",
          "postalCode": "1231231"
        },
        "account": {
          "accountHolderName": null,
          "country": "IN",
          "currency": "INR",
          "routingCodes": {
            "ifsc": "ABCD0123456"
          },
          "accountNumber": "1234678812",
          "iban": null,
          "ledgerNumber": null,
          "alias": "INR account"
        },
        "fullName": "Dalsim Limited"
      }
    }
  },
  "connect": {},
  "metadata": {}
}

Generic Transaction is now released for our customers via API. Generic Transaction API Guide

User API changes:

  • Added status to user JSON object. Users
  • Added id and status to user client relation JSON object. Users
  • Added a new endpoint for updating user invitations: User Invitations
PATCH /users/{email}/invitations/{id}
{
    "workflow": {
        "code": "direct"
    },
    "data": {
        "userInvitation": {
            "status": "cancelled"
        }
    },
    "connect": {},
    "metadata": {}
}
PATCH /users/{userId}/client-relations/{id}
{
    "workflow": {
        "code": "direct"
    },
    "data": {
        "userClientRelation": {
            "status": "revoked"
        }
    },
    "connect": {},
    "metadata": {}
}

Integrated Finance clients can now benefit from a comprehensive summary of financial accounts with the newly released Account Statement API Account Statement API Guide. Below, you will find details about the functionalities included in this release.

metadata.page.number
metadata.page.size
data.accountStatement.transactionNumber
data.accountStatement.entryDateTimeFrom
data.accountStatement.entryDateTimeTo
GET /accounts/{accountId}/account-statements
{
  "workflow": {},
  "data": {
    "accountStatements": [
      {
        "accountId": "00000000-0000-0000-0000-000000000000",
        "transactionNumber": "20220822-GK2ADA",
        "transactionType": "adjustment",
        "entryType": "principal",
        "entryDateTime": "2022-09-09T09:13:10.496",
        "direction": "credit/debit",
        "amount": 10,
        "balance": 153019.26,
        "currency": "TRY",
        "narrative": "Transfer fee for 20220822-GK2ADA"
      }
    ]
  },
  "connect": {},
  "metadata": {
    "page": {
      "size": 20,
      "number": 0,
      "totalElements": 1,
      "totalPages": 1
    }
  }
}

​​We have introduced a new identification number structure for the Client and Beneficiary APIs. Below, you'll find details about the new and deprecated corporate and individual JSON objects included in this release.

  • identifications was added to the corporate and individual JSON objects. Clients & Beneficiary
  • identificationNumbers was deprecated from the corporate and individual identity JSON objects. Clients & Beneficiary

Beneficiary Bank Account Requirements are now released for our customers via API. Beneficiary Bank Account Requirements

{
  "workflow": {},
  "data": {
    "beneficiaryBankAccount": {
      "requirements": {
        "beneficiaryAddress": "optional/required"
      },
      "iban": {
        "requirement": "required",
        "regex": ""
      },
      "accountNumber": {
        "requirement": "none/optional/required",
        "regex": "^[0-9]{7,20}$"
      },
      "bankName": {
        "requirement": "none/optional/required",
        "regex": null
      },
      "routingCodes": {
        "bic": {
          "requirement": "none/optional/required",
          "regex": "^[A-Z]{6}[A-Z0-9]{2}([A-Z0-9]{3})?$"
        }
      }
    },
    "beneficiaryAddress": {
      "country": {
        "requirement": "required",
        "regex": "^[A-Z]{2}$"
      },
      "region": {
        "requirement": "none/required",
        "regex": "^.{1,255}"
      },
      "city": {
        "requirement": "required",
        "regex": "^.{1,255}"
      },
      "street": {
        "requirement": "required",
        "regex": "^.{1,255}"
      },
      "houseNumber": {
        "requirement": "optional",
        "regex": "^.{1,255}"
      },
      "postalCode": {
        "requirement": "none/optional/required",
        "regex": "^.{1,12}"
      },
      "refinement": {
        "requirement": "optional",
        "regex": "^.{1,255}"
      }
    }
  },
  "connect": {},
  "metadata": {}
}

This release includes API changes to Incoming Transfer and Account. Below, you will find details about the modifications made to the Incoming Transfer and Account APIs.

Incoming Transfer API changes:

  • Added transferDateFrom and transferDateTo date filtering parameters to the Incoming Transfer List API. Incoming Transfers
  • Added transferDate to the Incoming Transfer JSON object. Incoming Transfers

Account API changes:

  • New account balance adjustment workflows were introduced to ensure accurate and consistent adjustments to account balances.
    IF customers will now have the ability to reflect / mirror transactions from the providers they have integrated independently. This process, known as "Synchronisation," captures transactions that have taken place but were not initially recorded on the IF Platform.
    Please note: type can only be unconnected-service-provider and code of unconnected service provider must be included in data section.