API reference

Our API is built with REST principles and conventions in mind. We use a set of several resources as well as meaningful HTTP codes to indicate success or failure to make your developer's life easier.

The Ibanity API is HTTPS only and returns JSON payloads. We followed the jsonapi conventions when building our API. Should you want an easier way to integrate our API in your products, we have developed libraries in some popular languages that are available as open source packages free of charge.

To make it easy to test your application before going live, we have developped a multi-banking sandbox that you can use to create fake data and simulate users during the development phase of your product. There is no flip switch to change from test to production, the type of API key will determine what mode you are in. Of course, test mode is there free of charge and will not trigger an actual request to a real-life bank.

Authentication

Authenticate using the certificate you received in our developer portal for your application. You can manage your certificates in the portal.

Those application certificates guarantee access to our API. Do not share them!

All API calls are made using HTTPS, calls made with HTTP will be rejected. Requests without a valid application certificate will also be rejected.

We use TLS and more specifically mutual authentication to ensure the server and the client are authenticated for each API call.

Example request
$ curl -X GET --cert appcert.pfx:passwd https://api.ibanity.com/financial-institutions

curl uses --cert to pass certificates as authentication means. Be sure to use your public key file, it usually has the .pfx extension unless you renamed it.

Pagination

Pagination in ibanity is cursor based. A cursor refers to a resource uuid which then marks a specific resource, unless this resource has been deleted.

Our pagination supports the following parameters:

limit

number

Maximum amount of objects that might be returned. It is possible that the response has fewer elements.

before

uuid

Cursor that specifies the end of the page being returned.

after

uuid

Cursor that specifies the start of the page being returned.

Next to the paging attributes, the response will also include the following links when applicable:

first

url

Link to the first page.

next

url

Link to the next page.

previous

url

Link to the previous page.

Example request
$ curl -X GET --cert appcert.pfx:passwd https://api.ibanity.com/accounts?limit=2&before=d500ddac-27e8-447b-b0a1-dbca8c181b99
Example response
{
"meta": {
  "paging": {
    "limit": 2,
    "before": "d500ddac-27e8-447b-b0a1-dbca8c181b99",
    "after": "80cdb338-0da8-4039-863c-b108943c1e22"
  }
},
"links": {
  "first": "http://api.ibanity.com/accounts",
  "next": "http://api.ibanity.com/accounts?after=d500ddac-27e8-447b-b0a1-dbca8c181b99"
},
  "data": [
    ...
  ]
}

Status codes

Ibanity uses conventional HTTP codes to indicate if a request was successful or not. As an example, 2xx when the request succeeded, 4xx when the information sent was missing or authentication faild and 5xx in case of server errors on our side.

Please refer to the errors section to know more about errors and their associated status codes, as well as their human readable messages.

Status codes

200

OK

Request successful.

201

Created

Resource successfully created.

202

Accepted

Request is accepted but outcome might happen later or needs to be polled.

400

Bad Request

Something is missing or wrong in your request.

401

Unauthorized

Wrong credentials. Certificate invalid or not provided.

403

Forbidden

Request cannot be executed in the current environment. Sent when attempting to use sandbox routes with production applications.

404

Not found

Requested resource not found.

500

Server error

Something went wrong on our side... It should not happen often...

Error codes

To make it easier to understand what went wrong, we didn't just use HTTP status codes. When a request fails, meaning when it's status code is either 4xx or 5xx, we provide extra information to help you.

Some of those codes are specific to certain routes. In case of a 404 that was caused by a request referencing a non-existant resource name, the response will also include a resource key, with the name of the resource you were trying to call as value.

Example response
{
  "errors": [
    {
      "code": "invalid_credentials",
      "message": "Your financial credentials are invalid"
    }
  ]
}
Error codes

Status code

Error code

Message

400

invalid_paging_limit

The paging limit is invalid.

400

ambiguous_paging_cursors

The paging cursors are ambiguous, you should specify only before or after, not both.

400

invalid_paging_cursor

The paging cursor is invalid.

400

invalid_application_api_version

The API version specified by your application is outdated.

400

invalid_api_version_header

The API version specified in the header is invalid.

400

invalid_resource_type

You have to specify the resource type in your request body for creating or updating resources

400

validation_error

One or multiple attributes are invalid. The attribute key will specify the name of the attribute and the message will provide some details

401

invalid_application_certificate

Your application certificate is invalid.

401

application_certificate_revoked

Your application certificate has been revoked.

403

sandbox_application_required

This operation is only authorized for sandbox applications.

404

resource_no_found

Resource not found. Adds key resource with value :resource_name in case of undefined resource.

500

internal_server_error

Internal server error.

Account

This is an object representing a customer account. This object will give you the balance and its currency.

From this object, you can follow the link to its list of transactions that will be composed of several types of banking operations.

The Account Object

Attributes

id

string

Unique identifier for the account.

type

string

Resource type. Will always be account for account resource.

meta

object

Meta of the current resource. Check account_meta reference for more details.

attributes

object

Attributes of the current resource. Check account_attributes reference for more details.

relationships

object

Related resource relationships. Check account_relationships reference for more details.

links

object

Current resource links. Check links object reference for more details.

Example
{
  "id": "d174c19f-136c-4dcc-9f0d-26b937bc4c1d",
  "type": "account",
  "meta": {
    "synchronizedAt": "2017-05-19T15:20:03.688660Z",
    "transactionsSynchronizedAt": "2017-05-19T15:20:03.688674Z",
  },
  "attributes": {
    "subtype": "checking",
    "relationship": "owner",
    "reference": "nobis",
    "iban": "BE12123456789012",
    "description": "Cupiditate provident ad qui nihil est et vitae unde.",
    "currency": "EUR",
    "balance": 100.0
  },
  "relationships": {
    "transactions": {
      "links": {
        "related": "https://api.ibanity.com/customers/d9aa5419-6a35-4e33-a98b-15a85107ab96/accounts/d174c19f-136c-4dcc-9f0d-26b937bc4c1d/transactions"
      }
    },
    "customer": {
      "data": {
        "id": "d9aa5419-6a35-4e33-a98b-15a85107ab96",
        "type": "customer"
      },
      "links": {
        "related": "https://api.ibanity.com/customers/d9aa5419-6a35-4e33-a98b-15a85107ab96"
      }
    },
    "financialInstitution": {
      "data": {
        "id": "dc8d746f-68ff-40d0-98a3-86ba8322d33d",
        "type": "financialInstitution"
      },
      "links": {
        "related": "https://api.ibanity.com/financial-institutions/dc8d746f-68ff-40d0-98a3-86ba8322d33d"
      }
    },
    "authorization": {
      "data": {
        "id": "ac9d746f-68ff-40d0-98a3-86ba8322d33d",
        "type": "authorization"
      },
      "links": {
        "related": "https://api.ibanity.com/customers/d9aa5419-6a35-4e33-a98b-15a85107ab96/authorizations/ac9d746f-68ff-40d0-98a3-86ba8322d33d"
      }
    }
  },
  "links": {
    "self": "https://api.ibanity.com/customers/d9aa5419-6a35-4e33-a98b-15a85107ab96/accounts/d174c19f-136c-4dcc-9f0d-26b937bc4c1d"
  }
}

Account Meta

Attributes

synchronizedAt

datetime

The last time this account was synchronized with the financial institution. Formatted according to ISO8601 spec.

transactionsSynchronizedAt

datetime

The last time this account transactions were synchronized with the financial institution. Formatted according to ISO8601 spec.

Example
{
  "synchronizedAt": "2017-05-19T15:20:03.688660Z",
  "transactionsSynchronizedAt": "2017-05-19T15:20:03.688674Z",
}

Account Attributes

Attributes

subtype

string

Type of account. Can be checking or savings.

relationship

string

What relationship the customer has towards this account. Can be owner or trustee.

reference

string

Represents the internal bank reference for that account.

iban

string

Account's IBAN number.

description

string

Description of the account.

currency

string

Currency of the account, in ISO4217 format.

balance

number

Current balance of the account.

Example
{
  "subtype": "checking",
  "relationship": "owner",
  "reference": "nobis",
  "iban": "BE12123456789012",
  "description": "Cupiditate provident ad qui nihil est et vitae unde.",
  "currency": "EUR",
  "balance": 100.0
}

Account Relationships

Available relationships

transactions

object

Link to the list of transactions for this account.

customer

object

Link to the customer who authorized access to that account.

financialInstitution

object

Link to the financial institution who hosts the specified account.

authorization

object

Link to the authorization of the account by your customer for this application.

Example
{
  "transactions": {
    "links": {
      "related": "https://api.ibanity.com/customers/d9aa5419-6a35-4e33-a98b-15a85107ab96/accounts/d174c19f-136c-4dcc-9f0d-26b937bc4c1d/transactions"
    }
  },
  "customer": {
    "data": {
      "id": "d9aa5419-6a35-4e33-a98b-15a85107ab96",
      "type": "customer"
    },
    "links": {
      "related": "https://api.ibanity.com/customers/d9aa5419-6a35-4e33-a98b-15a85107ab96"
    }
  },
  "financialInstitution": {
    "data": {
      "id": "dc8d746f-68ff-40d0-98a3-86ba8322d33d",
      "type": "financial-institution"
    },
    "links": {
      "related": "https://api.ibanity.com/financial-institutions/dc8d746f-68ff-40d0-98a3-86ba8322d33d"
    }
  },
  "authorization": {
    "data": {
      "id": "ac9d746f-68ff-40d0-98a3-86ba8322d33d",
      "type": "authorization"
    },
    "links": {
      "related": "https://api.ibanity.com/customers/d9aa5419-6a35-4e33-a98b-15a85107ab96/authorizations/ac9d746f-68ff-40d0-98a3-86ba8322d33d"
    }
  }
}

List Accounts

Parameters

customerUuid

string

Specifies the UUID of the customer you would like to fetch the accounts from.

Arguments

limit

integer

Specifies the number of account resources that you want to be returned.

before

uuid

Specify a UUID to tell from which cursor the API should fetch the account resources. Will return all accounts under the specified of default limit before the one with that UUID.

after

uuid

Specify a UUID to tell from which cursor the API should fetch the account resources. Will return all accounts after the specified of default limit before the one with that UUID.

Definition
GET https://api.ibanity.com/customers/{customerUuid}/accounts
Example request
$ curl -X GET --cert appcert.pfx:passwd https://api.ibanity.com/customers/d9aa5419-6a35-4e33-a98b-15a85107ab96/accounts?limit=2
Returns

Returns a list of account resources.

Example response
{
  "meta": {
    "paging": {
      "limit": 2,
      "before": "d500ddac-27e8-447b-b0a1-dbca8c181b99",
      "after": "80cdb338-0da8-4039-863c-b108943c1e22"
    }
  },
  "links": {
    "first": "http://api.ibanity.com/customers/d9aa5419-6a35-4e33-a98b-15a85107ab96/accounts"
  },
  "data": [
    {
      "id": "d174c19f-136c-4dcc-9f0d-26b937bc4c1d",
      "type": "account",
      "meta": {
        "synchronizedAt": "2017-05-19T15:20:03.688660Z",
        "transactionsSynchronizedAt": "2017-05-19T15:20:03.688674Z",
      },
      "attributes": {
        "subtype": "checking",
        "relationship": "owner",
        "reference": "nobis",
        "iban": "BE12123456789012",
        "description": "Cupiditate provident ad qui nihil est et vitae unde.",
        "currency": "EUR",
        "balance": 100.0
      },
      "relationships": {
        "transactions": {
          "links": {
            "related": "https://api.ibanity.com/customers/d9aa5419-6a35-4e33-a98b-15a85107ab96/accounts/d174c19f-136c-4dcc-9f0d-26b937bc4c1d/transactions"
          }
        },
        "customer": {
          "data": {
            "id": "d9aa5419-6a35-4e33-a98b-15a85107ab96",
            "type": "customer"
          },
          "links": {
            "related": "https://api.ibanity.com/customers/d9aa5419-6a35-4e33-a98b-15a85107ab96"
          }
        },
        "financialInstitution": {
          "data": {
            "id": "dc8d746f-68ff-40d0-98a3-86ba8322d33d",
            "type": "financial-institution"
          },
          "links": {
            "related": "https://api.ibanity.com/financial-institutions/dc8d746f-68ff-40d0-98a3-86ba8322d33d"
          }
        },
        "authorization": {
          "data": {
            "id": "ac9d746f-68ff-40d0-98a3-86ba8322d33d",
            "type": "authorization"
          },
          "links": {
            "related": "https://api.ibanity.com/customers/d9aa5419-6a35-4e33-a98b-15a85107ab96/authorizations/ac9d746f-68ff-40d0-98a3-86ba8322d33d"
          }
        }
      },
      "links": {
        "self": "https://api.ibanity.com/customers/d9aa5419-6a35-4e33-a98b-15a85107ab96/accounts/d174c19f-136c-4dcc-9f0d-26b937bc4c1d"
      }
    },
    ...
  ]
}

