general

Overview

Salt Edge Partners API aims to provide access to financial information for registered partners as simple as a cURL.

  • Import financial information from PSD2 APIs (Open Banking Standard, NextGenPSD2 Berlin Group, CBI Globe Northbound, Polish API, etc.)
  • Securely import financial information from online banking interfaces of multiple countries;
  • Automatically synchronize accounts and transactions on a daily basis;
  • Automatically enrich financial transactions by categorization and merchant identification;
  • Keep a well-organized and up-to-date list of currency rates.

If you have any questions regarding what can be done with Salt Edge Partners API, feel free to contact us.

Integrations

The Salt Edge platform is easy to integrate. However, if you think that your application could benefit more from the native look and feel, you can always contact us, and we can discuss what would be the best solution for your app.

Formats

We use JSON for all the requests and responses, including the errors.

Glossary

Most of the API revolves around several important concepts:

  • Country - the country where providers are located;
  • Provider - a bank or an online payments system;
  • Lead - a verified end-user email associated with Salt Edge Limited customer record;
  • Partner Consent - a permission given to Salt Edge Limited to share fetched data with registered partner;
  • Customer - a customer of the client who is consuming Salt Edge Partners API;
  • Connection - the central entity of the API, representing a connection between a customer’s bank and Salt Edge;
  • Consent - the permission from an end-user to fetch data;
  • Attempt - an attempt which is created when an end-user connects his financial institution;
  • Holder Info - information about the account holder;
  • Account - one of the accounts associated with a connection. It can be a credit card account, a savings account, one of the online accounts, etc;
  • Transaction - a single financial movement made within an account;
  • Merchant - a company that sells goods or provides services to the customer;
  • Category - one of the personal or business categories that can be assigned to a transaction;
  • Currency - string code that is used for an account.

Following the guides

You can start with Authentication and follow the links in the sidebar. If you have any questions, contact us anytime using our contact form.

Quick start

This quick start guide will show the easiest path of integrating with Partners API: creating a lead, granting consent, authenticating in the bank interface, fetching financial data on success.

Get invitation

Request an invitation through contact us or our sales team.

Create an account

a. Get an invitation to visit the Sign Up page, then generate a secure password to confirm partner account creation.

b. Add your technical team members who will work on the next integration steps on the Team page and choose the specific roles for them.

Create api keys

Any request to Salt Edge Partners API is authenticated, so before you are able to fetch any data you need to create Service API keys. To do that, visit https://www.saltedge.com/keys_and_secrets and create a Service API key. You can leave Public key field blank as when you will go LIVE, signing the requests will become mandatory.

Salt Edge Partners API is supporting only Service API keys use. All communication should be done from a centralized Web Service to grant control over the data flows, security and privacy.

Each request to Partners API is authenticated with an App-id, and a Secret. Let’s store them as environment variables so that all the later requests are authenticated.

$ export APP_ID=YOUR_APP_ID
$ export SECRET=YOUR_APP_SECRET

We can provide examples in various programming languages. Start testing different connection types by using Fake and Sandbox providers to make sure that the application can handle any scenario that might happen with a real data provider (e.g. bank or standard).

Create lead

Before we can create any connections using Salt Edge Partners API, we need to create a Lead. A Lead in Salt Edge Partners API is the verified end-user email of your application.

The result of this request will be a Customer id and Email.

We need to save the Customer id (in this case “222222222222222222”), because we will use it later to create connections.

$ export CUSTOMER_ID=222222222222222222

See lead reference and customers reference for related API endpoints.

URL

https://www.saltedge.com/api/partners/v1/leads

https://www.saltedge.com/api/partners/v1/leads

Method

POST

Sample request

curl -v -H "Accept: application/json" \
        -H "Content-type: application/json" \
        -H "App-id: $APP_ID" \
        -H "Secret: $SECRET" \
        -X POST \
        -d "{ \
              \"data\": { \
                \"email\": \"test@email.com\" \
              } \
            }" \
        https://www.saltedge.com/api/partners/v1/leads
curl -v -H "Accept: application/json" \
        -H "Content-type: application/json" \
        -H "App-id: $APP_ID" \
        -H "Secret: $SECRET" \
        -X POST \
        -d "{ \
              \"data\": { \
                \"email\": \"test@email.com\" \
              } \
            }" \
        https://www.saltedge.com/api/partners/v1/leads

Sample response

{
  "data": {
    "email": "test+123@email.com",
    "customer_id": "222222222222222222"
  }
}

Create lead session

Once we have the Customer id (in this case id “222222222222222222”), we can create a connection.

To initiate a connection you need to execute a request to create lead session endpoint.

You will receive in response a redirect_url. This is the URL your end-user will visit to create the connection.

See Lead sessions reference for more information and related API endpoints.

URL

https://www.saltedge.com/api/partners/v1/lead_sessions/create

https://www.saltedge.com/api/partners/v1/lead_sessions/create

Method

POST

Sample request

curl -v -H "Accept: application/json" \
        -H "Content-type: application/json" \
        -H "App-id: $APP_ID" \
        -H "Secret: $SECRET" \
        -X POST \
        -d "{ \
              \"data\": { \
                \"customer_id\": \"$CUSTOMER_ID\", \
                \"consent\": { \
                  \"from_date\": \"2020-01-01\", \
                  \"period_days\": 90, \
                  \"scopes\": [ \
                    \"account_details\", \
                    \"transactions_details\" \
                  ] \
                }, \
                \"attempt\": { \
                  \"from_date\": \"2020-02-01\", \
                  \"fetch_scopes\": [ \
                    \"accounts\", \
                    \"transactions\" \
                  ] \
                } \
              } \
            }" \
        https://www.saltedge.com/api/partners/v1/lead_sessions/create
curl -v -H "Accept: application/json" \
        -H "Content-type: application/json" \
        -H "App-id: $APP_ID" \
        -H "Secret: $SECRET" \
        -X POST \
        -d "{ \
              \"data\": { \
                \"customer_id\": \"$CUSTOMER_ID\", \
                \"consent\": { \
                  \"from_date\": \"2020-01-01\", \
                  \"period_days\": 90, \
                  \"scopes\": [ \
                    \"account_details\", \
                    \"transactions_details\" \
                  ] \
                }, \
                \"attempt\": { \
                  \"from_date\": \"2020-02-01\", \
                  \"fetch_scopes\": [ \
                    \"accounts\", \
                    \"transactions\" \
                  ] \
                } \
              } \
            }" \
        https://www.saltedge.com/api/partners/v1/lead_sessions/create

Sample response

{
  "data": {
    "expires_at": "2020-10-26T17:54:09Z",
    "redirect_url": "https://www.saltedge.com/dashboard/connect?invitation_token=GENERATED_TOKEN"
  }
}

Visit redirect url

Initially, all Salt Edge registered partners are in pending status and only have access to fake and sandbox providers. Let’s connect one of them. Visit the redirect_url from the previous API response and search for “Fake Bank Simple”.

Once selected, we will be presented with a form for end-user credential input, from this provider. Input “username” and “secret” as per the on-screen instructions and press “Connect”.

Afterward, we will have to wait for the connection process to finish so that we can proceed with retrieving all its data via the API.

Fetch connections

In Salt Edge Partners API, a distinct bank connection is called a Connection. Each Salt Edge Partners API Customer can have multiple Connections. When we visited Redirect URL and connected “Fake Bank Simple”, we created a Connection associated with our Customer in the system. To retrieve all data for this Connection, we first need to retrieve the Connection itself.

The response contains an array of entries, each representing a connection to a financial institution.

In our case, we will have only one entry. We need to save the id (in our case 111111111111111111) to retrieve its accounts.

$ export CONNECTION_ID=111111111111111111

See connections reference for more information on Connection endpoints.

Sample Request

URL

https://www.saltedge.com/api/partners/v1/connections?customer_id={customer.id}

https://www.saltedge.com/api/partners/v1/connections?customer_id={customer.id}

Method

GET

curl -v -H "Accept: application/json" \
        -H "Content-type: application/json" \
        -H "App-id: $APP_ID" \
        -H "Secret: $SECRET" \
        -X GET \
        https://www.saltedge.com/api/partners/v1/connections?customer_id=$CUSTOMER_ID
curl -v -H "Accept: application/json" \
        -H "Content-type: application/json" \
        -H "App-id: $APP_ID" \
        -H "Secret: $SECRET" \
        -X GET \
        https://www.saltedge.com/api/partners/v1/connections?customer_id=$CUSTOMER_ID

Sample Response

{
  "data": [
    {
      "id": "111111111111111111",
      "provider_code": "fakebank_simple_xf",
      "provider_name": "Fakebank Simple",
      "customer_id": "222222222222222222",
      ...
    }
  ]
}

Fetch accounts for connections

Having the Connection id, we can retrieve all its accounts.

The response contains an array of entries, each representing an account from a financial institution.

We need to save the id (in our case 333333333333333333) to retrieve all transactions for this account.

$ export ACCOUNT_ID=333333333333333333

Sample Request

URL

https://www.saltedge.com/api/partners/v1/accounts?connection_id={connection.id}

https://www.saltedge.com/api/partners/v1/accounts?connection_id={connection.id}

Method

GET

curl -v -H "Accept: application/json" \
        -H "Content-type: application/json" \
        -H "App-id: $APP_ID" \
        -H "Secret: $SECRET" \
        -X GET \
        https://www.saltedge.com/api/partners/v1/accounts?connection_id=$CONNECTION_ID
curl -v -H "Accept: application/json" \
        -H "Content-type: application/json" \
        -H "App-id: $APP_ID" \
        -H "Secret: $SECRET" \
        -X GET \
        https://www.saltedge.com/api/partners/v1/accounts?connection_id=$CONNECTION_ID

Sample Response

{
  "data": [
    {
      "id": "333333333333333333",
      "name": "Fake account 1",
      "nature": "card",
      "balance": 2007.2,
      "currency_code": "EUR",
      "connection_id": "111111111111111111",
      "created_at": "2020-10-26T13:54:09Z",
      "updated_at": "2020-10-26T13:54:09Z",
      "extra": {
        "client_name": "Fake name"
      },
      ...
    }
  ]
}

Fetch transactions for an account

Having the Connection id and the Account id, we can retrieve transactions for the account.

The response contains an array of entries, each representing a transaction from a financial institution.

See transactions reference for more information on Transaction endpoints.

Sample Request

URL

https://www.saltedge.com/api/partners/v1/transactions?connection_id={connection.id}&account_id={account.id}

https://www.saltedge.com/api/partners/v1/transactions?connection_id={connection.id}&account_id={account.id}

Method

GET

curl -v -H "Accept: application/json" \
        -H "Content-type: application/json" \
        -H "App-id: $APP_ID" \
        -H "Secret: $SECRET" \
        -X GET \
        https://www.saltedge.com/api/partners/v1/transactions?connection_id=$CONNECTION_ID&account_id=$ACCOUNT_ID
curl -v -H "Accept: application/json" \
        -H "Content-type: application/json" \
        -H "App-id: $APP_ID" \
        -H "Secret: $SECRET" \
        -X GET \
        https://www.saltedge.com/api/partners/v1/transactions?connection_id=$CONNECTION_ID&account_id=$ACCOUNT_ID

Sample Response

{
  "data": [
    {
      "id": "444444444444444444",
      "duplicated": false,
      "mode": "normal",
      "status": "posted",
      "made_on": "2020-05-03",
      "amount": -200.0,
      "currency_code": "USD",
      "description": "test transaction",
      "category": "advertising",
      "account_id": "100",
      "created_at": "2020-10-24T16:54:09Z",
      "updated_at": "2020-10-25T16:54:09Z",
      "extra": {
        "original_amount": -3974.60,
        "original_currency_code": "CZK",
        "posting_date": "2020-05-07",
        "time": "23:56:12"
      },
      ...
    }
  ]
}

Next steps

  • Request Test status to connect real banking institutions.
  • Switch to Live status to bring value to your customers globally.
  • Since new Salt Edge partners are in pending mode and have access only to fake and sandbox providers, the request signature is not required. However, you will need to implement request signing before you are going live. For more information see our signature guide.
  • All responses with arrays (like accounts or transactions) are paginated by default. See how to implement it on our pagination guide.
  • The recommended way of synchronizing data with Salt Edge Partners API is via callbacks. That way you won’t have to poll the servers to see whether there is new data available. See our callbacks guide for more information.

Try in Postman

Step 1

Install Postman. You can get it on https://www.getpostman.com/apps.

Step 2

Import the postman collection, click the button below to do that.

Run in Postman

Step 3

Salt Edge Partners API requires APP_ID and SECRET headers in order to authenticate as partner. If you don’t have an API key created yet, you can you use our quick start guide to help you create one. Once you have the API key created, you can add its secrets to postman.

Click on the eye on the top right corner and press on “Add” next to “Environments”.

Define variables APP_ID and SECRET with values from the key that you generated on https://www.saltedge.com/clients/profile/secrets, then add the environment.

Once added, you can select it in the top right corner, and all the requests to Salt Edge API will be authenticated using your API key.

Before going LIVE

In order to upgrade you partner accounts status to LIVE mode, the following steps should be followed:

After your Account Manager at Salt Edge has reviewed the app’s integration with Partners API, the account’s status will be upgraded to live status.

Callbacks

The most important parts of Salt Edge Partners API (e.g. Connection management) are asynchronous.

Every Web application has to provide a set of valid URLs which we will use to notify about the fetching progress. Applications can also poll Salt Edge Partners API in order to retrieve the updated information.

There are several common points about the request we send to the callback URLs provided by the client:

  • The Content-Type header is application/json;
  • There is a Signature header that identifies the request was signed by Salt Edge Partners API;
  • The request method is always POST;
  • The JSON object sent will always have a data field;
  • The meta field will display the version of the callbacks API.

You can set the callback URLs for your application by accessing your callbacks page.

Due to security reasons, the callbacks can be sent to port 80/HTTP only in test and pending modes.
Port 443/HTTPS is accepted by all modes.
Also, the callbacks do not follow redirects!

Signature

Signature

In order for the client to identify that the request is coming from Salt Edge Partners API, there is a Signature header in the request.

Signature - base64 encoded SHA256 signature of the string represented in the form callback_url|post_body - 2 parameters concatenated with a vertical bar |, signed with a Salt Edge Partners API’s private key. You can find the version of the signature key used to sign the callback in the Signature-key-version header. The current version is 5.0 which corresponds to the following public key:

  -----BEGIN PUBLIC KEY-----
  MIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEAvL/Xxdmj7/cpZgvDMvxr
  nTTU/vkHGM/qkJ0Q+rmfYLru0Z/rSWthPDEK3orY5BTa0sAe2wUV5Fes677X6+Ib
  roCF8nODW5hSVTrqWcrQ55I7InpFkpTxyMkiFN8XPS7qmYXl/xofbYq0olcwE/aw
  9lfHlZD7iwOpVJqTsYiXzSMRu92ZdECV895kYS/ggymSEtoMSW3405dQ6OfnK53x
  7AJPdkAp0Wa2Lk4BNBMd24uu2tasO1bTYBsHpxonwbA+o8BXffdTEloloJgW7pV+
  TWvxB/Uxil4yhZZJaFmvTCefxWFovyzLdjn2aSAEI7D1y4IYOdByMOPYQ6Mn7J9A
  9wIDAQAB
  -----END PUBLIC KEY-----

An example of the string that is to be used to generate the signature looks as follows:

https://www.client.com/api/callbacks/success|{"data":{"connection_id":"111111111111111111","customer_id":"222222222222222222","custom_fields":{}},"meta":{"version":"5","time":"2020-01-03T13:00:28Z"}}

The pseudocode that we use to generate the signature looks like this:

base64(sha256_signature(private_key, "callback_url|post_body"))

Success

We send a callback to your application’s success URL whenever any triggered operation has caused a change in the data we store for a particular connection.

For instance, after you’ve redirected your user to the Connect page and they have selected their provider, filled in the credentials and pressed Connect, we’ll send you a success callback. This callback will contain the customer identifier and the id of the newly created connection. Afterwards, your application will be able to use the show connection route and query the information about this connection. You could also fetch the connection’s accounts and query the accounts (if any exist at the moment we sent the callback).

Whenever we have more information about the connection, we will send another success callback.

A success callback marks a change in the data and you can generally expect from one to three success callbacks with the same payload within several minutes. We recommend that your application fetch the full connection data, along with the accounts and transactions at each callback, as some information might change during the fetching process.

Here’s an example callback sent to the /success route of your app:

{
  "data": {
    "connection_id": "111111111111111111",
    "customer_id": "222222222222222222",
    "custom_fields": { "key": "value" }
  },
  "meta": {
    "version": "5",
    "time": "2020-10-26T16:54:10.063Z"
  }
}

You can now use the show connection route and obtain the provider, country and some other attributes of the new connection.

Failure

Sometimes we fail to fetch the information from the provider’s page. It might happen because the interactive data was not sent by the end-user, the credentials are wrong or we could not perform one of the steps of the fetching process. In this case, you will receive a fail callback, containing a JSON similar to the following:

{
  "data": {
    "connection_id": "111111111111111111",
    "customer_id": "222222222222222222",
    "custom_fields": { "key": "value" },
    "error_class": "InvalidCredentials",
    "error_message": "Invalid credentials."
  },
  "meta": {
    "version": "5",
    "time": "2020-10-26T16:54:10.074Z"
  }
}

After you get this callback, you need to fetch the connection to check for its updates. Please note that even if there’s an error, we still store the connection.

You can also receive a fail callback if the lead revokes the partner’s consent of the connection:

{
  "data": {
    "connection_id": "111111111111111111",
    "customer_id": "222222222222222222",
    "custom_fields": { "key": "value" },
    "error_class": "PartnerConsentRevoked",
    "error_message": "The partner consent was revoked by the end-user"
  },
  "meta": {
    "version": "5",
    "time": "2020-10-26T16:54:10.074Z"
  }
}

Additional callbacks

There are additional callbacks that your app needs to implement in order to use the API-only version of Salt Edge Partners API.

Notify

Salt Edge can inform you about the progress of a connection using Notify callback.

Your app can expect the notify callback several times, depending on the type of the connection, but you can use this information to inform your user about what’s happening with their connection.

The possible stages sent in a notify callback are as follows:

  • start - the fetching process has just begun;
  • connect - connecting to the data source;
  • interactive - waiting for the interactive credentials;
  • fetch_holder_info - fetching the information about account holder;
  • fetch_accounts - fetching the accounts;
  • fetch_recent - fetching the data for a recent period (several months);
  • fetch_full - fetching the data for a longer period;
  • disconnect - disconnecting from the data source;
  • finish - wrapping up the fetching process.

Note that for some of the connections, you might not receive all the stages.

Notify callback will not be triggered for daily attempts.

Here’s an example callback sent to the /notify route of your app:

{
  "data": {
    "connection_id": "111111111111111111",
    "customer_id": "222222222222222222",
    "custom_fields": { "key": "value" },
    "stage": "start"
  },
  "meta": {
    "version": "5",
    "time": "2020-10-25T16:54:10Z"
  }
}

Destroy

Whenever a connection gets removed, we will send a callback to your application’s destroy URL, if such exists.

An example callback sent to your app’s /destroy route:

{
  "data": {
    "connection_id": "111111111111111111",
    "customer_id": "222222222222222222"
  },
  "meta": {
    "version": "5",
    "time": "2020-05-17T14:29:35Z"
  }
}

Service

If the connection had issues in the past and a change was made in connection’s provider codebase, your application will receive a callback informing you that a refresh is needed in order to update the connection’s data.

The possible reasons sent in a service callback are as follows:

  • fixed - a fix was made;
  • updated - an update was made;

Here’s an example callback sent to the /service route of your app:

{
  "data": {
    "connection_id": "111111111111111111",
    "customer_id": "222222222222222222",
    "custom_fields": { "key": "value" },
    "reason": "updated"
  },
  "meta": {
    "version": "5",
    "time": "2020-10-25T16:54:10Z"
  }
}

Know Your Customer

Account holder info

This feature allows the client to fetch essential information about customers from their bank accounts to be further used with the purpose of KYC verification. Make sure to contact our support team to enable holder info for your client account.

Holder info route returns the information fetched from customer’s account with the particular provider.

Depending on the provider, the following attributes might be returned in the holder_info:

  • names - returns the name(s) on the customer’s account with the provider, e.g. ["John Doe"];
  • emails - returns email(s) registered within customer’s account with the provider, e.g. ["john.doe@example.com", "johndoe@gmail.com"];
  • phone_numbers - returns the phone number(s) registered in the customer’s account with the provider, e.g. ["+16135550175", "+40981233422"];
  • addresses - returns the address(es) on the customer’s account with the provider, e.g.

For some providers extra fields, e.g. Social Security Number or Cadastro de Pessoas Físicas, can also be returned.

Holder info can be fetched independently or along with other connection information, e.g. accounts and transactions.

In order to test the holder_info attribute, you can connect the fakebank_simple_xf fake provider.

Sample response (as provider attribute)

"holder_info": ["names", "emails", "addresses"]

Sample response (as separate route)

{
  "data": {
    "names": ["John Doe"],
    "emails": ["john.doe@example.com"]
    "addresses": [
      {
        "city": "Cupertino",
        "state": "CA",
        "street": "1 Infinite Loop",
        "country_code": "US",
        "post_code": "95014"
      }
    ]
  }
}

Errors

The API can return multiple errors for any operation, each having its meaning and usage.

Error attributes

class

string

The class of the error, one of the listed below

message

string

A message describing the error

documentation_url

string

A link for error documentation

request

object

The body of the request that caused the error

request_id

string

A unique identifier for this specific HTTP request. Can be sent to support for debugging

class

string

The class of the error, one of the listed below

message

string

A message describing the error

documentation_url

string

A link for error documentation

request

object

The body of the request that caused the error

request_id

string

A unique identifier for this specific HTTP request. Can be sent to support for debugging

Error codes

[400] Bad Request
[404] Not Found
[406] Not Acceptable
[409] Duplicated
[429] Too Many Requests

Sample response

{
  "error": {
    "class": "ConnectionNotFound",
    "message": "Connection with id: '111111111111111111' was not found.",
    "documentation_url": "https://docs.saltedge.com/account_information/v5/#errors-connection_not_found",
    "request_id": "313b4518-10d4-4c15-a18e-34ddd583ebdf"
  },
  "request": {
    "connection_id": "111111111111111111"
  }
}

List

AccountNotFound

An account with the sent account_id could not be found

ActionNotAllowed

The client has no access to the required route or direct API access is not permitted. Please contact us

AllAccountsExcluded

You have excluded all the accounts from the connection fetching process

ApiKeyNotFound

The API key with the provided App-id and Secret does not exist or is inactive

AppIdNotProvided

The App-id was not provided in request headers

AttemptNotFound

An attempt with such id does not exist

BackgroundFetchLimitExceeded

Background fetch limit (4 times in a 24 hour period) was exceeded. This restriction applies only to PSD2 providers.

BatchSizeLimitExceeded

More than 100 objects were sent in the request (100 is the limit)

CategorizationLimitReached

One client can categorize at most 1000 transactions per day

ClientDisabled

The client has been disabled. You can find out more about the disabled status on Disabled guides page

ClientNotFound

The API key used in the request does not belong to a client

ClientPending

The client is pending approval. You can find out more about the pending status on Pending guides page

ClientRestricted

The client is in restricted status. You can find out more about the restricted status on Restricted guides page

ConnectionFailed

Some network errors appear while fetching data

ConnectionLost

Internet connection was lost in the process

CountryNotFound

Sending a country_code that is not present in our system

CustomerNotFound

A customer with such customer_id could not be found, there is no shared consent with the partner for this customer, or there are no active connections for the customer_id in question

CustomerLocked

Customer is locked

CredentialsNotMatch

New connection credentials do not match old ones on reconnect. Please contact us in case you encountered this error

CustomFieldsSizeTooBig

