afterbanks API

Standardizing connections with any bank in real-time.

Default response content-types: application/json
Schemes: https

Summary

Tag: forms

Operation Description
GET /forms

List of supported banks

Tag: serviceV3

Operation Description
POST /serviceV3

Global position and transactions to a given date.

Tag: User

Operation Description
POST /me

My licence usage information.

Paths

List of supported banks

GET /forms

Tags: forms

Get a full list of supported banks, as well as the names of the fields necessary to draw a login form similar to the one from the bank.

country_code

Country code, format ISO 3166-1 alpha-2 (https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2). For example, ES for Spain. If no code is provided, the full list is returned.

query string

Uses default content-types: application/json

200

Array with the list of supported banks and information needed to draw your login form

default

Unexpected error

My licence usage information.

POST /me

Tags: User

Returns information about my license and remaining calls

servicekey

License that identifies the client. If you do not have one, you can request it at https://www.afterbanks.com

query string

Uses default content-types: application/json

200

Profile information for an user

me
default

Unexpected error

Global position and transactions to a given date.

POST /serviceV3

Tags: serviceV3

This endpoint returns the list of products and movements for each of the products from the requested date to the current date. There is a sandbox where test calls: https://www.afterbanks.com/sandbox/

servicekey

License that identifies the client. If you do not have one, you can request it at https://www.afterbanks.com

query string
service

Unique identifier for each bank. The list of supported banks is obtained from https://www.afterbanks.com/forms/

query string
documentType

Some banks, in their login form, request the document type. In these cases, you must identify an integer (0 to 4), which corresponds to its position in the bank's login form.

query number (int32)
user

User

query string
pass

Password

query string
pass2

Some banks use a second password.

query string
products

Names of banking products (checking accounts, cards, etc.), separated by commas. Note that in the first call to the API, we do not know the names of the products that the user has contracted, so this parameter is empty, or can be set to GLOBAL.

query string
startdate

Date from which we get the transactions in dd-mm-yyyy. Required if the value of "products" is different than GLOBAL.

query string
account_id

It is a value from 0 to n. Some banks allow you to access different contracts with different products using the same credentials. In cases where this happens, and this parameter is null, the API response will notify that those credentials can access more than one contract.

query number (int32)

Uses default content-types: application/json

200

Array with list of banking products and transactions.

default

Unexpected error

Schema definitions

Forms: object

country_code: string

Country code, format ISO 3166-1 alpha-2 (https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2).

service: string

Unique identifier of the bank in the API.

swift: string

SWIFT code, format ISO 9362 (https://en.wikipedia.org/wiki/ISO_9362).

fullname: string

Full name of the bank.

business: boolean

Boolean value. There are banks that have different access for individuals and businesses. If the value is 1, it indicates that is the business access

documentType: string

List of possible values for the field "type", separated by the character "|" (Eg NIF|Passport|residence card). In the event that the bank does not require this information in their login form, the value is 0

user: string

Text accompanying the user inputbox

pass: string

Text accompanying the password inputbox

pass2: string

Text accompanying the second password inputbox. In the event that the bank does not require this information in their login form, the value is 0

userdesc: string

Help text to fill the user inputbox, if the original form from the bank have some help text.

passdesc: string

Help text to fill the password inputbox, if the original form from the bank have some help text.

pass2desc: string

Help text to fill the second password inputbox, if the original form from the bank have some help text.

usertype: string

Data type allowed for the user inputbox.

passtype: string

Data type allowed for the password inputbox

pass2type: string

Data type allowed for the second password inputbox

image: string

Transparent icon URL in PNG format and 128x128 size.

serviceV3: object

product: string

Unique identifier for a product. For example, bank account number or credit card numeration.

type: string

Product type. The most common values are "checking" for checking account, "card" for credit card, "debit" for debit card "loan" for loans. The possible values are: card, checking, debit, insurance, investment, loan, other, pensionplan, saving, securities, stocks

balance: number (float)

Current product balance

currency: string

Currency code in ISO 4217 format.

description: string

Product name. Sometimes it is an alias assigned by the user or can match the product value.

transactions: object[]

Transactions: object

date: string (date)

Transaction date with format dd-mm-yyyy

date2: string (date)

Value date with format dd-mm-yyyy

amount: number (float)

Transaction amount

balance: number (float)

Product balance after the transaction

me: object

remaining_calls: integer (int32)

Calls remaining for your current billing cycle.

date_renewal: string (date)

Renewal date in format dd-mm-yyyy

Error: object

message: string
code: integer (int32)

Possible values: description: 1, Generic; 2 The bank's website is out of service; 3 Some data connection is invalid; 4 The requested account does not exist; 5, Connection cut retry the request; 6, the user must access the website of the bank to perform an action; 50, incorrect parameter in the call to the API