Get Account

Parameters

customerUuid

string

UUID of the customer that gave access to the account.

uuid

string

UUID of the account to be retrived

Definition
GET https://api.ibanity.com/customers/{customerUuid}/accounts/{uuid}
Example request
$ curl -X GET --cert appcert.pfx:passwd https://api.ibanity.com/customers/d9aa5419-6a35-4e33-a98b-15a85107ab96/accounts/6f159fa1-372a-4bd1-b20d-4f62f4ed17b2
Returns

Returns the specified account resource or 404 if not found.

Example response
{
  "data": {
    "id": "6f159fa1-372a-4bd1-b20d-4f62f4ed17b2",
    "type": "account",
    "meta": {
      "synchronizedAt": "2017-05-19T15:20:03.688660Z",
      "transactionsSynchronizedAt": "2017-05-19T15:20:03.688674Z",
    },
    "attributes": {
      "subtype": "savings",
      "relationship": "owner",
      "reference": "lipsum",
      "iban": "BE34123456789012",
      "description": "Cupiditate provident ad qui nihil est et vitae unde.",
      "currency": "EUR",
      "balance": 200.0
    },
    "relationships": {
      "transactions": {
        "links": {
          "related": "https://api.ibanity.com/customers/d9aa5419-6a35-4e33-a98b-15a85107ab96/accounts/6f159fa1-372a-4bd1-b20d-4f62f4ed17b2/transactions"
        }
      },
      "customer": {
        "data": {
          "id": "d9aa5419-6a35-4e33-a98b-15a85107ab96",
          "type": "customer"
        },
        "links": {
          "related": "https://api.ibanity.com/customers/d9aa5419-6a35-4e33-a98b-15a85107ab96"
        }
      },
      "financialInstitution": {
        "data": {
          "id": "dc8d746f-68ff-40d0-98a3-86ba8322d33d",
          "type": "financial-institution"
        },
        "links": {
          "related": "https://api.ibanity.com/financial-institutions/dc8d746f-68ff-40d0-98a3-86ba8322d33d"
        }
      },
      "authorization": {
        "data": {
          "id": "ac9d746f-68ff-40d0-98a3-86ba8322d33d",
          "type": "authorization"
        },
        "links": {
          "related": "https://api.ibanity.com/customers/d9aa5419-6a35-4e33-a98b-15a85107ab96/authorizations/ac9d746f-68ff-40d0-98a3-86ba8322d33d"
        }
      }
    },
    "links": {
      "self": "https://api.ibanity.com/customers/d9aa5419-6a35-4e33-a98b-15a85107ab96/accounts/6f159fa1-372a-4bd1-b20d-4f62f4ed17b2"
    }
  }
}

List Application Accounts

Arguments

limit

integer

Specifies the number of account resources that you want to be returned.

before

uuid

Specify a UUID to tell from which cursor the API should fetch the account resources. Will return all accounts created before the specified of default limit before the one with that UUID.

after

uuid

Specify a UUID to tell from which cursor the API should fetch the account resources. Will return all accounts created after the specified of default limit before the one with that UUID.

Definition
GET https://api.ibanity.com/accounts
Example request
$ curl -X GET --cert appcert.pfx:passwd https://api.ibanity.com/accounts?limit=2
Returns

Returns a list of account resources.

Example response
{
  "meta": {
    "paging": {
      "limit": 2,
      "before": "d500ddac-27e8-447b-b0a1-dbca8c181b99",
      "after": "80cdb338-0da8-4039-863c-b108943c1e22"
    }
  },
  "links": {
    "first": "http://api.ibanity.com/accounts"
  },
  "data": [
    {
      "id": "d174c19f-136c-4dcc-9f0d-26b937bc4c1d",
      "type": "account",
      "meta": {
        "synchronizedAt": "2017-05-19T15:20:03.688660Z",
        "transactionsSynchronizedAt": "2017-05-19T15:20:03.688674Z",
      },
      "attributes": {
        "subtype": "checking",
        "relationship": "owner",
        "reference": "nobis",
        "iban": "BE12123456789012",
        "description": "Cupiditate provident ad qui nihil est et vitae unde.",
        "currency": "EUR",
        "balance": 100.0
      },
      "relationships": {
        "transactions": {
          "links": {
            "related": "https://api.ibanity.com/customers/d9aa5419-6a35-4e33-a98b-15a85107ab96/accounts/d174c19f-136c-4dcc-9f0d-26b937bc4c1d/transactions"
          }
        },
        "customer": {
          "data": {
            "id": "d9aa5419-6a35-4e33-a98b-15a85107ab96",
            "type": "customer"
          },
          "links": {
            "related": "https://api.ibanity.com/customers/d9aa5419-6a35-4e33-a98b-15a85107ab96"
          }
        },
        "financialInstitution": {
          "data": {
            "id": "dc8d746f-68ff-40d0-98a3-86ba8322d33d",
            "type": "financial-institution"
          },
          "links": {
            "related": "https://api.ibanity.com/financial-institutions/dc8d746f-68ff-40d0-98a3-86ba8322d33d"
          }
        },
        "authorization": {
          "data": {
            "id": "ac9d746f-68ff-40d0-98a3-86ba8322d33d",
            "type": "authorization"
          },
          "links": {
            "related": "https://api.ibanity.com/customers/d9aa5419-6a35-4e33-a98b-15a85107ab96/authorizations/ac9d746f-68ff-40d0-98a3-86ba8322d33d"
          }
        }
      },
      "links": {
        "self": "https://api.ibanity.com/customers/d9aa5419-6a35-4e33-a98b-15a85107ab96/accounts/d174c19f-136c-4dcc-9f0d-26b937bc4c1d"
      }
    },
    ...
  ]
}

Transaction

This is an object representing an account transaction. This object will give you the details of the financial transaction.

From this object, you can link back to its account.

The Transaction Object

Attributes

id

string

Unique identifier for the transaction.

type

string

Resource type. Will always be transaction for transaction resource.

meta

object

Meta data of the current resource. Check transaction_meta reference for more details.

attributes

object

Attributes of the current resource. Check transaction_attributes reference for more details.

relationships

object

Related resource relationships. Check transaction_relationships reference for more details.

links

object

Current resource links. Check links object reference for more details.

Example
{
  "id": "fd1790d4-78a6-4779-90a9-81e9b3667996",
  "type": "transaction",
  "meta": {
    "synchronizedAt": "2017-05-25T07:57:21.452068Z",
  },
  "attributes": {
    "valueDate": "2017-05-22T00:00:00Z",
    "reference": "6025dae7-559e-4795-951a-2214cb9530ef",
    "executionDate": "2017-05-25T00:00:00Z",
    "currency": "EUR",
    "counterpart": "BE9786154282554",
    "communication": "Small Cotton Shoes",
    "amount": 42.42
  },
  "relationships": {
    "account": {
      "links": {
        "related": "https://api.ibanity.com/customers/8f618811-2488-4d36-91b1-ed636ca72b58/accounts/30923957-87cc-42cf-ae3c-ad0563cec3d3"
      },
      "data": {
        "type": "account",
        "id": "30923957-87cc-42cf-ae3c-ad0563cec3d3"
      }
    }
  },
  "links": {
    "self": "https://api.ibanity.com/customers/8f618811-2488-4d36-91b1-ed636ca72b58/accounts/30923957-87cc-42cf-ae3c-ad0563cec3d3/transactions/fd1790d4-78a6-4779-90a9-81e9b3667996"
  }
}

Transaction Meta

Attributes

synchronizedAt

datetime

When this transaction was synchronized with the financial institution. Formatted according to ISO8601 spec.

Example
{
  "synchronizedAt": "2017-05-25T07:57:21.452068Z"
}

Transaction Attributes

Attributes

reference

string

Financial institution's internal reference for this transaction.

valueDate

datetime

Date representing the moment the transaction is considered effective.

executionDate

datetime

Date representing the moment the transaction has been recorded.

currency

string

Currency of the transaction, in ISO4217 format.

counterpart

string

Counterpart's account IBAN number.

communication

string

Description of the transaction, as received by the financial institution.

amount

number

Transaction amount, can be positive or negative.

Example
{
  "reference": "6025dae7-559e-4795-951a-2214cb9530ef",
  "valueDate": "2017-05-22T00:00:00Z",
  "executionDate": "2017-05-25T00:00:00Z",
  "currency": "EUR",
  "counterpart": "BE9786154282554",
  "communication": "Small Cotton Shoes",
  "amount": 42.42
}

Transaction Relationships

Available relationships

account

object

Link to the account that this transaction belongs to.

financialInstitution

object

Link to the financial institution who hosts the specified account.

Example
{
  "account": {
    "data": {
      "id": "d174c19f-136c-4dcc-9f0d-26b937bc4c1d",
      "type": "account"
    },
    "links": {
      "related": "https://api.ibanity.com/customers/d9aa5419-6a35-4e33-a98b-15a85107ab96/accounts/d174c19f-136c-4dcc-9f0d-26b937bc4c1d"
    }
  },
  "financialInstitution": {
    "data": {
      "id": "dc8d746f-68ff-40d0-98a3-86ba8322d33d",
      "type": "financial-institution"
    },
    "links": {
      "related": "https://api.ibanity.com/financial-institutions/dc8d746f-68ff-40d0-98a3-86ba8322d33d"
    }
  }
}

List Transactions

Parameters

customerUuid

string

Specifies the UUID of the customer you would like to fetch the transactions from.

accountUuid

string

Specifies the UUID of the customer account you would like to fetch the transactions from.

Arguments

limit

integer

Specifies the number of transaction resources that you want to be returned.

before

uuid

Specify a UUID to tell from which cursor the API should fetch the transaction resources. Will return transactions synchronized before the one with that UUID.

after

uuid

Specify a UUID to tell from which cursor the API should fetch the transaction resources. Will return transactions synchronized after the one with that UUID.

Definition
GET https://api.ibanity.com/customers/{customerUuid}/accounts/{accountUuid}/transactions
Example request
$ curl -X GET --cert appcert.pfx:passwd https://api.ibanity.com/customers/8f618811-2488-4d36-91b1-ed636ca72b58/accounts/30923957-87cc-42cf-ae3c-ad0563cec3d3/transactions
Returns

Returns a list of transaction resources.

Example response
{
  "meta": {
    "paging": {
      "limit": 2,
      "before": "d500ddac-27e8-447b-b0a1-dbca8c181b99",
      "after": "80cdb338-0da8-4039-863c-b108943c1e22"
    }
  },
  "links": {
    "first": "https://api.ibanity.com/customers/8f618811-2488-4d36-91b1-ed636ca72b58/accounts/30923957-87cc-42cf-ae3c-ad0563cec3d3/transactions"
  },
  "data": [
    {
      "id": "fd1790d4-78a6-4779-90a9-81e9b3667996",
      "type": "transaction",
      "meta": {
        "synchronizedAt": "2017-05-25T07:57:21.452068Z",
      },
      "attributes": {
        "valueDate": "2017-05-22T00:00:00Z",
        "reference": "6025dae7-559e-4795-951a-2214cb9530ef",
        "executionDate": "2017-05-25T00:00:00Z",
        "currency": "EUR",
        "counterpart": "BE9786154282554",
        "communication": "Small Cotton Shoes",
        "amount": 42.42
      },
      "relationships": {
        "account": {
          "links": {
            "related": "https://api.ibanity.com/customers/8f618811-2488-4d36-91b1-ed636ca72b58/accounts/30923957-87cc-42cf-ae3c-ad0563cec3d3"
          },
          "data": {
            "type": "account",
            "id": "30923957-87cc-42cf-ae3c-ad0563cec3d3"
          }
        }
      },
      "links": {
        "self": "https://api.ibanity.com/customers/8f618811-2488-4d36-91b1-ed636ca72b58/accounts/30923957-87cc-42cf-ae3c-ad0563cec3d3/transactions/fd1790d4-78a6-4779-90a9-81e9b3667996"
      }
    },
    ...
  ]
}

