Financial movements
/
Retrieve financial movements history

Client API IBANFIRST (1.1)

Download OpenAPI description
ClientAPI.json
ClientAPI.yaml
Languages
Servers
https://sandbox.ibanfirst.com/api/

Wallets

In the IBANFIRST API, what we call a "wallet" account can be either a physical iban account, or a virtual iban account with IBANFIRST. A virtual account is an administrative "subaccount" of one physical iban account (the "masteraccount"). Cash can be earmarked as belonging to a virtual account so that you can easily allocate funds per business unit, per client, or incoming/outgoing transactions).

Operations

Financial movements

The IBANFIRST Rest API allows you to get all financial movements from your Wallets.

Operations

Retrieve financial movements history

Request

Request the list of financial movements that has been received or sent on a specific period of time.

Query
walletIdstring

A wallet ID to specify to retreive only financial movements concerning this wallet.

fromDatestring(YYYY-MM-DD)

The starting date to search financial movements on your wallets.

toDatestring(YYYY-MM-DD)

The ending date to search financial movements on your wallets.

pagestring

Index of the page.

Default "1"
per_pagestring

Inumber 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

OK

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": { … }
  }
]

Retrieve 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

OK

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"
}

External bank account

In the IBANFIRST API, what we call external bank account, can be either your own account in another bank or a third party recipient account.

Operations

Payments

Sending funds from your IBANFIRST wallet account to your own bank account or a third-party recipient involves two steps:

  1. Generate the payment object with the Submit Payment method. When you submit a payment to be scheduled, you assign a unique id to that payment.
    Caution: The payment created will be automatically rolled to the next closest working days if not confirmed in the scheduled date of operation.

  2. Confirm the payment to the API for processing, using the Confirm Payment method. When you confirm a payment for processing, make sure you have sufficient funds in your wallet account balance.
    Caution: If the balance of your wallet account is not sufficient to cover the payment amount, funds may be locked-in by IBANFIRST.

Operations

Trades

IBANFIRST provides a deliverable FX facility and deliverable FX liquidity via the IBANFIRST-REST API. 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.

The IBANFIRST-rest API supports online trading for the following contracts: TOD (Same-day), TOM (next-day), SPOT (T+2) and forward contracts up to one year.

FX trades are always made between two wallet accounts of a unique counterparty. IBANFIRST will automatically debit the source wallet account and credit the delivery wallet 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 wallet 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 IBANFIRST API let you acces your online documents stored on the IBANFIRST platform.
Note that the API do not send the document content, but a one-time link to access it.
This one-time link is only available once. So if you need another access to the document, you have to request another link by listing documents or getting document result.

Operations

Logs

As a developper, you might want to go further than sending request and recieve responses.
The IBANFIRST API allows you to access the logs of its own services, to provide you some details about what you send, and what it's done on the platform.

You can retrieve informations during a certain time.
This time passed, your log entry will be lost.

HTTP MethodTime
GET1 hour
POST, PUT1 week
Operations

Auth

This service is intended to authenticate users on the API for certain cases

Operations