The custom_fields object has more than 1 KB

CustomFieldsFormatInvalid

The custom_fields field is not of type object

DateFormatInvalid

We have received an invalid Date format

DateOutOfRange

Sending a date value that does not fit in admissible range

DateTimeFormatInvalid

We have received an invalid DateTime format

DateTimeOutOfRange

Sending a datetime value that does not fit in admissible range

DuplicatedCustomer

The customer you are trying to create already exists

EmailInvalid

The email is invalid

ExecutionTimeout

The whole fetching process took too long to execute

ExpiresAtInvalid

The Expires-at header is invalid, or is set to more than 1 hour from now in UTC

FetchingTimeout

One of the steps of the fetching process took too long to execute

FetchScopesNotAllowed

The value of fetch_scopes parameter is not allowed by client, provider and/or consent. In case you encounter this error, please contact us

FetchScopesInvalid

The value of fetch_scopes parameter is invalid

FileError

There were errors while uploading and processing files

FileNotProvided

Provider with the file mode was chosen, but no file was uploaded before creating or reconnecting a connection

FileNotSaved

File was not saved because of an error

HolderInfoNotSupported

Fetching holder info for this provider is not supported

IdentifierInvalid

Invalid identifier sent for identifying the customer

InteractiveAdapterTimeout

The interactive step of the fetching process took too long to execute

InteractiveTimeout

It took too long to respond to the interactive question

InternalServerError

An internal error has occurred

InvalidCredentials

The customer tried to connect/reconnect a connection with invalid credentials

InvalidEncoding

Invalid JSON encoded values

InvalidFromDate

Invalid from_date value, whether out of range or wrong date format

InvalidInteractiveCredentials

Interactive credentials that were sent are wrong

InvalidToDate

Invalid to_date value, whether out of range or wrong date format

JsonParseError

We have received some other request format instead of JSON, or the body could not be parsed

ConnectionAlreadyProcessing

The connection is already being processed

ConnectionAlreadyAuthorized

The connection was already authorized

ConnectionCannotBeRefreshed

The next refresh attempt will be allowed according to next_refresh_possible attribute or connection’s status is inactive

ConnectionDisabled

The customer tried to connect, reconnect or fetch a connection, but it appears to be disabled

ConnectionDuplicated

The client tried to create a connection that already exists

ConnectionFetchingStopped

Connection fetching had stopped because of fetching timeout or connection was deleted during fetch process

ConnectionLimitReached

The client tried to create more connections than possible for a client which is in Test or Pending status

ConnectionNotFound

We could not find a connection with the requested connection_id

MissingExpiresAt

The Expires-at field is missing in the headers

MissingSignature

The Signature field is missing in the headers

ProviderAccessNotGranted

The access to the provider during the redirect flow did not complete successfully

ProviderDisabled

The accessed provider is disabled

ProviderError

There’s an error on the provider’s side which obstructs us from obtaining the data for the connection

ProviderInactive

The accessed provider is inactive at the moment

ProviderNotFound

Sending a provider_code that is not present in our system

ProviderKeyFound

The chosen provider does not have provider keys

ProviderNotInteractive

The connection’s provider has no interactive step

ProviderUnavailable

The provider is temporarily unavailable

PublicKeyNotProvided

The client did not provide the public key in his account information

RateLimitExceeded

Too many connections are being processed at the same time from one application

RequestExpired

The request has expired, took longer than mentioned in the Expires-at header

ReturnURLInvalid

The return_to URL is missing from attempts-object or you need to specify your application’s home_url in your Client dashboard

ReturnURLTooLong

The return_to URL exceeds 2040 characters

RouteNotFound

The action and/or the endpoint you are trying to access does not exist

SecretNotProvided

The Secret was not provided in request headers

SignatureNotMatch

The Signature header does not match the correct one

TooManyRequests

Too many requests have occurred for connecting/reconnecting a connection from one IP address in a small period of time

TransactionNotFound

A transaction with the sent transaction_id could not be found

ValueOutOfRange

Sending a value (e.g. id) which exceeds integer limit

WrongClientToken

We have received a wrong combination of customer_id, app_id and connection_id

WrongProviderMode

We do not support the received provider_mode

WrongRequestFormat

The JSON request is incorrectly formed

The passed from_date - to_date interval is out of consent from_date - to_date range

The value of consent scopes parameter is invalid

The value of consent scopes parameter is not allowed by client or/and by provider

Invalid consent from_date value, whether out of range or wrong date format

Invalid consent period_days value or not allowed by provider

The consent has already been revoked

Refresh is not possible because the consent has been revoked

Refresh is not possible because the consent has expired

A consent with such id does not exist

A partner consent has already been revoked

A partner consent with such id does not exist

The partner consent was revoked by the end-user

AccountNotFound

An account with the sent account_id could not be found

ActionNotAllowed

The client has no access to the required route or direct API access is not permitted. Please contact us

AllAccountsExcluded

You have excluded all the accounts from the connection fetching process

ApiKeyNotFound

The API key with the provided App-id and Secret does not exist or is inactive

AppIdNotProvided

The App-id was not provided in request headers

AttemptNotFound

An attempt with such id does not exist

BackgroundFetchLimitExceeded

Background fetch limit (4 times in a 24 hour period) was exceeded. This restriction applies only to PSD2 providers.

BatchSizeLimitExceeded

More than 100 objects were sent in the request (100 is the limit)

CategorizationLimitReached

One client can categorize at most 1000 transactions per day

ClientDisabled

The client has been disabled. You can find out more about the disabled status on Disabled guides page

ClientNotFound

The API key used in the request does not belong to a client

ClientPending

The client is pending approval. You can find out more about the pending status on Pending guides page

ClientRestricted

The client is in restricted status. You can find out more about the restricted status on Restricted guides page

ConnectionFailed

Some network errors appear while fetching data

ConnectionLost

Internet connection was lost in the process

CountryNotFound

Sending a country_code that is not present in our system

CustomerNotFound

A customer with such customer_id could not be found, there is no shared consent with the partner for this customer, or there are no active connections for the customer_id in question

CustomerLocked

Customer is locked

CredentialsNotMatch

New connection credentials do not match old ones on reconnect. Please contact us in case you encountered this error

CustomFieldsSizeTooBig

The custom_fields object has more than 1 KB

CustomFieldsFormatInvalid

The custom_fields field is not of type object

DateFormatInvalid

We have received an invalid Date format

DateOutOfRange

Sending a date value that does not fit in admissible range

DateTimeFormatInvalid

We have received an invalid DateTime format

DateTimeOutOfRange

Sending a datetime value that does not fit in admissible range

DuplicatedCustomer

The customer you are trying to create already exists

EmailInvalid

The email is invalid

ExecutionTimeout

The whole fetching process took too long to execute

ExpiresAtInvalid

The Expires-at header is invalid, or is set to more than 1 hour from now in UTC

FetchingTimeout

One of the steps of the fetching process took too long to execute

FetchScopesNotAllowed

The value of fetch_scopes parameter is not allowed by client, provider and/or consent. In case you encounter this error, please contact us

FetchScopesInvalid

The value of fetch_scopes parameter is invalid

FileError

There were errors while uploading and processing files

FileNotProvided

Provider with the file mode was chosen, but no file was uploaded before creating or reconnecting a connection

FileNotSaved

File was not saved because of an error

HolderInfoNotSupported

Fetching holder info for this provider is not supported

IdentifierInvalid

Invalid identifier sent for identifying the customer

InteractiveAdapterTimeout

The interactive step of the fetching process took too long to execute

InteractiveTimeout

It took too long to respond to the interactive question

InternalServerError

An internal error has occurred

InvalidCredentials

The customer tried to connect/reconnect a connection with invalid credentials

InvalidEncoding

Invalid JSON encoded values

InvalidFromDate

Invalid from_date value, whether out of range or wrong date format

InvalidInteractiveCredentials

Interactive credentials that were sent are wrong

InvalidToDate

Invalid to_date value, whether out of range or wrong date format

JsonParseError

We have received some other request format instead of JSON, or the body could not be parsed

ConnectionAlreadyProcessing

The connection is already being processed

ConnectionAlreadyAuthorized

The connection was already authorized

ConnectionCannotBeRefreshed

The next refresh attempt will be allowed according to next_refresh_possible attribute or connection’s status is inactive

ConnectionDisabled

The customer tried to connect, reconnect or fetch a connection, but it appears to be disabled

ConnectionDuplicated

The client tried to create a connection that already exists

ConnectionFetchingStopped

Connection fetching had stopped because of fetching timeout or connection was deleted during fetch process

ConnectionLimitReached

The client tried to create more connections than possible for a client which is in Test or Pending status

ConnectionNotFound

We could not find a connection with the requested connection_id

MissingExpiresAt

The Expires-at field is missing in the headers

MissingSignature

The Signature field is missing in the headers

ProviderAccessNotGranted

The access to the provider during the redirect flow did not complete successfully

ProviderDisabled

The accessed provider is disabled

ProviderError

There’s an error on the provider’s side which obstructs us from obtaining the data for the connection

ProviderInactive

The accessed provider is inactive at the moment

ProviderNotFound

Sending a provider_code that is not present in our system

ProviderKeyFound

The chosen provider does not have provider keys

ProviderNotInteractive

The connection’s provider has no interactive step

ProviderUnavailable

The provider is temporarily unavailable

PublicKeyNotProvided

The client did not provide the public key in his account information

RateLimitExceeded

Too many connections are being processed at the same time from one application

RequestExpired

The request has expired, took longer than mentioned in the Expires-at header

ReturnURLInvalid

The return_to URL is missing from attempts-object or you need to specify your application’s home_url in your Client dashboard

ReturnURLTooLong

The return_to URL exceeds 2040 characters

RouteNotFound

The action and/or the endpoint you are trying to access does not exist

SecretNotProvided

The Secret was not provided in request headers

SignatureNotMatch

The Signature header does not match the correct one

TooManyRequests

Too many requests have occurred for connecting/reconnecting a connection from one IP address in a small period of time

TransactionNotFound

A transaction with the sent transaction_id could not be found

ValueOutOfRange

Sending a value (e.g. id) which exceeds integer limit

WrongClientToken

We have received a wrong combination of customer_id, app_id and connection_id

WrongProviderMode

We do not support the received provider_mode

WrongRequestFormat

The JSON request is incorrectly formed

The passed from_date - to_date interval is out of consent from_date - to_date range

The value of consent scopes parameter is invalid

The value of consent scopes parameter is not allowed by client or/and by provider

Invalid consent from_date value, whether out of range or wrong date format

Invalid consent period_days value or not allowed by provider

The consent has already been revoked

Refresh is not possible because the consent has been revoked

Refresh is not possible because the consent has expired

A consent with such id does not exist

A partner consent has already been revoked

A partner consent with such id does not exist

The partner consent was revoked by the end-user

If a ‘500’ error is received, please report this error to our support team.

api

Countries

The country is represented just as a string. We’re using ISO 3166-1 alpha-2 country codes. Thus, all the country codes will have exactly two uppercase letters. There are two special cases:

  • “Other”, encoded as XO
  • “Fake”, encoded as XF

Note that the Fake country is only available for clients in Test and Pending statuses.

List

Returns a list of countries supported by Salt Edge Partners API.

Parameters

include_fake_providers

boolean, optional

Whether you wish to fetch the fake countries, defaults to false

include_fake_providers

boolean, optional

Whether you wish to fetch the fake countries, defaults to false

Response

name

string

Name of the country

code

string

Country code as dated in ISO 3166-1 alpha-2

refresh_start_time

integer

Local country time when connections will be automatically refreshed. Possible values: 0 to 23

name

string

Name of the country

code

string

Country code as dated in ISO 3166-1 alpha-2

refresh_start_time

integer

Local country time when connections will be automatically refreshed. Possible values: 0 to 23

Possible Errors

URL

https://www.saltedge.com/api/partners/v1/countries

https://www.saltedge.com/api/partners/v1/countries

Method

GET

Sample request

curl -v -H "Accept: application/json" \
        -H "Content-type: application/json" \
        -H "App-id: $APP_ID" \
        -H "Secret: $SECRET" \
        -X GET \
        https://www.saltedge.com/api/partners/v1/countries
curl -v -H "Accept: application/json" \
        -H "Content-type: application/json" \
        -H "App-id: $APP_ID" \
        -H "Secret: $SECRET" \
        -X GET \
        https://www.saltedge.com/api/partners/v1/countries

Sample response

{
  "data": [
    {
      "code": "CZ",
      "name": "Czech Republic",
      "refresh_start_time": 2
    },
    {
      "code": "IL",
      "name": "Israel",
      "refresh_start_time": 2
    },
    {
      "code": "MD",
      "name": "Moldova",
      "refresh_start_time": 2
    },
    {
      "code": "RO",
      "name": "Romania",
      "refresh_start_time": 2
    },
    {
      "code": "RU",
      "name": "Russia",
      "refresh_start_time": 2
    },
    {
      "code": "UA",
      "name": "Ukraine",
      "refresh_start_time": 2
    },
    {
      "code": "XF",
      "name": "Fake",
      "refresh_start_time": 2
    },
    {
      "code": "XO",
      "name": "Other",
      "refresh_start_time": 2
    },
    ...
  ]
}

Providers

A provider is a source of financial data. We recommend you update all of the provider’s fields at least daily.

Attributes

id

string

Provider’s id

code

string

Provider’s code

name

string

Provider’s name

modes

string

Possible values are:

  • oauth - access through the bank’s dedicated API (regulated: true). The user is redirected to the bank’s page for authorization. For more details, check OAuth providers.
  • web - access through the bank’s WEB interface using screen scraping technology. Therefore, a user undergoes the same authorization flow as in their bank’s web interface with an identical set of credentials.
  • api - access through a dedicated (regulated: true) or non-dedicated (regulated: false) bank’s API. Some required credentials fields might be present which the user should complete (IBAN, username, etc.). In case of a dedicated API, an interactive redirect might be present, but there are required credentials fields which the user should complete (IBAN, username, etc.). Using these credentials, we authorize the user on the bank’s side.
  • file - access through uploading a file of certain format (XLS, CSV, etc.), which is processed to extract information of their accounts and transactions.

status

string

Possible values are: active, inactive, disabled

automatic_fetch

boolean

Whether the provider’s connections can be automatically fetched

customer_notified_on_sign_in

boolean

Whether the provider will notify the customer on log in attempt

interactive

boolean

Whether the provider requires interactive input

identification_mode

string

Whether the request to the provider is made with your authorization headers or with Salt Edge’s. Possible values are: client, saltedge

instruction

string

Instructions on how to connect the bank, in English

home_url

string

The URL of the main page of the provider

login_url

string

Point of entrance to provider’s login web interface

logo_url

string

The URL for the provider logo, may have a placeholder for providers with missing logos

country_code

string

Code of the provider’s country

refresh_timeout

integer

Amount of time (in minutes) after which the provider’s connections are allowed to be refreshed

holder_info

array

Contains information on the account holder details that can be fetched from this provider

max_consent_days

integer

Maximum allowed consent duration. If it is null then there are no limits

created_at

datetime

Time and date when the provider was integrated

updated_at

datetime

The last time when any of provider’s attributes were changed

timezone

string

Time zone data of capital/major city in a region corresponding to a provider.

max_interactive_delay

integer

Delay in seconds before InteractiveAdapterTimeout will happen

optional_interactivity

boolean

Provider which supports flipping of interactive and automatic_fetch flags after connect

regulated

boolean

Whether the provider is integrated via a regulated channel under PSD2

max_fetch_interval

integer

Max period in days that can be fetched form from the provider’s interface

supported_fetch_scopes

array

Array of strings with supported fetch_scopes

supported_account_extra_fields

array

Array of possible account extra fields to be fetched

supported_transaction_extra_fields

array

Array of possible transaction extra fields to be fetched

supported_account_natures

array

Array of possible account natures to be fetched. Non-payment natures: bonus, credit, insurance, investment

supported_account_types

array

Possible values are: personal, business

identification_codes

array

List of codes identifying supported branches of a specific provider. It may include BLZ(Germany), ABI+CAB(Italy), Branch Codes(France) etc.

bic_codes

array

List of BIC codes identifying supported branches of a specific provider.

supported_iframe_embedding

boolean

Possible values are: true, false

id

string

Provider’s id

code

string

Provider’s code

name

string

Provider’s name

modes

string

Possible values are:

  • oauth - access through the bank’s dedicated API (regulated: true). The user is redirected to the bank’s page for authorization. For more details, check OAuth providers.
  • web - access through the bank’s WEB interface using screen scraping technology. Therefore, a user undergoes the same authorization flow as in their bank’s web interface with an identical set of credentials.
  • api - access through a dedicated (regulated: true) or non-dedicated (regulated: false) bank’s API. Some required credentials fields might be present which the user should complete (IBAN, username, etc.). In case of a dedicated API, an interactive redirect might be present, but there are required credentials fields which the user should complete (IBAN, username, etc.). Using these credentials, we authorize the user on the bank’s side.
  • file - access through uploading a file of certain format (XLS, CSV, etc.), which is processed to extract information of their accounts and transactions.

status

string

Possible values are: active, inactive, disabled

automatic_fetch

boolean

Whether the provider’s connections can be automatically fetched

customer_notified_on_sign_in

boolean

Whether the provider will notify the customer on log in attempt

interactive

boolean

Whether the provider requires interactive input

identification_mode

string

Whether the request to the provider is made with your authorization headers or with Salt Edge’s. Possible values are: client, saltedge

instruction

string

Instructions on how to connect the bank, in English

home_url

string

The URL of the main page of the provider

login_url

string

Point of entrance to provider’s login web interface

logo_url

string

The URL for the provider logo, may have a placeholder for providers with missing logos

country_code

string

Code of the provider’s country

refresh_timeout

integer

Amount of time (in minutes) after which the provider’s connections are allowed to be refreshed

holder_info

array

Contains information on the account holder details that can be fetched from this provider

max_consent_days

integer

Maximum allowed consent duration. If it is null then there are no limits

created_at

datetime

Time and date when the provider was integrated

updated_at

datetime

The last time when any of provider’s attributes were changed

timezone

string

Time zone data of capital/major city in a region corresponding to a provider.

max_interactive_delay

integer

Delay in seconds before InteractiveAdapterTimeout will happen

optional_interactivity

boolean

Provider which supports flipping of interactive and automatic_fetch flags after connect

regulated

boolean

Whether the provider is integrated via a regulated channel under PSD2

max_fetch_interval

integer

Max period in days that can be fetched form from the provider’s interface

supported_fetch_scopes

array

Array of strings with supported fetch_scopes

supported_account_extra_fields

array

Array of possible account extra fields to be fetched

supported_transaction_extra_fields

array

Array of possible transaction extra fields to be fetched

supported_account_natures

array

Array of possible account natures to be fetched. Non-payment natures: bonus, credit, insurance, investment

supported_account_types

array

Possible values are: personal, business

identification_codes

array

List of codes identifying supported branches of a specific provider. It may include BLZ(Germany), ABI+CAB(Italy), Branch Codes(France) etc.

bic_codes

array

List of BIC codes identifying supported branches of a specific provider.

supported_iframe_embedding

boolean

Possible values are: true, false

Sample object

{
  "id": "111111111111111111",
  "code": "fakebank_simple_xf",
  "name": "Fake Bank",
  "mode": "web",
  "status": "active",
  "automatic_fetch": true,
  "customer_notified_on_sign_in": false,
  "interactive": false,
  "identification_mode": "saltedge",
  "instruction": "Please fill in all the fields.",
  "home_url": "http://example.com",
  "login_url": "http://example.com/login",
  "logo_url": "https://cdn.com/logos/providers/xf/fake.svg",
  "country_code": "XF",
  "refresh_timeout": 60,
  "holder_info": ["names", "emails", "phone_numbers"],
  "max_consent_days": 10,
  "created_at": "2020-10-16T16:54:10Z",
  "updated_at": "2020-10-21T16:54:10Z",
  "timezone": "Europe/London",
  "max_interactive_delay": 480,
  "optional_interactivity": true,
  "regulated": false,
  "max_fetch_interval": 60,
  "supported_fetch_scopes": ["accounts", "transactions"],
  "supported_account_extra_fields": [],
  "supported_transaction_extra_fields": [],
  "supported_account_natures": ["account", "card"],
  "supported_account_types": ["personal"]
  "identification_codes": ["123123"],
  "bic_codes": ["ABCDEFGH"],
  "supported_iframe_embedding": true
}

Show

Provider show allows you to inspect the single provider in order to give your users a proper interface to input their credentials. The response will have an array of required_fields and interactive_fields.

Parameters

provider_code

string

Provider’s code

provider_code

string

Provider’s code

Possible Errors

URL

https://www.saltedge.com/api/partners/v1/providers/{provider.code}

https://www.saltedge.com/api/partners/v1/providers/{provider.code}

Method

GET

Sample request

curl -v -H "Accept: application/json" \
        -H "Content-type: application/json" \
        -H "App-id: $APP_ID" \
        -H "Secret: $SECRET" \
        -X GET \
        https://www.saltedge.com/api/partners/v1/providers/fakebank_interactive_xf
curl -v -H "Accept: application/json" \
        -H "Content-type: application/json" \
        -H "App-id: $APP_ID" \
        -H "Secret: $SECRET" \
        -X GET \
        https://www.saltedge.com/api/partners/v1/providers/fakebank_interactive_xf

Sample response

{
  "data": {
    "id": "111111111111111111",
    "code": "fakebank_interactive_xf",
    "name": "Fake Bank with SMS",
    "mode": "web",
    "status": "active",
    "automatic_fetch": false,
    "interactive": true,
    "instruction": "Valid credentials for this provider are:\nlogin - any string which starts with \"username\",\npassword - \"secret\",\nsms - \"123456\"\n",
    "refresh_timeout": 5,
    "customer_notified_on_sign_in": false,
    "home_url": "http://example.com",
    "login_url": "http://example.com/login",
    "forum_url": "https://www.saltedge.com/support_requests/new?provider_code=fakebank_interactive_xf",
    "logo_url": "https://d1uuj3mi6rzwpm.cloudfront.net/logos/providers/xf/fakebank_interactive_xf.svg",
    "country_code": "XF",
    "created_at": "2020-03-19T17:55:44Z",
    "updated_at": "2020-03-07T09:57:26Z",
    "timezone": "UTC",
    "holder_info": [],
    "max_consent_days": null,
    "identification_mode": "saltedge",
    "max_interactive_delay": 180,
    "optional_interactivity": false,
    "regulated": false,
    "max_fetch_interval": 60,
    "supported_fetch_scopes": ["accounts", "transactions"],
    "supported_account_natures": ["account", "card"],
    "supported_account_types": ["personal"],
    "identification_codes": ["123123"],
    "bic_codes": ["ABCDEFGH"],
    "supported_iframe_embedding": true,
    "supported_account_extra_fields": [
      "account_name",
      "account_number",
      "card_type",
      "cards",
      "client_name",
      "iban",
      "sort_code",
      "status",
      "swift"
    ],
    "supported_transaction_extra_fields": [
      "convert",
      "original_amount",
      "original_currency_code",
      "payee",
      "posting_date",
      "transfer_account_name"
    ],
    "required_fields": [{
        "name": "login",
        "english_name": "Login",
        "localized_name": "Login",
        "nature": "text",
        "position": 1,
        "optional": false,
        "extra": {}
      },
      {
        "name": "password",
        "english_name": "Password",
        "localized_name": "Password",
        "nature": "password",
        "position": 2,
        "optional": false,
        "extra": {}
      }
    ],
    "interactive_fields": [{
      "name": "sms",
      "english_name": "SMS code",
      "localized_name": "SMS code",
      "nature": "number",
      "position": 1,
      "optional": false,
      "extra": {}
    }]
  }
}

List

Returns all the providers we operate with. If a provider becomes disabled, it is not included in the list. You can read more about the next_id field, in the pagination section of the reference.

Parameters

