Client API IBANFIRST (1.1)

Try it out in Postman: View Postman Collection

Download OpenAPI description

ClientAPI.json

ClientAPI.yaml

Servers

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

Wallets

In the IBANFIRST API, a "wallet" is a bank account for a specific currency.

Operations

Financial movements

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

Operations

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:

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.

Operations

Submit a payment

Request

You can use this request in order to schedule a new payment.

You may want to use the GET /payments/options/-{walletId}/-{externalBankAccountId}/ before calling this service to get proper values for feePaymentOption and priorityPaymentOption concerning your payment.

You can also use this request to get the cost of a payment.

Bodyapplication/jsonrequired

The payment to post

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

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

Example: "Na5Dv6E"

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

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

Example: "Na5Dv6E"

amountobject(Amount)required

Representation of an amount.

amount.valuestring(^((\-){?})[0-9]{12}((\.[0-9]{1-7}){?})$)(QuotedDecimal)^((\-){?})[0-9]{12}((\.[0-9]{1-7}){?})$required

A String representing a formatted floating number.

Example: "2.257"

amount.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"

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

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

Example: "2016-01-01"

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

feePaymentOptionstringrequired

A code representing the charges option to be applied to this payment.

Enum"BEN""OUR""SHARE""SEPA""DSP""RTGS"

priorityPaymentOptionstringrequired

A code representing whether this payment as a standard priority, or a priority treatment in IBANFIRST an correspondent bank systems.

Enum"48H""24H""1H"

tagstring<= 50 characters

A custom reference that you want to be related to this payment in the system. This tag is not communicated to the beneficiary.

communicationstring<= 76 characters

A Free format string representing the communication for the beneficiary.

curl -i -X POST \
  https://sandbox.ibanfirst.com/api/payments/ \
  -H 'Content-Type: application/json' \
  -d '{
    "sourceWalletId": "Na5Dv6E",
    "externalBankAccountId": "Na5Dv6E",
    "amount": {
      "value": "2.257",
      "currency": "USD"
    },
    "desiredExecutionDate": "2016-01-01",
    "feeCurrency": "USD",
    "feePaymentOption": "BEN",
    "priorityPaymentOption": "48H",
    "tag": "string",
    "communication": "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"

statusstring

The code identifying the payment status.

Enum"planified""rejected""finalized""canceled""refused""blocked""waitingconfirmation"

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

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