Get Transaction

Parameters

customerUuid

string

Specifies the UUID of the customer you would like to fetch the transactions from.

accountUuid

string

Specifies the UUID of the customer account you would like to fetch the transactions from.

uuid

string

UUID of the transaction to be retrived

Definition
GET https://api.ibanity.com/customers/{customerUuid}/accounts/{accountUuid}/transactions/{uuid}
Example request
$ curl -X GET --cert appcert.pfx:passwd https://api.ibanity.com/customers/8f618811-2488-4d36-91b1-ed636ca72b58/accounts/30923957-87cc-42cf-ae3c-ad0563cec3d3/transactions/b23c4af4-73f9-4a62-818c-593d6395520d
Returns

Returns the specified transaction resource or 404 if not found.

Example response
{
  "data": {
    "id": "b23c4af4-73f9-4a62-818c-593d6395520d",
    "type": "transaction",
    "meta": {
      "synchronizedAt": "2017-05-25T07:57:21.452068Z",
    },
    "attributes": {
      "valueDate": "2017-05-22T00:00:00Z",
      "reference": "6025dae7-559e-4795-951a-2214cb9530ef",
      "executionDate": "2017-05-25T00:00:00Z",
      "currency": "EUR",
      "counterpart": "BE9786154282554",
      "communication": "Mud boots",
      "amount": 24.24
    },
    "relationships": {
      "account": {
        "links": {
          "related": "https://api.ibanity.com/customers/8f618811-2488-4d36-91b1-ed636ca72b58/accounts/30923957-87cc-42cf-ae3c-ad0563cec3d3"
        },
        "data": {
          "type": "account",
          "id": "30923957-87cc-42cf-ae3c-ad0563cec3d3"
        }
      }
    },
    links: {
      self: "https://api.ibanity.com/customers/8f618811-2488-4d36-91b1-ed636ca72b58/accounts/30923957-87cc-42cf-ae3c-ad0563cec3d3/transactions/b23c4af4-73f9-4a62-818c-593d6395520d"
    }
  }
}

List Customer Transactions

Arguments

customerUuid

uuid

Specifies which customer you'd like to get the transactions from.

Arguments

limit

integer

Specifies the number of transaction resources that you want to be returned.

before

uuid

Specify a UUID to tell from which cursor the API should fetch the transaction resources. Will return transactions synchronized before the one with that UUID.

after

uuid

Specify a UUID to tell from which cursor the API should fetch the transaction resources. Will return transactions synchronized after the one with that UUID.

Definition
GET https://api.ibanity.com/customers/{customerUuid}/transactions
Example request
$ curl -X GET --cert appcert.pfx:passwd https://api.ibanity.com/customers/8f618811-2488-4d36-91b1-ed636ca72b58/transactions?limit=2
Returns

Returns a list of transaction resources.

Example response
{
  "meta": {
    "paging": {
      "limit": 2,
      "before": "d500ddac-27e8-447b-b0a1-dbca8c181b99",
      "after": "80cdb338-0da8-4039-863c-b108943c1e22"
    }
  },
  "links": {
    "first": "https://api.ibanity.com/customers/8f618811-2488-4d36-91b1-ed636ca72b58/transactions"
  },
  "data": [
    {
      "id": "fd1790d4-78a6-4779-90a9-81e9b3667996",
      "type": "transaction",
      "meta": {
        "synchronizedAt": "2017-05-25T07:57:21.452068Z",
      },
      "attributes": {
        "valueDate": "2017-05-22T00:00:00Z",
        "reference": "6025dae7-559e-4795-951a-2214cb9530ef",
        "executionDate": "2017-05-25T00:00:00Z",
        "currency": "EUR",
        "counterpart": "BE9786154282554",
        "communication": "Small Cotton Shoes",
        "amount": 42.42
      },
      "relationships": {
        "account": {
          "links": {
            "related": "https://api.ibanity.com/customers/8f618811-2488-4d36-91b1-ed636ca72b58/accounts/30923957-87cc-42cf-ae3c-ad0563cec3d3"
          },
          "data": {
            "type": "account",
            "id": "30923957-87cc-42cf-ae3c-ad0563cec3d3"
          }
        }
      },
      "links": {
        "self": "https://api.ibanity.com/customers/8f618811-2488-4d36-91b1-ed636ca72b58/accounts/30923957-87cc-42cf-ae3c-ad0563cec3d3/transactions/fd1790d4-78a6-4779-90a9-81e9b3667996"
      }
    },
    ...
  ]
}

List Application Transactions

Parameters

limit

integer

Specifies the number of transaction resources that you want to be returned.

before

uuid

Specify a UUID to tell from which cursor the API should fetch the transaction resources. Will return all transactions created before the specified of default limit before the one with that UUID.

after

uuid

Specify a UUID to tell from which cursor the API should fetch the transaction resources. Will return all transactions created after the specified of default limit before the one with that UUID.

Definition
GET https://api.ibanity.com/transactions
Example request
$ curl -X GET --cert appcert.pfx:passwd https://api.ibanity.com/transactions?limit=2
Returns

Returns a list of transaction resources.

Example response
{
  "meta": {
    "paging": {
      "limit": 2,
      "before": "d500ddac-27e8-447b-b0a1-dbca8c181b99",
      "after": "80cdb338-0da8-4039-863c-b108943c1e22"
    }
  },
  "links": {
    "first": "https://api.ibanity.com/transactions"
  },
  "data": [
    {
      "id": "fd1790d4-78a6-4779-90a9-81e9b3667996",
      "type": "transaction",
      "meta": {
        "synchronizedAt": "2017-05-25T07:57:21.452068Z",
      },
      "attributes": {
        "valueDate": "2017-05-22T00:00:00Z",
        "reference": "6025dae7-559e-4795-951a-2214cb9530ef",
        "executionDate": "2017-05-25T00:00:00Z",
        "currency": "EUR",
        "counterpart": "BE9786154282554",
        "communication": "Small Cotton Shoes",
        "amount": 42.42
      },
      "relationships": {
        "account": {
          "links": {
            "related": "https://api.ibanity.com/customers/8f618811-2488-4d36-91b1-ed636ca72b58/accounts/30923957-87cc-42cf-ae3c-ad0563cec3d3"
          },
          "data": {
            "type": "account",
            "id": "30923957-87cc-42cf-ae3c-ad0563cec3d3"
          }
        }
      },
      "links": {
        "self": "https://api.ibanity.com/customers/8f618811-2488-4d36-91b1-ed636ca72b58/accounts/30923957-87cc-42cf-ae3c-ad0563cec3d3/transactions/fd1790d4-78a6-4779-90a9-81e9b3667996"
      }
    },
    ...
  ]
}

Customer

This is an object representing a platform customer. This object will give you basic details about a customer.

From this object, you can link back to its accounts, transactions and authorizations.

The Customer Object

Attributes

id

string

Unique identifier for the customer.

type

string

Resource type. Will always be customer for customer resource.

attributes

object

Attributes of the current resource. Check customer_attributes reference for more details.

relationships

object

Related resource relationships. Check customer_relationships reference for more details.

links

object

Current resource links. Check links object reference for more details.

Example
{
  "id": "fe767e93-d419-4f16-aefe-12c2c525f75b",
  "type": "customer",
  "attributes": {
    "phoneNumber": "+14458259968",
    "email": "janis1965@okeefe.org",
    "createdAt": "2017-05-19T15:20:03.688660Z"
  },
  "relationships": {
    "transactions": {
      "links": {
        "related": "https://api.ibanity.com/customers/fe767e93-d419-4f16-aefe-12c2c525f75b/transactions"
      }
    },
    "authorizations": {
      "links": {
        "related": "https://api.ibanity.com/customers/fe767e93-d419-4f16-aefe-12c2c525f75b/authorizations"
      }
    },
    "accounts": {
      "links": {
        "related": "https://api.ibanity.com/customers/fe767e93-d419-4f16-aefe-12c2c525f75b/accounts"
      }
    }
  },
  "links": {
    "self": "https://api.ibanity.com/customers/fe767e93-d419-4f16-aefe-12c2c525f75b"
  }
}

Customer Attributes

Attributes

phoneNumber

string

Customer's phone number

email

string

Email entered by the customer at authorization.

createdAt

datetime

The date and time when this customer was created. Formatted according to ISO8601 spec.

Example
{
  "phoneNumber": "+14458259968",
  "email": "janis1965@okeefe.org",
  "createdAt": "2017-05-19T15:20:03.688660Z"
}

Customer Relationships

Available relationships

transactions

object

Link to the customer's transactions.

authorizations

object

Link to the list of authorizations this customer has made through ibanity.

accounts

object

Link to the list of accounts authorized from this customer.

Example
{
  "transactions": {
    "links": {
      "related": "https://api.ibanity.com/customers/fe767e93-d419-4f16-aefe-12c2c525f75b/transactions"
    }
  },
  "authorizations": {
    "links": {
      "related": "https://api.ibanity.com/customers/fe767e93-d419-4f16-aefe-12c2c525f75b/authorizations"
    }
  },
  "accounts": {
    "links": {
      "related": "https://api.ibanity.com/customers/fe767e93-d419-4f16-aefe-12c2c525f75b/accounts"
    }
  }
}

List Customers

Arguments

limit

integer

Specifies the number of customer resources that you want to be returned.

before

uuid

Specify a UUID to tell from which cursor the API should fetch the customer resources. Will return customers before the one with that UUID.

after

uuid

Specify a UUID to tell from which cursor the API should fetch the customer resources. Will return customers after the one with that UUID.

Definition
GET https://api.ibanity.com/customers
Example request
$ curl -X GET --cert appcert.pfx:passwd https://api.ibanity.com/customers?limit=2
Returns

Returns a list of customer resources.

Example response
{
  "meta": {
    "paging": {
      "limit": 2,
      "before": "d500ddac-27e8-447b-b0a1-dbca8c181b99",
      "after": "80cdb338-0da8-4039-863c-b108943c1e22"
    }
  },
  "links": {
    "first": "https://api.ibanity.com/customers"
  },
  "data": [
    {
      "id": "fe767e93-d419-4f16-aefe-12c2c525f75b",
      "type": "customer",
      "attributes": {
        "phoneNumber": "+14458259968",
        "email": "janis1965@example.org",
        "createdAt": "2017-05-19T15:20:03.688660Z"
      },
      "relationships": {
        "transactions": {
          "links": {
            "related": "https://api.ibanity.com/customers/fe767e93-d419-4f16-aefe-12c2c525f75b/transactions"
          }
        },
        "authorizations": {
          "links": {
            "related": "https://api.ibanity.com/customers/fe767e93-d419-4f16-aefe-12c2c525f75b/authorizations"
          }
        },
        "accounts": {
          "links": {
            "related": "https://api.ibanity.com/customers/fe767e93-d419-4f16-aefe-12c2c525f75b/accounts"
          }
        }
      },
      "links": {
        "self": "https://api.ibanity.com/customers/fe767e93-d419-4f16-aefe-12c2c525f75b"
      }
    },
    ...
  ]
}

Get Customer

Parameters

uuid

string

UUID of the customer to be retrived

Definition
GET https://api.ibanity.com/customers/{uuid}
Example request
$ curl -X GET --cert appcert.pfx:passwd https://api.ibanity.com/customers/8fabbecc-3ab7-40ff-b46b-3f93e475435c
Returns

Returns the specified customer resource or 404 if not found.

Example response
{
  "data": {
    "id": "fe767e93-d419-4f16-aefe-12c2c525f75b",
    "type": "customer",
    "attributes": {
      "phoneNumber": "+14458259968",
      "email": "janis1965@example.org",
      "createdAt": "2017-05-19T15:20:03.688660Z"
    },
    "relationships": {
      "transactions": {
        "links": {
          "related": "https://api.ibanity.com/customers/fe767e93-d419-4f16-aefe-12c2c525f75b/transactions"
        }
      },
      "authorizations": {
        "links": {
          "related": "https://api.ibanity.com/customers/fe767e93-d419-4f16-aefe-12c2c525f75b/authorizations"
        }
      },
      "accounts": {
        "links": {
          "related": "https://api.ibanity.com/customers/fe767e93-d419-4f16-aefe-12c2c525f75b/accounts"
        }
      }
    },
    "links": {
      "self": "https://api.ibanity.com/customers/fe767e93-d419-4f16-aefe-12c2c525f75b"
    }
  }
}