from_id

string, optional

The id of the record starting the next page, defaults to null

from_date

date, optional

Filtering providers created or updated starting from this date, defaults to null

country_code

string, optional

Filtering providers by country, defaults to null

mode

string, optional

Filtering providers by mode, possible values are: oauth, web, api, file

include_fake_providers

boolean, optional

Whether you wish to fetch the fake providers, defaults to false

from_id

string, optional

The id of the record starting the next page, defaults to null

from_date

date, optional

Filtering providers created or updated starting from this date, defaults to null

country_code

string, optional

Filtering providers by country, defaults to null

mode

string, optional

Filtering providers by mode, possible values are: oauth, web, api, file

include_fake_providers

boolean, optional

Whether you wish to fetch the fake providers, defaults to false

Possible Errors

URL

https://www.saltedge.com/api/partners/v1/providers

https://www.saltedge.com/api/partners/v1/providers

Method

GET

Sample request

curl -v -H "Accept: application/json" \
        -H "Content-type: application/json" \
        -H "App-id: $APP_ID" \
        -H "Secret: $SECRET" \
        -X GET \
        https://www.saltedge.com/api/partners/v1/providers
curl -v -H "Accept: application/json" \
        -H "Content-type: application/json" \
        -H "App-id: $APP_ID" \
        -H "Secret: $SECRET" \
        -X GET \
        https://www.saltedge.com/api/partners/v1/providers

Sample Response

{
  "data": [
    {
      "id": "111111111111111111",
      "code": "fakebank_image_xf",
      "name": "Fake Bank with Image",
      "mode": "web",
      "status": "active",
      "automatic_fetch": false,
      "customer_notified_on_sign_in": true,
      "interactive": true,
      "identification_mode": "saltedge",
      "instruction": "Please fill in all the fields.",
      "home_url": "http://example.com",
      "login_url": "http://example.com/login",
      "logo_url": "https://cdn.com/logos/providers/xf/fake.svg",
      "country_code": "XF",
      "refresh_timeout": 60,
      "holder_info": ["names", "emails", "phone_numbers"],
      "max_consent_days": 10,
      "created_at": "2020-10-16T16:54:10Z",
      "updated_at": "2020-10-21T16:54:10Z",
      "timezone": "Europe/London",
      "max_interactive_delay": 480,
      "optional_interactivity": true,
      "regulated": false,
      "max_fetch_interval": 60,
      "supported_fetch_scopes": ["accounts", "transactions"],
      "supported_account_extra_fields": [],
      "supported_transaction_extra_fields": [],
      "supported_account_natures": ["account", "card"],
      "supported_account_types": ["personal"],
      "identification_codes": ["123123"],
      "bic_codes": ["ABCDEFGH"],
      "supported_iframe_embedding": true
    }
  ],
  "meta": {
    "next_id": null,
    "next_page": null
  }
}

Fake

In order to help with testing, we provide a fake country (having the country code XF) and a set of fake providers. If your application is in the Test or Pending status, the Connect page will let you select the fake country and its providers.

The API supplies a number of fake providers:

  • fakebank_simple_xf - requires a username and password;
  • fakebank_select_xf - has a dropdown list with some options for the user to choose from;
  • fakebank_image_xf - the user needs to solve a CAPTCHA for authentication;
  • fakebank_interactive_xf - asks for a fake SMS code;
  • fakebank_two_step_interactive_xf - asks for interactive data twice during the fetching process;
  • fakebank_semi_interactive_xf - occasionally requires an SMS code;
  • fakebank_with_optional_fields_xf - similar to fakebank_interactive_xf, but with some of the interactive fields marked as optional;
  • fakebank_api_with_fields_xf - similar to fakebank_simple_xf, used for ensuring API providers availability;
  • fakebank_oauth_xf - asks for authorization;
  • fakebank_oauth_with_pending_xf - similar to fakebank_oauth_xf, returns pending transactions;
  • fakebank_oauth_with_n_transactions_xf - similar to fakebank_oauth_xf, returns more than 1000 transactions;
  • fakebank_with_updates_xf - generates up to 4 transactions on every connect, refresh, reconnect with random amounts and modes;
  • fake_demobank_xf - generates multiple accounts with different currencies, and different account natures;
  • fakebank_with_token_xf - requires a username and a fake token;
  • fakebank_with_error_xf - allows you to test the appearing errors when connecting a new provider;
  • fakebank_oauth_with_pending_and_available_balance_xf - similar to fakebank_oauth_with_pending_xf, having accounts, which have different values for balance and available_balance;
  • fakebank_with_possible_duplicates_xf - each attempt generates a transactions with same made_on, amount, currency_code but different description. On second attempt and later it marks those transaction with extra[:possible_duplicate] flag;
  • fakebank_with_rememberable_credentials_xf - remembers all the answers to secret questions and doesn’t ask them in the interactive stage if they were introduced correctly on previous attempts.
  • fakebank_with_file_csv_xf - extracts transactions from a csv file. You can download the sample here.
    Note: Testing this provider allows the client to test categorization and merchant identification in the country they are interested in. For that, it is required to configure the Country and Account Currency fields accordingly.

The Fake Bank with Error allows to select which error you would like to test. The choices are as follows:

  • No Errors - works the same as fakebank_simple_xf;
  • No Errors with Partial Data - returns accounts and transactions, where partial flag is set to true;
  • ExecutionTimeout - no accounts and transactions, raises the ExecutionTimeout error;
  • FetchingTimeout - no accounts and transactions, raises the FetchingTimeout error;
  • ProviderUnavailable - no accounts and transactions, raises the ProviderUnavailable error;
  • ProviderError - no accounts and transactions, raises error with a generic message An error has occurred. Please report this error..

We also supply fake providers:

  • fake_client_xf - requires a username and password (embedded);
  • fake_oauth_client_xf - asks for authorization (OAuth redirect);
  • fake_interactive_client_xf - asks for a fake SMS code in addition to username and password (embedded).

Check the provider’s instructions in the Connect page for the appropriate credentials. You can use these providers in order to test the codes, the format of the transactions, errors, etc.

Leads

Leads are end-users (PSUs) that can create connections and share data with a partner.

Create

Allows to create or return an existing lead, thus bypassing the Sign Up stage which requires user input. The response contains the email of the lead and the associated customer_id which can be used for creating a lead session.

If the lead didn’t exist before, it is created with a one-time password. An email with instructions on how to set their own password and access their Salt Edge Dashboard account will be sent.

Parameters

email

string, required

Email address

email

string, required

Email address

Possible Errors

URL

https://www.saltedge.com/api/partners/v1/leads

https://www.saltedge.com/api/partners/v1/leads

Method

POST

Sample request

curl -v -H "Accept: application/json" \
        -H "Content-type: application/json" \
        -H "App-id: $APP_ID" \
        -H "Secret: $SECRET" \
        -X POST \
        -d "{ \
              \"data\": { \
                \"email\": \"test@email.com\" \
              } \
            }" \
        https://www.saltedge.com/api/partners/v1/leads
curl -v -H "Accept: application/json" \
        -H "Content-type: application/json" \
        -H "App-id: $APP_ID" \
        -H "Secret: $SECRET" \
        -X POST \
        -d "{ \
              \"data\": { \
                \"email\": \"test@email.com\" \
              } \
            }" \
        https://www.saltedge.com/api/partners/v1/leads

Sample response

{
  "data": {
    "email": "test@email.com",
    "customer_id": "222222222222222222"
  }
}

Lead session

Lead session is a temporary object that links the Connect session with new connection object that will be created once the user grants his consent to Salt Edge Partners API to fetch data.

Create

Allows you to create a lead session.

Parameters

customer_id

string, optional

The id of the customer. If passed, following the redirect_url will allow the customer to continue bypassing the Sign Up/Sign In stage.

consent

object, required

attempt

object, optional

allowed_countries

array of strings, optional

The list of countries that will be accessible for the customer to choose from, defaults to EU and EEA region + XF. Full list: AT, BE, BG, CY, CZ, DE, DK, EE, ES, FI, FR, GB, GR, HR, HU, IE, IS, IT, LI, LT, LU, LV, MT, NL, NO, PL, PT, RO, SE, SI, SK, XF.

Example: ['CZ', 'DE']

provider_code

string, optional

The code of the desired provider, defaults to null

skip_provider_select

boolean, optional

Whether the provider selection page should be skipped. In order for this to work, besides passing skip_provider_select as true, an OAuth provider’s provider_code should be passed. Defaults to: false

daily_refresh

boolean, optional

Whether the connection should be automatically refreshed by Salt Edge, defaults to true

disable_provider_search

boolean, optional

Whether the provider search will be disabled, works only if provider_code parameter is sent. Defaults to false

return_connection_id

boolean, optional

Whether to append connection_id to return_to URL. Will be accompanied by shared: true/false to show whether access to this connection has been granted. Only works if return_to in the attempt object is also passed. Defaults to true

provider_modes

array of strings, optional

Restrict the list of the providers to only the ones that have the mode included in the array.

Possible values inside the array are: oauth, web, api, file, defaults to the array containing all possible modes

categorization

string, optional

The type of categorization applied. Possible values: none, personal, business. Default: personal

include_fake_providers

boolean, optional

By default, partners in live mode cannot create fake provider connections. However, if sent as true, even a partner in the live mode can test fake providers. Defaults to false

return_error_class

boolean, optional

Whether to append error_class to return_to URL. Defaults to false

regulated

boolean, optional

Whether to show regulated providers in Connect. Passing true will show only the regulated providers. Passing false will show only the non-regulated providers. Defaults to null, which will show both regulated and non-regulated providers

theme

string, optional

Theme of Salt Edge Connect template. If not passed or available for the current template, will use default. Allowed values: default, dark.

connect_template

string, optional

Template of Salt Edge Connect. If not passed or available for the current client, will use the default template.

javascript_callback_type

string, optional

Allows you to specify what kind of JavaScript callback method Connect should use. Possible value: post_message.

consent

object, required

attempt

object, optional

allowed_countries

array of strings, optional

The list of countries that will be accessible for the customer to choose from, defaults to EU and EEA region + XF. Full list: AT, BE, BG, CY, CZ, DE, DK, EE, ES, FI, FR, GB, GR, HR, HU, IE, IS, IT, LI, LT, LU, LV, MT, NL, NO, PL, PT, RO, SE, SI, SK, XF.

Example: ['CZ', 'DE']

provider_code

string, optional

The code of the desired provider, defaults to null

skip_provider_select

boolean, optional

Whether the provider selection page should be skipped. In order for this to work, besides passing skip_provider_select as true, an OAuth provider’s provider_code should be passed. Defaults to: false

daily_refresh

boolean, optional

Whether the connection should be automatically refreshed by Salt Edge, defaults to true

disable_provider_search

boolean, optional

Whether the provider search will be disabled, works only if provider_code parameter is sent. Defaults to false

return_connection_id

boolean, optional

Whether to append connection_id to return_to URL. Will be accompanied by shared: true/false to show whether access to this connection has been granted. Only works if return_to in the attempt object is also passed. Defaults to true

provider_modes

array of strings, optional

Restrict the list of the providers to only the ones that have the mode included in the array.

Possible values inside the array are: oauth, web, api, file, defaults to the array containing all possible modes

categorization

string, optional

The type of categorization applied. Possible values: none, personal, business. Default: personal

include_fake_providers

boolean, optional

By default, partners in live mode cannot create fake provider connections. However, if sent as true, even a partner in the live mode can test fake providers. Defaults to false

return_error_class

boolean, optional

Whether to append error_class to return_to URL. Defaults to false

regulated

boolean, optional

Whether to show regulated providers in Connect. Passing true will show only the regulated providers. Passing false will show only the non-regulated providers. Defaults to null, which will show both regulated and non-regulated providers

theme

string, optional

Theme of Salt Edge Connect template. If not passed or available for the current template, will use default. Allowed values: default, dark.

connect_template

string, optional

Template of Salt Edge Connect. If not passed or available for the current client, will use the default template.

javascript_callback_type

string, optional

Allows you to specify what kind of JavaScript callback method Connect should use. Possible value: post_message.

Possible Errors

URL

https://www.saltedge.com/api/partners/v1/lead_sessions/create

https://www.saltedge.com/api/partners/v1/lead_sessions/create

Method

POST

Sample request

curl -v -H "Accept: application/json" \
        -H "Content-type: application/json" \
        -H "App-id: $APP_ID" \
        -H "Secret: $SECRET" \
        -X POST \
        -d "{ \
              \"data\": { \
                \"consent\": { \
                  \"from_date\": \"2020-01-01\", \
                  \"period_days\": 90, \
                  \"scopes\": [ \
                    \"account_details\", \
                    \"transactions_details\" \
                  ] \
                }, \
                \"attempt\": { \
                  \"from_date\": \"2020-02-01\", \
                  \"fetch_scopes\": [ \
                    \"accounts\", \
                    \"transactions\" \
                  ], \
                  \"custom_fields\": { \
                    \"test\": true \
                  } \
                } \
              } \
            }" \
        https://www.saltedge.com/api/partners/v1/lead_sessions/create
curl -v -H "Accept: application/json" \
        -H "Content-type: application/json" \
        -H "App-id: $APP_ID" \
        -H "Secret: $SECRET" \
        -X POST \
        -d "{ \
              \"data\": { \
                \"consent\": { \
                  \"from_date\": \"2020-01-01\", \
                  \"period_days\": 90, \
                  \"scopes\": [ \
                    \"account_details\", \
                    \"transactions_details\" \
                  ] \
                }, \
                \"attempt\": { \
                  \"from_date\": \"2020-02-01\", \
                  \"fetch_scopes\": [ \
                    \"accounts\", \
                    \"transactions\" \
                  ], \
                  \"custom_fields\": { \
                    \"test\": true \
                  } \
                } \
              } \
            }" \
        https://www.saltedge.com/api/partners/v1/lead_sessions/create

Sample response

{
  "data": {
    "expires_at": "2020-10-26T17:54:10Z",
    "redirect_url": "https://www.saltedge.com/dashboard/sign_up?invitation_token=GENERATED_TOKEN"
  }
}

Reconnect

Allows you to create a lead session to reconnect an existing connection.

Reconnect requires a new consent to be given. The consent confirmation in this case can be handled either on the client’s side (the ‘access terms’ on which the customer has agreed should be sent) or on Salt Edge side (‘access terms’ on which the customer has to agree should be sent).

Reconnect will prompt a new partner consent to be given and is only possible if the connection was previously shared with you.

Parameters

customer_id

string, required

The id of the customer.

connection_id

string, required

The id of the connection you wish to reconnect

consent

object, required

attempt

object, optional

daily_refresh

boolean, optional

Whether the connection should be automatically refreshed by Salt Edge, defaults to true

return_connection_id

boolean, optional

Whether to append connection_id to return_to URL. Will be accompanied by shared: true/false to show whether access to this connection has been granted. Only works if return_to in the attempt object is also passed. Defaults to true

categorization

string, optional

The type of categorization applied. Possible values: none, personal, business. Default: personal

include_fake_providers

boolean, optional

By default, partners in live mode cannot reconnect fake provider connections. However, if sent as true, even a partner in the live mode can test fake providers. Defaults to false

return_error_class

boolean, optional

Whether to append error_class to return_to URL. Defaults to false

theme

string, optional

Theme of Salt Edge Connect template. If not passed or available for the current template, will use default. Allowed values: default, dark.

connect_template

string, optional

Template of Salt Edge Connect. If not passed or available for the current client, will use the default template.

javascript_callback_type

string, optional

Allows you to specify what kind of JavaScript callback method Connect should use. Possible value: post_message.

connection_id

string, required

The id of the connection you wish to reconnect

consent

object, required

attempt

object, optional

daily_refresh

boolean, optional

Whether the connection should be automatically refreshed by Salt Edge, defaults to true

return_connection_id

boolean, optional

Whether to append connection_id to return_to URL. Will be accompanied by shared: true/false to show whether access to this connection has been granted. Only works if return_to in the attempt object is also passed. Defaults to true

categorization

string, optional

The type of categorization applied. Possible values: none, personal, business. Default: personal

include_fake_providers

boolean, optional

By default, partners in live mode cannot reconnect fake provider connections. However, if sent as true, even a partner in the live mode can test fake providers. Defaults to false

return_error_class

boolean, optional

Whether to append error_class to return_to URL. Defaults to false

theme

string, optional

Theme of Salt Edge Connect template. If not passed or available for the current template, will use default. Allowed values: default, dark.

connect_template

string, optional

Template of Salt Edge Connect. If not passed or available for the current client, will use the default template.

javascript_callback_type

string, optional

Allows you to specify what kind of JavaScript callback method Connect should use. Possible value: post_message.

Possible Errors

URL

https://www.saltedge.com/api/partners/v1/lead_sessions/reconnect

https://www.saltedge.com/api/partners/v1/lead_sessions/reconnect

Method

POST

Sample request

curl -v -H "Accept: application/json" \
        -H "Content-type: application/json" \
        -H "App-id: $APP_ID" \
        -H "Secret: $SECRET" \
        -X POST \
        -d "{ \
              \"data\": { \
                \"customer_id\": \"222222222222222222\", \
                \"connection_id\": \"111111111111111111\", \
                \"consent\": { \
                  \"from_date\": \"2020-01-01\", \
                  \"period_days\": 90, \
                  \"scopes\": [ \
                    \"account_details\", \
                    \"transactions_details\" \
                  ] \
                }, \
                \"attempt\": { \
                  \"from_date\": \"2020-02-01\", \
                  \"fetch_scopes\": [ \
                    \"accounts\", \
                    \"transactions\" \
                  ], \
                  \"custom_fields\": { \
                    \"test\": true \
                  } \
                } \
              } \
            }" \
        https://www.saltedge.com/api/partners/v1/lead_sessions/reconnect
curl -v -H "Accept: application/json" \
        -H "Content-type: application/json" \
        -H "App-id: $APP_ID" \
        -H "Secret: $SECRET" \
        -X POST \
        -d "{ \
              \"data\": { \
                \"customer_id\": \"222222222222222222\", \
                \"connection_id\": \"111111111111111111\", \
                \"consent\": { \
                  \"from_date\": \"2020-01-01\", \
                  \"period_days\": 90, \
                  \"scopes\": [ \
                    \"account_details\", \
                    \"transactions_details\" \
                  ] \
                }, \
                \"attempt\": { \
                  \"from_date\": \"2020-02-01\", \
                  \"fetch_scopes\": [ \
                    \"accounts\", \
                    \"transactions\" \
                  ], \
                  \"custom_fields\": { \
                    \"test\": true \
                  } \
                } \
              } \
            }" \
        https://www.saltedge.com/api/partners/v1/lead_sessions/reconnect

Sample response

{
  "data": {
    "expires_at": "2020-10-26T17:54:10Z",
    "redirect_url": "https://www.saltedge.com/dashboard/connect?token=GENERATED_TOKEN"
  }
}

Refresh

Allows you to create a lead session to refresh an existing connection.

Refresh does not require a new consent, it is based on the limitations of the current active consent. If the latest consent has been revoked, only a reconnect is possible.

Parameters

customer_id

string, required

The id of the customer.

connection_id

string, required

The id of the connection you wish to refresh

attempt

object, optional

daily_refresh

boolean, optional

Whether the connection should be automatically refreshed by Salt Edge, defaults to true

return_connection_id

boolean, optional

Whether to append connection_id to return_to URL. Will be accompanied by shared: true/false to show whether access to this connection has been granted. Only works if return_to in the attempt object is also passed. Defaults to true

categorization

string, optional

The type of categorization applied. Possible values: none, personal, business. Default: personal

return_error_class

boolean, optional

Whether to append error_class to return_to URL. Defaults to false

theme

string, optional

Theme of Salt Edge Connect template. If not passed or available for the current template, will use default. Allowed values: default, dark.

connect_template

string, optional

Template of Salt Edge Connect. If not passed or available for the current client, will use the default template.

javascript_callback_type

string, optional

Allows you to specify what kind of JavaScript callback method Connect should use. Possible value: post_message.

connection_id

string, required

The id of the connection you wish to refresh

attempt

object, optional

daily_refresh

boolean, optional

Whether the connection should be automatically refreshed by Salt Edge, defaults to true

return_connection_id

boolean, optional

Whether to append connection_id to return_to URL. Will be accompanied by shared: true/false to show whether access to this connection has been granted. Only works if return_to in the attempt object is also passed. Defaults to true

categorization

string, optional

The type of categorization applied. Possible values: none, personal, business. Default: personal

return_error_class

boolean, optional

Whether to append error_class to return_to URL. Defaults to false

theme

string, optional

Theme of Salt Edge Connect template. If not passed or available for the current template, will use default. Allowed values: default, dark.

connect_template

string, optional

Template of Salt Edge Connect. If not passed or available for the current client, will use the default template.

javascript_callback_type

string, optional

Allows you to specify what kind of JavaScript callback method Connect should use. Possible value: post_message.

Possible Errors

URL

https://www.saltedge.com/api/partners/v1/lead_sessions/refresh

https://www.saltedge.com/api/partners/v1/lead_sessions/refresh

Method

POST

Sample request

curl -v -H "Accept: application/json" \
        -H "Content-type: application/json" \
        -H "App-id: $APP_ID" \
        -H "Secret: $SECRET" \
        -X POST \
        -d "{ \
              \"data\": { \
                \"customer_id\": \"222222222222222222\", \
                \"connection_id\": \"111111111111111111\", \
                \"attempt\": { \
                  \"from_date\": \"2020-02-01\", \
                  \"fetch_scopes\": [ \
                    \"accounts\", \
                    \"transactions\" \
                  ], \
                  \"custom_fields\": { \
                    \"test\": true \
                  } \
                } \
              } \
            }" \
        https://www.saltedge.com/api/partners/v1/lead_sessions/refresh
curl -v -H "Accept: application/json" \
        -H "Content-type: application/json" \
        -H "App-id: $APP_ID" \
        -H "Secret: $SECRET" \
        -X POST \
        -d "{ \
              \"data\": { \
                \"customer_id\": \"222222222222222222\", \
                \"connection_id\": \"111111111111111111\", \
                \"attempt\": { \
                  \"from_date\": \"2020-02-01\", \
                  \"fetch_scopes\": [ \
                    \"accounts\", \
                    \"transactions\" \
                  ], \
                  \"custom_fields\": { \
                    \"test\": true \
                  } \
                } \
              } \
            }" \
        https://www.saltedge.com/api/partners/v1/lead_sessions/refresh

Sample response

{
  "data": {
    "expires_at": "2020-10-26T17:54:10Z",
    "redirect_url": "https://www.saltedge.com/dashboard/connect?token=GENERATED_TOKEN"
  }
}

Partner consents

Partner consent is a part of the combined consent shown to the customer that allows Salt Edge to share account, transaction and holder info data with the registered partner, based on the right to data portability enforced by the EU General Data Protection Regulation (GDPR).

Attributes

id

string

The id of the partner consent

connection_id

string

The id of the connection

customer_id

string

The id of the customer

status

string

Possible values are: active, revoked

revoked_by

string

Entity who revoked the partner consent. Possible values: partner, lead, saltedge

revoked_at

date

When the partner consent was revoked

created_at

date

When the partner consent was created

updated_at

date

When the partner consent was updated

id

string

The id of the partner consent

connection_id

string

The id of the connection

customer_id

string

The id of the customer

status

string

Possible values are: active, revoked

revoked_by

string

Entity who revoked the partner consent. Possible values: partner, lead, saltedge

revoked_at

date

When the partner consent was revoked

created_at

date

When the partner consent was created

updated_at

date

When the partner consent was updated

List

Returns all the partner consents accessible to your application for a certain customer. The partner consents are sorted in ascending order of their id, so the latest partner consents will come last. You can read more about next_id field, in the pagination section of the reference.

Parameters

connection_id

string, optional

The id of the connection containing the partner consents

customer_id

string, optional