executionDatestring(^[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.

counterValueobject(Amount)

Representation of an amount.

rateobject(Rate)

Representation of a Rate.

tagstring<= 50 characters

The custom reference related to the payment. (For internal use only, not communicated to the beneficiary).

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

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

communicationstring<= 50 characters

The wording of the payment.

priorityPaymentOptionstring

The code representing whether this payment as a normal priority or if it as to be treated with a priority status by all the routing banks.

Enum"48H""24H""1H"

feePaymentOptionstring

The code identifying the charges option for this payment.

Enum"BEN""OUR""SHARE""SEPA""DSP""RTGS"

feePaymentAmountobject(Amount)

Representation of an amount.

Response

application/json

{
  "id": "Na5Dv6E",
  "status": "planified",
  "createdDate": "2016-01-01 00:00:00",
  "desiredExecutionDate": "2016-01-01",
  "executionDate": "2016-01-01",
  "amount": {
    "value": "2.257",
    "currency": "USD"
  },
  "counterValue": {
    "value": "2.257",
    "currency": "USD"
  },
  "rate": {
    "currencyPair": "EURUSD",
    "midMarket": "2.257",
    "date": "2016-01-01 00:00:00",
    "coreAsk": "2.257",
    "coreBid": "2.257",
    "appliedAsk": "2.257",
    "appliedBid": "2.257"
  },
  "tag": "string",
  "externalBankAccountId": "Na5Dv6E",
  "sourceWalletId": "Na5Dv6E",
  "communication": "string",
  "priorityPaymentOption": "48H",
  "feePaymentOption": "BEN",
  "feePaymentAmount": {
    "value": "2.257",
    "currency": "USD"
  }
}

Get payment options for a wallet and an external bank account

Request

Before doing any payments, you may use this request to get payments options for the payment you want to do. This will give you the priorityPaymentOption and feePaymentOption available for the given wallet and external bank account. You will also get fee cost for each priorityPaymentOption and feePaymentOption combinations, and minimal source and target amount to use this combination.

Path

walletIdstringrequired

The source wallet ID you want to put your payment debit on.

externalBankAccountIdstringrequired

The target external bank account ID you want to put your payment credit on.

curl -i -X GET \
  'https://sandbox.ibanfirst.com/api/payments/options/-{walletId}/-{externalBankAccountId}/'

Responses

Bodyapplication/json

paymentOptionobject

Response

application/json

{
  "paymentOption": {
    "externalBankAccountId": "Na5Dv6E",
    "sourceWalletId": "Na5Dv6E",
    "options": [ … ]
  }
}

Get payment list by status

Request

Request the list of payments that has been created on a specific period of time.

Path

statusstringrequired

A code representing the status of the payments you want to get.

Enum"all""planified""rejected""finalized""canceled""refused""blocked""waitingconfirmation"

Query

fromDatestring(YYYY-MM-DD)

The starting date to search payments.

toDatestring(YYYY-MM-DD)

The ending date to search payments.

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/payments/_{status}/?fromDate=string&page=1&per_page=50&sort=ASC&toDate=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"

statusstring

The code identifying the payment status.

Enum"planified""rejected""finalized""canceled""refused""blocked""waitingconfirmation"

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

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

executionDatestring(^[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.

counterValueobject(Amount)

Representation of an amount.

rateobject(Rate)

Representation of a Rate.

tagstring<= 50 characters

The custom reference related to the payment. (For internal use only, not communicated to the beneficiary).

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

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

communicationstring<= 50 characters

The wording of the payment.

priorityPaymentOptionstring

The code representing whether this payment as a normal priority or if it as to be treated with a priority status by all the routing banks.

Enum"48H""24H""1H"

feePaymentOptionstring

The code identifying the charges option for this payment.

Enum"BEN""OUR""SHARE""SEPA""DSP""RTGS"

feePaymentAmountobject(Amount)

Representation of an amount.

]

Response

application/json

[
  {
    "id": "Na5Dv6E",
    "status": "planified",
    "createdDate": "2016-01-01 00:00:00",
    "desiredExecutionDate": "2016-01-01",
    "executionDate": "2016-01-01",
    "amount": { … },
    "counterValue": { … },
    "rate": { … },
    "tag": "string",
    "externalBankAccountId": "Na5Dv6E",
    "sourceWalletId": "Na5Dv6E",
    "communication": "string",
    "priorityPaymentOption": "48H",
    "feePaymentOption": "BEN",
    "feePaymentAmount": { … }
  }
]

Get payment details

Request

Retrieve the details of a specific payment.

Path

idstringrequired

The code identifying the payment you want.

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

statusstring

The code identifying the payment status.

Enum"planified""rejected""finalized""canceled""refused""blocked""waitingconfirmation"

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

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

executionDatestring(^[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.

counterValueobject(Amount)

Representation of an amount.

rateobject(Rate)

Representation of a Rate.

tagstring<= 50 characters

The custom reference related to the payment. (For internal use only, not communicated to the beneficiary).

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

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

communicationstring<= 50 characters

The wording of the payment.

priorityPaymentOptionstring

The code representing whether this payment as a normal priority or if it as to be treated with a priority status by all the routing banks.

Enum"48H""24H""1H"

feePaymentOptionstring

The code identifying the charges option for this payment.

Enum"BEN""OUR""SHARE""SEPA""DSP""RTGS"

feePaymentAmountobject(Amount)

Representation of an amount.

Response

application/json

{
  "id": "Na5Dv6E",
  "status": "planified",
  "createdDate": "2016-01-01 00:00:00",
  "desiredExecutionDate": "2016-01-01",
  "executionDate": "2016-01-01",
  "amount": {
    "value": "2.257",
    "currency": "USD"
  },
  "counterValue": {
    "value": "2.257",
    "currency": "USD"
  },
  "rate": {
    "currencyPair": "EURUSD",
    "midMarket": "2.257",
    "date": "2016-01-01 00:00:00",
    "coreAsk": "2.257",
    "coreBid": "2.257",
    "appliedAsk": "2.257",
    "appliedBid": "2.257"
  },
  "tag": "string",
  "externalBankAccountId": "Na5Dv6E",
  "sourceWalletId": "Na5Dv6E",
  "communication": "string",
  "priorityPaymentOption": "48H",
  "feePaymentOption": "BEN",
  "feePaymentAmount": {
    "value": "2.257",
    "currency": "USD"
  }
}

Delete a payemt

Request

The code identifying the payment you want to delete.

Path

idstringrequired

The code identifying the payment you want to delete.

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

statusstring

The code identifying the payment status.

Enum"planified""rejected""finalized""canceled""refused""blocked""waitingconfirmation"

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

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

executionDatestring(^[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.

counterValueobject(Amount)

Representation of an amount.

rateobject(Rate)

Representation of a Rate.

tagstring<= 50 characters

The custom reference related to the payment. (For internal use only, not communicated to the beneficiary).

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

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

communicationstring<= 50 characters

The wording of the payment.

priorityPaymentOptionstring

The code representing whether this payment as a normal priority or if it as to be treated with a priority status by all the routing banks.

Enum"48H""24H""1H"

feePaymentOptionstring

The code identifying the charges option for this payment.

Enum"BEN""OUR""SHARE""SEPA""DSP""RTGS"

feePaymentAmountobject(Amount)

Representation of an amount.

Response

application/json

{
  "id": "Na5Dv6E",
  "status": "planified",
  "createdDate": "2016-01-01 00:00:00",
  "desiredExecutionDate": "2016-01-01",
  "executionDate": "2016-01-01",
  "amount": {
    "value": "2.257",
    "currency": "USD"
  },
  "counterValue": {
    "value": "2.257",
    "currency": "USD"
  },
  "rate": {
    "currencyPair": "EURUSD",
    "midMarket": "2.257",
    "date": "2016-01-01 00:00:00",
    "coreAsk": "2.257",
    "coreBid": "2.257",
    "appliedAsk": "2.257",
    "appliedBid": "2.257"
  },
  "tag": "string",
  "externalBankAccountId": "Na5Dv6E",
  "sourceWalletId": "Na5Dv6E",
  "communication": "string",
  "priorityPaymentOption": "48H",
  "feePaymentOption": "BEN",
  "feePaymentAmount": {
    "value": "2.257",
    "currency": "USD"
  }
}

Confirm a payment

Request

Payments that has been scheduled must be confirmed in order to be released. If the payment is not confirmed before the end of scheduled date of operation, it will be automatically postponed to the next operation date available.

Path

idstringrequired

The code identifying the payment you want to confirm.

curl -i -X PUT \
  'https://sandbox.ibanfirst.com/api/payments/-{id}/confirm'

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"

statusstring

The code identifying the payment status.

Enum"planified""rejected""finalized""canceled""refused""blocked""waitingconfirmation"

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

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

executionDatestring(^[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.

counterValueobject(Amount)

Representation of an amount.

rateobject(Rate)

Representation of a Rate.

tagstring<= 50 characters

The custom reference related to the payment. (For internal use only, not communicated to the beneficiary).

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

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

communicationstring<= 50 characters

The wording of the payment.

priorityPaymentOptionstring

The code representing whether this payment as a normal priority or if it as to be treated with a priority status by all the routing banks.

Enum"48H""24H""1H"

feePaymentOptionstring

The code identifying the charges option for this payment.

Enum"BEN""OUR""SHARE""SEPA""DSP""RTGS"

feePaymentAmountobject(Amount)

Representation of an amount.

Response

application/json

{
  "id": "Na5Dv6E",
  "status": "planified",
  "createdDate": "2016-01-01 00:00:00",
  "desiredExecutionDate": "2016-01-01",
  "executionDate": "2016-01-01",
  "amount": {
    "value": "2.257",
    "currency": "USD"
  },
  "counterValue": {
    "value": "2.257",
    "currency": "USD"
  },
  "rate": {
    "currencyPair": "EURUSD",
    "midMarket": "2.257",
    "date": "2016-01-01 00:00:00",
    "coreAsk": "2.257",
    "coreBid": "2.257",
    "appliedAsk": "2.257",
    "appliedBid": "2.257"
  },
  "tag": "string",
  "externalBankAccountId": "Na5Dv6E",
  "sourceWalletId": "Na5Dv6E",
  "communication": "string",
  "priorityPaymentOption": "48H",
  "feePaymentOption": "BEN",
  "feePaymentAmount": {
    "value": "2.257",
    "currency": "USD"
  }
}

Upload a proof of transaction for a payment

Request

We may ask you to provide a proof of transaction under specific terms. You can anticipate our request and send us your invoice or the ID of the beneficiary to avoid any request from us and fully automate your payment process. To send a file with this request, you have to extract the content of the file with a binary format, and encode it with a base64 algorithm to put in in the “file” field.

Path

idstringrequired

The code identifying the payment you want to confirm.

Bodyapplication/jsonrequired

The proof of transaction to upload

documentTypestringrequired

The type of document to submit for a transaction.

Enum"invoice""identity"

tagstringrequired

The name of the document to be attached.

filestringrequired

The binary content of the file, encoded with a base64 algorithm.

curl -i -X PUT \
  'https://sandbox.ibanfirst.com/api/payments/-{id}/proofOfTransaction/' \
  -H 'Content-Type: application/json' \
  -d '{
    "documentType": "invoice",
    "tag": "string",
    "file": "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"

statusstring

The code identifying the payment status.

Enum"planified""rejected""finalized""canceled""refused""blocked""waitingconfirmation"

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

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

executionDatestring(^[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.

counterValueobject(Amount)

Representation of an amount.

rateobject(Rate)

Representation of a Rate.

tagstring<= 50 characters

The custom reference related to the payment. (For internal use only, not communicated to the beneficiary).

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

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

communicationstring<= 50 characters

The wording of the payment.

priorityPaymentOptionstring

The code representing whether this payment as a normal priority or if it as to be treated with a priority status by all the routing banks.

Enum"48H""24H""1H"

feePaymentOptionstring

The code identifying the charges option for this payment.

Enum"BEN""OUR""SHARE""SEPA""DSP""RTGS"

feePaymentAmountobject(Amount)

Representation of an amount.

Response

application/json

{
  "id": "Na5Dv6E",
  "status": "planified",
  "createdDate": "2016-01-01 00:00:00",
  "desiredExecutionDate": "2016-01-01",
  "executionDate": "2016-01-01",
  "amount": {
    "value": "2.257",
    "currency": "USD"
  },
  "counterValue": {
    "value": "2.257",
    "currency": "USD"
  },
  "rate": {
    "currencyPair": "EURUSD",
    "midMarket": "2.257",
    "date": "2016-01-01 00:00:00",
    "coreAsk": "2.257",
    "coreBid": "2.257",
    "appliedAsk": "2.257",
    "appliedBid": "2.257"
  },
  "tag": "string",
  "externalBankAccountId": "Na5Dv6E",
  "sourceWalletId": "Na5Dv6E",
  "communication": "string",
  "priorityPaymentOption": "48H",
  "feePaymentOption": "BEN",
  "feePaymentAmount": {
    "value": "2.257",
    "currency": "USD"
  }
}

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 Method	Time
GET	1 hour
POST, PUT	1 week

Operations

Auth

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

Operations

Client API IBANFIRST (1.1)

Wallets

Financial movements

External bank account

Payments

Submit a payment

Request

Responses

Was this helpful?

Get payment options for a wallet and an external bank account

Request

Responses

Was this helpful?

Get payment list by status

Request

Responses

Was this helpful?

Get payment details

Request

Responses

Was this helpful?

Delete a payemt

Request

Responses

Was this helpful?

Confirm a payment

Request

Responses

Was this helpful?

Upload a proof of transaction for a payment

Request

Responses

Was this helpful?

Trades

Documents

Logs

Auth

Client API IBANFIRST (1.1)

Wallets

Financial movements

External bank account

Payments

Submit a payment

RequestExpand all

Responses

Was this helpful?

Get payment options for a wallet and an external bank account

Request

Responses

Was this helpful?

Get payment list by status

Request

Responses

Was this helpful?

Get payment details

Request

Responses

Was this helpful?

Delete a payemt

Request

Responses

Was this helpful?

Confirm a payment

Request

Responses

Was this helpful?

Upload a proof of transaction for a payment

Request

Responses

Was this helpful?

Trades

Documents

Logs

Auth

Request