Get accounts list

iBanFirst API (1.1)

Try it out in Postman: View Postman Collection

Download OpenAPI description

Servers

https://sandbox.ibanfirst.com/api/

Accounts

Each of your accounts has its own specific currency and IBAN. The API allows you to get details and balances about each account in real time.

Note : accounts are also labelled as wallets in the iBanFirst API.

Operations

Submit a new account

Request

This request allows you to submit a new account.

Caution : The holder object in the parameters will only be considered if you suscribed to the Multi account per currency with holder account option.

Bodyapplication/jsonrequired

The account to create

currencystring(^[A-Z]{3}$)(Currency)^[A-Z]{3}$required

A String representing the Three-digit ISO 4217 Currency Code of a currency. This String only contains capitalized letters.

Example: "USD"

tagstring

Custom data.

holderobject(Holder)

What we call a Holder can be either an Individual or an Organisation that own the account. May also be referred to as: Beneficiary/Supplier/Vendor/Payee/Recipient.

In the beneficiary address, only the Country is mandatory, but you can specify all fields to be more precise.

curl -i -X POST \
  https://sandbox.ibanfirst.com/api/wallets/ \
  -H 'Content-Type: application/json' \
  -d '{
    "currency": "USD",
    "tag": "string",
    "holder": {
      "name": "string",
      "type": "Individual",
      "address": {
        "street": "string",
        "postCode": "string",
        "city": "string",
        "province": "st",
        "country": "string"
      }
    }
  }'

Responses

Bodyapplication/json

idstring(^[A-Za-z0-9]{*}$)(ID)^[A-Za-z0-9]{*}$

A String representing the id of an object. This string contains alpha-numeric characters, including the capital ones.

Example: "Na5Dv6E"

currencystring(^[A-Z]{3}$)(Currency)^[A-Z]{3}$

A String representing the Three-digit ISO 4217 Currency Code of a currency. This String only contains capitalized letters.

Example: "USD"

tagstring<= 50 characters

Custom reference associated to this wallet. (For internal use only, not communicated to any beneficiary).

statusstring

The code identifying the status of the account.

Enum"authorized""locked""not authorized"

accountNumberstring<= 40 characters

Iban or account number.

correspondentBankobject(CorrespondantBank)

Representation of a correspondant bank.

holderBankobject(HolderBank)

Representation of a beneficiary bank.

holderobject(Holder)

What we call a Holder can be either an Individual or an Organisation that own the account. May also be referred to as: Beneficiary/Supplier/Vendor/Payee/Recipient.

In the beneficiary address, only the Country is mandatory, but you can specify all fields to be more precise.

Response

application/json

{
  "id": "Na5Dv6E",
  "currency": "USD",
  "tag": "string",
  "status": "authorized",
  "accountNumber": "string",
  "correspondentBank": {
    "bic": "string",
    "name": "string",
    "address": { … }
  },
  "holderBank": {
    "bic": "string",
    "clearingCodeType": "st",
    "clearingCode": "string",
    "name": "string",
    "address": { … }
  },
  "holder": {
    "name": "string",
    "type": "Individual",
    "address": { … }
  }
}

Get accounts list

Request

This service allows you to retrieve the list of all your accounts hold with iBanFirst. The object returned in the array is a simplified version of the account details providing you main information about the account.

Query

pagestring

Index of the page.

Default "1"

per_pagestring

Number of items returned.

Default "50"

sortstring

Accounts are sorted by creation date.

Enum"ASC""DESC"

curl -i -X GET \
  'https://sandbox.ibanfirst.com/api/wallets/?page=1&per_page=50&sort=ASC'

Responses

Bodyapplication/jsonArray [

idstring(^[A-Za-z0-9]{*}$)(ID)^[A-Za-z0-9]{*}$

A String representing the id of an object. This string contains alpha-numeric characters, including the capital ones.

Example: "Na5Dv6E"

tagstring

The custom wording of the account.

currencystring(^[A-Z]{3}$)(Currency)^[A-Z]{3}$

A String representing the Three-digit ISO 4217 Currency Code of a currency. This String only contains capitalized letters.

Example: "USD"

bookingAmountobject(Amount)

Representation of an amount.

valueAmountobject(Amount)

Representation of an amount.

dateLastFinancialMovementstring(^[0-9]{4}\-[0-9]{2}\-[0-9]{2}$)(Date)^[0-9]{4}\-[0-9]{2}\-[0-9]{2}$

A String representing a date by its year, month and day in month.

Example: "2016-01-01"

]

Response

application/json

[
  {
    "id": "Na5Dv6E",
    "tag": "string",
    "currency": "USD",
    "bookingAmount": { … },
    "valueAmount": { … },
    "dateLastFinancialMovement": "2016-01-01"
  }
]

Get an account details

Request

Retrieve details about a specific account.

Path

idstringrequired

The unique id identifying your account.

Note : you may use the Get account lists service to get the unique id of your accounts.