The id of the customer containing the partner consents.
Note: Will be ignored if connection_id is present.

from_id

string, optional

The id from which the next page of partner consents starts

from_id

string, optional

The id from which the next page of partner consents starts

Possible Errors

URL

https://www.saltedge.com/api/partners/v1/partner_consents?connection_id={connection.id}

https://www.saltedge.com/api/partners/v1/partner_consents

Method

GET

Sample request

curl -v -H "Accept: application/json" \
        -H "Content-type: application/json" \
        -H "App-id: $APP_ID" \
        -H "Secret: $SECRET" \
        -X GET \
        https://www.saltedge.com/api/partners/v1/partner_consents?connection_id=111111111111111111
curl -v -H "Accept: application/json" \
        -H "Content-type: application/json" \
        -H "App-id: $APP_ID" \
        -H "Secret: $SECRET" \
        -H "Connection-secret: $CONNECTION_SECRET" \
        -X GET \
        https://www.saltedge.com/api/partners/v1/partner_consents

Sample Response

{
  "data": [
    {
      "id": "555555555555555555",
      "connection_id": "111111111111111111",
      "customer_id": "222222222222222222",
      "status": "active",
      "revoked_by": null,
      "revoked_at": null,
      "created_at": "2020-10-26T13:54:10Z",
      "updated_at": "2020-10-26T13:54:10Z"
    }
  ],
  "meta" : {
    "next_id": "555555555555555556",
    "next_page": "/api/partners/v1/partner_consents?connection_id=111111111111111111&from_id=555555555555555556"
  }
}
{
  "data": [
    {
      "id": "555555555555555555",
      "connection_id": "111111111111111111",
      "customer_id": "222222222222222222",
      "status": "active",
      "revoked_by": null,
      "revoked_at": null,
      "created_at": "2020-10-26T13:54:10Z",
      "updated_at": "2020-10-26T13:54:10Z"
    }
  ],
  "meta" : {
    "next_id": "555555555555555556",
    "next_page": "/api/partners/v1/partner_consents?from_id=555555555555555556"
  }
}

Show

Returns the partner consent object.

Parameters

connection_id

string, optional

The id of the connection containing the consents

customer_id

string, optional

The id of the customer containing the consents.
Note: Will be ignored if connection_id is present.

id

string, required

The id of the consent

id

string, required

The id of the consent

Possible Errors

URL

https://www.saltedge.com/api/partners/v1/partner_consents/{consent.id}?connection_id={connection.id}

https://www.saltedge.com/api/partners/v1/partner_consents/{consent.id}

Method

GET

Sample request

curl -v -H "Accept: application/json" \
        -H "Content-type: application/json" \
        -H "App-id: $APP_ID" \
        -H "Secret: $SECRET" \
        -X GET \
        https://www.saltedge.com/api/partners/v1/partner_consents/555555555555555555?connection_id=111111111111111111
curl -v -H "Accept: application/json" \
        -H "Content-type: application/json" \
        -H "App-id: $APP_ID" \
        -H "Secret: $SECRET" \
        -H "Connection-secret: $CONNECTION_SECRET" \
        -X GET \
        https://www.saltedge.com/api/partners/v1/partner_consents/555555555555555555

Sample Response

{
  "data":  {
      "id": "555555555555555555",
      "connection_id": "111111111111111111",
      "customer_id": "222222222222222222",
      "status": "active",
      "revoked_by": null,
      "revoked_at": null,
      "created_at": "2020-10-26T13:54:10Z",
      "updated_at": "2020-10-26T13:54:10Z"
    }
}
{
  "data": {
      "id": "555555555555555555",
      "connection_id": "111111111111111111",
      "customer_id": "222222222222222222",
      "status": "active",
      "revoked_by": null,
      "revoked_at": null,
      "created_at": "2020-10-26T13:54:10Z",
      "updated_at": "2020-10-26T13:54:10Z"
    }
}

Revoke

Partner consent revoke is an action that allows you to revoke a partner consent given by a specific customer.

Attributes

connection_id

string, optional

The id of the connection containing the consents

customer_id

string, optional

The id of the customer containing the consents.
Note: Will be ignored if connection_id is present.

id

string, required

The id of the partner consent

id

string, required

The id of the partner consent

Possible Errors

URL

https://www.saltedge.com/api/partners/v1/partner_consents/{consent.id}/revoke?connection_id={connection.id}

https://www.saltedge.com/api/partners/v1/partner_consents/{consent.id}/revoke

Method

PUT

Sample request

curl -v -H "Accept: application/json" \
        -H "Content-type: application/json" \
        -H "App-id: $APP_ID" \
        -H "Secret: $SECRET" \
        -X PUT \
        https://www.saltedge.com/api/partners/v1/partner_consents/555555555555555555/revoke?connection_id=111111111111111111
curl -v -H "Accept: application/json" \
        -H "Content-type: application/json" \
        -H "App-id: $APP_ID" \
        -H "Secret: $SECRET" \
        -H "Connection-secret: $CONNECTION_SECRET" \
        -X PUT \
        https://www.saltedge.com/api/partners/v1/partner_consents/555555555555555555/revoke

Sample Response

{
  "data": {
      "id": "555555555555555555",
      "connection_id": "111111111111111111",
      "customer_id": "222222222222222222",
      "status": "revoked",
      "revoked_by": "partner",
      "revoked_at": "2020-10-26T13:54:10Z",
      "created_at": "2020-10-26T13:54:10Z",
      "updated_at": "2020-10-26T13:54:10Z"
    }
}
{
  "data": {
      "id": "555555555555555555",
      "connection_id": "111111111111111111",
      "customer_id": "222222222222222222",
      "status": "revoked",
      "revoked_by": "partner",
      "revoked_at": "2020-10-26T13:54:10Z",
      "created_at": "2020-10-26T13:54:10Z",
      "updated_at": "2020-10-26T13:54:10Z"
    }
}

Customers

A customer represents a single end-user of the Salt Edge Partners API.

  • Customer - a single end-user;
  • Connection - a single connection to a provider. A single customer can have multiple connections to multiple banks;
  • Account - an account returned by the provider. Corresponds to a customer’s bank account;
  • Transaction - a single transaction made within an account. Can be a transfer transaction;

Here’s a diagram that illustrates the Customer and its associated concepts:

You need to store the id returned in the callbacks, which is necessary when listing Connections. We give you the following customer API actions so that the customer will be successfully identified within Salt Edge.

Show

Returns the customer object.

Parameters

id

string, required

The id of the customer

id

string, required

The id of the customer

Possible Errors

URL

https://www.saltedge.com/api/partners/v1/customers/{customer.id}

https://www.saltedge.com/api/partners/v1/customers/{customer.id}

Method

GET

Sample request

curl -v -H "Accept: application/json" \
        -H "Content-type: application/json" \
        -H "App-id: $APP_ID" \
        -H "Secret: $SECRET" \
        -X GET \
        https://www.saltedge.com/api/partners/v1/customers/222222222222222222
curl -v -H "Accept: application/json" \
        -H "Content-type: application/json" \
        -H "App-id: $APP_ID" \
        -H "Secret: $SECRET" \
        -X GET \
        https://www.saltedge.com/api/partners/v1/customers/222222222222222222

Sample Response

{
  "data": {
    "id":         "222222222222222222",
    "identifier": "12rv1212f1efxchsdhbgv"
  }
}

List

List all of your app customers. This route is available only for web applications, not mobile ones.

Possible Errors

URL

https://www.saltedge.com/api/partners/v1/customers

https://www.saltedge.com/api/partners/v1/customers

Method

GET

Sample request

curl -v -H "Accept: application/json" \
        -H "Content-type: application/json" \
        -H "App-id: $APP_ID" \
        -H "Secret: $SECRET" \
        -X GET \
        https://www.saltedge.com/api/partners/v1/customers
curl -v -H "Accept: application/json" \
        -H "Content-type: application/json" \
        -H "App-id: $APP_ID" \
        -H "Secret: $SECRET" \
        -X GET \
        https://www.saltedge.com/api/partners/v1/customers

Sample Response

{
  "data": [
    {
      "id":         "222222222222222222",
      "identifier": "unique_customer_identifier",
    },
    {
      "id":         "222222222222222223",
      "identifier": "unique_customer_identifier_2",
    }
  ],
  "meta": {
    "next_id": "222222222222222224",
    "next_page": "/api/partners/v1/customers?from_id=222222222222222224"
  }
}

Connections

A connection represents a set of credentials required to access the accounts and transactions through a specific provider.

Within Salt Edge Partners API, a connection can have one of the following statuses:

  • active - the current set of credentials is valid and allows us to properly fetch the data;
  • inactive - an error appeared while fetching the connection;

    The conditions when a connection will have inactive status:

    • Any attempt that fails with Invalid credentials error will mark the connection’s status to inactive
    • Any attempt that fails with Provider Unavailable with one of the following error messages:
      • Account blocked. Please, contact your provider.
      • Provider does not have any account records available at this time.
      • Provider asked to update your account settings.
      • No active accounts were found. Please, contact your provider.
      • Provider is disabled.
  • disabled - in case of non-compliance with our Terms of Service, we can contact the application’s owner and disable the connection.

A Connection represents a permanent connection of a specific customer to a bank. A single end-user represents a single customer in Salt Edge Partners API.

Attributes

id

string

The id of the connection

provider_id

string

The id of the provider the connection belongs to

provider_code

string

The code of the provider the connection belongs to

provider_name

string

The name of the provider the connection belongs to

daily_refresh

boolean

Whether the connection will be refreshed daily

customer_id

string

The id of the customer

created_at

datetime

Time and date when the connection was added

updated_at

datetime

The last time when the connection’s balance was changed, new accounts were imported or new transactions added/removed

last_success_at

datetime

Time when the connection was successfully fetched

status

string

Possible values are: active, inactive, disabled

country_code

string

Code of the country the provider belongs to

next_refresh_possible_at

datetime

When the next refresh will be available. May contain null value if the connection has automatic_fetch set as false, or is already processing

last_attempt

object, attempt object

Last attempt of this connection

show_consent_confirmation

boolean

Whether any consent was given for this login on Salt Edge side

last_consent_id

string

The id of the last consent

id

string

The id of the connection

provider_id

string

The id of the provider the connection belongs to

provider_code

string

The code of the provider the connection belongs to

provider_name

string

The name of the provider the connection belongs to

daily_refresh

boolean

Whether the connection will be refreshed daily

customer_id

string

The id of the customer

created_at

datetime

Time and date when the connection was added

updated_at

datetime

The last time when the connection’s balance was changed, new accounts were imported or new transactions added/removed

last_success_at

datetime

Time when the connection was successfully fetched

status

string

Possible values are: active, inactive, disabled

country_code

string

Code of the country the provider belongs to

next_refresh_possible_at

datetime

When the next refresh will be available. May contain null value if the connection has automatic_fetch set as false, or is already processing

last_attempt

object, attempt object

Last attempt of this connection

show_consent_confirmation

boolean

Whether any consent was given for this login on Salt Edge side

last_consent_id

string

The id of the last consent

Sample object

{
  "country_code": "XF",
  "created_at": "2020-10-25T16:54:10Z",
  "customer_id": "222222222222222222",
  "daily_refresh": false,
  "id": "111111111111111111",
  "show_consent_confirmation": true,
  "last_consent_id": "555555555555555555",
  "last_attempt": {
    "api_mode": "service",
    "api_version": "5",
    "automatic_fetch": true,
    "daily_refresh": false,
    "categorization": "personal",
    "created_at": "2020-10-26T16:54:10Z",
    "customer_last_logged_at": "2020-10-26T13:54:10Z",
    "custom_fields": {},
    "device_type": "desktop",
    "remote_ip": "93.184.216.34",
    "fail_at": null,
    "fail_error_class": null,
    "fail_message": null,
    "fetch_scopes": ["accounts", "transactions"],
    "finished": true,
    "finished_recent": true,
    "from_date": null,
    "id": "777777777777777777",
    "interactive": false,
    "locale": "en",
    "partial": false,
    "success_at": "2020-10-26T16:54:10Z",
    "to_date": null,
    "updated_at": "2020-10-26T16:54:10Z",
    "show_consent_confirmation": true,
    "consent_id": "555555555555555555",
    "include_natures": ["account", "card", "bonus"],
    "last_stage": {
      "created_at": "2020-10-26T16:54:10Z",
      "id": "888888888888888888",
      "name": "finish",
      "updated_at": "2020-10-26T16:54:10Z"
    }
  },
  "holder_info": {
    "names": ["John Doe"],
    "emails": ["john.doe@example.com", "johndoe@gmail.com"],
    "phone_numbers": ["+40981233422"],
    "addresses": [
      {
        "city": "Cupertino",
        "state": "CA",
        "street": "1 Infinite Loop",
        "country_code": "US",
        "post_code": "95014"
      }
    ]
  },
  "last_success_at": "2020-10-26T16:54:10Z",
  "next_refresh_possible_at": "2020-02-02T17:16:19Z",
  "provider_id": "1234",
  "provider_code": "fakebank_simple_xf",
  "provider_name": "Fakebank Simple",
  "status": "active",
  "updated_at": "2020-10-26T16:54:10Z"
}

List

Returns all the connections accessible to your application for a certain customer. The connections are sorted in ascending order of their id, so the newest connections will come last. We recommend you fetch the whole list of connections to check whether any of the properties have changed. You can read more about next_id field, in the pagination section of the reference.

Parameters

customer_id

string, required

The id of the customer, allows to fetch connections only for a certain customer

from_id

string, optional

The id of the record starting the next page

customer_id

string, required

The id of the customer, allows to fetch connections only for a certain customer

from_id

string, optional

The id of the record starting the next page

Possible Errors

URL

https://www.saltedge.com/api/partners/v1/connections

https://www.saltedge.com/api/partners/v1/connections

Method

GET

Sample request

curl -v -H "Accept: application/json" \
        -H "Content-type: application/json" \
        -H "App-id: $APP_ID" \
        -H "Secret: $SECRET" \
        -X GET \
        https://www.saltedge.com/api/partners/v1/connections?customer_id=$CUSTOMER_ID
curl -v -H "Accept: application/json" \
        -H "Content-type: application/json" \
        -H "App-id: $APP_ID" \
        -H "Secret: $SECRET" \
        -X GET \
        https://www.saltedge.com/api/partners/v1/connections?customer_id=$CUSTOMER_ID

Sample Response

{ "data":
  [
    {
      "country_code": "XF",
      "created_at": "2020-10-25T16:54:10Z",
      "customer_id": "222222222222222222",
      "daily_refresh": false,
      "id": "111111111111111111",
      "show_consent_confirmation": true,
      "last_consent_id": "555555555555555555",
      "last_attempt": {
          "api_mode": "service",
          "api_version": "5",
          "automatic_fetch": true,
          "daily_refresh": false,
          "categorization": "personal",
          "created_at": "2020-10-26T16:14:10Z",
          "customer_last_logged_at": "2020-10-26T13:54:10Z",
          "custom_fields": {},
          "device_type": "desktop",
          "remote_ip": "93.184.216.34",
          "fail_at": null,
          "fail_error_class": null,
          "fail_message": null,
          "fetch_scopes": ["accounts", "transactions"],
          "finished": true,
          "finished_recent": true,
          "from_date": null,
          "id": "777777777777777777",
          "interactive": false,
          "locale": "en",
          "partial": false,
          "success_at": "2020-10-26T16:14:10Z",
          "to_date": null,
          "updated_at": "2020-10-26T16:14:10Z",
          "show_consent_confirmation": true,
          "consent_id": "555555555555555555",
          "include_natures": ["account", "card", "bonus"],
          "last_stage": {
            "created_at": "2020-10-26T16:14:10Z",
            "id": "888888888888888888",
            "name": "finish",
            "updated_at": "2020-10-26T16:14:10Z"
          }
      },
      "last_success_at": "2020-10-26T16:14:10Z",
      "next_refresh_possible_at": "2020-02-02T17:16:19Z",
      "provider_id": "1234",
      "provider_code": "fakebank_simple_xf",
      "provider_name": "Fakebank Simple",
      "status": "active",
      "updated_at": "2020-10-26T16:14:10Z"
    }
  ],
  "meta" : {
    "next_id": "111111111111111112",
    "next_page": "/api/partners/v1/connections?customer_id=222222222222222222&from_id=111111111111111112"
  }
}

Show

Returns a single connection object.

Possible Errors

URL

https://www.saltedge.com/api/partners/v1/connections/{connection.id}

https://www.saltedge.com/api/partners/v1/connection

Method

GET

Sample request

curl -v -H "Accept: application/json" \
        -H "Content-type: application/json" \
        -H "App-id: $APP_ID" \
        -H "Secret: $SECRET" \
        -X GET \
        https://www.saltedge.com/api/partners/v1/connections/111111111111111111
curl -v -H "Accept: application/json" \
        -H "Content-type: application/json" \
        -H "App-id: $APP_ID" \
        -H "Secret: $SECRET" \
        -H "Connection-secret: $CONNECTION_SECRET" \
        -X GET \
        https://www.saltedge.com/api/partners/v1/connection

Sample Response

{
  "data": {
    "country_code": "MD",
    "created_at": "2020-10-24T20:09:02Z",
    "customer_id": "222222222222222222",
    "daily_refresh": false,
    "id": "111111111111111111",
    "show_consent_confirmation": true,
    "last_consent_id": "555555555555555555",
    "last_attempt": {
      "api_mode": "service",
      "api_version": "5",
      "automatic_fetch": true,
      "daily_refresh": false,
      "categorization": "personal",
      "created_at": "2020-02-02T16:14:53Z",
      "customer_last_logged_at": "2020-10-26T13:54:10Z",
      "custom_fields": {},
      "device_type": "desktop",
      "remote_ip": "93.184.216.34",
      "fail_at": null,
      "fail_error_class": null,
      "fail_message": null,
      "fetch_scopes": ["accounts", "transactions"],
      "finished": true,
      "finished_recent": true,
      "from_date": null,
      "id": "777777777777777777",
      "interactive": false,
      "locale": "en",
      "partial": false,
      "success_at": "2020-02-02T16:16:19Z",
      "to_date": null,
      "updated_at": "2020-02-02T16:16:19Z",
      "show_consent_confirmation": true,
      "consent_id": "555555555555555555",
      "include_natures": ["account", "card", "bonus"],
      "last_stage": {
        "created_at": "2020-02-02T16:16:19Z",
        "id": "888888888888888888",
        "name": "finish",
        "updated_at": "2020-02-02T16:16:19Z"
      }
    },
    "last_success_at": "2020-02-02T16:16:19Z",
    "next_refresh_possible_at": "2020-02-02T17:16:19Z",
    "provider_id": "1234",
    "provider_code": "moldindconbank_wb_md",
    "provider_name": "Moldindconbank Web Banking",
    "status": "active",
    "updated_at": "2020-02-04T09:41:23Z"
  }
}
{
  "data": {
    "country_code": "MD",
    "created_at": "2020-10-24T20:09:02Z",
    "customer_id": "222222222222222222",
    "daily_refresh": false,
    "id": "111111111111111111",
    "show_consent_confirmation": true,
    "last_consent_id": "555555555555555555",
    "last_attempt": {
      "api_mode": "service",
      "api_version": "5",
      "automatic_fetch": true,
      "daily_refresh": false,
      "categorization": "personal",
      "created_at": "2020-02-02T16:14:53Z",
      "customer_last_logged_at": "2020-10-26T13:54:10Z",
      "custom_fields": {},
      "device_type": "desktop",
      "remote_ip": "93.184.216.34",
      "fail_at": null,
      "fail_error_class": null,
      "fail_message": null,
      "fetch_scopes": ["accounts", "transactions"],
      "finished": true,
      "finished_recent": true,
      "from_date": null,
      "id": "777777777777777777",
      "interactive": false,
      "locale": "en",
      "partial": false,
      "success_at": "2020-02-02T16:16:19Z",
      "to_date": null,
      "updated_at": "2020-02-02T16:16:19Z",
      "show_consent_confirmation": true,
      "consent_id": "555555555555555555",
      "include_natures": ["account", "card", "bonus"],
      "last_stage": {
        "created_at": "2020-02-02T16:16:19Z",
        "id": "888888888888888888",
        "name": "finish",
        "updated_at": "2020-02-02T16:16:19Z"
      }
    },
    "last_success_at": "2020-02-02T16:16:19Z",
    "next_refresh_possible_at": "2020-02-02T17:16:19Z",
    "provider_id": "1234",
    "provider_code": "moldindconbank_wb_md",
    "provider_name": "Moldindconbank Web Banking",
    "status": "active",
    "updated_at": "2020-02-04T09:41:23Z"
  }
}

Consents

A consent represents the access to data and the limits of this access agreed on by a customer. It is required to access the accounts, transactions and holder information through a specific provider.

The limits of a consent are represented by:

  • data that is allowed to be accessed;
  • period of time the data can be accessed for;
  • interval of time to which the accessed data belongs to.

Attributes

id

string

The id of the consent

connection_id

string

The id of the connection

customer_id

string

The id of the customer

scopes

array of strings, required

Data that is allowed to be fetched. Possible values: ['account_details'], ['holder_information'], ['account_details', 'holder_information'], ['account_details', 'transactions_details'], ['account_details', 'holder_information', 'transactions_details']

period_days

integer

The period the consent will be valid for

expires_at

date

The date when the consent will expire

from_date

date

The date from which the data has been allowed to be fetched

to_date

date

The date until which the data has been allowed to be fetched

revoked_at

date

The date when consent was revoked

created_at

date

When the consent was created

updated_at

date

When the consent was updated

id

string

The id of the consent

connection_id

string

The id of the connection

customer_id

string

The id of the customer

scopes

array of strings, required

Data that is allowed to be fetched. Possible values: ['account_details'], ['holder_information'], ['account_details', 'holder_information'], ['account_details', 'transactions_details'], ['account_details', 'holder_information', 'transactions_details']

period_days

integer

The period the consent will be valid for

expires_at

date

The date when the consent will expire

from_date

date

The date from which the data has been allowed to be fetched

to_date

date

The date until which the data has been allowed to be fetched

revoked_at

date

The date when consent was revoked

created_at

date

When the consent was created

updated_at

date

When the consent was updated

List

Returns all the consents accessible to your application for a certain customer or connection. The consents are sorted in ascending order of their id, so the latest consents will come last. You can read more about next_id field, in the pagination section of the reference.

Parameters

connection_id

string, optional

The id of the connection containing the consents

customer_id

string, optional

The id of the customer containing the consents.
Note: Will be ignored if connection_id is present.

from_id

string, optional

The id from which the next page of consents starts

from_id

string, optional

The id from which the next page of consents starts

Possible Errors

URL

https://www.saltedge.com/api/partners/v1/consents?connection_id={connection.id}

https://www.saltedge.com/api/partners/v1/consents

Method

GET

Sample request

curl -v -H "Accept: application/json" \
        -H "Content-type: application/json" \
        -H "App-id: $APP_ID" \
        -H "Secret: $SECRET" \
        -X GET \
        https://www.saltedge.com/api/partners/v1/consents?connection_id=111111111111111111
curl -v -H "Accept: application/json" \
        -H "Content-type: application/json" \
        -H "App-id: $APP_ID" \
        -H "Secret: $SECRET" \
        -H "Connection-secret: $CONNECTION_SECRET" \
        -X GET \
        https://www.saltedge.com/api/partners/v1/consents

Sample Response

