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).
The wallet to create
A String representing the Three-digit ISO 4217 Currency Code of a currency. This String only contains capitalized letters.
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"
}
}
}'OK
A String representing the id of an object. This string contains alpha-numeric characters, including the capital ones.
A String representing the Three-digit ISO 4217 Currency Code of a currency. This String only contains capitalized letters.
Custom reference associated to this wallet. (For internal use only, not communicated to any beneficiary).
The code identifying the status of the account.
{ "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": { … } } }
curl -i -X GET \
'https://sandbox.ibanfirst.com/api/wallets/?page=1&per_page=50&sort=ASC'OK
A String representing the id of an object. This string contains alpha-numeric characters, including the capital ones.
A String representing the Three-digit ISO 4217 Currency Code of a currency. This String only contains capitalized letters.
A String representing a date by its year, month and day in month.
[ { "id": "Na5Dv6E", "tag": "string", "currency": "USD", "bookingAmount": { … }, "valueAmount": { … }, "dateLastFinancialMovement": "2016-01-01" } ]
curl -i -X GET \
'https://sandbox.ibanfirst.com/api/wallets/-{id}'OK
A String representing the id of an object. This string contains alpha-numeric characters, including the capital ones.
A String representing the Three-digit ISO 4217 Currency Code of a currency. This String only contains capitalized letters.
Custom reference associated to this wallet. (For internal use only, not communicated to any beneficiary).
The code identifying the status of the account.
{ "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": { … } } }
curl -i -X GET \
'https://sandbox.ibanfirst.com/api/wallets/-{id}/balance/{date}'{ "id": "Na5Dv6E", "balance": { "closingDate": "2016-01-01", "bookingAmount": { … }, "valueAmount": { … } } }
Sending funds from your IBANFIRST wallet account to your own bank account or a third-party recipient involves two steps:
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.
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.
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'.
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.
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 Method | Time |
|---|---|
| GET | 1 hour |
| POST, PUT | 1 week |