curl -i -X GET \
  'https://sandbox.ibanfirst.com/api/wallets/{id}'

Responses

Bodyapplication/json

idstring(^[A-Za-z0-9]{*}$)(ID)^[A-Za-z0-9]{*}$

A String representing the id of an object. This string contains alpha-numeric characters, including the capital ones.

Example: "Na5Dv6E"

currencystring(^[A-Z]{3}$)(Currency)^[A-Z]{3}$

A String representing the Three-digit ISO 4217 Currency Code of a currency. This String only contains capitalized letters.

Example: "USD"

tagstring<= 50 characters

Custom reference associated to this wallet. (For internal use only, not communicated to any beneficiary).

statusstring

The code identifying the status of the account.

Enum"authorized""locked""not authorized"

accountNumberstring<= 40 characters

Iban or account number.

correspondentBankobject(CorrespondantBank)

Representation of a correspondant bank.

holderBankobject(HolderBank)

Representation of a beneficiary bank.

holderobject(Holder)

What we call a Holder can be either an Individual or an Organisation that own the account. May also be referred to as: Beneficiary/Supplier/Vendor/Payee/Recipient.

In the beneficiary address, only the Country is mandatory, but you can specify all fields to be more precise.

Response

application/json

{
  "id": "Na5Dv6E",
  "currency": "USD",
  "tag": "string",
  "status": "authorized",
  "accountNumber": "string",
  "correspondentBank": {
    "bic": "string",
    "name": "string",
    "address": { … }
  },
  "holderBank": {
    "bic": "string",
    "clearingCodeType": "st",
    "clearingCode": "string",
    "name": "string",
    "address": { … }
  },
  "holder": {
    "name": "string",
    "type": "Individual",
    "address": { … }
  }
}

Get account balance at a given date

Request

This request allows you to see the details of an account balance at a given date.

Path

idstringrequired

The unique id identifying your account.

Note : you may use the Get accounts list service to get the unique id of your accounts.

datestringrequired

The date used to retrieve the account balance.

curl -i -X GET \
  'https://sandbox.ibanfirst.com/api/wallets/{id}/balance/{date}'

Responses

Bodyapplication/json

idstring(^[A-Za-z0-9]{*}$)(ID)^[A-Za-z0-9]{*}$

A String representing the id of an object. This string contains alpha-numeric characters, including the capital ones.

Example: "Na5Dv6E"

balanceobject(Balance)

Representation of a balance.

Response

application/json

{
  "id": "Na5Dv6E",
  "balance": {
    "closingDate": "2016-01-01",
    "bookingAmount": { … },
    "valueAmount": { … }
  }
}

Financial movements

The API allows you to retrieve all financial movements from your accounts.

Operations

Beneficiaries

A beneficiary can be either your own account in another bank or a third party recipient account. Beneficiaries can be created or deleted through the API.

Note : beneficiaries are also labelled as externalBankAccounts in the iBanFirst API.

Operations

Payments

Sending funds from one of your iBanFirst accounts to your own bank account or a third-party recipient involves two steps:

Generate the payment object with the 'Submit Payment' method.
A unique id is assigned to each payment.
Use the 'Confirm Payment' method to send the payment for processing. When you confirm a payment, make sure you have sufficient funds in your account balance.

Caution:
Payments are automatically rolled to the next closest working days if not confirmed in the scheduled date of operation. If the balance of your account is not sufficient to cover the payment amount, funds may be locked-in by iBanFirst.

Operations

Trades

The API provides a deliverable FX facility and deliverable FX liquidity. You will become counterparty to iBanFirst and can market and sell deliverable FX services to corporate and private clients as well as using such services on their behalf.

FX trades are always made between two accounts of a unique counterparty. iBanFirst will automatically debit the source account and credit the delivery account at the date specified in the FX trade instructions. If the delivery date has been scheduled, the delivery is automatically processed in the morning before 00:30 am Paris time. If the delivery date is today (TOD), the funds is available on your account by the next 20mn.

A FX trades also involves an amount, which includes both the numeric amount and the currency in order to define if this amount is the nominal to be bought or sold, for example: '100000.00+GBP'.

Operations

Documents

The API allows you to access your documents stored on the iBanFirst platform through a one-time access link.

Documents must be generated on the platform before being available through the API.

Operations

Logs

Operations

iBanFirst API (1.1)

Accounts

Submit a new account

Request

Responses

Was this helpful?

Get accounts list

Request

Responses

Was this helpful?

Get an account details

Request

Responses

Was this helpful?

Get account balance at a given date

Request

Responses

Was this helpful?

Financial movements

Beneficiaries

Payments

Trades

Documents

Logs

iBanFirst API (1.1)

Accounts

Submit a new account

RequestExpand all

Responses

Was this helpful?

Get accounts list

Request

Responses

Was this helpful?

Get an account details

Request

Responses

Was this helpful?

Get account balance at a given date

Request

Responses

Was this helpful?

Financial movements

Beneficiaries

Payments

Trades

Documents

Logs

Request