{
  "data": [
    {
      "id": "555555555555555555",
      "connection_id": "111111111111111111",
      "customer_id": "222222222222222222",
      "scopes": [
        "account_details",
        "transactions_details"
      ],
      "period_days": 60,
      "expires_at": "2020-12-25T13:54:10Z",
      "from_date": "2020-09-26",
      "to_date": null,
      "collected_by": "client",
      "revoked_at": null,
      "revoke_reason": null,
      "created_at": "2020-10-26T13:54:10Z",
      "updated_at": "2020-10-26T13:54:10Z"
    }
  ],
  "meta" : {
    "next_id": "555555555555555556",
    "next_page": "/api/partners/v1/consents?connection_id=111111111111111111&from_id=555555555555555556"
  }
}
{
  "data": [
    {
      "id": "555555555555555555",
      "scopes": [
        "account_details",
        "transactions_details"
      ],
      "period_days": 60,
      "expires_at": "2020-12-25T13:54:10Z",
      "from_date": "2020-09-26",
      "to_date": null,
      "collected_by": "client",
      "revoked_at": null,
      "revoke_reason": null,
      "created_at": "2020-10-26T13:54:10Z",
      "updated_at": "2020-10-26T13:54:10Z"
    }
  ],
  "meta" : {
    "next_id": "555555555555555556",
    "next_page": "/api/partners/v1/consents?from_id=555555555555555556"
  }
}

Show

Returns the consent object.

Parameters

connection_id

string, optional

The id of the connection containing the consent, required unless customer_id parameter is sent

customer_id

string, optional

The id of the customer containing the consent, required unless connection_id parameter is sent.

id

string, required

The id of the consent

id

string, required

The id of the consent

Possible Errors

URL

https://www.saltedge.com/api/partners/v1/consents/{consent.id}?connection_id={connection.id}

https://www.saltedge.com/api/partners/v1/consents/{consent.id}

Method

GET

Sample request

curl -v -H "Accept: application/json" \
        -H "Content-type: application/json" \
        -H "App-id: $APP_ID" \
        -H "Secret: $SECRET" \
        -X GET \
        https://www.saltedge.com/api/partners/v1/consents/555555555555555555?connection_id=111111111111111111
curl -v -H "Accept: application/json" \
        -H "Content-type: application/json" \
        -H "App-id: $APP_ID" \
        -H "Secret: $SECRET" \
        -H "Connection-secret: $CONNECTION_SECRET" \
        -X GET \
        https://www.saltedge.com/api/partners/v1/consents/555555555555555555

Sample Response

{
  "data": {
    "id": "555555555555555555",
    "connection_id": "111111111111111111",
    "customer_id": "222222222222222222",
    "scopes": [
      "account_details",
      "transactions_details"
    ],
    "period_days": 60,
    "expires_at": "2020-12-25T13:54:10Z",
    "from_date": "2020-09-26",
    "to_date": null,
    "collected_by": "client",
    "revoked_at": null,
    "revoke_reason": null,
    "created_at": "2020-10-26T13:54:10Z",
    "updated_at": "2020-10-26T13:54:10Z"
  }
}
{
  "data": {
    "id": "555555555555555555",
    "scopes": [
      "account_details",
      "transactions_details"
    ],
    "period_days": 60,
    "expires_at": "2020-12-25T13:54:10Z",
    "from_date": "2020-09-26",
    "to_date": null,
    "collected_by": "client",
    "revoked_at": null,
    "revoke_reason": null,
    "created_at": "2020-10-26T13:54:10Z",
    "updated_at": "2020-10-26T13:54:10Z"
  }
}

Parameters object

The following represents the consent parameters object that is passed in requests.

scopes

array of strings, required

Data to be allowed for fetching. Possible values: ['account_details'], ['holder_information'], ['account_details', 'holder_information'], ['account_details', 'transactions_details'], ['account_details', 'holder_information', 'transactions_details']
Note: The allowed values for this parameter must fall within the client’s allowed_fetch_scopes and/or provider’s supported_fetch_scopes restrictions. To change the client’s allowed scopes, please contact our sales team.

from_date

date, optional

Date to be allowed for fetching the data from. Default: 90 days ago (only for the providers with regulated:true).
Note: This parameter is used when scopes parameter contains transactions_details. The allowed values for this parameter must be within exactly 365 days ago.

to_date

date, optional

Date to be allowed for fetching the data untill. Default: null (limitless).
Note: The allowed values for this parameter must be equal or more than from_date.

period_days

integer, optional

Determines the period the consent will be valid for. Default: null (limitless) or provider’s max_consent_days.
Note: The allowed value for this parameter must not be higher than the provider’s max_consent_days.

scopes

array of strings, required

Data to be allowed for fetching. Possible values: ['account_details'], ['holder_information'], ['account_details', 'holder_information'], ['account_details', 'transactions_details'], ['account_details', 'holder_information', 'transactions_details']
Note: The allowed values for this parameter must fall within the client’s allowed_fetch_scopes and/or provider’s supported_fetch_scopes restrictions. To change the client’s allowed scopes, please contact our sales team.

from_date

date, optional

Date to be allowed for fetching the data from. Default: 90 days ago (only for the providers with regulated:true).
Note: This parameter is used when scopes parameter contains transactions_details. The allowed values for this parameter must be within exactly 365 days ago.

to_date

date, optional

Date to be allowed for fetching the data untill. Default: null (limitless).
Note: The allowed values for this parameter must be equal or more than from_date.

period_days

integer, optional

Determines the period the consent will be valid for. Default: null (limitless) or provider’s max_consent_days.
Note: The allowed value for this parameter must not be higher than the provider’s max_consent_days.

Attempts

The attempt resource represents a detailed description of a particular connection attempt. They are meant to provide you with more information about the established connections for further usage in technical and statistical purposes.

Attributes

api_mode

string

The API mode of the customer that queried the API. Possible values: app, service

api_version

string

The API version in which the attempt was created

automatic_fetch

boolean

Whether the connection related to the attempt can be automatically fetched

daily_refresh

boolean

Latest assigned value for daily_refresh in connection

categorization

string, optional

The type of categorization applied. Possible values: none, personal, business. Default: personal

created_at

datetime

When the attempt was created

custom_fields

object

The custom fields that had been sent when creating connection/connect_session/oauth_provider

device_type

string

The type of the device that created the attempt. Possible values: desktop, tablet, mobile

remote_ip

string

The IP of the device that created the attempt

customer_last_logged_at

datetime

The datetime when user was last active in your application

fail_at

datetime

When the attempt failed to finish

fail_error_class

string

Class of error that triggered the fail for the attempt

fail_message

string

Message that describes the error class

fetch_scopes

array of strings, required

Fetching mode, possible values: ['accounts'], ['holder_info'], ['accounts', 'holder_info'], ['accounts', 'transactions'], ['accounts', 'holder_info', 'transactions']

finished

boolean

Whether the connection has finished fetching

finished_recent

boolean

Whether the connection has finished data for recent range (2 months)

from_date

date

Date from which the data has been fetched

id

string

The id of the attempt

interactive

boolean

Whether the connection related to the attempt is interactive

locale

string

The language of the provider error messages in the ISO 639-1 format. Possible values are: bg, cz, de, en, es, es-MX, fr, he, hu, it, nl, pl, pt, pt-BR, ro, ru, sk, tr, uk, zh-HongKong. Defaults to en

partial

boolean

Whether the connection was partially fetched

success_at

datetime

When the attempt succeeded and finished

to_date

date

Date until which the data has been fetched

updated_at

datetime

When last attempt update occurred

show_consent_confirmation

boolean

Whether any consent was given for this connection

include_natures

array of strings

The natures of the accounts that need to be fetched

stages

array of stage objects

Information about stages through which the connection has passed

api_mode

string

The API mode of the customer that queried the API. Possible values: app, service

api_version

string

The API version in which the attempt was created

automatic_fetch

boolean

Whether the connection related to the attempt can be automatically fetched

daily_refresh

boolean

Latest assigned value for daily_refresh in connection

categorization

string, optional

The type of categorization applied. Possible values: none, personal, business. Default: personal

created_at

datetime

When the attempt was created

custom_fields

object

The custom fields that had been sent when creating connection/connect_session/oauth_provider

device_type

string

The type of the device that created the attempt. Possible values: desktop, tablet, mobile

remote_ip

string

The IP of the device that created the attempt

customer_last_logged_at

datetime

The datetime when user was last active in your application

fail_at

datetime

When the attempt failed to finish

fail_error_class

string

Class of error that triggered the fail for the attempt

fail_message

string

Message that describes the error class

fetch_scopes

array of strings, required

Fetching mode, possible values: ['accounts'], ['holder_info'], ['accounts', 'holder_info'], ['accounts', 'transactions'], ['accounts', 'holder_info', 'transactions']

finished

boolean

Whether the connection has finished fetching

finished_recent

boolean

Whether the connection has finished data for recent range (2 months)

from_date

date

Date from which the data has been fetched

id

string

The id of the attempt

interactive

boolean

Whether the connection related to the attempt is interactive

locale

string

The language of the provider error messages in the ISO 639-1 format. Possible values are: bg, cz, de, en, es, es-MX, fr, he, hu, it, nl, pl, pt, pt-BR, ro, ru, sk, tr, uk, zh-HongKong. Defaults to en

partial

boolean

Whether the connection was partially fetched

success_at

datetime

When the attempt succeeded and finished

to_date

date

Date until which the data has been fetched

updated_at

datetime

When last attempt update occurred

show_consent_confirmation

boolean

Whether any consent was given for this connection

include_natures

array of strings

The natures of the accounts that need to be fetched

stages

array of stage objects

Information about stages through which the connection has passed

Note: The values of the interactive and automatic_fetch are subject to change, since the customer can activate or deactivate the interactive requirements separately with their bank.

Sample object

{
  "api_mode": "service",
  "api_version": "5",
  "automatic_fetch": true,
  "categorization": "personal",
  "created_at": "2020-10-26T14:54:10Z",
  "customer_last_logged_at": "2020-10-26T13:54:10Z",
  "custom_fields": {},
  "daily_refresh": false,
  "device_type": "desktop",
  "remote_ip": "93.184.216.34",
  "fail_at": null,
  "fail_error_class": null,
  "fail_message": null,
  "fetch_scopes": ["accounts", "transactions"],
  "finished": true,
  "finished_recent": true,
  "from_date": null,
  "id": "777777777777777777",
  "interactive": false,
  "partial": false,
  "success_at": "2020-10-26T15:54:10Z",
  "to_date": null,
  "updated_at": "2020-10-26T15:54:10Z",
  "show_consent_confirmation": true,
  "include_natures": ["account", "card", "bonus"],
  "last_stage": {
    "created_at": "2020-10-26T15:54:10Z",
    "id": "888888888888888888",
    "name": "finish",
    "updated_at": "2020-10-26T15:54:10Z"
  }
}

Stages

The following represents the objects you get in the stages field of the attempt object.

created_at

datetime

When the stage was created

id

string

The id of the stage

name

string

The name of the stage. Possible values: start, connect, interactive, fetch_holder_info, fetch_accounts, fetch_recent, fetch_full, disconnect, finish

updated_at

datetime

When the stage was last updated

created_at

datetime

When the stage was created

id

string

The id of the stage

name

string

The name of the stage. Possible values: start, connect, interactive, fetch_holder_info, fetch_accounts, fetch_recent, fetch_full, disconnect, finish

updated_at

datetime

When the stage was last updated

List

Returns a paginated list of all attempts for a specific connection.

Parameters

connection_id

string

The id of the connection whose attempts are to be fetched

URL

https://www.saltedge.com/api/partners/v1/attempts?connection_id={connection.id}

https://www.saltedge.com/api/partners/v1/attempts

Method

GET

Sample request

curl -v -H "Accept: application/json" \
        -H "Content-type: application/json" \
        -H "App-id: $APP_ID" \
        -H "Secret: $SECRET" \
        -X GET \
        https://www.saltedge.com/api/partners/v1/attempts?connection_id=111111111111111111
curl -v -H "Accept: application/json" \
        -H "Content-type: application/json" \
        -H "App-id: $APP_ID" \
        -H "Secret: $SECRET" \
        -H "Connection-secret: $CONNECTION_SECRET" \
        -X GET \
        https://www.saltedge.com/api/partners/v1/attempts

Sample response

{
  "data": {
    [
      {
        "api_mode": "service",
        "api_version": "5",
        "automatic_fetch": true,
        "categorization": "personal",
        "created_at": "2020-10-26T14:54:10Z",
        "customer_last_logged_at": "2020-10-26T13:54:10Z",
        "custom_fields": {},
        "device_type": "desktop",
        "daily_refresh": false,
        "remote_ip": "93.184.216.34",
        "fail_at": null,
        "fail_error_class": null,
        "fail_message": null,
        "fetch_scopes": ["accounts", "transactions"],
        "finished": true,
        "finished_recent": true,
        "from_date": null,
        "id": "777777777777777777",
        "interactive": false,
        "locale": "en",
        "partial": false,
        "success_at": "2020-10-26T15:54:10Z",
        "to_date": null,
        "updated_at": "2020-10-26T15:54:10Z",
        "show_consent_confirmation": true,
        "include_natures": ["account", "card", "bonus"],
        "last_stage": {
          "created_at": "2020-10-26T15:54:10Z",
          "id": "888888888888888888",
          "name": "finish",
          "updated_at": "2020-10-26T15:54:10Z"
        }
      }
    ]
  },
  "meta": {
    "next_id": "777777777777777778",
    "next_page": "/api/partners/v1/attempts?connection_id=111111111111111111&from_id=777777777777777778"
  }
}
{
  "data": {
    [
      {
        "api_mode": "app",
        "api_version": "5",
        "automatic_fetch": true,
        "categorization": "personal",
        "created_at": "2020-10-26T14:54:10Z",
        "customer_last_logged_at": "2020-10-26T13:54:10Z",
        "custom_fields": {},
        "device_type": "desktop",
        "daily_refresh": false,
        "remote_ip": "93.184.216.34",
        "fail_at": null,
        "fail_error_class": null,
        "fail_message": null,
        "fetch_scopes": ["accounts", "transactions"],
        "finished": true,
        "finished_recent": true,
        "from_date": null,
        "id": "777777777777777777",
        "interactive": false,
        "locale": "en",
        "partial": false,
        "success_at": "2020-10-26T15:54:10Z",
        "to_date": null,
        "updated_at": "2020-10-26T15:54:10Z",
        "show_consent_confirmation": true,
        "include_natures": ["account", "card", "bonus"],
        "last_stage": {
          "created_at": "2020-10-26T15:54:10Z",
          "id": "888888888888888888",
          "name": "finish",
          "updated_at": "2020-10-26T15:54:10Z"
        }
      }
    ]
  },
  "meta": {
    "next_id": "777777777777777778",
    "next_page": "/api/partners/v1/attempts?from_id=777777777777777778"
  }
}

Show

Returns a single attempt object.

Parameters

connection_id

string

The id of the connection whose attempts are to be fetched

URL

https://www.saltedge.com/api/partners/v1/attempts/{attempt.id}?connection_id={connection.id}

https://www.saltedge.com/api/partners/v1/attempts/{attempt.id}

Method

GET

Sample request

curl -v -H "Accept: application/json" \
        -H "Content-type: application/json" \
        -H "App-id: $APP_ID" \
        -H "Secret: $SECRET" \
        -X GET \
        https://www.saltedge.com/api/partners/v1/attempts/777777777777777777?connection_id=111111111111111111
curl -v -H "Accept: application/json" \
        -H "Content-type: application/json" \
        -H "App-id: $APP_ID" \
        -H "Secret: $SECRET" \
        -H "Connection-secret: $CONNECTION_SECRET" \
        -X GET \
        https://www.saltedge.com/api/partners/v1/attempts/777777777777777777

Sample response

{
  "data": {
    "api_mode": "service",
    "api_version": "5",
    "automatic_fetch": true,
    "daily_refresh": false,
    "categorization": "personal",
    "created_at": "2020-10-26T14:54:10Z",
    "customer_last_logged_at": "2020-10-26T13:54:10Z",
    "custom_fields": {},
    "device_type": "desktop",
    "remote_ip": "93.184.216.34",
    "fail_at": null,
    "fail_error_class": null,
    "fail_message": null,
    "fetch_scopes": ["accounts", "transactions"],
    "finished": true,
    "finished_recent": true,
    "from_date": null,
    "id": "777777777777777777",
    "interactive": false,
    "locale": "en",
    "partial": false,
    "success_at": "2020-10-26T15:54:10Z",
    "to_date": null,
    "updated_at": "2020-10-26T15:54:10Z",
    "show_consent_confirmation": true,
    "include_natures": ["account", "card", "bonus"],
    "stages": [
      {
        "created_at": "2020-10-26T14:54:10Z",
        "id": "888888888888888881",
        "name": "start",
        "updated_at": "2020-10-26T14:54:10Z"
      },
      {
        "created_at": "2020-10-26T15:04:10Z",
        "id": "888888888888888882",
        "name": "connect",
        "updated_at": "2020-10-26T15:04:10Z"
      },
      {
        "created_at": "2020-10-26T15:54:10Z",
        "id": "888888888888888883",
        "name": "finish",
        "updated_at": "2020-10-26T15:54:10Z"
      }
    ]
  }
}
{
  "data": {
    "api_mode": "app",
    "api_version": "5",
    "automatic_fetch": true,
    "daily_refresh": false,
    "categorization": "personal",
    "created_at": "2020-10-26T14:54:10Z",
    "customer_last_logged_at": "2020-10-26T13:54:10Z",
    "custom_fields": {},
    "device_type": "desktop",
    "remote_ip": "93.184.216.34",
    "fail_at": null,
    "fail_error_class": null,
    "fail_message": null,
    "fetch_scopes": ["accounts", "transactions"],
    "finished": true,
    "finished_recent": true,
    "from_date": null,
    "id": "777777777777777777",
    "interactive": false,
    "locale": "en",
    "partial": false,
    "success_at": "2020-10-26T15:54:10Z",
    "to_date": null,
    "updated_at": "2020-10-26T15:54:10Z",
    "show_consent_confirmation": true,
    "include_natures": ["account", "card", "bonus"],
    "stages": [
      {
        "created_at": "2020-10-26T14:54:10Z",
        "id": "888888888888888881",
        "name": "start",
        "updated_at": "2020-10-26T14:54:10Z"
      },
      {
        "created_at": "2020-10-26T15:04:10Z",
        "id": "888888888888888882",
        "name": "connect",
        "updated_at": "2020-10-26T15:04:10Z"
      },
      {
        "created_at": "2020-10-26T15:54:10Z",
        "id": "888888888888888883",
        "name": "finish",
        "updated_at": "2020-10-26T15:54:10Z"
      }
    ]
  }
}

Parameters object

The following represents the attempt parameters object that is passed in requests.

fetch_scopes

array of strings, optional

Fetching mode. Possible values: ['accounts'], ['holder_info'], ['accounts', 'holder_info'], ['accounts', 'transactions'], ['accounts', 'holder_info', 'transactions']. Default: consent scopes.
Note: The allowed values for this parameter must comply to the consent scopes restriction.

from_date

date, optional

Date from which you want to fetch data for your connection. Default: consent from_date.
Note: The allowed values for this parameter must be within exactly 365 days ago and it should comply to the fetching period restrictions in the consent.

to_date

date, optional

Date until which you want to fetch data for your connection. Default: null (today).
Note: The allowed values for this parameter must be equal or more than from_date and less or equal than tomorrow. Also it should comply to the fetching period restrictions in the consent.

fetched_accounts_notify

boolean, optional

Whether Salt Edge should send a success callback after fetching accounts. Defaults to false

custom_fields

object, optional

A JSON object, which will be sent back on any of your callbacks, defaults to empty object

locale

string, optional

The language of the provider error messages in the ISO 639-1 format. Possible values are: bg, cz, de, en, es, es-MX, fr, he, hu, it, nl, pl, pt, pt-BR, ro, ru, sk, tr, uk, zh-HongKong. Defaults to en

include_natures

array of strings, optional

The natures of the accounts that need to be fetched. Check accounts attributes for possible values. Default value: null (all accounts will be fetched)

customer_last_logged_at

datetime, optional

The datetime when the user was last active in your application

return_to

string, optional

The URL the user will be redirected to. Defaults to client’s home URL (if set and valid) or Lead’s Dashboard

fetch_scopes

array of strings, optional

Fetching mode. Possible values: ['accounts'], ['holder_info'], ['accounts', 'holder_info'], ['accounts', 'transactions'], ['accounts', 'holder_info', 'transactions']. Default: consent scopes.
Note: The allowed values for this parameter must comply to the consent scopes restriction.

from_date

date, optional

Date from which you want to fetch data for your connection. Default: consent from_date.
Note: The allowed values for this parameter must be within exactly 365 days ago and it should comply to the fetching period restrictions in the consent.

to_date

date, optional

Date until which you want to fetch data for your connection. Default: null (today).
Note: The allowed values for this parameter must be equal or more than from_date and less or equal than tomorrow. Also it should comply to the fetching period restrictions in the consent.

fetched_accounts_notify

boolean, optional

Whether Salt Edge should send a success callback after fetching accounts. Defaults to false

custom_fields

object, optional

A JSON object, which will be sent back on any of your callbacks, defaults to empty object

locale

string, optional

The language of the provider error messages in the ISO 639-1 format. Possible values are: bg, cz, de, en, es, es-MX, fr, he, hu, it, nl, pl, pt, pt-BR, ro, ru, sk, tr, uk, zh-HongKong. Defaults to en

include_natures

array of strings, optional

The natures of the accounts that need to be fetched. Check accounts attributes for possible values. Default value: null (all accounts will be fetched)

customer_last_logged_at

datetime, optional

The datetime when the user was last active in your application

return_to

string, optional

The URL the user will be redirected to. Defaults to client’s home URL (if set and valid) or Lead’s Dashboard

Accounts

Any connection can have one or more accounts. The accounts are bound to a currency such that all the transactions within a single account have the same currency.

Sometimes, the provider allows the user to have several currencies grouped under the same account. For example, if a user holds a debit card that supports 3 currencies, the corresponding connection will have 3 accounts, each with one of the debit card’s currencies.

Attributes

id

string

The id of the account

name

string

The unique name of the account.
Note: The name directly identifies the account. In case the account’s name has changed (in the bank’s WEB/API interface, through code changes, etc.) a new account will be created.

nature

string

The type of the account. Possible values are: account, bonus, card, checking, credit, credit_card, debit_card, ewallet, insurance, investment, loan, mortgage, savings.
Note: for credit_card nature, the balance represents the sum of all negative transactions, the positive ones do not count

balance

decimal

The account’s current balance

currency_code

string

One of the possible values for currency codes. Max 3 letters.
Note: The currency directly identifies the account. In case the account’s currency code has changed (in the bank’s WEB/API interface, through code changes, etc.) a new account will be created.

extra

object, extra object

Extra data associated with the account

connection_id

string

The id of the connection the account belongs to

created_at

datetime

Time and date when the account was imported

updated_at

datetime

The last time when the account’s balance was changed or new transactions were imported

id

string

The id of the account

name

string

The unique name of the account.
Note: The name directly identifies the account. In case the account’s name has changed (in the bank’s WEB/API interface, through code changes, etc.) a new account will be created.

nature

string

The type of the account. Possible values are: account, bonus, card, checking, credit, credit_card, debit_card, ewallet, insurance, investment, loan, mortgage, savings.
Note: for credit_card nature, the balance represents the sum of all negative transactions, the positive ones do not count

balance

decimal

The account’s current balance

currency_code

string

One of the possible values for currency codes. Max 3 letters.
Note: The currency directly identifies the account. In case the account’s currency code has changed (in the bank’s WEB/API interface, through code changes, etc.) a new account will be created.

extra

object, extra object

Extra data associated with the account

connection_id

string

The id of the connection the account belongs to

created_at

datetime

Time and date when the account was imported

updated_at

datetime

The last time when the account’s balance was changed or new transactions were imported

Sample Object

{
    "id": "333333333333333333",
    "name": "Fake account 2",
    "nature": "account",
    "balance": 2012.7,
    "currency_code": "USD",
    "extra": {
        "cards": [
            "1234....5678",
            "*8765"
        ],
        "transactions_count": {
          "posted": 22,
          "pending": 1
        }
    },
    "connection_id": "111111111111111111",
    "created_at": "2020-10-26T14:54:10Z",
    "updated_at": "2020-10-26T14:54:10Z"
}