Delete Customer

Use this to notify that your user has left your platform. This will notify ibanity that this customer no longer wants to use your service.

Parameters

uuid

string

UUID of the customer to delete

Definition
DELETE https://api.ibanity.com/customers/{uuid}
Example request
$ curl -X DELETE --cert appcert.pfx:passwd https://api.ibanity.com/customers/8fabbecc-3ab7-40ff-b46b-3f93e475435c
Returns

Returns a hash with the deleted resource identifier.

Example response
{
  "data": {
    "id":   "8fabbecc-3ab7-40ff-b46b-3f93e475435c",
    "type": "customer"
  }
}

Financial Institution

This is an object representing a financial institution. This object will give you basic details for this institution.

The Financial Institution Object

Attributes

id

string

Unique identifier for the institution.

type

string

Type of the resource, will always be financialInstitution for financial institution resource.

Example
{
  "id": "fd1790d4-78a6-4779-90a9-81e9b3667996",
  "type": "financialInstitution",
  "attributes": {
    "name": "WonderFin",
    "sandbox": true
  },
  "links": {
    "self": "http://api.ibanity.com/financialInstitutions/8f618811-2488-4d36-91b1-ed636ca72b58"
  }
}

Financial Institution Attributes

Attributes

name

string

Name of the financial institution.

sandbox

boolean

Says if this bank is a sandbox bank or the real deal.

Example
{
  "name": "WonderFin",
  "sandbox": true
}

List Financial Institutions

Arguments

limit

integer

Specifies the number of authorization resources that you want to be returned.

before

uuid

Specify a UUID to tell from which cursor the API should fetch the authorization resources. Will return authorizations created before the one with that UUID.

after

uuid

Specify a UUID to tell from which cursor the API should fetch the authorization resources. Will return authorizations created after the one with that UUID.

Definition
GET https://api.ibanity.com/financial-institutions
Example request
$ curl -X GET --cert appcert.pfx:passwd https://api.ibanity.com/financial-institutions?limit=2
Returns

Returns a list of financial institution resources.

Example response
{
  "meta": {
    "paging": {
      "limit": 2,
      "before": "d500ddac-27e8-447b-b0a1-dbca8c181b99",
      "after": "80cdb338-0da8-4039-863c-b108943c1e22"
    }
  },
  "links": {
    "first": "https://api.ibanity.com/financial-institutions"
  },
  "data": [
    {
      "id": "fd1790d4-78a6-4779-90a9-81e9b3667996",
      "type": "financialInstitution",
      "attributes": {
        "name": "WonderFin",
        "sandbox": true
      },
      "links": {
        self: "http://api.ibanity.com/financial-institutions/8f618811-2488-4d36-91b1-ed636ca72b58"
      }
    },
    ...
  ]
}

Get Financial Institution

Arguments

uuid

string

UUID of the institution to be retrived

Definition
GET https://api.ibanity.com/financial-institutions/{uuid}
Example request
$ curl -X GET --cert appcert.pfx:passwd https://api.ibanity.com/financial-institutions/97dbf0b9-1fbf-4bc4-913f-2458b100f529
Returns

Returns a financial institution resource or a 404.

Example response
{
  "data": {
    "id": "97dbf0b9-1fbf-4bc4-913f-2458b100f529",
    "type": "financialInstitution",
    "attributes": {
      "name": "SuperBank",
      "sandbox": true
    },
    "links": {
      "self": "http://api.ibanity.com/financial-institutions/97dbf0b9-1fbf-4bc4-913f-2458b100f529"
    }
  }
}

Authorization

This is an object representing the authorization that the customer gave a platform for a specific account. This object will give you basic details of an authorization.

From this object, you can link back to its account and customer.

The Authorization Object

Attributes

id

string

Unique identifier for the authorization.

attributes

object

Attributes of the current resource. Check authorization_attributes reference for more details.

type

string

Type of the resource, will always be authorization for authorization resource.

relationships

object

Related resource relationships. Check customer_relationships reference for more details.

Example
{
  "id": "f7b2f338-4cba-43c5-9aeb-fee45f8922f0",
  "type": "authorization",
  "attributes": {
    "createdAt": "2017-05-22T08:07:10.608981Z"
  },
  "relationships": {
    "customer": {
      "links": {
        "related": "http://api.ibanity.com/customers/20b96a3a-f361-4d48-b1f7-2566f096dd8c"
      },
      "data": {
        "type": "customer",
        "id": "20b96a3a-f361-4d48-b1f7-2566f096dd8c"
      }
    },
    "account": {
      "links": {
        "related": "http://api.ibanity.com/customers/20b96a3a-f361-4d48-b1f7-2566f096dd8c/accounts/48079401-1da4-4db9-b872-11a409e45dda"
      },
      "data": {
        "type": "account",
        "id": "48079401-1da4-4db9-b872-11a409e45dda"
      }
    }
  }
}

Authorization Attributes

Attributes

createdAt

datetime

The date and time when this authorization was created. Formatted according to ISO8601 spec.

Example
{
  "createdAt": "2017-05-22T00:00:00Z"
}

Authorization Relationships

Available relationships

customer

object

Link to the customer that initiated the authorization.

account

object

Link to the account authorized.

Example
{
  "customer": {
    "links": {
      "related": "http://api.ibanity.com/customers/20b96a3a-f361-4d48-b1f7-2566f096dd8c"
    },
    "data": {
      "type": "customer",
      "id": "20b96a3a-f361-4d48-b1f7-2566f096dd8c"
    }
  },
  "account": {
    "links": {
      "related": "http://api.ibanity.com/customers/20b96a3a-f361-4d48-b1f7-2566f096dd8c/accounts/48079401-1da4-4db9-b872-11a409e45dda"
    },
    "data": {
      "type": "account",
      "id": "48079401-1da4-4db9-b872-11a409e45dda"
    }
  }
}

List Authorizations

Parameters

customerUuid

uuid

Specifies for which customer you want the authorizations.

Arguments

limit

integer

Specifies the number of authorization resources that you want to be returned.

before

uuid

Specify a UUID to tell from which cursor the API should fetch the authorization resources. Will return authorizations created before the one with that UUID.

after

uuid

Specify a UUID to tell from which cursor the API should fetch the authorization resources. Will return authorizations created after the one with that UUID.

Definition
GET https://api.ibanity.com/customers/{customerUuid}/authorizations
Example request
$ curl -X GET --cert appcert.pfx:passwd https://api.ibanity.com/customers/20b96a3a-f361-4d48-b1f7-2566f096dd8c/authorizations?limit=2
Returns

Returns a list of authorization resources.

Example response
{
  "meta": {
    "paging": {
      "limit": 2,
      "before": "d500ddac-27e8-447b-b0a1-dbca8c181b99",
      "after": "80cdb338-0da8-4039-863c-b108943c1e22"
    }
  },
  "links": {
    "first": "https://api.ibanity.com/customers/20b96a3a-f361-4d48-b1f7-2566f096dd8c/authorizations"
  },
  "data": [
    {
      "id": "f7b2f338-4cba-43c5-9aeb-fee45f8922f0",
      "type": "authorization",
      "attributes": {
        "createdAt": "2017-05-22T08:07:10.608981Z"
      },
      "relationships": {
        "customer": {
          "links": {
            "related": "http://api.ibanity.com/customers/20b96a3a-f361-4d48-b1f7-2566f096dd8c"
          },
          "data": {
            "type": "customer",
            "id": "20b96a3a-f361-4d48-b1f7-2566f096dd8c"
          }
        },
        "account": {
          "links": {
            "related": "http://api.ibanity.com/customers/20b96a3a-f361-4d48-b1f7-2566f096dd8c/accounts/48079401-1da4-4db9-b872-11a409e45dda"
          },
          "data": {
            "type": "account",
            "id": "48079401-1da4-4db9-b872-11a409e45dda"
          }
        }
      }
    },
    ...
  ]
}

Get Authorization

Parameters

customerUuid

uuid

Specifies for which customer you want the authorizations.

uuid

uuid

UUID of the authorization to be retrived

Definition
GET https://api.ibanity.com/customers/{customerUuid}/authorizations/{uuid}
Example request
$ curl -X GET --cert appcert.pfx:passwd https://api.ibanity.com/customers/fe767e93-d419-4f16-aefe-12c2c525f75b/authorizations/fe767e93-d419-4f16-aefe-12c2c525f75b
Returns

Returns the specified authorization resource or 404 if not found.

Example response
{
  "data": {
    "id": "f7b2f338-4cba-43c5-9aeb-fee45f8922f0",
    "type": "authorization",
    "attributes": {
      "createdAt": "2017-05-22T08:07:10.608981Z"
    },
    "relationships": {
      "customer": {
        "links": {
          "related": "http://api.ibanity.com/customers/20b96a3a-f361-4d48-b1f7-2566f096dd8c"
        },
        "data": {
          "type": "customer",
          "id": "20b96a3a-f361-4d48-b1f7-2566f096dd8c"
        }
      },
      "account": {
        "links": {
          "related": "http://api.ibanity.com/customers/20b96a3a-f361-4d48-b1f7-2566f096dd8c/accounts/48079401-1da4-4db9-b872-11a409e45dda"
        },
        "data": {
          "type": "account",
          "id": "48079401-1da4-4db9-b872-11a409e45dda"
        }
      }
    }
  }
}

Delete Authorization

Use this method when your user revokes authorization to an account on your platform.

Parameters

customerUuid

uuid

Specifies for which customer you want the authorizations.

uuid

uuid

UUID of the customer to be retrived

Definition
DELETE https://api.ibanity.com/customers/{customerUuid}/authorizations/{uuid}
Example request
$ curl -X DELETE --cert appcert.pfx:passwd https://api.ibanity.com/customers/fe767e93-d419-4f16-aefe-12c2c525f75b/authorizations/fe767e93-d419-4f16-aefe-12c2c525f75b
Returns

Returns a hash with the deleted resource identifier.

Example response
{
  "data": {
    "id": "fe767e93-d419-4f16-aefe-12c2c525f75b",
    "type": "authorization"
  }
}

Synchronization

As accounts and transactions are not synchronized automatically, when you want it to happen, you will have to use the synchronizations resource.

It represents a request to synchronize and has a status. It can be pending when the synchronization has been queued for execution, running during execution, done when it succeeded, or failed in case we couldn't connect to the financial institution to fetch the updated data.

The Synchronization Object

Attributes

id

string

Unique identifier for the synchronization.

type

string

Resource type. Will always be synchronization for synchronization resource.

attributes

object

Attributes of the current resource. Check synchronization_attributes reference for more details.

relationships

object

Related resource relationships. Check synchronization_relationships reference for more details.

links

object

Current resource links. Check links object reference for more details.

Example
{
  "id": "3c135acd-0cb7-4368-a985-240db7cf983c",
  "type": "synchronization",
  "attributes": {
    "status": "done",
    "duration": 150,
    "createdAt": "2017-05-26T14:04:42.186616Z",
    "updatedAt": "2017-05-26T14:04:42.186616Z"
  },
  "relationships": {
    "customer": {
      "links": {
        "related": "https://api.ibanity.com/customers/75fbe473-fde1-4c44-b9c5-faafde664cd7"
      },
      "data": {
        "id": "75fbe473-fde1-4c44-b9c5-faafde664cd7",
        "type": "customer"
      }
    }
  },
  "links": {
    "self": "https://api.ibanity.com/customers/75fbe473-fde1-4c44-b9c5-faafde664cd7/synchronizations/3c135acd-0cb7-4368-a985-240db7cf983c"
  }
}

Synchronization Attributes

Attributes

status

string

Either one of pending, running, done, failed

duration

integer

The duration in milliseconds of this synchronization

createdAt

datetime

The date and time when this synchronization was created. Formatted according to ISO8601 spec.

updatedAt

datetime

