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

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

Get logs list

Request

The iBanFirst API provides a log feed for every request sent allowing you to know exactly the result on our platform.

This service uses the login sent in your header as a filter to get logs about this user's actions.

Query

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/logs/?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"

createdAtstring(^((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"

closedAtstring(^((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"

tokenNoncestring

The nonce used in the HTTP header to authenticate the request.

remoteAddressstring<= 15 characters

The IP address of the request's emiter.

requestMethodstring<= 6 characters

The HTTP method of the request

uriRequestedstring

The Universal Resource Identifier given for this request.

parametersGivenstring

The optional parameters (e.g. after the ?) given for this request.

requestBodystring

The HTTP request body.

httpResponseCodenumber(int)

The HTTP response code.

responseBodystring

The text sent by the server as a result for the request.

restErrorTypeIdnumber(integer)

If there is an error during the processing the request, this id could be used to find this error.

loginstring

The login used for the request.

legalnamestring

The legal name of the client used for the request.

]

Response

application/json

[
  {
    "id": "Na5Dv6E",
    "createdAt": "2016-01-01 00:00:00",
    "closedAt": "2016-01-01 00:00:00",
    "tokenNonce": "string",
    "remoteAddress": "string",
    "requestMethod": "string",
    "uriRequested": "string",
    "parametersGiven": "string",
    "requestBody": "string",
    "httpResponseCode": 0,
    "responseBody": "string",
    "restErrorTypeId": 0,
    "login": "string",
    "legalname": "string"
  }
]

Get log details

Request

In case of somewhat happens during the request, this service API allows you to retrieve a log entry by its nonce.

Path

noncestringrequired

The nonce used to authenticate the request. As the one in the header, this nonce has to be Base64 encoded. The nonce you get with GET /logs is already encoded.

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

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"

createdAtstring(^((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"

closedAtstring(^((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"

tokenNoncestring

The nonce used in the HTTP header to authenticate the request.

remoteAddressstring<= 15 characters

The IP address of the request's emiter.

requestMethodstring<= 6 characters

The HTTP method of the request

uriRequestedstring

The Universal Resource Identifier given for this request.

parametersGivenstring

The optional parameters (e.g. after the ?) given for this request.

requestBodystring

The HTTP request body.

httpResponseCodenumber(int)

The HTTP response code.

responseBodystring

The text sent by the server as a result for the request.

restErrorTypeIdnumber(integer)

If there is an error during the processing the request, this id could be used to find this error.

loginstring

The login used for the request.

legalnamestring

The legal name of the client used for the request.

Response

application/json

{
  "id": "Na5Dv6E",
  "createdAt": "2016-01-01 00:00:00",
  "closedAt": "2016-01-01 00:00:00",
  "tokenNonce": "string",
  "remoteAddress": "string",
  "requestMethod": "string",
  "uriRequested": "string",
  "parametersGiven": "string",
  "requestBody": "string",
  "httpResponseCode": 0,
  "responseBody": "string",
  "restErrorTypeId": 0,
  "login": "string",
  "legalname": "string"
}

iBanFirst API (1.1)

Accounts

Financial movements

Beneficiaries

Payments

Trades

Documents

Logs

Get logs list

Request

Responses

Was this helpful?

Get log details

Request

Responses

Was this helpful?