List

You can see the list of accounts of a connection. The accounts are sorted in ascending order of their id, so the newest accounts will come last. You can read more about next_id field, in the pagination section of the reference.

Parameters

connection_id

string

The id of the connection whose attempts are to be fetched

from_id

string, optional

The id from which the next page of accounts starts

customer_id

string, optional

The id of the customer containing the accounts. It is required unless connection_id parameter is sent.
Note: Will be ignored if connection_id is present.

from_id

string, optional

The id from which the next page of accounts starts

customer_id

string, optional

The id of the customer containing the accounts. It is required unless connection_id parameter is sent.
Note: Will be ignored if connection_id is present.

Possible Errors

URL

https://www.saltedge.com/api/partners/v1/accounts?connection_id={connection.id}

https://www.saltedge.com/api/partners/v1//accounts

Method

GET

Sample request

curl -v -H "Accept: application/json" \
        -H "Content-type: application/json" \
        -H "App-id: $APP_ID" \
        -H "Secret: $SECRET" \
        -X GET \
        https://www.saltedge.com/api/partners/v1/accounts?connection_id=111111111111111111
curl -v -H "Accept: application/json" \
        -H "Content-type: application/json" \
        -H "App-id: $APP_ID" \
        -H "Secret: $SECRET" \
        -H "Connection-secret: $CONNECTION_SECRET" \
        -X GET \
        https://www.saltedge.com/api/partners/v1/accounts

Sample Response

{
  "data": [
    {
      "id": "333333333333333333",
      "name": "Fake account 1",
      "nature": "card",
      "balance": 2007.2,
      "currency_code": "EUR",
      "extra": {
        "client_name": "Fake name"
      },
      "connection_id": "111111111111111111",
      "created_at": "2020-10-26T13:54:10Z",
      "updated_at": "2020-10-26T13:54:10Z"
    },
    {
      "id": "333333333333333334",
      "name": "Fake account 2",
      "nature": "account",
      "balance": 2012.7,
      "currency_code": "USD",
      "extra": {
        "cards": [
          "1234....5678",
          "*8765"
        ],
        "transactions_count": {
          "posted": 22,
          "pending": 1
        }
      },
      "connection_id": "111111111111111111",
      "created_at": "2020-10-26T14:54:10Z",
      "updated_at": "2020-10-26T14:54:10Z"
    }
  ],
  "meta" : {
    "next_id": "333333333333333335",
    "next_page": "/api/partners/v1/accounts?connection_id=111111111111111111&from_id=333333333333333335"
  }
}
{
  "data": [
    {
      "id": "333333333333333333",
      "name": "Fake account 1",
      "nature": "card",
      "balance": 2007.2,
      "currency_code": "EUR",
      "extra": {
        "client_name": "Fake name"
      },
      "created_at": "2020-10-26T13:54:10Z",
      "updated_at": "2020-10-26T13:54:10Z"
    },
    {
      "id": "333333333333333334",
      "name": "Fake account 2",
      "nature": "account",
      "balance": 2012.7,
      "currency_code": "USD",
      "extra": {
        "cards": [
          "1234....5678",
          "*8765"
        ],
        "transactions_count": {
          "posted": 22,
          "pending": 1
        }
      },
      "connection_id": "111111111111111111",
      "created_at": "2020-10-26T14:54:10Z",
      "updated_at": "2020-10-26T14:54:10Z"
    }
  ],
  "meta" : {
    "next_id": "333333333333333335",
    "next_page": "/api/partners/v1/accounts?from_id=333333333333333335"
  }
}

Nature

An account can be of one of the several types, as described by the nature field:

Payment account natures:

  • account (nature assigned to current account or when the account type could not be identified)
  • card (the type of card could not be identified)
  • checking
  • credit_card
  • debit_card
  • ewallet
  • loan*
  • mortgage*
  • savings*

* Depending on the bank, it can be handled as payment or non-payment account

Non-payment account natures:

  • bonus
  • insurance
  • investment
  • credit

Although these values do not affect neither the account’s behavior, nor its properties, they might provide some additional information to the end user.

Extra

The following represents the object you get in the extra field of the account object.

You may or may not have all of the fields listed below.

General accounts extra fields:

account_name

string

Changeable name of the account

account_number

string

Internal bank account number

assets

array of objects

Array of crypto codes and their amounts assigned to investment account

available_amount

decimal

Available amount in the account’s currency

balance_type

string

Type of the imported balance as showed/returned by the bank

blocked_amount

decimal

The amount currently blocked in the account’s currency

card_type

string

Type of the card account. Possible values are: american_express, china_unionpay, diners_club, jcb, maestro, master_card, uatp, visa and mir

cards

array of strings

List of masked card numbers

client_name

string

Account client owner

closing_balance

decimal

Account balance at the end of the accounting period

credit_limit

decimal

Credit limit in the account’s currency

current_date

date

Date of provider statement generation (applicable to banks)

current_time

datetime

Time of provider statement generation (applicable to banks)

expiry_date

date

Card expiry date

iban

string

Account IBAN number

interest_rate

decimal

Interest rate of the account as percentage value

next_payment_amount

decimal

Next payment amount for loans or credits

next_payment_date

date

Next payment date for loans or credits

open_date

date

Card open date

opening_balance

decimal

Account balance that is brought forward from the end of one accounting period to the beginning of a new accounting period

partial

boolean

Account transactions were not imported or imported partially because of some internal error on the bank’s side

sort_code

string

Routing number(US)/BSB code(Australia)/sort code(UK)

statement_cut_date

date

Date when the current statement becomes previous one

status

string

Shows whether the account is active or inactive

swift

string

Account SWIFT code

total_payment_amount

decimal

Total payment amount for loans or credits

transactions_count

object

Number of transactions, separated by posted and pending. e.g. {'posted': 12, 'pending': 0}

payment_type

string

Account payment method

cashback_amount

decimal

Accumulated CashBack / Cash Benefit

account_name

string

Changeable name of the account

account_number

string

Internal bank account number

assets

array of objects

Array of crypto codes and their amounts assigned to investment account

available_amount

decimal

Available amount in the account’s currency

balance_type

string

Type of the imported balance as showed/returned by the bank

blocked_amount

decimal

The amount currently blocked in the account’s currency

card_type

string

Type of the card account. Possible values are: american_express, china_unionpay, diners_club, jcb, maestro, master_card, uatp, visa and mir

cards

array of strings

List of masked card numbers

client_name

string

Account client owner

closing_balance

decimal

Account balance at the end of the accounting period

credit_limit

decimal

Credit limit in the account’s currency

current_date

date

Date of provider statement generation (applicable to banks)

current_time

datetime

Time of provider statement generation (applicable to banks)

expiry_date

date

Card expiry date

iban

string

Account IBAN number

interest_rate

decimal

Interest rate of the account as percentage value

next_payment_amount

decimal

Next payment amount for loans or credits

next_payment_date

date

Next payment date for loans or credits

open_date

date

Card open date

opening_balance

decimal

Account balance that is brought forward from the end of one accounting period to the beginning of a new accounting period

partial

boolean

Account transactions were not imported or imported partially because of some internal error on the bank’s side

sort_code

string

Routing number(US)/BSB code(Australia)/sort code(UK)

statement_cut_date

date

Date when the current statement becomes previous one

status

string

Shows whether the account is active or inactive

swift

string

Account SWIFT code

total_payment_amount

decimal

Total payment amount for loans or credits

transactions_count

object

Number of transactions, separated by posted and pending. e.g. {'posted': 12, 'pending': 0}

payment_type

string

Account payment method

cashback_amount

decimal

Accumulated CashBack / Cash Benefit

Investment accounts extra fields:

unit_price

decimal

Price per unit (used with units)

units

decimal

Amount of units owned (used with unit_price)

indicative_unit_price

decimal

Indicative price per unit (used with units)

interest_income

decimal

Amount of interest income/profit

interest_amount

decimal

Interest amount in currency

fund_holdings

object

Fund holdings list with own values such as (investment_percentage, balance, bid_price, value, value_date, total_quantity, available_quantity, actual_price, actual_value)

unit_price

decimal

Price per unit (used with units)

units

decimal

Amount of units owned (used with unit_price)

indicative_unit_price

decimal

Indicative price per unit (used with units)

interest_income

decimal

Amount of interest income/profit

interest_amount

decimal

Interest amount in currency

fund_holdings

object

Fund holdings list with own values such as (investment_percentage, balance, bid_price, value, value_date, total_quantity, available_quantity, actual_price, actual_value)

Insurance accounts extra fields:

premium_frequency

string

Frequency of premium payments

policy_status

string

Current policy status

life_assured_name

string

Name of the person who is assured

premium_amount

decimal

Premium amount to be paid

financial_consultant

string

Financial consultant name

total_reversionary_bonus

decimal

Reversionary bonus accumulated amount

gross_surrender

decimal

Current Gross Surrender value

guaranteed_gross_surrender

decimal

Guaranteed Gross Surrender value

reversionary_bonus_cash_value

decimal

Cash value of reversionary bonus

owned_policy_amount

decimal

Amount currently own on policy

policy_loan_limit

decimal

Maximum amount of additional Policy Loan

policy_converted_to_paid_up

decimal

New assured sum if Policy is converted to paid up

paid_up_conversion_reversionary_bonus

decimal

Reversionary bonus amount after ‘Policy to paid up’ conversion

policy_components

object

Policy components with own values such as (status, amount_assured, amount_premium, start_date, expiry_date, premium_expiry_date, assured_name)

premium_frequency

string

Frequency of premium payments

policy_status

string

Current policy status

life_assured_name

string

Name of the person who is assured

premium_amount

decimal

Premium amount to be paid

financial_consultant

string

Financial consultant name

total_reversionary_bonus

decimal

Reversionary bonus accumulated amount

gross_surrender

decimal

Current Gross Surrender value

guaranteed_gross_surrender

decimal

Guaranteed Gross Surrender value

reversionary_bonus_cash_value

decimal

Cash value of reversionary bonus

owned_policy_amount

decimal

Amount currently own on policy

policy_loan_limit

decimal

Maximum amount of additional Policy Loan

policy_converted_to_paid_up

decimal

New assured sum if Policy is converted to paid up

paid_up_conversion_reversionary_bonus

decimal

Reversionary bonus amount after ‘Policy to paid up’ conversion

policy_components

object

Policy components with own values such as (status, amount_assured, amount_premium, start_date, expiry_date, premium_expiry_date, assured_name)

Transactions

A transaction represents a movement of funds. Any transaction can represent a monetary transfer, withdrawal, income or expense interchange. Transactions are retained in a connection’s accounts, and are imported from one of the providers.

Category

Salt Edge Partners API uses an algorithm for automatic categorization of transactions. Thus, when importing a connection, all the transactions corresponding to the connection will be assigned to one of the categories.

Attributes

id

string

The id of the transaction

mode

string

Possible values are: normal, fee, transfer

status

string

Possible values are: posted, pending

made_on

date

The date when the transaction was made

amount

decimal

Transaction’s amount

currency_code

string

Transaction’s currency code

description

string

Transaction’s description

category

string

Transaction’s category

duplicated

boolean

Whether the transaction is duplicated or not

extra

object, extra object

Extra data associated with the transaction

account_id

string

The id of the account the transaction belongs to

created_at

datetime

Time and date when the transaction was imported

updated_at

datetime

The last time when the transaction’s attributes (duplicated flag set, category learned applied) were changed by the client

id

string

The id of the transaction

mode

string

Possible values are: normal, fee, transfer

status

string

Possible values are: posted, pending

made_on

date

The date when the transaction was made

amount

decimal

Transaction’s amount

currency_code

string

Transaction’s currency code

description

string

Transaction’s description

category

string

Transaction’s category

duplicated

boolean

Whether the transaction is duplicated or not

extra

object, extra object

Extra data associated with the transaction

account_id

string

The id of the account the transaction belongs to

created_at

datetime

Time and date when the transaction was imported

updated_at

datetime

The last time when the transaction’s attributes (duplicated flag set, category learned applied) were changed by the client

Sample object

{
    "id": "444444444444444444",
    "duplicated": false,
    "mode": "normal",
    "status": "posted",
    "made_on": "2020-05-03",
    "amount": -200.0,
    "currency_code": "USD",
    "description": "Money spent on company advertising",
    "category": "advertising",
    "extra": {
      "merchant_id": "b3e8ec2349df872072c051e0c...",
      "original_amount": -3974.60,
      "original_currency_code": "CZK",
      "posting_date": "2020-05-07",
      "time": "23:56:12"
    },
    "account_id": "333333333333333333",
    "created_at": "2020-10-24T16:54:10Z",
    "updated_at": "2020-10-25T16:54:10Z"
}

List

You can see the list of non-duplicated transactions of an account. You can read more about the next_id field in the pagination section of the reference.

Parameters

connection_id

string, required

The id of the connection

account_id

string, optional

The id of the account

from_id

string, optional

The id from which the next page of transactions starts

account_id

string, optional

The id of the account

from_id

string, optional

The id from which the next page of transactions starts

All of the optional parameters for transactions list can be combined in any possible manner.

Possible Errors

URL

https://www.saltedge.com/api/partners/v1/transactions?connection_id={connection.id}&account_id={account.id}

https://www.saltedge.com/api/partners/v1/transactions?account_id={account.id}

Method

GET

Sample request

curl -v -H "Accept: application/json" \
        -H "Content-type: application/json" \
        -H "App-id: $APP_ID" \
        -H "Secret: $SECRET" \
        -X GET \
        https://www.saltedge.com/api/partners/v1/transactions?connection_id=111111111111111111&account_id=333333333333333333
curl -v -H "Accept: application/json" \
        -H "Content-type: application/json" \
        -H "App-id: $APP_ID" \
        -H "Secret: $SECRET" \
        -H "Connection-secret: $CONNECTION_SECRET" \
        -X GET \
        https://www.saltedge.com/api/partners/v1/transactions?account_id=333333333333333333

Sample response

{
  "data": [
    {
      "id": "444444444444444444",
      "duplicated": false,
      "mode": "normal",
      "status": "posted",
      "made_on": "2020-05-03",
      "amount": -200.0,
      "currency_code": "USD",
      "description": "test transaction",
      "category": "advertising",
      "extra": {
        "original_amount": -3974.60,
        "original_currency_code": "CZK",
        "posting_date": "2020-05-07",
        "time": "23:56:12"
      },
      "account_id": "333333333333333333",
      "created_at": "2020-10-24T16:54:10Z",
      "updated_at": "2020-10-25T16:54:10Z"
    },
    {
      "id": "444444444444444445",
      "duplicated": false,
      "mode": "normal",
      "status": "posted",
      "made_on": "2020-05-03",
      "amount": 50.0,
      "currency_code": "USD",
      "description": "business expense",
      "category": "business_services",
      "extra": {
        "original_amount": 993.90,
        "original_currency_code": "CZK",
        "posting_date": "2020-05-06",
        "time": "12:16:25"
      },
      "account_id": "333333333333333333",
      "created_at": "2020-10-24T16:54:10Z",
      "updated_at": "2020-10-25T16:54:10Z"
    }
  ],
  "meta" : {
    "next_id": "444444444444444446",
    "next_page": "/api/partners/v1/transactions/?connection_id=111111111111111111&account_id=333333333333333333&from_id=444444444444444446"
  }
}
  "data": [
    {
      "id": "444444444444444444",
      "duplicated": false,
      "mode": "normal",
      "status": "posted",
      "made_on": "2020-05-03",
      "amount": -200.0,
      "currency_code": "USD",
      "description": "test transaction",
      "category": "advertising",
      "extra": {
        "original_amount": -3974.60,
        "original_currency_code": "CZK",
        "posting_date": "2020-05-07",
        "time": "23:56:12"
      },
      "account_id": "333333333333333333",
      "created_at": "2020-10-24T16:54:10Z",
      "updated_at": "2020-10-25T16:54:10Z"
    },
    {
      "id": "444444444444444445",
      "duplicated": false,
      "mode": "normal",
      "status": "posted",
      "made_on": "2020-05-03",
      "amount": 50.0,
      "currency_code": "USD",
      "description": "business expense",
      "category": "business_services",
      "extra": {
        "original_amount": 993.90,
        "original_currency_code": "CZK",
        "posting_date": "2020-05-06",
        "time": "12:16:25"
      },
      "account_id": "333333333333333333",
      "created_at": "2020-10-24T16:54:10Z",
      "updated_at": "2020-10-25T16:54:10Z"
    }
  ],
  "meta" : {
    "next_id": "444444444444444445",
    "next_page": "/api/partners/v1/transactions/?account_id=333333333333333333&from_id=444444444444444445"
  }
}

Pending

You can use this route to obtain the currently pending transactions for an account. Note that although pending transactions have the same structure as the regular transactions, they behave differently.

The provider may delete the pending transactions and modify some of its attributes. Thus, every time a connection is refreshed, the existing pending transactions will be replaced by the currently pending transactions.

This means that your app should not rely on the pending transactions having an id, since they might be replaced with similar transactions having a different id. We also recommend to remove the account’s pending transactions from your app every time you fetch the transactions.

Parameters

connection_id

string, required

The id of the connection

account_id

string, optional

The id of the account

from_id

string, optional

The id from which the next page of transactions starts

account_id

string, optional

The id of the account

from_id

string, optional

The id from which the next page of transactions starts

As with the list route, you can combine the parameters.

Possible Errors

URL

https://www.saltedge.com/api/partners/v1/transactions/pending?connection_id={connection.id}&account_id={account.id}

https://www.saltedge.com/api/partners/v1/transactions/pending?account_id={account.id}

Method

GET

Sample request

curl -v -H "Accept: application/json" \
        -H "Content-type: application/json" \
        -H "App-id: $APP_ID" \
        -H "Secret: $SECRET" \
        -X GET \
        https://www.saltedge.com/api/partners/v1/transactions/pending?connection_id=111111111111111111&account_id=333333333333333333
curl -v -H "Accept: application/json" \
        -H "Content-type: application/json" \
        -H "App-id: $APP_ID" \
        -H "Secret: $SECRET" \
        -H "Customer-secret: $CUSTOMER_SECRET" \
        -H "Connection-secret: $CONNECTION_SECRET" \
        -X GET \
        https://www.saltedge.com/api/partners/v1/transactions/pending?account_id=333333333333333333

Sample response

{
  "data": [
    {
      "id": "444444444444444444",
      "duplicated": false,
      "mode": "normal",
      "status": "pending",
      "made_on": "2020-05-03",
      "amount": -200.0,
      "currency_code": "USD",
      "description": "ads expense",
      "category": "advertising",
      "extra": {
        "original_amount": -3974.60,
        "original_currency_code": "CZK",
        "posting_date": "2020-05-07",
        "time": "23:56:12"
      },
      "account_id": "333333333333333333",
      "created_at": "2020-10-24T16:54:10Z",
      "updated_at": "2020-10-25T16:54:10Z"
    }
  ],
  "meta" : {
    "next_id": "444444444444444445",
    "next_page": "/api/v1/transactions/pending?connection_id=111111111111111111&account_id=333333333333333333&from_id=444444444444444445"
  }
}
{
  "data": [
    {
      "id": "444444444444444444",
      "duplicated": false,
      "mode": "normal",
      "status": "pending",
      "made_on": "2020-05-03",
      "amount": -200.0,
      "currency_code": "USD",
      "description": "ads expense",
      "category": "advertising",
      "extra": {
        "original_amount": -3974.60,
        "original_currency_code": "CZK",
        "posting_date": "2020-05-07",
        "time": "23:56:12"
      },
      "account_id": "333333333333333333",
      "created_at": "2020-10-24T16:54:10Z",
      "updated_at": "2020-10-25T16:54:10Z"
    }
  ],
  "meta" : {
    "next_id": "444444444444444445",
    "next_page": "/api/v1/transactions/pending?account_id=333333333333333333&from_id=444444444444444445"
  }
}

List Duplicates

You can see the list of duplicated transactions of an account.

Parameters

connection_id

string, required

The id of the connection

account_id

string, optional

The id of the account

from_id

string, optional

The id of the transaction which the list starts with.

account_id

string, optional

The id of the account

from_id

string, optional

The id of the transaction which the list starts with.

All of the optional parameters for transactions list can be combined in any possible manner.

Possible Errors

URL

https://www.saltedge.com/api/partners/v1/transactions/duplicates?connection_id={connection.id}&account_id={account.id}

https://www.saltedge.com/api/partners/v1/transactions/duplicates&account_id=333333333333333333

Method

GET

Sample request

curl -v -H "Accept: application/json" \
        -H "Content-type: application/json" \
        -H "App-id: $APP_ID" \
        -H "Secret: $SECRET" \
        -X GET \
        https://www.saltedge.com/api/partners/v1/transactions/duplicates?connection_id=111111111111111111&account_id=333333333333333333
curl -v -H "Accept: application/json" \
        -H "Content-type: application/json" \
        -H "App-id: $APP_ID" \
        -H "Secret: $SECRET" \
        -H "Customer-secret: $CUSTOMER_SECRET" \
        -H "Connection-secret: $CONNECTION_SECRET" \
        -X GET \
        https://www.saltedge.com/api/partners/v1/transactions/duplicates?account_id=333333333333333333

Sample response

{
  "data": [
    {
      "id": "444444444444444444",
      "duplicated": true,
      "mode": "normal",
      "status": "posted",
      "made_on": "2020-05-03",
      "amount": -200.0,
      "currency_code": "USD",
      "description": "test transaction",
      "category": "advertising",
      "extra": {
        "original_amount": -3974.60,
        "original_currency_code": "CZK",
        "posting_date": "2020-05-07",
        "time": "23:56:12"
      },
      "account_id": "333333333333333333",
      "created_at": "2020-10-24T16:54:10Z",
      "updated_at": "2020-10-25T16:54:10Z"
    },
    {
      "id": "444444444444444445",
      "duplicated": true,
      "mode": "normal",
      "status": "posted",
      "made_on": "2020-05-03",
      "amount": 50.0,
      "currency_code": "USD",
      "description": "business expense",
      "category": "business_services",
      "extra": {
        "original_amount": 993.90,
        "original_currency_code": "CZK",
        "posting_date": "2020-05-06",
        "time": "12:16:25"
      },
      "account_id": "333333333333333333",
      "created_at": "2020-10-24T16:54:10Z",
      "updated_at": "2020-10-25T16:54:10Z"
    }
  ],
  "meta" : {
    "next_id": "444444444444444445",
    "next_page": "/api/v1/transactions/?connection_id=111111111111111111&account_id=333333333333333333&from_id=444444444444444445"
  }
}
{
  "data": [
    {
      "id": "444444444444444447",
      "duplicated": true,
      "mode": "normal",
      "status": "posted",
      "made_on": "2020-05-03",
      "amount": -200.0,
      "currency_code": "USD",
      "description": "test transaction",
      "category": "advertising",
      "extra": {
        "original_amount": -3974.60,
        "original_currency_code": "CZK",
        "posting_date": "2020-05-07",
        "time": "23:56:12"
      },
      "account_id": "333333333333333333",
      "created_at": "2020-10-24T16:54:10Z",
      "updated_at": "2020-10-25T16:54:10Z"
    },
    {
      "id": "444444444444444448",
      "duplicated": true,
      "mode": "normal",
      "status": "posted",
      "made_on": "2020-05-03",
      "amount": 50.0,
      "currency_code": "USD",
      "description": "business expense",
      "category": "business_services",
      "extra": {
        "original_amount": 993.90,
        "original_currency_code": "CZK",
        "posting_date": "2020-05-06",
        "time": "12:16:25"
      },
      "account_id": "333333333333333333",
      "created_at": "2020-10-24T16:54:10Z",
      "updated_at": "2020-10-25T16:54:10Z"
    }
  ],
  "meta" : {
    "next_id": "444444444444444449",
    "next_page": "/api/v1/transactions/?account_id=333333333333333333&from_id=444444444444444449"
  }
}