The date and time when this synchronization was updated. Formatted according to ISO8601 spec.

Example
{
  "status": "pending",
  "duration": 150,
  "createdAt": "2017-05-26T14:04:42.186616Z",
  "updatedAt": "2017-05-26T14:04:42.186616Z"
}

Synchronization Relationships

Available relationships

customer

object

Link to the associated customer.

Example
{
  "customer": {
    "links": {
      "related": "https://api.ibanity.com/customers/75fbe473-fde1-4c44-b9c5-faafde664cd7"
    },
    "data": {
      "id": "75fbe473-fde1-4c44-b9c5-faafde664cd7",
      "type": "customer"
    }
  }
}

Trigger Synchronization

Arguments

customerUuid

uuid

UUID of the customer to synchronize transactions for.

Definition
POST https://api.ibanity.com/customers/{customerUuid}/synchronizations
Example request
$ curl -X POST --cert appcert.pfx:passwd https://api.ibanity.com/customers/75fbe473-fde1-4c44-b9c5-faafde664cd7/synchronizations
Returns

Returns a synchronization resource with 202 status code.

Example response
{
  "data": {
    "id": "3c135acd-0cb7-4368-a985-240db7cf983c",
    "type": "synchronization",
    "attributes": {
    "status": "pending",
    "duration": 0,
    "createdAt": "2017-05-26T14:04:42.186616Z",
    "updatedAt": "2017-05-26T14:04:42.186616Z"
  },
  "relationships": {
    "customer": {
      "links": {
        "related": "https://api.ibanity.com/customers/75fbe473-fde1-4c44-b9c5-faafde664cd7"
      },
      "data": {
        "id": "75fbe473-fde1-4c44-b9c5-faafde664cd7",
        "type": "customer"
      }
    }
  },
  "links": {
    "self": "https://api.ibanity.com/customers/75fbe473-fde1-4c44-b9c5-faafde664cd7/synchronizations/3c135acd-0cb7-4368-a985-240db7cf983c"
  }
}

Get Synchronization

In order to know when a synchronization is done, you will have to use long polling on this route.

Parameters

uuid

string

UUID of the synchronization to be retrived

Definition
GET https://api.ibanity.com/synchronizations/{uuid}
Example request
$ curl -X GET --cert appcert.pfx:passwd https://api.ibanity.com/synchronizations/5e9e71f6-17d0-4f68-aca0-35ad838490c9
Returns

Returns the specified synchronization resource or 404 if not found.

Example response
{
  "data": {
    "id": "3c135acd-0cb7-4368-a985-240db7cf983c",
    "type": "synchronization",
    "attributes": {
    "status": "done",
    "duration": 150,
    "createdAt": "2017-05-26T14:04:42.186616Z",
    "updatedAt": "2017-05-26T14:04:42.186616Z"
  },
  "relationships": {
    "customer": {
      "links": {
        "related": "https://api.ibanity.com/customers/75fbe473-fde1-4c44-b9c5-faafde664cd7"
      },
      "data": {
        "id": "75fbe473-fde1-4c44-b9c5-faafde664cd7",
        "type": "customer"
      }
    }
  },
  "links": {
    "self": "https://api.ibanity.com/customers/75fbe473-fde1-4c44-b9c5-faafde664cd7/synchronizations/3c135acd-0cb7-4368-a985-240db7cf983c"
  }
}

Sandbox Account

This is an object representing a sandbox account. It is a fake account you can create for test purposes.

From this object, you can follow the link to its list of sandbox transactions that will be composed of several types of banking operations, as well as the sandbox user that is associated to it.

The Account Object

Attributes

id

string

Unique identifier for the account.

type

string

Resource type. Will always be sandboxAccount for this resource.

attributes

object

Attributes of the current resource. Check sandbox_account_attributes reference for more details.

relationships

object

Related resource relationships. Check sandbox_account_relationships reference for more details.

links

object

Current resource links. Check links object reference for more details.

Example
{
  "id": "49c5f439-3abe-44ae-a46a-f047245dda87",
  "type": "sandboxAccount",
  "attributes": {
  "subtype": "checking",
  "relationship": "owner",
  "iban": "BE123456679",
  "description": "Checking account",
  "currency": "EUR",
  "balance": 56.42,
  "createdAt": "2017-05-26T14:04:42.186616Z",
  "updatedAt": "2017-05-26T14:04:42.199663Z"
  },
  "relationships": {
    "sandboxTransactions": {
      "links": {
        "related": "https://api.ibanity.com/sandbox/financial-institutions/cd1790d4-78a6-4779-90a9-81e9b3667996/users/bd1790d4-78a6-4779-90a9-81e9b3667996/accounts/ad1790d4-78a6-4779-90a9-81e9b3667996/transactions"
      }
    },
    "sanboxUser": {
      "links": {
        "related": "https://api.ibanity.com/sandbox/users/293df907-1c00-47f5-b0d8-7a3dd35a18c4"
      },
      "data": {
        "type": "sandboxUser",
        "id": "293df907-1c00-47f5-b0d8-7a3dd35a18c4"
      }
    },
    "financialInstitution": {
      "links": {
        "related": "https://api.ibanity.com/financial-institutions/393df907-1c00-47f5-b0d8-7a3dd35a18c4"
      },
      "data": {
        "type": "financialInstitution",
        "id": "393df907-1c00-47f5-b0d8-7a3dd35a18c4"
      }
    }
  },
  "links": {
    "self": "https://api.ibanity.com/sandbox/financial-institutions/cd1790d4-78a6-4779-90a9-81e9b3667996/users/bd1790d4-78a6-4779-90a9-81e9b3667996/accounts/ad1790d4-78a6-4779-90a9-81e9b3667996"
  }
}

Sandbox Account Attributes

Attributes

subtype

string

Resource subtype. Can be checking or savings.

relationship

string

What relationship the sandbox user has towards this account. Can be owner or trustee.

iban

string

Account's IBAN number.

description

string

Description of the account.

currency

string

Currency of the account, in ISO4217 format.

balance

number

Current balance of the account.

createdAt

datetime

When this account was created. Formatted according to ISO8601 spec.

updatedAt

datetime

When this account was updated last. Formatted according to ISO8601 spec.

Example
{
  "subtype": "checking",
  "relationship": "owner",
  "iban": "BE123456679",
  "description": "Checking account",
  "currency": "EUR",
  "balance": 56.42,
  "createdAt": "2017-05-26T14:04:42.186616Z",
  "updatedAt": "2017-05-26T14:04:42.199663Z"
}

Sandbox Account Relationships

Available relationships

sandboxTransactions

object

Link to the list of sandboxTransactions for this account.

sandboxUser

object

Link to the associated sandboxUser.

financialInstitution

object

Link to the associated financial institution.

Example
{
  "sandboxTransactions": {
    "links": {
      "related": "https://api.ibanity.com/sandbox/financial-institutions/cd1790d4-78a6-4779-90a9-81e9b3667996/users/bd1790d4-78a6-4779-90a9-81e9b3667996/accounts/ad1790d4-78a6-4779-90a9-81e9b3667996/transactions"
    }
  },
  "sanboxUser": {
    "links": {
      "related": "https://api.ibanity.com/sandbox/users/293df907-1c00-47f5-b0d8-7a3dd35a18c4"
    },
    "data": {
      "type": "sandboxUser",
      "id": "293df907-1c00-47f5-b0d8-7a3dd35a18c4"
    }
  },
  "financialInstitution": {
    "links": {
      "related": "https://api.ibanity.com/financial-institutions/393df907-1c00-47f5-b0d8-7a3dd35a18c4"
    },
    "data": {
      "type": "financialInstitution",
      "id": "393df907-1c00-47f5-b0d8-7a3dd35a18c4"
    }
  }
}

List Sandbox Accounts

Parameters

financialInstitutionUuid

string

Specifies the UUID of the financial institution from which you would like to fetch the accounts from.

sandboxUserUuid

string

Specifies the UUID of sandboxUser from which you would like to fetch the accounts from.

Arguments

limit

integer

Specifies the number of account resources that you want to be returned.

before

uuid

Specify a UUID to tell from which cursor the API should fetch the account resources. Will return all accounts under the specified of default limit before the one with that UUID.

after

uuid

Specify a UUID to tell from which cursor the API should fetch the account resources. Will return all accounts after the specified of default limit before the one with that UUID.

Definition
GET https://api.ibanity.com/sandbox/financial-institutions/{financialInstitutionUuid}/users/{sandboxUserUuid}/accounts
Example request
$ curl -X GET --cert appcert.pfx:passwd https://api.ibanity.com/sandbox/financial-institutions/811b48e4-082d-4c76-aa6c-94d8b44332bb/users/293df907-1c00-47f5-b0d8-7a3dd35a18c4/accounts?limit=2
Returns

Returns a list of sandbox account resources.

Example response
{
  "meta": {
    "paging": {
      "limit": 2,
      "before": "d500ddac-27e8-447b-b0a1-dbca8c181b99",
      "after": "80cdb338-0da8-4039-863c-b108943c1e22"
    }
  },
  "links": {
    "first": "https://api.ibanity.com/sandbox/financial-institutions/811b48e4-082d-4c76-aa6c-94d8b44332bb/users/293df907-1c00-47f5-b0d8-7a3dd35a18c4/accounts"
  },
  "data": [
    {
      "id": "49c5f439-3abe-44ae-a46a-f047245dda87",
      "type": "sandboxAccount",
      "attributes": {
        "subtype": "checking",
        "relationship": "owner",
        "iban": "BE123456679",
        "description": "Checking account",
        "currency": "EUR",
        "balance": 56.42,
        "createdAt": "2017-05-26T14:04:42.186616Z",
        "updatedAt": "2017-05-26T14:04:42.199663Z"
      },
      "relationships": {
        "sandboxTransactions": {
          "links": {
            "related": "https://api.ibanity.com/sandbox/financial-institutions/cd1790d4-78a6-4779-90a9-81e9b3667996/users/bd1790d4-78a6-4779-90a9-81e9b3667996/accounts/49c5f439-3abe-44ae-a46a-f047245dda87/transactions"
          }
        },
        "sanboxUser": {
          "links": {
            "related": "https://api.ibanity.com/sandbox/users/bd1790d4-78a6-4779-90a9-81e9b3667996"
          },
          "data": {
            "type": "sandboxUser",
            "id": "293df907-1c00-47f5-b0d8-7a3dd35a18c4"
          }
        }
      },
      "links": {
        "self": "https://api.ibanity.com/sandbox/financial-institutions/cd1790d4-78a6-4779-90a9-81e9b3667996/users/bd1790d4-78a6-4779-90a9-81e9b3667996/accounts/49c5f439-3abe-44ae-a46a-f047245dda87"
      }
    },
    ...
  ]
}

List Sandbox User Accounts

Parameters

sandboxUserUuid

string

Specifies the UUID of sandboxUser from which you would like to fetch the accounts from.

Arguments

limit

integer

Specifies the number of account resources that you want to be returned.

before

uuid

Specify a UUID to tell from which cursor the API should fetch the account resources. Will return all accounts under the specified of default limit before the one with that UUID.

after

uuid

Specify a UUID to tell from which cursor the API should fetch the account resources. Will return all accounts after the specified of default limit before the one with that UUID.

Definition
GET https://api.ibanity.com/sandbox/users/{sandboxUserUuid}/accounts
Example request
$ curl -X GET --cert appcert.pfx:passwd https://api.ibanity.com/sandbox/users/293df907-1c00-47f5-b0d8-7a3dd35a18c4/accounts
Returns

Returns a list of sandbox account resources.

Example response
{
  "meta": {
    "paging": {
      "limit": 2,
      "before": "d500ddac-27e8-447b-b0a1-dbca8c181b99",
      "after": "80cdb338-0da8-4039-863c-b108943c1e22"
    }
  },
  "links": {
    "first": "https://api.ibanity.com/sandbox/financial-institutions/811b48e4-082d-4c76-aa6c-94d8b44332bb/users/293df907-1c00-47f5-b0d8-7a3dd35a18c4/accounts"
  },
  "data": [
    {
      "id": "49c5f439-3abe-44ae-a46a-f047245dda87",
      "type": "sandboxAccount",
      "attributes": {
        "subtype": "checking",
        "relationship": "owner",
        "iban": "BE123456679",
        "description": "Checking account",
        "currency": "EUR",
        "balance": 56.42,
        "createdAt": "2017-05-26T14:04:42.186616Z",
        "updatedAt": "2017-05-26T14:04:42.199663Z"
      },
      "relationships": {
        "sandboxTransactions": {
          "links": {
            "related": "https://api.ibanity.com/sandbox/financial-institutions/cd1790d4-78a6-4779-90a9-81e9b3667996/users/bd1790d4-78a6-4779-90a9-81e9b3667996/accounts/49c5f439-3abe-44ae-a46a-f047245dda87/transactions"
          }
        },
        "sanboxUser": {
          "links": {
            "related": "https://api.ibanity.com/sandbox/users/bd1790d4-78a6-4779-90a9-81e9b3667996"
          },
          "data": {
            "type": "sandboxUser",
            "id": "293df907-1c00-47f5-b0d8-7a3dd35a18c4"
          }
        }
      },
      "links": {
        "self": "https://api.ibanity.com/sandbox/financial-institutions/cd1790d4-78a6-4779-90a9-81e9b3667996/users/bd1790d4-78a6-4779-90a9-81e9b3667996/accounts/49c5f439-3abe-44ae-a46a-f047245dda87"
      }
    },
    ...
  ]
}

Get Sandbox Account

Parameters

financialInstitutionUuid

string

UUID of the account's financial institution.

sandboxUserUuid

string

UUID of the user linked to this account.

uuid

string

UUID of the sandbox account to be retrived

Definition
GET https://api.ibanity.com/sandbox/financial-institutions/{financialInstitutionUuid}/users/{sandboxUserUuid}/accounts/{uuid}
Example request
$ curl -X GET --cert appcert.pfx:passwd https://api.ibanity.com/sandbox/financial-institutions/cd1790d4-78a6-4779-90a9-81e9b3667996/users/bd1790d4-78a6-4779-90a9-81e9b3667996/accounts/49c5f439-3abe-44ae-a46a-f047245dda87
Returns

Returns the specified account resource or 404 if not found.

Example response
{
  "data": {
    "id": "64537245-8895-47e0-890f-deab42a4a69c",
    "type": "sandboxAccount",
    "attributes": {
      "subtype": "savings",
      "relationship": "owner",
      "iban": "BE456789012",
      "description": "Savings account",
      "currency": "EUR",
      "balance": 67.89,
      "createdAt": "2017-05-26T14:04:42.186616Z",
      "updatedAt": "2017-05-26T14:04:42.199663Z"
    },
    "relationships": {
      "sandboxTransactions": {
        "links": {
          "related": "https://api.ibanity.com/sandbox/financial-institutions/cd1790d4-78a6-4779-90a9-81e9b3667996/users/bd1790d4-78a6-4779-90a9-81e9b3667996/accounts/64537245-8895-47e0-890f-deab42a4a69c/transactions"
        }
      },
      "sanboxUser": {
        "links": {
          "related": "https://api.ibanity.com/sandbox/users/293df907-1c00-47f5-b0d8-7a3dd35a18c4"
        },
        "data": {
          "type": "sandboxUser",
          "id": "293df907-1c00-47f5-b0d8-7a3dd35a18c4"
        }
      }
    },
    "links": {
      "self": "https://api.ibanity.com/sandbox/financial-institutions/cd1790d4-78a6-4779-90a9-81e9b3667996/users/bd1790d4-78a6-4779-90a9-81e9b3667996/accounts/6f159fa1-372a-4bd1-b20d-4f62f4ed17b2"
    }
  }
}

Create Sandbox Account

Parameters

financialInstitutionUuid

string

UUID of the transaction's account financial institution.

sandboxUserUuid

string

UUID of the user linked to this transaction's account.

Arguments

type

string
required

Specifies the type of resource that is created, in this case sandboxAccount

attributes

object
required

Account attributes, check following section for more information.

Attributes

subtype

string

Resource subtype. Can be checking or savings.

relationship

string
required

What relationship the sandbox user has towards this account. Can be owner or trustee.

iban

string
required

Account's IBAN number.

description

string
required

Description of the account.

currency

string
required

Currency of the account, in ISO4217 format.

balance

number
required

Current balance of the account.

Definition
POST https://api.ibanity.com/sandbox/financial-institutions/{financialInstitutionUuid}/users/{userUuid}/accounts/{accountUuid}/transactions
Example request
$ curl -X POST -H "Content-Type: application/json" --cert appcert.pfx:passwd https://api.ibanity.com/sandbox/users/293df907-1c00-47f5-b0d8-7a3dd35a18c4/transactions -d "@payload.json"
Example request payload.json
{
  "data": {
    "type": "sandboxAccount",
    "attributes": {
      "subtype": "checking",
      "relationship": "owner",
      "iban": "BE456789012",
      "description": "Savings account",
      "currency": "EUR",
      "balance": 67.89
    }
  }
}
Returns

Returns a list of account resources.

Example response
{
  "data": {
    "id": "64537245-8895-47e0-890f-deab42a4a69c",
    "type": "sandboxAccount",
    "attributes": {
      "subtype": "savings",
      "relationship": "owner",
      "iban": "BE456789012",
      "description": "Savings account",
      "currency": "EUR",
      "balance": 67.89,
      "createdAt": "2017-05-26T14:04:42.186616Z",
      "updatedAt": "2017-05-26T14:04:42.199663Z",
    },
    "relationships": {
      "sandboxTransactions": {
        "links": {
          "related": "https://api.ibanity.com/sandbox/financial-institutions/cd1790d4-78a6-4779-90a9-81e9b3667996/users/bd1790d4-78a6-4779-90a9-81e9b3667996/accounts/64537245-8895-47e0-890f-deab42a4a69c/transactions"
        }
      },
      "sanboxUser": {
        "links": {
          "related": "https://api.ibanity.com/sandbox/users/293df907-1c00-47f5-b0d8-7a3dd35a18c4"
        },
        "data": {
          "type": "sandboxUser",
          "id": "293df907-1c00-47f5-b0d8-7a3dd35a18c4"
        }
      }
    },
    "links": {
      "self": "https://api.ibanity.com/sandbox/financial-institutions/cd1790d4-78a6-4779-90a9-81e9b3667996/users/bd1790d4-78a6-4779-90a9-81e9b3667996/accounts/6f159fa1-372a-4bd1-b20d-4f62f4ed17b2"
    }
  }
}

Delete Sandbox Account

Arguments

financialInstitutionUuid

string

UUID of the account's financial institution.

sandboxUserUuid

string

UUID of the user linked to this account.

uuid

string

UUID of the sandbox account to be deleted

Definition
DELETE https://api.ibanity.com/sandbox/financial-institutions/{financialInstitutionUuid}/users/{userUuid}/accounts/{uuid}
Example request
$ curl -X DELETE --cert appcert.pfx:passwd https://api.ibanity.com/sandbox/financial-institutions/cd1790d4-78a6-4779-90a9-81e9b3667996/users/bd1790d4-78a6-4779-90a9-81e9b3667996/accounts/49c5f439-3abe-44ae-a46a-f047245dda87
Returns

Returns a hash with the deleted resource identifier.

Example response
{
  "data": {
    "type": "sandboxAccount",
    "id":   "49c5f439-3abe-44ae-a46a-f047245dda87"
  }
}

Sandbox Transaction

This is an object representing a sandbox transaction. It is a fake transaction from a fake account you can create for test purposes.

From this object, you can follow the link to its related sandbox account

The Sandbox Transaction Object

Attributes

id

string

Unique identifier for the transaction.

type

string

Resource type. Will always be sandboxTransaction for this resource.

attributes

object

Attributes of the current resource. Check sandbox_transaction_attributes reference for more details.

relationships

object

Related resource relationships. Check sandbox_transaction_relationships reference for more details.

links

object

Current resource links. Check links object reference for more details.

Example
{
  "id": "fd1790d4-78a6-4779-90a9-81e9b3667996",
  "type": "sandboxTransaction",
  "links": {
    "self": "http://api.ibanity.com/sandbox/financial-institutions/cd1790d4-78a6-4779-90a9-81e9b3667996/users/bd1790d4-78a6-4779-90a9-81e9b3667996/accounts/ad1790d4-78a6-4779-90a9-81e9b3667996/transactions/fd1790d4-78a6-4779-90a9-81e9b3667995"
  },
  "attributes": {
    "valueDate": "2017-05-22T00:00:00Z",
    "executionDate": "2017-05-25T00:00:00Z",
    "counterpart": "BE9786154282554",
    "communication": "Small Cotton Shoes",
    "amount": 6.99,
    "currency": "EUR",
    "createdAt": "2017-05-26T14:04:42.186616Z",
    "updatedAt": "2017-05-26T14:04:42.199663Z"
  },
  "relationships": {
    "sandboxAccount": {
      "links": {
        "related": "http://api.ibanity.com/sandbox/financial-institutions/cd1790d4-78a6-4779-90a9-81e9b3667996/users/bd1790d4-78a6-4779-90a9-81e9b3667996/accounts/ad1790d4-78a6-4779-90a9-81e9b3667996"
      },
      "data": {
        "type": "sandboxAccount",
        "id": "30923957-87cc-42cf-ae3c-ad0563cec3d3"
      }
    }
  }
}

Sandbox transaction Attributes

Attributes

valueDate

datetime

Date representing the moment the transaction is considered effective.

executionDate

datetime

Date representing the moment the transaction has been recorded.

currency

string

Currency of the transaction, in ISO4217 format.

counterpart

string

Counterpart's account IBAN number.

communication

string

Description of the transaction, as received by the financial institution.

amount

number

Transaction amount, can be positive or negative.

createdAt

datetime

When this transaction was created. Formatted according to ISO8601 spec.

updatedAt

datetime

When this transaction was updated last. Formatted according to ISO8601 spec.

Example
{
  "valueDate": "2017-05-22T00:00:00Z",
  "executionDate": "2017-05-25T00:00:00Z",
  "currency": "EUR",
  "counterpart": "BE9786154282554",
  "communication": "Small Cotton Shoes",
  "amount": 6.99,
  "createdAt": "2017-05-26T14:04:42.186616Z",
  "updatedAt": "2017-05-26T14:04:42.199663Z"
}

Sandbox Transaction Relationships

Available relationships

sandboxAccount

object

Link to the account this transaction belongs to.

Example
{
  "sandboxAccount": {
    "links": {
      "related": "http://api.ibanity.com/sandbox/financial-institutions/cd1790d4-78a6-4779-90a9-81e9b3667996/users/bd1790d4-78a6-4779-90a9-81e9b3667996/accounts/ad1790d4-78a6-4779-90a9-81e9b3667996"
    },
    "data": {
      "type": "sandboxAccount",
      "id": "30923957-87cc-42cf-ae3c-ad0563cec3d3"
    }
  }
}

List Sandbox Transactions

Parameters

financialInstitutionUuid

string

Specifies the UUID of the financial institution from which you would like to fetch the transactions from.

sandboxUserUuid

string

Specifies the UUID of sandboxUser from which you would like to fetch the transactions from.

sandboxAccountUuid

string

Specifies the UUID of the sandboxAccount from which you would like to fetch the transactions from.

Arguments

limit

integer

Specifies the number of transaction resources that you want to be returned.

before

uuid

Specify a UUID to tell from which cursor the API should fetch the transaction resources. Will return all transactions created before the specified UUID.

after

uuid

Specify a UUID to tell from which cursor the API should fetch the transaction resources. Will return all transactions created after the specified UUID.

Definition
GET https://api.ibanity.com/sandbox/financial-institutions/{financialInstitutionUuid}/users/{sandboxUserUuid}/account/{sendboxAccountUuid}/transactions
Example request
$ curl -X GET --cert appcert.pfx:passwd https://api.ibanity.com/sandbox/financial-institutions/811b48e4-082d-4c76-aa6c-94d8b44332bb/users/293df907-1c00-47f5-b0d8-7a3dd35a18c4/accounts/30923957-87cc-42cf-ae3c-ad0563cec3d3/transactions
Returns

Returns a list of sandbox transaction resources.

Example response
{
  "meta": {
    "paging": {
      "limit": 2,
      "before": "d500ddac-27e8-447b-b0a1-dbca8c181b99",
      "after": "80cdb338-0da8-4039-863c-b108943c1e22"
    }
  },
  "links": {
    "first": "https://api.ibanity.com/sandbox/financial-institutions/811b48e4-082d-4c76-aa6c-94d8b44332bb/users/293df907-1c00-47f5-b0d8-7a3dd35a18c4/accounts"
  },
  "data": [
    {
      "id": "fd1790d4-78a6-4779-90a9-81e9b3667996",
      "type": "sandboxTransaction",
      "links": {
        "self": "http://api.ibanity.com/sandbox/financial-institutions/cd1790d4-78a6-4779-90a9-81e9b3667996/users/bd1790d4-78a6-4779-90a9-81e9b3667996/accounts/ad1790d4-78a6-4779-90a9-81e9b3667996/transactions/fd1790d4-78a6-4779-90a9-81e9b3667995"
      },
      "attributes": {
        "valueDate": "2017-05-22T00:00:00Z",
        "executionDate": "2017-05-25T00:00:00Z",
        "counterpart": "BE9786154282554",
        "communication": "Small Cotton Shoes Ltd.",
        "amount": 6.99,
        "currency": "EUR",
        "createdAt": "2017-05-26T14:04:42.186616Z",
        "updatedAt": "2017-05-26T14:04:42.199663Z"
      },
      "relationships": {
        "sandboxAccount": {
          "links": {
            "related": "http://api.ibanity.com/sandbox/financial-institutions/cd1790d4-78a6-4779-90a9-81e9b3667996/users/bd1790d4-78a6-4779-90a9-81e9b3667996/accounts/ad1790d4-78a6-4779-90a9-81e9b3667996"
          },
          "data": {
            "type": "sandboxAccount",
            "id": "30923957-87cc-42cf-ae3c-ad0563cec3d3"
          }
        }
      }
    },
    ...
  ]
}

List Sandbox User Transactions

Parameters

sandboxUserUuid

string

Specifies the UUID of sandboxUser from which you would like to fetch the transactions from.

Arguments

limit

integer

Specifies the number of transaction resources that you want to be returned.

before

uuid

Specify a UUID to tell from which cursor the API should fetch the transaction resources. Will return all transactions created before the specified UUID.

after

uuid

Specify a UUID to tell from which cursor the API should fetch the transaction resources. Will return all transactions created after the specified UUID.

Definition
GET https://api.ibanity.com/sandbox/users/{sandboxUserUuid}/transactions
Example request
$ curl -X GET --cert appcert.pfx:passwd https://api.ibanity.com/sandbox/users/293df907-1c00-47f5-b0d8-7a3dd35a18c4/transactions
Returns

Returns a list of sandbox transaction resources.

Example response
{
  "meta": {
    "paging": {
      "limit": 2,
      "before": "d500ddac-27e8-447b-b0a1-dbca8c181b99",
      "after": "80cdb338-0da8-4039-863c-b108943c1e22"
    }
  },
  "links": {
    "first": "https://api.ibanity.com/sandbox/financial-institutions/811b48e4-082d-4c76-aa6c-94d8b44332bb/users/293df907-1c00-47f5-b0d8-7a3dd35a18c4/accounts"
  },
  "data": [
    {
      "id": "fd1790d4-78a6-4779-90a9-81e9b3667996",
      "type": "sandboxTransaction",
      "links": {
        "self": "http://api.ibanity.com/sandbox/financial-institutions/cd1790d4-78a6-4779-90a9-81e9b3667996/users/bd1790d4-78a6-4779-90a9-81e9b3667996/accounts/ad1790d4-78a6-4779-90a9-81e9b3667996/transactions/fd1790d4-78a6-4779-90a9-81e9b3667995"
      },
      "attributes": {
        "valueDate": "2017-05-22T00:00:00Z",
        "executionDate": "2017-05-25T00:00:00Z",
        "counterpart": "BE9786154282554",
        "communication": "Small Cotton Shoes Ltd.",
        "amount": 6.99,
        "currency": "EUR",
        "createdAt": "2017-05-26T14:04:42.186616Z",
        "updatedAt": "2017-05-26T14:04:42.199663Z",
      },
      "relationships": {
        "sandboxAccount": {
          "links": {
            "related": "http://api.ibanity.com/sandbox/financial-institutions/cd1790d4-78a6-4779-90a9-81e9b3667996/users/bd1790d4-78a6-4779-90a9-81e9b3667996/accounts/ad1790d4-78a6-4779-90a9-81e9b3667996"
          },
          "data": {
            "type": "sandboxAccount",
            "id": "30923957-87cc-42cf-ae3c-ad0563cec3d3"
          }
        }
      }
    },
    ...
  ]
}

Get Sandbox transaction

Parameters

financialInstitutionUuid

string

UUID of the account's financial institution.

sandboxUserUuid

string

UUID of the user linked to this account.

sandboxAccountUuid

string

UUID of the account that this transaction belongs to.

uuid

string

UUID of the sandbox transaction to be retrived

Definition
GET https://api.ibanity.com/sandbox/financial-institutions/{financialInstitutionUuid}/users/{sandboxUserUuid}/accounts/{sandboxAccountUuid}/transactions/{uuid}
Example request
$ curl -X GET --cert appcert.pfx:passwd https://api.ibanity.com/sandbox/financial-institutions/cd1790d4-78a6-4779-90a9-81e9b3667996/users/bd1790d4-78a6-4779-90a9-81e9b3667996/accounts/49c5f439-3abe-44ae-a46a-f047245dda87/transactions/1134eaca-0d68-4d5d-a114-4bf80f03d701
Returns

Returns the specified transaction resource or 404 if not found.

Example response
{
  "data": {
    "id": "1134eaca-0d68-4d5d-a114-4bf80f03d701",
    "type": "sandboxTransaction",
    "links": {
      "self": "http://api.ibanity.com/sandbox/financial-institutions/cd1790d4-78a6-4779-90a9-81e9b3667996/users/bd1790d4-78a6-4779-90a9-81e9b3667996/accounts/ad1790d4-78a6-4779-90a9-81e9b3667996/transactions/1134eaca-0d68-4d5d-a114-4bf80f03d701"
    },
    "attributes": {
      "valueDate": "2017-05-22T00:00:00Z",
      "executionDate": "2017-05-25T00:00:00Z",
      "counterpart": "BE9786154282554",
      "communication": "Big boots barn",
      "amount": 32.99,
      "currency": "EUR",
      "createdAt": "2017-05-26T14:04:42.186616Z",
      "updatedAt": "2017-05-26T14:04:42.199663Z",
    },
    "relationships": {
      "sandboxAccount": {
        "links": {
          "related": "http://api.ibanity.com/sandbox/financial-institutions/cd1790d4-78a6-4779-90a9-81e9b3667996/users/bd1790d4-78a6-4779-90a9-81e9b3667996/accounts/ad1790d4-78a6-4779-90a9-81e9b3667996"
        },
        "data": {
          "type": "sandboxAccount",
          "id": "30923957-87cc-42cf-ae3c-ad0563cec3d3"
        }
      }
    }
  }
}

Create Sandbox transaction

Parameters

financialInstitutionUuid

string

UUID of the transaction's account financial institution.

sandboxUserUuid

string

UUID of the user linked to this transaction's account.

sandboxAccountUuid

string

UUID of the account that this transaction belongs to.

Arguments

type

string
required

Specifies the type of resource that is created, in this case sandboxTransaction

attributes

object
required

Transaction attributes, check following section for more information.

Attributes

valueDate

datetime
required

Date representing the moment the transaction is considered effective.

executionDate

datetime
required

Date representing the moment the transaction has been recorded.

currency

string
required

Currency of the transaction, in ISO4217 format.

counterpart

string
required

Counterpart's account IBAN number.

communication

string
required

Description of the transaction, as received by the financial institution.

amount

number
required

Transaction amount, can be positive or negative.

Definition
POST https://api.ibanity.com/sandbox/financial-institutions/{financialInstitutionUuid}/users/{userUuid}/accounts/{accountUuid}/transactions
Example request
$ curl -X POST -H "Content-Type: application/json" --cert appcert.pfx:passwd https://api.ibanity.com/sandbox/users/293df907-1c00-47f5-b0d8-7a3dd35a18c4/transactions -d "@payload.json"
Example request payload.json
{
  "data": {
    "type": "sandboxTransaction",
    "attributes": {
      "valueDate": "2017-05-22T00:00:00Z",
      "executionDate": "2017-05-25T00:00:00Z",
      "counterpart": "BE9786154282554",
      "communication": "Hole foods",
      "amount": 84.42,
      "currency": "EUR"
    }
  }
}
Returns

Returns a sandbox transaction resources.

Example response
{
  "data": {
    "id": "1134eaca-0d68-4d5d-a114-4bf80f03d701",
    "type": "sandboxTransaction",
    "links": {
      "self": "http://api.ibanity.com/sandbox/financial-institutions/cd1790d4-78a6-4779-90a9-81e9b3667996/users/bd1790d4-78a6-4779-90a9-81e9b3667996/accounts/ad1790d4-78a6-4779-90a9-81e9b3667996/transactions/1134eaca-0d68-4d5d-a114-4bf80f03d701"
    },
    "attributes": {
      "valueDate": "2017-05-22T00:00:00Z",
      "executionDate": "2017-05-25T00:00:00Z",
      "counterpart": "BE9786154282554",
      "communication": "Hole foods",
      "amount": 84.42,
      "currency": "EUR",
      "createdAt": "2017-05-26T14:04:42.186616Z",
      "updatedAt": "2017-05-26T14:04:42.199663Z",
    },
    "relationships": {
      "sandboxAccount": {
        "links": {
          "related": "http://api.ibanity.com/sandbox/financial-institutions/cd1790d4-78a6-4779-90a9-81e9b3667996/users/bd1790d4-78a6-4779-90a9-81e9b3667996/accounts/ad1790d4-78a6-4779-90a9-81e9b3667996"
        },
        "data": {
          "type": "sandboxAccount",
          "id": "30923957-87cc-42cf-ae3c-ad0563cec3d3"
        }
      }
    }
  }
}

Delete Sandbox Transaction

Arguments

financialInstitutionUuid

string

UUID of the account's financial institution.

sandboxUserUuid

string

UUID of the user linked to this account.

accountUuuid

string

UUID of the sandbox account linked to this transaction.

uuid

string

UUID of the transaction to delete.

Definition
DELETE https://api.ibanity.com/sandbox/financial-institutions/{financialInstitutionUuid}/users/{userUuid}/accounts/{accountUuid}/transactions/{uuid}
Example request
$ curl -X DELETE --cert appcert.pfx:passwd https://api.ibanity.com/sandbox/financial-institutions/cd1790d4-78a6-4779-90a9-81e9b3667996/users/bd1790d4-78a6-4779-90a9-81e9b3667996/accounts/49c5f439-3abe-44ae-a46a-f047245dda87/transactions/1134eaca-0d68-4d5d-a114-4bf80f03d701
Returns

Returns a hash with the deleted resource identifier.

Example response
{
  "data": {
    "type": "sandboxTransaction",
    "id":   "1134eaca-0d68-4d5d-a114-4bf80f03d701"
  }
}

Sandbox User

This is an object representing a sandbox user. It is a fake financial institution client you can create for test purposes.

From this object, you can follow the links to its related sandbox accounts and transactions.

The Sandbox User Object

Attributes

id

string

Unique identifier for the user.

type

string

Resource type. Will always be sandboxUser for this resource.

attributes

object

Attributes of the current resource. Check sandbox_user_attributes reference for more details.

relationships

object

Related resource relationships. Check sandbox_user_relationships reference for more details.

links

object

Current resource links. Check links object reference for more details.

Example
{
  "id": "8625d265-1dd4-494a-8851-e55b52a49152",
  "type": "sandboxUser",
  "attributes": {
    "login": "ocorwin",
    "password": "password",
    "lastName": "Corwin",
    "firstName": "Octavia",
    "createdAt": "2017-05-26T14:04:42.186616Z",
    "updatedAt": "2017-05-26T14:04:42.199663Z"
  },
  "relationships": {
    "sandboxAccounts": {
      "links": {
        "related": "http://api.ibanity.com/sandbox/users/8625d265-1dd4-494a-8851-e55b52a49152/accounts"
      }
    },
    "sandboxTransactions": {
      "links": {
        "related": "http://api.ibanity.com/sandbox/users/8625d265-1dd4-494a-8851-e55b52a49152/transactions"
      }
    }
  },
  "links": {
    "self": "http://api.ibanity.com/sandbox/users/8625d265-1dd4-494a-8851-e55b52a49152"
  }
}

Sandbox User Attributes

Attributes

login

string

The user's fake financial institution login.

password

string

The user's fake financial institution login. Remenber these are test data, so the password is stored and distributed unencrypted.

firstName

string

First name of this user.

lastName

string

Last name of this user.

createdAt

datetime

When this user was created. Formatted according to ISO8601 spec.

updatedAt

datetime

When this user was updated last. Formatted according to ISO8601 spec.

Example
{
  "login": "ocorwin",
  "password": "password",
  "lastName": "Corwin",
  "firstName": "Octavia",
  "createdAt": "2017-05-26T14:04:42.186616Z",
  "updatedAt": "2017-05-26T14:04:42.199663Z"
}

Sandbox User Relationships

Available relationships

sandboxAccounts

object

Link to the accounts owned by this user.

sandboxTransactions

object

Link to the transactions of this user's accounts.

Example
{
  "sandboxAccounts": {
    "links": {
      "related": "http://api.ibanity.com/sandbox/users/8625d265-1dd4-494a-8851-e55b52a49152/accounts"
    }
  },
  "sandboxTransactions": {
    "links": {
      "related": "http://api.ibanity.com/sandbox/users/8625d265-1dd4-494a-8851-e55b52a49152/transactions"
    }
  }
}

List Sandbox Users

Parameters

No parameters

Arguments

limit

integer

Specifies the number of user resources that you want to be returned.

before

uuid

Specify a UUID to tell from which cursor the API should fetch the user resources. Will return all users created before the specified UUID.

after

uuid

Specify a UUID to tell from which cursor the API should fetch the user resources. Will return all users created after the specified UUID.

Definition
GET https://api.ibanity.com/sandbox/users
Example request
$ curl -X GET --cert appcert.pfx:passwd https://api.ibanity.com/sandbox/users
Returns

Returns a list of sandbox user resources.

Example response
{
  "meta": {
    "paging": {
      "limit": 2,
      "before": "d500ddac-27e8-447b-b0a1-dbca8c181b99",
      "after": "80cdb338-0da8-4039-863c-b108943c1e22"
    }
  },
  "links": {
    "first": "https://api.ibanity.com/sandbox/financial-institutions/811b48e4-082d-4c76-aa6c-94d8b44332bb/users/293df907-1c00-47f5-b0d8-7a3dd35a18c4/accounts"
  },
  "data": [
    {
      "id": "8625d265-1dd4-494a-8851-e55b52a49152",
      "type": "sandboxUser",
      "attributes": {
        "login": "ocorwin",
        "password": "password",
        "lastName": "Corwin",
        "firstName": "Octavia",
        "createdAt": "2017-05-26T14:04:42.186616Z",
        "updatedAt": "2017-05-26T14:04:42.199663Z"
      },
      "relationships": {
        "sandboxAccounts": {
          "links": {
            "related": "http://api.ibanity.com/sandbox/users/8625d265-1dd4-494a-8851-e55b52a49152/accounts"
          }
        },
        "sandboxTransactions": {
          "links": {
            "related": "http://api.ibanity.com/sandbox/users/8625d265-1dd4-494a-8851-e55b52a49152/transactions"
          }
        }
      },
      "links": {
        "self": "http://api.ibanity.com/sandbox/users/8625d265-1dd4-494a-8851-e55b52a49152"
      }
    },
    ...
  ]
}

Get Sandbox User

Parameters

uuid

string

UUID of the sandbox user to be retrived

Definition
GET https://api.ibanity.com/sandbox/users/{uuid}
Example request
$ curl -X GET --cert appcert.pfx:passwd https://api.ibanity.com/sandbox/users/1942b502-12f2-47e4-987b-a77a77ffe09d
Returns

Returns the specified user resource or 404 if not found.

Example response
{
  "data": {
    "id": "1942b502-12f2-47e4-987b-a77a77ffe09d",
    "type": "sandboxUser",
    "attributes": {
      "login": "msmith",
      "password": "password",
      "lastName": "Smith",
      "firstName": "Matt",
      "createdAt": "2017-05-26T14:04:42.186616Z",
      "updatedAt": "2017-05-26T14:04:42.199663Z"
    },
    "relationships": {
      "sandboxAccounts": {
        "links": {
          "related": "http://api.ibanity.com/sandbox/users/1942b502-12f2-47e4-987b-a77a77ffe09d/accounts"
        }
      },
      "sandboxTransactions": {
        "links": {
          "related": "http://api.ibanity.com/sandbox/users/1942b502-12f2-47e4-987b-a77a77ffe09d/transactions"
        }
      }
    },
    "links": {
      "self": "http://api.ibanity.com/sandbox/users/1942b502-12f2-47e4-987b-a77a77ffe09d"
    }
  }
}

Create Sandbox User

Parameters

No parameters

Arguments

type

string
required

Specifies the type of resource that is created, in this case sandboxUser.

attributes

object
required

User attributes, check following section for more information.

Attributes

login

string
required

User's login.

password

string
required

User's password. As it is only for test purposes, sandbox user password is stored unencrypted.

firstName

string
required

User's first name.

lastName

string
required

User's last name.

Definition
POST https://api.ibanity.com/sandbox/users
Example request
$ curl -X POST -H "Content-Type: application/json" --cert appcert.pfx:passwd https://api.ibanity.com/sandbox/users -d "@payload.json"
Example request payload.json
{
  "data": {
    "type": "sandboxUser",
    "attributes": {
      "login": "msmith",
      "password": "password",
      "lastName": "Smith",
      "firstName": "Matt"
    }
  }
}
Returns

Returns a sandbox user resource.

Example response
{
  "data": {
    "id": "1942b502-12f2-47e4-987b-a77a77ffe09d",
    "type": "sandboxUser",
    "attributes": {
      "login": "msmith",
      "password": "password",
      "lastName": "Smith",
      "firstName": "Matt",
      "createdAt": "2017-05-26T14:04:42.186616Z",
      "updatedAt": "2017-05-26T14:04:42.199663Z"
    },
    "relationships": {
      "sandboxAccounts": {
        "links": {
          "related": "http://api.ibanity.com/sandbox/users/1942b502-12f2-47e4-987b-a77a77ffe09d/accounts"
        }
      },
      "sandboxTransactions": {
        "links": {
          "related": "http://api.ibanity.com/sandbox/users/1942b502-12f2-47e4-987b-a77a77ffe09d/transactions"
        }
      }
    },
    "links": {
      "self": "http://api.ibanity.com/sandbox/users/1942b502-12f2-47e4-987b-a77a77ffe09d"
    }
  }
}

Update Sandbox User

Parameters

uuid

string

UUID of the user to delete.

Arguments

type

string
required

Specifies the type of resource that will be updated, in this case sandboxUser.

attributes

object
required

User attributes, check following section for more information.

Attributes

login

string
required

User's login.

password

string
required

User's password. As it is only for test purposes, sandbox user password is stored unencrypted.

firstName

string
required

User's first name.

lastName

string
required

User's last name.

Definition
PATCH https://api.ibanity.com/sandbox/users/{uuid}
Example request
$ curl -X PATCH -H "Content-Type: application/json" --cert appcert.pfx:passwd https://api.ibanity.com/sandbox/users/1942b502-12f2-47e4-987b-a77a77ffe09d -d "@payload.json"
Example request payload.json
{
  "data": {
    "type": "sandboxUser",
    "attributes": {
      "login": "msmith",
      "password": "password",
      "lastName": "John",
      "firstName": "Doe"
    }
  }
}
Returns

Returns a sandbox user resource.

Example response
{
  "data": {
    "id": "1942b502-12f2-47e4-987b-a77a77ffe09d",
    "type": "sandboxUser",
    "attributes": {
      "login": "msmith",
      "password": "password",
      "lastName": "John",
      "firstName": "Doe",
      "createdAt": "2017-05-26T14:04:42.186616Z",
      "updatedAt": "2017-05-26T14:04:42.199663Z"
    },
    "relationships": {
      "sandboxAccounts": {
        "links": {
          "related": "http://api.ibanity.com/sandbox/users/1942b502-12f2-47e4-987b-a77a77ffe09d/accounts"
        }
      },
      "sandboxTransactions": {
        "links": {
          "related": "http://api.ibanity.com/sandbox/users/1942b502-12f2-47e4-987b-a77a77ffe09d/transactions"
        }
      }
    },
    "links": {
      "self": "http://api.ibanity.com/sandbox/users/1942b502-12f2-47e4-987b-a77a77ffe09d"
    }
  }
}

Delete Sandbox User

Arguments

uuid

string

UUID of the user to delete.

Definition
DELETE https://api.ibanity.com/sandbox/users/{uuid}
Example request
$ curl -X DELETE --cert appcert.pfx:passwd https://api.ibanity.com/sandbox/users/1942b502-12f2-47e4-987b-a77a77ffe09d
Returns

Returns a hash with the deleted resource identifier.

Example response
{
  "data": {
    "type": "sandboxUser",
    "id": "1942b502-12f2-47e4-987b-a77a77ffe09d"
  }
}

Financial Institution

This object represents a financial institution in the sandbox environment. This means it will be selectable in the connect widget and you will be allowed to create users that are clients of this fake bank, as well as fake accounts.

The object structure and attributes are exactly the same as the core financial institution resource. Please refer to the core financial institution reference for more details.

Create Financial Institution

Parameters

No parameters

Arguments

type

string
required

Specifies the type of resource that is created, in this case financialInstitution.

attributes

object
required

User attributes, check following section for more information.

Attributes

name

string
required

Financial Institution name.

Definition
POST https://api.ibanity.com/sandbox/financial-institutions
Example request
$ curl -X POST -H "Content-Type: application/json" --cert appcert.pfx:passwd https://api.ibanity.com/sandbox/financial-institutions -d "@payload.json"
Example request payload.json
{
  "data": {
    "type": "financialInstitution",
    "attributes": {
      "name": "WonderFin"
    },
  }
}
Returns

Returns a financial institution resource.

Example response
{
  "data": {
    "id": "fd1790d4-78a6-4779-90a9-81e9b3667996",
    "type": "financialInstitution",
    "attributes": {
      "name": "WonderFin",
      "sandbox": true
    },
    "links": {
      "self": "http://api.ibanity.com/financial-institutions/fd1790d4-78a6-4779-90a9-81e9b3667996"
    }
  }
}

Update Financial Institution

Parameters

uuid

string

UUID of the financial institution to update.

Arguments

type

string
required

Specifies the type of resource that will be updated, in this case financial institution.

attributes

object
required

Financial institution attributes, check following section for more information.

Attributes

name

string
required

Financial institution's name.

Definition
PATCH https://api.ibanity.com/sandbox/financial-institutions/{uuid}
Example request
$ curl -X PATCH -H "Content-Type: application/json" --cert appcert.pfx:passwd https://api.ibanity.com/sandbox/financial-institutions/fd1790d4-78a6-4779-90a9-81e9b3667996 -d "@payload.json"
Example request payload.json
{
  "data": {
    "type": "financialInstitution",
    "attributes": {
      "name": "Metabank"
    }
  }
}
Returns

Returns a financial institution resource.

Example response
{
  "data": {
    "id": "fd1790d4-78a6-4779-90a9-81e9b3667996",
    "type": "financialInstitution",
    "attributes": {
      "name": "Metabank",
      "sandbox": true
    },
    "links": {
      "self": "http://api.ibanity.com/financial-institutions/fd1790d4-78a6-4779-90a9-81e9b3667996"
    }
  }
}

Delete Financial Institution

Arguments

uuid

string

UUID of the financial institution to delete.

Definition
DELETE https://api.ibanity.com/sandbox/financial-institutions
Example request
$ curl -X DELETE --cert appcert.pfx:passwd https://api.ibanity.com/sandbox/financial-institutions/fd1790d4-78a6-4779-90a9-81e9b3667996
Returns

Returns a hash with the deleted resource identifier.

Example response
{
  "data": {
    "type": "financialInstitution",
    "id":   "fd1790d4-78a6-4779-90a9-81e9b3667996"
  }
}