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

Financial movements

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

Operations

Get financial movements

Request

Retrieve a list of financial movements that has been received or sent.

Query

walletIdstring

The unique id of an account.

fromDatestring(YYYY-MM-DD)

The starting date to search financial movements on your accounts.

toDatestring(YYYY-MM-DD)

The ending date to search financial movements on your accounts.

pagestring

Index of the page.

Default "1"

per_pagestring

Number of items returned.

Default "50"

sortstring

A code representing the order of rendering objects.

Enum"ASC""DESC"

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

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"

bookingDatestring(^((19[0,99]|2[0-9]{3})\-(0[1-9]|1[012])\-([012][0-9]|3[01])\ ([01][0-9]|2[0-3])\:([0-5][0-9])\:([0-5][0-9]))$)(Datetime)^((19[0,99]|2[0-9]{3})\-(0[1-9]|1[012])\-([01...

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

Example: "2016-01-01 00:00:00"

walletIdstring(^[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"

valueDatestring(^[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"

amountobject(Amount)

Representation of an amount.

]

Response

application/json

[
  {
    "id": "Na5Dv6E",
    "bookingDate": "2016-01-01 00:00:00",
    "walletId": "Na5Dv6E",
    "valueDate": "2016-01-01",
    "amount": { … }
  }
]

Get a financial movements details

Request

Request information on a particular financial movement that has been credited or debited to a wallet. The typeLabel field may contain these values:

rejectOperation: Payment returned by the bank counterparty
DebitForExchange: Debit for an FX operation
DebitForTransfer: Debit linked to a transfer
CreditForExchange: Credit linked to an FX operation
Immobilize: Payment registered but not debited on value date
ExternalCounterpartCredit: Account credit
debitForAccountGuaranteeCredit: Movement related to the deposit for forward exchange transaction
debitAccountGuarantee: Movement related to the deposit for forward exchange transaction
internalGuaranteeTransfer: Movement related to the deposit for forward exchange transaction
corrective: Corrective
rejectCreditDepositAccount: Rejection of a flow credited to the account / after liquidation
returnFund: Payment returned by the recipient counterparty
rejectDebit: Rejection of an automatic debit on iBanFirst account (SDD)
PrepaidCardDepositAccountDebit: Initialization of a virtual payment card
PrepaidCardDepositAccountCredit: Recredit funds stored on a virtual payment card that expires
clientFee: Fees for using iBanFirst accounts
cancelClientFee: Commercial gesture
DirectDebit: Direct debit on iBanFirst account

Path

idstringrequired

The id referring the financial movement.

curl -i -X GET \
  'https://sandbox.ibanfirst.com/api/financialMovements/{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"

bookingDatestring(^[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"

valueDatestring(^[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"

orderingAccountNumberstring<= 40 characters

The number referring the ordering account of the transfer.

orderingCustomerstring

A free formatted String representing the ordering customer with it's name and it's address.

orderingInstitutionstring

A free formatted String representing the ordering institution with it's name and it's address.

orderingAmountobject(Amount)

Representation of an amount.

beneficiaryAccountNumberstring<= 40 characters

The number referring the beneficiary account.

beneficiaryCustomerstring

A free formatted String representing the beneficiary customer with it's name and it's address.

beneficiaryInstitutionstring

A free formatted String representing the beneficiary institution with it's name and it's address.

beneficiaryAmountobject(Amount)

Representation of an amount.

remittanceInformationstring

The communication field.

chargesDetailsstring

The charges details related to the transfer.

exchangeRatenumber(float)

The exchange rate applied on the transfer.

typeLabelstring

The type of the financial movement.

internalReferencestring

Internal Reference of the financial movement.

descriptionstring

Description of the financial movement.

Response

application/json

{
  "id": "Na5Dv6E",
  "bookingDate": "2016-01-01",
  "valueDate": "2016-01-01",
  "orderingAccountNumber": "string",
  "orderingCustomer": "string",
  "orderingInstitution": "string",
  "orderingAmount": {
    "value": "2.257",
    "currency": "USD"
  },
  "beneficiaryAccountNumber": "string",
  "beneficiaryCustomer": "string",
  "beneficiaryInstitution": "string",
  "beneficiaryAmount": {
    "value": "2.257",
    "currency": "USD"
  },
  "remittanceInformation": "string",
  "chargesDetails": "string",
  "exchangeRate": 0.1,
  "typeLabel": "string",
  "internalReference": "string",
  "description": "string"
}

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

Financial movements

Get financial movements

Request

Responses

Was this helpful?

Get a financial movements details

Request

Responses

Was this helpful?

Beneficiaries

Payments

Trades

Documents

Logs