Extra

The following represents the object you get in the extra field of the transaction object.

Note: You may or may not have all of the fields listed below.

account_balance_snapshot

decimal

The balance of the account at the moment of the attempt when the transaction was imported

account_number

string

Number of the account the transaction belongs to

additional

string

Additional information (recommended to use in concatenation with original description, if present)

asset_amount

decimal

Original transaction amount in asset units

asset_code

string

Asset common used abbreviation (Ex.: BTC - Bitcoin, XAU - Gold etc.)

categorization_confidence

float

Value from 0 to 1, the probability that the current category is the correct one

check_number

string

Payee’s transaction check number

closing_balance

decimal

Account balance after the transaction has been made

constant_code

string

Payment reference for cashless domestic payments (transfers)

convert

boolean

Whether the transaction amount was converted using exchange rates or not

customer_category_code

string

The category (present in categories list) that was categorized by the rules created by the customer

customer_category_name

string

The category (not present in categories list) that was categorized by the rules created by the customer

id

string

Transaction’s identifier on the bank’s end (do not confuse it with Salt Edge transaction id)

information

string

Information about the transaction

mcc

string

The transaction’s Merchant Category Code

merchant_id

string

Merchant identifier

opening_balance

decimal

Account balance before the transaction has been made

installment_debt_amount

decimal

Amount of the total installment transactions group

original_amount

decimal

Native amount of the transaction in transaction’s currency (comes with original_currency_code)

original_category

string

The original category of the transaction

original_currency_code

string

Native currency of the transaction (comes with original_amount)

original_subcategory

string

The original subcategory of the transaction

payee

string

To whom money is paid

payee_information

string

Additional payee information

payer

string

Who paid the money

payer_information

string

Additional payer information

possible_duplicate

boolean

Is set to true if current transaction duplicates amount, made_on and currency_code of any transaction parsed in previous attempt

posting_date

date

Date when the transaction appears in statement

posting_time

string

Time in HH:MM:SS format, representing time when the transaction appears in statement

record_number

string

Bank record number

specific_code

string

Additional identification information for cashless domestic payments (transfers)

tags

array of strings

The original tags of the transaction

time

time

Time when the transaction was made

transfer_account_name

string

Name of the linked account

type

string

Transaction type

unit_price

decimal

Price per unit (used with units, available for investment accounts nature only)

units

decimal

Amount of units owned (used with unit_price, available for investment accounts nature only)

variable_code

string

Identifies the tax subject to the tax office, used for domestic payments (transfers)

account_balance_snapshot

decimal

The balance of the account at the moment of the attempt when the transaction was imported

account_number

string

Number of the account the transaction belongs to

additional

string

Additional information (recommended to use in concatenation with original description, if present)

asset_amount

decimal

Original transaction amount in asset units

asset_code

string

Asset common used abbreviation (Ex.: BTC - Bitcoin, XAU - Gold etc.)

categorization_confidence

float

Value from 0 to 1, the probability that the current category is the correct one

check_number

string

Payee’s transaction check number

closing_balance

decimal

Account balance after the transaction has been made

constant_code

string

Payment reference for cashless domestic payments (transfers)

convert

boolean

Whether the transaction amount was converted using exchange rates or not

customer_category_code

string

The category (present in categories list) that was categorized by the rules created by the customer

customer_category_name

string

The category (not present in categories list) that was categorized by the rules created by the customer

id

string

Transaction’s identifier on the bank’s end (do not confuse it with Salt Edge transaction id)

information

string

Information about the transaction

mcc

string

The transaction’s Merchant Category Code

merchant_id

string

Merchant identifier

opening_balance

decimal

Account balance before the transaction has been made

installment_debt_amount

decimal

Amount of the total installment transactions group

original_amount

decimal

Native amount of the transaction in transaction’s currency (comes with original_currency_code)

original_category

string

The original category of the transaction

original_currency_code

string

Native currency of the transaction (comes with original_amount)

original_subcategory

string

The original subcategory of the transaction

payee

string

To whom money is paid

payee_information

string

Additional payee information

payer

string

Who paid the money

payer_information

string

Additional payer information

possible_duplicate

boolean

Is set to true if current transaction duplicates amount, made_on and currency_code of any transaction parsed in previous attempt

posting_date

date

Date when the transaction appears in statement

posting_time

string

Time in HH:MM:SS format, representing time when the transaction appears in statement

record_number

string

Bank record number

specific_code

string

Additional identification information for cashless domestic payments (transfers)

tags

array of strings

The original tags of the transaction

time

time

Time when the transaction was made

transfer_account_name

string

Name of the linked account

type

string

Transaction type

unit_price

decimal

Price per unit (used with units, available for investment accounts nature only)

units

decimal

Amount of units owned (used with unit_price, available for investment accounts nature only)

variable_code

string

Identifies the tax subject to the tax office, used for domestic payments (transfers)

Show Holder Info

You can query essential information about the account holder. Make sure to request this feature to be enabled for your client account.

Attributes

connection_id

string

The id of the connection whose holder info is to be fetched

names

array

Account holder’s name(s)

emails

array

Account holder’s email(s)

phone_numbers

array

Account holder’s phone number(s)

addresses

array of objects

Account holder’s address(es)

names

array

Account holder’s name(s)

emails

array

Account holder’s email(s)

phone_numbers

array

Account holder’s phone number(s)

addresses

array of objects

Account holder’s address(es)

Extra

Depending on the provider, additional information on account holder might be available:

  • ssn - Social Security Number shortened (last 4 digits)
  • cpf - Cadastro de Pessoas Físicas (present in Brazil)

Possible Errors

URL

https://www.saltedge.com/api/partners/v1/holder_info?connection_id={connection.id}

https://www.saltedge.com/api/partners/v1/holder_info

Method

GET

Sample request

curl -v -H "Accept: application/json" \
        -H "Content-type: application/json" \
        -H "App-id: $APP_ID" \
        -H "Secret: $SECRET" \
        -X GET \
        https://www.saltedge.com/api/partners/v1/holder_info?connection_id=111111111111111111
curl -v -H "Accept: application/json" \
        -H "Content-type: application/json" \
        -H "App-id: $APP_ID" \
        -H "Secret: $SECRET" \
        -H "Connection-secret: $CONNECTION_SECRET" \
        -X GET \
        https://www.saltedge.com/api/partners/v1/holder_info

Sample Response

{
  "data": {
    "names": ["John Doe"],
    "emails": ["john.doe@example.com", "johndoe@gmail.com"],
    "phone_numbers": ["+40981233422"],
    "addresses": [
      {
        "city": "Cupertino",
        "state": "CA",
        "street": "1 Infinite Loop",
        "country_code": "US",
        "post_code": "95014"
      }
    ]
  }
}

Transaction Categorization

Salt Edge API automatically categorizes all the transactions. Thus, when importing a connection, all the transactions corresponding to the connection will be assigned to one of the categories.

There are 2 types of categories: personal categories and business categories, which help to categorize transactions, made by physical persons or legal entities.

The categories are represented as strings. They are structured as parent and child categories, which can be identified by the tree structure sent in the Listing categories request.

This arrangement is represented as a reference. You can change it as you wish.

You can test the categorization, using the fakebank_with_file_csv_xf provider. Fill out the predefined sample.csv template. The file size limit is 5MB.
Note: Country and Account Currency defaults to GB and GBP respectively. In order to test the transaction categorization in other countries, the two codes must be configured accordingly.

How to use

By default, transactions are categorized, using the list of personal categories, via parameter categorization set on routes: lead sessions #create, #refresh, #reconnect, as you need.

We also expose an API route for your applications to provide the possibility for your users to update categories for their transactions with certain description.

List

You can get the list of all the categories that we support.

Possible Errors

URL

https://www.saltedge.com/api/partners/v1/categories

https://www.saltedge.com/api/partners/v1/categories

Method

GET

Sample request

curl -v -H "Accept: application/json" \
        -H "Content-type: application/json" \
        -H "App-id: $APP_ID" \
        -H "Secret: $SECRET" \
        -X GET \
        https://www.saltedge.com/api/partners/v1/categories
curl -v -H "Accept: application/json" \
        -H "Content-type: application/json" \
        -H "App-id: $APP_ID" \
        -H "Secret: $SECRET" \
        -X GET \
        https://www.saltedge.com/api/partners/v1/categories

Sample Response

{
  "data": {
    "business": {
      "equipment_and_materials": [
        "electronics",
        "software",
        "supplies_and_furniture",
        "raw_materials",
        "consumer_goods"
      ],
      "financials": [
        "dividends",
        "donations",
        "interest",
        "fees",
        "fines",
        "loans"
      ],
      "human_resources": [
        "wages",
        "bonus",
        "employee_benefits",
        "education_and_trainings",
        "staff_outsourcing",
        "travel",
        "entertainment",
        "meals"
      ],
      "income": [
        "investments",
        "sales",
        "returns",
        "prepayments"
      ],
      "insurance": [
        "business_insurance",
        "liability_insurance",
        "health_insurance",
        "equipment_insurance",
        "vehicle_insurance",
        "professional_insurance"
      ],
      "real_estate": [
        "office_rent",
        "mortgage",
        "construction_and_repair"
      ],
      "services": [
        "contractors",
        "accounting_and_auditing",
        "legal",
        "consulting",
        "storage",
        "marketing_and_media",
        "online_subscriptions",
        "it_services",
        "cleaning"
      ],
      "taxes": [
        "vat",
        "federal_taxes",
        "property_taxes",
        "income_taxes",
        "duty_taxes",
        "tax_return",
        "payroll_taxes"
      ],
      "transport": [
        "shipping",
        "leasing",
        "gas_and_fuel",
        "taxi",
        "service_and_parts"
      ],
      "uncategorized": [],
      "utilities": [
        "internet",
        "phone",
        "water",
        "gas",
        "electricity"
      ]
    },
    "personal": {
      "auto_and_transport": [
        "car_rental",
        "gas_and_fuel",
        "parking",
        "public_transportation",
        "service_and_parts",
        "taxi"
      ],
      "bills_and_utilities": [
        "internet",
        "phone",
        "television",
        "utilities"
      ],
      "business_services": [
        "advertising",
        "office_supplies",
        "shipping"
      ],
      "education": [
        "books_and_supplies",
        "student_loan",
        "tuition"
      ],
      "entertainment": [
        "amusement",
        "arts",
        "games",
        "movies_and_music",
        "newspapers_and_magazines"
      ],
      "fees_and_charges": [
        "provider_fee",
        "loans",
        "service_fee",
        "taxes"
      ],
      "food_and_dining": [
        "alcohol_and_bars",
        "cafes_and_restaurants",
        "groceries"
      ],
      "gifts_and_donations": [
        "charity",
        "gifts"
      ],
      "health_and_fitness": [
        "doctor",
        "personal_care",
        "pharmacy",
        "sports",
        "wellness"
      ],
      "home": [
        "home_improvement",
        "home_services",
        "home_supplies",
        "mortgage",
        "rent"
      ],
      "income": [
        "bonus",
        "investment_income",
        "paycheck"
      ],
      "insurance": [
        "car_insurance",
        "health_insurance",
        "life_insurance",
        "property_insurance"
      ],
      "kids": [
        "allowance",
        "babysitter_and_daycare",
        "baby_supplies",
        "child_support",
        "kids_activities",
        "toys"
      ],
      "pets": [
        "pet_food_and_supplies",
        "pet_grooming",
        "veterinary"
      ],
      "shopping": [
        "clothing",
        "electronics_and_software",
        "sporting_goods"
      ],
      "transfer": [],
      "travel": [
        "hotel",
        "transportation",
        "vacation"
      ],
      "uncategorized": []
    }
  }
}

Learn

Your customers can change the category of some of their transactions, thus improving the categorization accuracy.

The custom category will be applicable only for the customer’s new transactions, which have similar description.

The customer can change the category to the one already existing in categories list - in this case custom category is located in transaction extra as customer_category_code.

The customer can set their own category - in this case a custom category is located in the transaction extra as customer_category_name.

Note: To update the custom category, a new request should be sent for Learn with customer_id, id (the id of the transaction) and the new category_code.

The category identified by the Salt Edge Categorizer algorithms is always displayed in the transaction’s category field.

Request body

customer_id

string

The id of the customer received from lead create.

transactions

array of objects

Show child attributes

customer_id

string

The id of the customer received from lead create.

transactions

array of objects

Show child attributes

Possible Errors

URL

https://www.saltedge.com/api/partners/v1/categories/learn

https://www.saltedge.com/api/partners/v1/categories/learn

Method

POST

Sample request

curl -v -H "Accept: application/json" \
        -H "Content-type: application/json" \
        -H "App-id: $APP_ID" \
        -H "Secret: $SECRET" \
        -X POST \
        -d "{ \
              \"data\": { \
                \"customer_id\": \"$CUSTOMER_ID\", \
                \"transactions\": [ \
                  { \
                    \"id\": \"444444444444444444\", \
                    \"category_code\": \"paycheck\", \
                    \"immediate\": true \
                  }, \
                  { \
                    \"id\": \"444444444444444445\", \
                    \"category_code\": \"car_rental\", \
                    \"immediate\": false \
                  } \
                ] \
              } \
            }" \
        https://www.saltedge.com/api/partners/v1/categories/learn
curl -v -H "Accept: application/json" \
        -H "Content-type: application/json" \
        -H "App-id: $APP_ID" \
        -H "Secret: $SECRET" \
        -H "Customer-secret: $CUSTOMER_SECRET" \
        -X POST \
        -d "{ \
              \"data\": { \
                \"transactions\": [ \
                  { \
                    \"id\": \"444444444444444444\", \
                    \"category_code\": \"paycheck\", \
                    \"immediate\": true \
                  }, \
                  { \
                    \"id\": \"444444444444444445\", \
                    \"category_code\": \"car_rental\", \
                    \"immediate\": false \
                  } \
                ] \
              } \
            }" \
        https://www.saltedge.com/api/partners/v1/categories/learn

Sample Response

{
  "data": {
    "learned": true
  }
}

Merchant Identification

A merchant represents a company that sells goods, or provides services to a customer.

Identification

Merchant identification is an option that allows to identify merchant names and other useful information about them, basing on transactions’ data.

This option is country based and currently is available in 19 countries - UK, Ireland, Italy, Netherlands, Germany, Czech Republic, Austria, Hungary, Poland, Romania, Latvia, Spain, Portugal, Mexico, France, Australia, Russia, India, Singapore and the list will continue to grow.

You can test the merchant identification, using the fakebank_with_file_csv_xf provider. Fill out the predefined sample.csv template. The file size limit is 5MB.
Note: Country and Account Currency defaults to GB and GBP respectively. In order to test the merchant identification in other countries, the two codes must be configured accordingly.

How to use

To start using this option, all you need to do is:

  • on lead sessions #create, #refresh and #reconnect, when the connection creation succeeds and only if the merchant is identified, you will receive a merchant_id in the extra field of the transaction;
  • send all the merchant_ids you want to fetch the additional info for, to merchants.

Also, you can test it, using the fakebank_simple_xf provider, available for the fake XF country.

The API accepts batches of at most 100 objects.

Show

To fetch the name and additional info, available for identified merchants, pass the desired merchant_ids in an array to route https://www.saltedge.com/api/partners/v1/merchants.

Note that the first priority of this feature is to identify the merchant name, that’s why arrays with name and transliterated_name are always presented.

Sometimes, the transaction’s descriptional fields, can display additional information about the merchant, such as: shop number, or address of sale point, with city, post code and street numbers. In this case, it’s possible to identify the exact place where the customer’s transaction was made. If we find the point of sale corresponding to the transaction in our database, then we can return more granular information with contact and address details, including geo-coordinates.

The API accepts batches of at most 100 objects.

Attributes

id

string

The id of the merchant

names

array of objects

Merchant names that are used to name a company, corporation, brand name, franchise name or any other entity who has participated in the customer’s transaction
Possible values are: name, transliterated_name, alternative_name, brand, operator

address

object

Merchant address may include the next location parameters: city, transliterated_city, state, street, transliterated_street, country_code, post_code, coordinates and extra data associated with the address, as building_name, shop_number and so on.

contact

array of objects

Contact information via which the merchant can be accessed, eg. via website, phone or social media
Possible values are: email, viber, phone, fax, website, facebook, twitter, google_plus, linkedin, instagram, skype, vk, flickr, youtube

id

string

The id of the merchant

names

array of objects

Merchant names that are used to name a company, corporation, brand name, franchise name or any other entity who has participated in the customer’s transaction
Possible values are: name, transliterated_name, alternative_name, brand, operator

address

object

Merchant address may include the next location parameters: city, transliterated_city, state, street, transliterated_street, country_code, post_code, coordinates and extra data associated with the address, as building_name, shop_number and so on.

contact

array of objects

Contact information via which the merchant can be accessed, eg. via website, phone or social media
Possible values are: email, viber, phone, fax, website, facebook, twitter, google_plus, linkedin, instagram, skype, vk, flickr, youtube

Possible Errors

URL

https://www.saltedge.com/api/partners/v1/merchants

https://www.saltedge.com/api/partners/v1/merchants

Method

POST

Sample request

curl -v -H "Accept: application/json" \
        -H "Content-type: application/json" \
        -H "App-id: $APP_ID" \
        -H "Secret: $SECRET" \
        -X POST \
        -d "{ \
              \"data\": [ \
                \"0e81d5f8be1e3e73e4e604a36...\", \
                \"b3e8ec2349df872072c051e0c...\" \
              ] \
            }" \
        https://www.saltedge.com/api/partners/v1/merchants
curl -v -H "Accept: application/json" \
        -H "Content-type: application/json" \
        -H "App-id: $APP_ID" \
        -H "Secret: $SECRET" \
        -X POST \
        -d "{ \
              \"data\": [ \
                \"0e81d5f8be1e3e73e4e604a36...\", \
                \"b3e8ec2349df872072c051e0c...\" \
              ] \
            }" \
        https://www.saltedge.com/api/partners/v1/merchants

Sample Response

{
  "data": [
    {
      "id": "f6dabf8bb3e1cbc7cce2f4571...",
      "names": [
        {
          "mode": "name",
          "value": "Amazon"
        },
        {
          "mode": "transliterated_name",
          "value": "amazon"
        }
      ],
      "contact": [
        {
          "mode": "website",
          "value": "www.amazon.com"
        }
      ],
      "address": {
        "country_code": "GB"
      }
    },
    {
      "id": "ae316a83508ecaa8897e90321...",
      "names": [
        {
          "mode": "name",
          "value": "Boots"
        },
        {
          "mode": "transliterated_name",
          "value": "boots"
        },
        {
          "mode": "operator",
          "value": "Boots Uk Limited"
        }
      ],
      "contact": [
        {
          "mode": "phone",
          "value": "+44 20 73818651"
        },
        {
          "mode": "website",
          "value": "http://www.boots.com/stores/773-london-fulham-palace-road-w6-9pa"
        }
      ],
      "address": {
        "country_code": "GB",
        "city": "London",
        "transliterated_city": "london",
        "street": "Fulham Palace Road",
        "transliterated_street": "fulham palace road",
        "post_code": "W6 9Pa",
        "coordinates": {
          "latitude": "51.48467107",
          "longitude": "-0.220126411"
        },
        "extra": {
          "building_number": "198-200",
          "shop_number": "773",
          "type_of_shop": "Chemist"
        }
      }
    }
  ]
}

Financial Insights

Financial Insights represents a report based on all the activities of a single customer. It analyzes all the customer’s connections to the connected providers for a selected period of time

Attributes

id

string

The id of the general report generated based on the customer’s data

customer_id

string

The id of the customer for which the report has been requested

partner_id

string

The id of the Salt Edge Partner, who requested the Financial Insights report

lead_email

string

Lead’s email address

status

string

Current report’s status. Possible values are: initialized, calculating, success, failed

connection_ids

array of strings

Ids of connections included in the report

currency_code

string

Main currency code used for the report’s generation and value conversion

from_date

date

The date from which the data in the report is included

to_date

date

The date to which the data in the report is included

report_types

array of strings

Types of reports. Possible values are: balance, expense, income, savings

data

object

Contains Report Object

created_at

datetime

The date when the report was created

updated_at

datetime

The date when the report was last updated

id

string

The id of the general report generated based on the customer’s data

customer_id

string

The id of the customer for which the report has been requested

partner_id

string

The id of the Salt Edge Partner, who requested the Financial Insights report

lead_email

string

Lead’s email address

status

string

Current report’s status. Possible values are: initialized, calculating, success, failed

connection_ids

array of strings

Ids of connections included in the report

currency_code

string

Main currency code used for the report’s generation and value conversion

from_date

date

The date from which the data in the report is included

to_date

date

The date to which the data in the report is included

report_types

array of strings

Types of reports. Possible values are: balance, expense, income, savings

data

object

Contains Report Object

created_at

datetime

The date when the report was created

updated_at

datetime

The date when the report was last updated

Sample object

{
  "id": "999999999999999999",
  "customer_id": "222222222222222222",
  "partner_id": "5292",
  "lead_email": "test@mail.com",
  "status": "success",
  "connection_ids": [
      "111111111111111112"
  ],
  "currency_code": "USD",
  "from_date": "2020-07-26",
  "to_date": "2020-10-25",
  "report_types": [
      "balance",
      "expense",
      "income",
      "savings"
  ],
  "data": {
      ...
  },
  "created_at": "2020-10-26T13:54:11Z",
  "updated_at": "2020-10-26T13:54:11Z"
}

Create

This endpoint is available only for apps using API keys of type service. For more information please see authentication guide.

Allows you to create a report for a customer for a specific date range.

The report might take some time to finish. This can be tracked by the status attribute.

Parameters

customer_id

string, required

The id of the customer that the report will be generated for

report_types

array of strings, required

Types of reports that can be generated, possible values balance, expense, income, savings
Note: at least one report type should be requested

currency_code

string, required

Main currency code to be used for the report’s generation and value conversion

from_date

date, required

The date from which the data in the report will be included

to_date

date, required

The date to which the data in the report will be included

customer_id

string, required

The id of the customer that the report will be generated for

report_types

array of strings, required

Types of reports that can be generated, possible values balance, expense, income, savings
Note: at least one report type should be requested

currency_code

string, required

Main currency code to be used for the report’s generation and value conversion

from_date

date, required

The date from which the data in the report will be included

to_date

date, required

The date to which the data in the report will be included

Possible Errors

URL

https://www.saltedge.com/api/partners/v1/reports

https://www.saltedge.com/api/partners/v1/reports

Method

POST

Sample request

curl -v -H "Accept: application/json" \
        -H "Content-type: application/json" \
        -H "App-id: $APP_ID" \
        -H "Secret: $SECRET" \
        -X POST \
        -d "{ \
              \"data\": { \
                \"customer_id\": \"$CUSTOMER_ID\", \
                \"report_types\": [ \
                  \"balance\", \
                  \"expense\", \
                  \"income\", \
                  \"savings\" \
                ], \
                \"currency_code\": \"USD\", \
                \"from_date\": \"2020-01-01\", \
                \"to_date\": \"2020-02-01\" \
              } \
            }" \
        https://www.saltedge.com/api/partners/v1/reports
curl -v -H "Accept: application/json" \
        -H "Content-type: application/json" \
        -H "App-id: $APP_ID" \
        -H "Secret: $SECRET" \
        -X POST \
        -d "{ \
              \"data\": { \
                \"report_types\": [ \
                  \"balance\", \
                  \"expense\", \
                  \"income\", \
                  \"savings\" \
                ], \
                \"currency_code\": \"USD\", \
                \"from_date\": \"2020-01-01\", \
                \"to_date\": \"2020-02-01\" \
              } \
            }" \
        https://www.saltedge.com/api/partners/v1/reports

Sample response

