APIs

CREATE CUSTOMER

This API is used to create a new customer profile for given customer ID.

POSTparty/profiles/{partyID}

Request

{
}

Response

{
  "data": {
    "id": "187784918888089957",
    "identifier": "GB0010001-100100",
    "secret": "RE1oMTTRL3t0EO1Cl5z6QaV-XhT2jCycXvZ8Kim32J4"
  }

}

CREATE CONNECTION

This API is used to create a connection for the customer in a given bank.

POSTparty/profiles/{partyID}/banks/{bankCode}/connections

Request

{
  "data": {
    "customer_id": "GB0010001-100100",
    "consent": {
      "from_date": "01-01-2020",
      "period_days": "90",
      "scope": [
        "string"
      ]
    },
    "attempt": {
      "from_date": "01-01-2020",
      "period_days": "90",
      "fetch_scope": [
        "accounts"
      ]
    },
    "javascript_callback_type": "post_message",
    "device": "iPad"
  }
}

Response

{
  "data": {
    "expires_at": "2020-04-03T14:42:31Z",
    "connect_url": "https://www.saltedge.com/connect?token=0d5cbfd4edd4ce9a3879b8b4367792cd86a534625002adac9c82f0d667e0e65f"
  }
}

GET CONNECTIONS

This API is used get the list of connections of the customer for the various banks that the customer has authorized.

GET/party/profiles/{partyid}/connections

Response

{
    "status": "Initiated : Loading Connections for Customer"
}

REFRESH CONNECTION

This API is used to refresh an existing connection in connection manager and reload the details.

PUT/party/profiles/{partyid}/banks/{bankcode}/refreshConnections

Request

{
}

Response

{
  "daily_refresh": "string",
  "next_refresh_at": "string",
  "message": "string"
}

REMOVE CONNECTION

This API is used to delete connection, delete connection data in connection manager, and delete holdings balance, transaction and arrangements for that connection.

DELETE/party/profiles/{partyid}/banks/{bankcode}/removeConnections

Request

{
}

Response

{
  "daily_refresh": "string",
  "next_refresh_at": "2020-04-03T14:57:46Z",
  "message": "success"
}

GET CONNECTIONDIRECTORYDETAILS

This API is used to view details of connections that are retrieved from third party provider of a customer.

GET/party/profiles/{partyid}/connectionDetails

Response

{
  "connections": [
    {
      "DigitalProfileID": "GB0010001-100100",
      "provider": "saltedge",
      "bankCode": "bank_of_east_asia_oauth_client_gb_xf",
      "bankName": "Bank of East Asia Open Banking",
      "NextRefresh": "2020-04-03T14:57:46Z",
      "CreatedAt": "2020-04-03T14:57:46Z",
      "status": "active",
      "providerConnectionStatus": "active",
      "CountryCode": "XF"
    }
  ]									
}

LOAD BANK DIRECTORY

This API is used to load all the banks and the respective details that the provider has to offer.

GET/system/banks

Response

{
  "Status": "Initiated: Loading all providers"
}

GET BANK DETAILS

This API is used to view the bank details from database of a specific bank code and provider.

GET/system/banks/{bankcode}/provider/{providername}

Response

{
            "bankCode": "bkbklull_oauth_client_lu_xf",
            "bankName": "Bankinter PSD2 (Sandbox)",
            "internalBankId": "BD2009400598",
            "homeUrl": "https://www.bankinter.lu",
            "loginUrl": "https://www.bankinter.lu",
            "logoUrl": "https://d1uuj3mi6rzwpm.cloudfront.net/logos/providers/xf/placeholder_global.svg",
            "timeZone": "Europe/Luxembourg",
            "providerStatus": "active",
            "isActive": "active",
            "countryCode": "XF",
            "provider": "saltedge",
            "mode": "oauth",
            "supportedAccountNaturess": [
                "account"
            ],
            "supportedFetchScopess": [
                "accounts",
                "transactions"
            ],
            "supportedAccountTypess": [
                "personal"
            ]
        }

GET BANK DETAILS FOR BANK ID

This API is used to view bank details from database of a specific Internal bank ID.

GET/system/banks/{bankid}

Response

{
            "bankCode": "bkbklull_oauth_client_lu_xf",
            "bankName": "Bankinter PSD2 (Sandbox)",
            "internalBankId": "BD2009400598",
            "homeUrl": "https://www.bankinter.lu",
            "loginUrl": "https://www.bankinter.lu",
            "logoUrl": "https://d1uuj3mi6rzwpm.cloudfront.net/logos/providers/xf/placeholder_global.svg",
            "timeZone": "Europe/Luxembourg",
            "providerStatus": "active",
            "isActive": "active",
            "countryCode": "XF",
            "provider": "saltedge",
            "mode": "oauth",
            "supportedAccountNaturess": [
                "account"
            ],
            "supportedFetchScopess": [
                "accounts",
                "transactions"
            ],
            "supportedAccountTypess": [
                "personal"
            ]
}

GET BANK DETAILS FOR COUNTRY

This API is used to view list of banks and bank details from database of a specific country.

GET/system/countries/{countrycode}/banks

Response

[
{
            "bankCode": "bkbklull_oauth_client_lu_xf",
            "bankName": "Bankinter PSD2 (Sandbox)",
            "internalBankId": "BD2009400598",
            "homeUrl": "https://www.bankinter.lu",
            "loginUrl": "https://www.bankinter.lu",
            "logoUrl": "https://d1uuj3mi6rzwpm.cloudfront.net/logos/providers/xf/placeholder_global.svg",
            "timeZone": "Europe/Luxembourg",
            "providerStatus": "active",
            "isActive": "active",
            "countryCode": "XF",
            "provider": "saltedge",
            "mode": "oauth",
            "supportedAccountNaturess": [
                "account"
            ],
            "supportedFetchScopess": [
                "accounts",
                "transactions"
            ],
            "supportedAccountTypess": [
                "personal"
            ]
        }
]

CREATE ENABLE ACCESS

This API is used to grant or revoke access to the specified bank.

PUT/system/bank/{bankcode}/access

Request

{
  "setAccess": "Yes"
}

Response

{
  "Status": " Successfully modified Record, Enabled access"
}

GET ACCOUNTS WITH TRANSACTION

This API is used to load all the accounts, balances and transactions of a customer in a specific bank into AMS and Holdings MS, respectively.

POST/holdings/profiles/{partyid}/banks/{bankcode}/accountwithtransactions

Request

{
}

Response

{
"status": "Initiated Accounts and Transaction Processing"
}