{
  "data": {
    "id": "999999999999999999",
    "customer_id": "222222222222222222",
    "lead_email": "test@email.com",
    "connection_ids": [
      "111111111111111112",
      "111111111111111113",
      "111111111111111114"
    ],
    "status": "initialized",
    "created_at": "2020-10-26T16:54:11Z"
  }
}

Show

This endpoint is available only for apps using API keys of type service. For more information please see authentication guide.

Shows the generated report with all the details.

Parameters

report_id

string, required

The id of the report generated based on the customer’s data.

report_id

string, required

The id of the report generated based on the customer’s data.

Possible Errors

URL

https://www.saltedge.com/api/partners/v1/reports/{report.id}

https://www.saltedge.com/api/partners/v1/reports/{report.id}

Method

POST

Sample request

curl -v -H "Accept: application/json" \
        -H "Content-type: application/json" \
        -H "App-id: $APP_ID" \
        -H "Secret: $SECRET" \
        -X GET \
        https://www.saltedge.com/api/partners/v1/reports/999999999999999999
curl -v -H "Accept: application/json" \
        -H "Content-type: application/json" \
        -H "App-id: $APP_ID" \
        -H "Secret: $SECRET" \
        -X GET \
        https://www.saltedge.com/api/partners/v1/reports/999999999999999999

Sample response

{
  "data": {
      "id": "999999999999999999",
      "customer_id": "222222222222222222",
      "lead_email": "test@mail.com",
      "status": "success",
      "connection_ids": [
          "111111111111111111"
      ],
      "currency_code": "USD",
      "from_date": "2020-07-26",
      "to_date": "2020-10-25",
      "report_types": [
          "balance",
          "expense",
          "income",
          "savings"
      ],
      "data": {
          "result": {
            "accounts": [
              {
                "id": "333333333333333333",
                "start_date": "2020-07-26",
                "end_date": "2020-10-25",
                "whole_months_count": 3,
                "days_count": 90,
                "monthly_average_transactions_count": {
                  "total": 10,
                  "income": 2,
                  "expense": 8
                },
                "balance": {
                  ...
                },
                "income": {
                  ...
                },
                "expense": {
                  ...
                },
                "savings": {
                  ...
                }
              }
            ],
            "accounts_summary": {
              "start_date": "2020-07-26",
              "transactions_count": 90,
              "whole_months_count": 3,
              "days_count": 107,
              "monthly_average_transactions_count": {
                "total": 10,
                "income": 2,
                "expense": 8
            },
            "balance": {
              ...
            },
            "income": {
              ...
            },
            "expense": {
              ...
            },
            "savings": {
              ...
            }
          },
          "status": "success",
          "to_date": "2020-10-25",
          "from_date": "2020-07-26",
          "report_id": 999999999999999999,
          "connections": [
              {
                  "id": "111111111111111111",
                  "accounts": [
                      {
                          "id": "333333333333333333",
                          "name": "Oauth account 1",
                          "nature": "card",
                          "balance": "2171.9658356",
                          "transactions": {
                              "start_date": "2020-09-26",
                              "end_date": "2020-10-25",
                              "first_id": "444444444444444441",
                              "last_id": "444444444444444489",
                              "count": 38
                          },
                          "original_balance": 2004.4,
                          "original_currency_code": "EUR"
                      }
                  ],
                  "client_name": "Client",
                  "customer_id": 222222222222222222,
                  "holder_info": null,
                  "provider_code": "fakebank_oauth_xf",
                  "provider_name": "Fake Bank OAuth"
              }
          ],
          "customer_id": 222222222222222222,
          "report_types": [
              "balance",
              "expense",
              "income",
              "savings"
          ],
          "currency_code": "USD",
          "connection_ids": [
              "111111111111111111"
          ],
          "exchange_rates": {
              "BTC": "7082.3464052288",
              "EUR": "1.083599",
              "GBP": "1.2341013636"
          }
      },
      "created_at": "2020-10-26T13:54:11Z",
      "updated_at": "2020-10-26T13:54:11Z"
  }
}

List

This endpoint is available only for apps using API keys of type service. For more information please see authentication guide.

Returns all the general available reports for a customer.

Parameters

customer_id

string, optional

The id of the customer for which the report(s) has been requested

from_id

string, optional

The id of the report which the list starts with

customer_id

string, optional

The id of the customer for which the report(s) has been requested

from_id

string, optional

The id of the report which the list starts with

Possible Errors

URL

https://www.saltedge.com/api/partners/v1/reports?customer_id={customer.id}

https://www.saltedge.com/api/partners/v1/reports?customer_id={customer.id}

Method

POST

Sample request

curl -v -H "Accept: application/json" \
        -H "Content-type: application/json" \
        -H "App-id: $APP_ID" \
        -H "Secret: $SECRET" \
        -X GET \
        https://www.saltedge.com/api/partners/v1/reports?customer_id=$CUSTOMER_ID
curl -v -H "Accept: application/json" \
        -H "Content-type: application/json" \
        -H "App-id: $APP_ID" \
        -H "Secret: $SECRET" \
        -X GET \
        https://www.saltedge.com/api/partners/v1/reports?customer_id=$CUSTOMER_ID

Sample response

{
  "data": [
        {
            "id": "999999999999999991",
            "customer_id": "222222222222222222",
            "lead_email": "test@email.com",
            "connection_ids": [
                "111111111111111111",
                "111111111111111112"
            ],
            "status": "success",
            "created_at": "2020-10-25T16:54:11Z",
        },
        {
            "id": "999999999999999992",
            "customer_id": "222222222222222222",
            "lead_email": "test@email.com",
            "connection_ids": [
                "111111111111111113",
                "111111111111111114"
            ],
            "status": "success",
            "created_at": "2020-10-25T16:54:11Z",
        }
    ],
    "meta": {
        "next_id": "111111111111111115",
        "next_page": "/api/v5/reports/?from_id=111111111111111115"
    }
  }
}

Remove

This endpoint is available only for apps using API keys of type service. For more information please see authentication guide.

Deletes a report.

Parameters

report_id

string, required

The id of the general report

report_id

string, required

The id of the general report

Possible Errors

URL

https://www.saltedge.com/api/partners/v1/reports/{report.id}

https://www.saltedge.com/api/partners/v1/reports/{report.id}

Method

DELETE

Sample request

curl -v -H "Accept: application/json" \
        -H "Content-type: application/json" \
        -H "App-id: $APP_ID" \
        -H "Secret: $SECRET" \
        -X DELETE \
        https://www.saltedge.com/api/partners/v1/reports/999999999999999999
curl -v -H "Accept: application/json" \
        -H "Content-type: application/json" \
        -H "App-id: $APP_ID" \
        -H "Secret: $SECRET" \
        -X DELETE \
        https://www.saltedge.com/api/partners/v1/reports/999999999999999999

Sample response

{
  "data": {
    "id": "999999999999999999",
    "deleted": true
  }
}

Report Object

result

string

Show child attributes

Report result

customer_id

integer

The id of the customer

connection_ids

array of strings

Ids of Connections included in report

connections

array of objects

Show child attributes

Information related to connections included in report

currency_code

string

Main currency code used for report’s generation and value convertion

exchange_rates

object

A list of exchange rates at the time of report creation

report_id

integer

The id of the generated report

report_types

array of strings

Types of generated reports. Possible values are: balance, expense, income, savings

status

string

Current report’s status. Possible values are: initialized, calculating, success, failed

from_date

date

The date from which the data in the report is included

to_date

date

The date to which the data in the report is included

result

string

Show child attributes

Report result

customer_id

integer

The id of the customer

connection_ids

array of strings

Ids of Connections included in report

connections

array of objects

Show child attributes

Information related to connections included in report

currency_code

string

Main currency code used for report’s generation and value convertion

exchange_rates

object

A list of exchange rates at the time of report creation

report_id

integer

The id of the generated report

report_types

array of strings

Types of generated reports. Possible values are: balance, expense, income, savings

status

string

Current report’s status. Possible values are: initialized, calculating, success, failed

from_date

date

The date from which the data in the report is included

to_date

date

The date to which the data in the report is included

Sample object

{
  "result": {
    "accounts": [
      {
        "id": "333333333333333333",
        "name": "Oauth account 1",
        "nature": "card",
        "connection_id": "111111111111111111"
        "start_date": 2020-07-26,
        "end_date": 2020-10-25,
        "whole_months_count": 3,
        "days_count": 90,
        "monthly_average_transactions_count": {
          "total": 10,
          "income": 2,
          "expense": 8
        },
        "balance": { ... },
        "income": { ... },
        "expense": { ... },
        "savings": { ... }
      }
    ],
    "accounts_summary": {
      "start_date": 2020-07-26,
      "end_date": 2020-10-25,
      "transactions_count": 90,
      "whole_months_count": 3,
      "days_count": 107,
      "monthly_average_transactions_count": {
        "total": 10,
        "income": 2,
        "expense": 8
      },
      "balance": { ...  },
      "income": { ... },
      "expense": { ... },
      "savings": { ... }
    }
  },
  "customer_id": 222222222222222222,
  "connection_ids": [
      "111111111111111111"
  ],
  "connections": [
    {
      "id": "111111111111111111",
      "accounts": [
        {
          "id": "333333333333333333",
          "name": "Oauth account 1",
          "nature": "card",
          "balance": "2171.9658356",
          "transactions": {
            "start_date": 2020-07-26,
            "end_date": 2020-10-25,
            "first_id": "444444444444444441",
            "last_id": "444444444444444489",
            "count": 38
          },
          "original_balance": 2004.4,
          "original_currency_code": "EUR"
        }
      ],
      "client_name": "Client",
      "customer_id": 222222222222222222,
      "holder_info": null,
      "provider_code": "fakebank_oauth_xf",
      "provider_name": "Fake Bank OAuth"
    }
  ],
  "currency_code": "USD",
  "exchange_rates": {
    "BTC": "7082.3464052288",
    "EUR": "1.083599",
    "GBP": "1.2341013636"
  },
  "report_id": 999999999999999999,
  "report_types": [
      "balance",
      "expense",
      "income",
      "savings"
  ],
  "status": "success",
  "from_date": "2020-07-26",
  "to_date": "2020-10-25"
}

Balance Report Object

start_date_amount

decimal

Opening balance. The balance before the first transaction was imported

end_date_amount

decimal

Closing balance. The balance after the last transaction was imported

minimum

decimal

The minimum balance registered for the report’s date range.

maximum

decimal

The maximum balance registered for the report’s date range.

average

object

Show child attributes

Average balance

forecasted_average

object

Show child attributes

Forecasted average balance

start_date_amount

decimal

Opening balance. The balance before the first transaction was imported

end_date_amount

decimal

Closing balance. The balance after the last transaction was imported

minimum

decimal

The minimum balance registered for the report’s date range.

maximum

decimal

The maximum balance registered for the report’s date range.

average

object

Show child attributes

Average balance

forecasted_average

object

Show child attributes

Forecasted average balance

Sample object

{
  "start_date_amount": 1000.0,
  "end_date_amount": 6485.0,
  "minimum": 1340.0,
  "maximum": 8945.0,
  "average": {
    "daily": {
      "amount": 4573.3,
      "start_date" : "2020-01-01",
      "end_date": "2020-05-10"
    },
    "monthly": {
      "amount": 4573.3,
      "start_date" : "2020-01-01",
      "end_date": "2020-04-30"
    },
    "quarterly": {
      "amount": 4481.5,
      "start_date" : "2020-01-01",
      "end_date": "2020-03-31"
    },
    "annual": {
      "amount": null,
      "start_date": null,
      "end_date": null
    },
    "minimum_monthly": {
      "amount": 3330.0,
      "start_date" : "2020-01-01",
      "end_date": "2020-04-30"
    },
    "maximum_monthly": {
      "amount": 6085.0
      "start_date" : "2020-01-01",
      "end_date": "2020-04-30"
    },
  },
  "forecasted_average": {
    "next_month": 7517.54,
    "next_quarter": null,
    "next_year": null
  }
}

Income/Expense Report Object

start_date

date

The date of the first income/expense transaction

end_date

date

The date of the last income/expense transaction

transactions_count

integer

Number of income/expense transactions

last_year_amount

decimal

Total amount of income/expense for the last fully covered 12 months

total

decimal

Total amount of income/expense per the calculated period

total_per_month

array of objects

Show child attributes

Total amount of income/expense per each month

average

object

Show child attributes

Average amount of income/expense

forecasted_average

object

Show child attributes

Forecasted average amount of income/expense

streams

object

Show child attributes

Information on income/expense a customer receives/spends on a regular/irregular basis

start_date

date

The date of the first income/expense transaction

end_date

date

The date of the last income/expense transaction

transactions_count

integer

Number of income/expense transactions

last_year_amount

decimal

Total amount of income/expense for the last fully covered 12 months

total

decimal

Total amount of income/expense per the calculated period

total_per_month

array of objects

Show child attributes

Total amount of income/expense per each month

average

object

Show child attributes

Average amount of income/expense

forecasted_average

object

Show child attributes

Forecasted average amount of income/expense

streams

object

Show child attributes

Information on income/expense a customer receives/spends on a regular/irregular basis

Sample object

{
  "start_date": "2020-01-01",
  "end_date": "2020-04-03",
  "transactions_count": 7,
  "last_year_amount": null,
  "total": 16962.5,
  "total_per_month": [
    {
      "year": 2020,
      "month": 3,
      "is_whole_month": true,
      "amount": 4100.0
    },
    {
      "year": 2020,
      "month": 4,
      "is_whole_month": false,
      "amount": 4100.0
    }
  ],
  "average": {
    "monthly": 4275.0,
    "quarterly": null,
    "annual": null
  },
  "forecasted_average": {
    "next_month": 4636.0,
    "next_quarter": null,
    "next_year": null
  },
  "streams": {
    "regular_amount": 16950.0,
    "irregular_amount": 12.5,
    "count": {
      "regular": 2,
      "irregular": 1,
      "maximum_overlapping": 2
    },
    "regular":[
      {
        "transactions_count": 3,
        "transaction_ids": ["11", "31", "51"],
        "start_date": "2020-01-01",
        "end_date": "2020-04-03",
        "amount": {
          "total": 16450.0,
          "average": 4112.5,
          "median": 4100.0,
          "stdev": 103.08
        },
        "frequency": "monthly",
        "days_count": 31,
        "category_code": "paycheck",
        "description": "IT SOLUTIONS INC PAYROLL",
        "merchant": {
           "name": "Solutions Inc",
           "email": null,
           "phone": null,
           "address": "GB",
           "website": null
        }
      }
    ],
    "irregular": {
      "transactions_count": 2,
      "transaction_ids": ["2", "7"],
      "start_date": "2020-01-01",
      "end_date": "2020-04-03"
    }
  }
}

Savings Report Object

per_month

array of objects

Show child attributes

Information related to net savings per each month

average

object

Show child attributes

Average savings

forecasted_average

object

Show child attributes

Forecasted average savings

runway

decimal

Provides an estimate (number of months) on how long the customer’s current balance will be sufficient until they run out of money. The customer’s income and expenses are taken into account.
Note: This indicator is calculated only for cases when the customer has positive current balance and the amount of their expenses exceeds the amount of their income

expense_to_savings_rate

decimal

Shows whether the customer increases or loses his capital. Taking into account the customer’s income and expenses, this indicator shows the number of months during which the customer’s savings are either increased or reduced by an amount equal to 1 month of expenses.
Note: This indicator is calculated only for cases when the customer has both savings/dissavings and expenses

stress_runway

decimal

Provides an estimate (number of months) on how long the customer’s current balance will be sufficient to cover their regular expenses in case they unexpectedly stops receiving income.
Note: This indicator is calculated for all cases, except the one, when the customer has no expenses

income_stability

decimal

Average weighted stability of income from all the sources
Note: it is close to 1, if customer has stable income

income_regularity

decimal

Average weighted regularity of income from all the sources
Note: it is close to 1, if customer has regular income

income_to_expense_rate

decimal

Ratio of average monthly income to average monthly expense

per_month

array of objects

Show child attributes

Information related to net savings per each month

average

object

Show child attributes

Average savings

forecasted_average

object

Show child attributes

Forecasted average savings

runway

decimal

Provides an estimate (number of months) on how long the customer’s current balance will be sufficient until they run out of money. The customer’s income and expenses are taken into account.
Note: This indicator is calculated only for cases when the customer has positive current balance and the amount of their expenses exceeds the amount of their income

expense_to_savings_rate

decimal

Shows whether the customer increases or loses his capital. Taking into account the customer’s income and expenses, this indicator shows the number of months during which the customer’s savings are either increased or reduced by an amount equal to 1 month of expenses.
Note: This indicator is calculated only for cases when the customer has both savings/dissavings and expenses

stress_runway

decimal

Provides an estimate (number of months) on how long the customer’s current balance will be sufficient to cover their regular expenses in case they unexpectedly stops receiving income.
Note: This indicator is calculated for all cases, except the one, when the customer has no expenses

income_stability

decimal

Average weighted stability of income from all the sources
Note: it is close to 1, if customer has stable income

income_regularity

decimal

Average weighted regularity of income from all the sources
Note: it is close to 1, if customer has regular income

income_to_expense_rate

decimal

Ratio of average monthly income to average monthly expense

Sample object

{
  "per_month": [
    {
      "year": 2020,
      "month": 1,
      "is_whole_month": true,
      "amount": 340.0
    },
    {
      "year": 2020,
      "month": 2,
      "is_whole_month": true,
      "amount": 1915.0
    }
  ],
  "average": {
    "monthly": 1281.66,
    "quarterly": null,
    "annual": null
  },
  "forecasted_average": {
    "next_month": 2014.29,
    "next_quarter": null,
    "next_year": null
  },
  "runway": null,
  "expense_to_savings_rate": 3.553,
  "stress_runway": 3.508,
  "income_stability": 0.960,
  "income_regularity": 0.925,
  "income_to_expense_rate": 1.281
}

Currencies

The currency is represented just as a string. We use ISO 4217 currency codes. Thus, all the currency codes will have exactly three uppercase letters. If certain currencies no longer exist, we will still support them for the transactions held in those currencies. Example:

  • Zambian Kwacha ZMK (old currency code)
  • Zambian Kwacha ZMW (new currency code)

Both of them are supported.

List

You can get the list of all the currencies that we support.

Possible Errors

URL

https://www.saltedge.com/api/partners/v1/currencies

https://www.saltedge.com/api/partners/v1/currencies

Method

GET

Sample request

curl -v -H "Accept: application/json" \
        -H "Content-type: application/json" \
        -H "App-id: $APP_ID" \
        -H "Secret: $SECRET" \
        -X GET \
        https://www.saltedge.com/api/partners/v1/currencies
curl -v -H "Accept: application/json" \
        -H "Content-type: application/json" \
        -H "App-id: $APP_ID" \
        -H "Secret: $SECRET" \
        -X GET \
        https://www.saltedge.com/api/partners/v1/currencies

Sample Response

{
  "data":
    [
      {
        "code": "AED",
        "name": "United Arab Emirates dirham"
      },
      {
        "code": "AFN",
        "name": "Afghan afghani"
      },
      {
        "code": "ALL",
        "name": "Albanian lek"
       },
      {
        "code": "AMD",
        "name": "Armenian dram"
      },
      {
        "code": "ANG",
        "name": "Netherlands Antillean guilder"
      },
      {
        "code": "AOA",
        "name": "Angolan kwanza"
      },
      {
        "code": "ARS",
        "name": "Argentine peso"
      },
      {
        "code": "AUD",
        "name": "Australian dollar"
      },
      {
        "code": "AWG",
        "name": "Aruban florin"
      },
    ...
    ]
}

Assets

Some of our providers support investment accounts. Such accounts may have an extra assets key which contains an array of assets. Each asset consists of:

  • code - asset common used abbreviation (Ex.: BTC - Bitcoin, XAU - Gold etc.)
  • amount - total amount of owned assets

Balance for these investment accounts is a sum of all assets amounts converted to selected currency.

Sample Object

{
    "id": "333333333333333333",
    "name": "bittrex trading",
    "nature": "investment",
    "balance": 4084.7,
    "currency_code": "USD",
    "extra": {
        "assets": [
          { "code": "BTC",  "amount": 0.25555165 },
          { "code": "ETH",  "amount": 12.456 },
          { "code": "USDT", "amount": 3054.57935489 },
          { "code": "XLM",  "amount": 0.0 }
        ],
        "transactions_count": {
          "posted": 22,
          "pending": 1
        }
    },
    "connection_id": "111111111111111111",
    "created_at": "2020-10-26T14:54:11Z",
    "updated_at": "2020-10-26T14:54:11Z"
}

List

You can get the list of all the assets that we support.

Possible Errors

URL

https://www.saltedge.com/api/partners/v1/assets

https://www.saltedge.com/api/partners/v1/assets

Method

GET

Sample request

curl -v -H "Accept: application/json" \
        -H "Content-type: application/json" \
        -H "App-id: $APP_ID" \
        -H "Secret: $SECRET" \
        -X GET \
        https://www.saltedge.com/api/partners/v1/assets
curl -v -H "Accept: application/json" \
        -H "Content-type: application/json" \
        -H "App-id: $APP_ID" \
        -H "Secret: $SECRET" \
        -X GET \
        https://www.saltedge.com/api/partners/v1/assets

Sample Response

{
  "data": [
    {
        "code": "BSD",
        "name": "BitSend"
    },
    {
        "code": "BSTY",
        "name": "GlobalBoost- Y"
    },
    {
        "code": "BTA",
        "name": "Bata"
    },
    {
        "code": "BTC",
        "name": "Bitcoin"
    },
    {
        "code": "BTCD",
        "name": "BitcoinDark"
    },
    {
        "code": "BTS",
        "name": "BitShares"
    }
    ...
  ]
}

Rates

A rate is an index of any currency value in relation to the USD currency. All rates are updated daily.

Attributes

currency_code

string

The code of the currency

rate

decimal

The ratio of the currency in relation to the USD currency

fail

boolean

The field which shows if we have an up-to-date rate for the currency. If the flag is true, it means that the rate has been taken from the previous available date

issued_on

date

The date the rate has been issued on

currency_code

string

The code of the currency

rate

decimal

The ratio of the currency in relation to the USD currency

fail

boolean

The field which shows if we have an up-to-date rate for the currency. If the flag is true, it means that the rate has been taken from the previous available date

issued_on

date

The date the rate has been issued on

Sample object

{
    "currency_code": "EUR",
    "rate": 1.37,
    "issued_on": "2020-02-12",
    "fail": false
}

List

You can get the list of all the currency rates that we support. You will receive the currency rates starting March 21, 2014. If any older date is requested, you will still receive the rates starting March 21, 2014.

Parameters

date

optional

Date for which currency rates will be retrieved

date

optional

Date for which currency rates will be retrieved

Possible Errors

URL

https://www.saltedge.com/api/partners/v1/rates

https://www.saltedge.com/api/partners/v1/rates

Method

GET

Sample request

curl -v -H "Accept: application/json" \
        -H "Content-type: application/json" \
        -H "App-id: $APP_ID" \
        -H "Secret: $SECRET" \
        -X GET \
        https://www.saltedge.com/api/partners/v1/rates?date=2020-03-21
curl -v -H "Accept: application/json" \
        -H "Content-type: application/json" \
        -H "App-id: $APP_ID" \
        -H "Secret: $SECRET" \
        -X GET \
        https://www.saltedge.com/api/partners/v1/rates?date=2020-03-21

Sample Response

{
  "data": [
    {
      "currency_code": "ZMK",
      "rate": 0.0001926968,
      "fail": false
    },
    {
      "currency_code": "ZWL",
      "rate": 0.0031021699,
      "fail": false
    },
    {
      "currency_code": "ZMW",
      "rate": 0.1589825119,
      "fail": false
    },
    {
      "currency_code": "AED",
      "rate": 0.2722570106,
      "fail": false
    }
    ...
  ],
  "meta" : {
    "issued_on": "2020-03-21"
  }
}