---
updatedAt: 2025-09-23T23:48:20.000Z
agentTools:
  projectIndex: https://docs.bridgeapi.io/llms.txt
---

# New API version v2021.06.01

We launched our new API version in June 2021. You will see in this page the core principles of this new version and some changes examples.

## New feature: get more precise information about a Bridge Pay transfer

### Execution status

In the first Bridge Pay version, you could get the status of a transfer **initiation** (meaning: the transfer order has been sent to the bank). If it was a success, the transfer's status was `succeeded`. In rare but possible cases, the bank could still refuse to execute the transfer (mainly for regulatory reasons) and we had no possibility to get the information.

With our improvement, we can now get the status of the transfer's execution. It means we know when:

* a transfer has been **initiated** (status = `initiated`)
* a transfer has been **executed** (status = `executed`)

After a transfer has been initiated, we ask the bank every hour if its status has changed. If we detect a status change, then we update it so you and your users can be sure of the final status (either `failed` or `executed`).

*Note: with the new API version, you won't get any old status`succeeded` from the 6th of July 2021*

### Failing reasons

A transfer can fail for several reasons: the receiver IBAN is not accepted by the bank, a technical error occurred, the user failed the SCA, etc.

For each `failed` transfer, we will provide a `status_reason` allowing you and your users to get more information about why the transfer failed.

[See every possible `status` and `status_reason` of a transfer.](https://docs.bridgeapi.io/v2021.06.01/docs/transfers-statuses)

## Core principles

* Cleaner responses: no more `resource_uri` and `resource_type` fields, homogeneous field names, etc.
* Simple rules: when a response make reference to another object, you can retrieve this object thanks to its id
* Better performance for lists thanks to optimized pagination
* No more `previous_uri` in pagination
* New version is `2021-06-01`
* `Bankin-Version` is now named `Bridge-Version`
* Endpoints route is now `https://api.bridgeapio.io/v2`

## Main changes examples

### Transfers

*Get transfer old response*

```json
{
  "uuid": "a73981be-c9b0-4320-a092-326e09e1e256",
  "item": {
     "id": 18293948,
     "resource_type": "item",
     "resource_uri": "/v2/items/18293948"
  },
  "status": "succeeded",
  "amount": 40,
  "label": "Virement course",
  "sender_account": {
    "id": 12121212,
    "name": "CC Xavier de Rosnay",
    "iban": "FR76 XXXX XXXX XXXX 1234",
    "resource_type": "transfer_account",
    "resource_uri": "/v2/transfers/accounts/12121212"
  },
  "receiver_account": null,
  "external_reference": "ABCDEF",
  "result_message": "Le virement ABCDEF a été executé avec succès.",  
  "created_at": "2020-09-19T13:52:31.000Z",
  "updated_at": "2020-09-19T14:02:12.200Z",
  "bulk_transfer_id": null,
  "client_reference": "fd5d81c5-4be2-412f-bb4d-5aa1db98dc99",
  "receiver_iban": "FR25XXXXXXXXXXXXXXXXXXXXN83",
  "beneficiary_name": "Test Name"
}
```

*Get transfer new response*

```json
{
  "id": "02d5b0b6-37e2-4684-aca9-4ede5fb9d7da",
  "amount": 1.0,
  "label": "Label test",
  "bank_reference": "123456789",
  "sender_account_id": 11679775,
  "beneficiary": {
    "name": "Michel Dupont",
    "iban": "FR76XXXXXXXXXXXXXXXXXXXX882"
  },
  "item_id": 4036595,
  "status": "failed",
  "status_reason": "regulatory_reason",
  "created_at": "2020-08-26T09:13:22.000Z",
  "updated_at": "2020-08-26T09:13:27.000Z",
  "bulk_transfer_id": "fc223ce9-080e-4a96-9cdc-73b2459c32d8",
  "client_reference": "3bc40e21-3ea5-4274-9744-c2f984f7072e",
}
```

*Please note that`external_reference` is now named`bank_reference`*

### Get accounts for a specific item

*Old way to get accounts for an item*

Call the endpoint "Get item" with the v2019

```json
{
  "id": 187791,
  "resource_uri": "/v2/items/187791",
  "resource_type": "item",
  "status": 0,
  "status_code_info": null,
  "status_code_description": null,
  "bank": {
    "id": 408,
    "resource_uri": "/v2/banks/408",
    "resource_type": "bank"
  },
  "accounts": [
    {
      "id": 2341671,
      "resource_uri": "/v2/accounts/2341671",
      "resource_type": "account"
    },
    {
      "id": 2341672,
      "resource_uri": "/v2/accounts/2341672",
      "resource_type": "account"
    },
    {
      "id": 2341673,
      "resource_uri": "/v2/accounts/2341673",
      "resource_type": "account"
    },
    {
      "id": 2341674,
      "resource_uri": "/v2/accounts/2341674",
      "resource_type": "account"
    }
  ],
}
```

*New way to get accounts for a specific item*

Call the endpoint "Get accounts" with an `item_id` url parameter with the v2021

```json
{
  "resources": [
    {
      "id": 2341501,
      "name": "Compte Crédit Immobilier",
      "balance": 140200,
      "status": 0,
      "status_code_info": null,
      "status_code_description": null,
      "updated_at": "2019-04-06T13:53:12Z",
      "type": "loan",
      "currency_code": "EUR",
      "item_id": 123456789,
      "bank_id": 408,
      "loan_details": {
        "next_payment_date": "2019-04-30",
        "next_payment_amount": 1000,
        "maturity_date": "2026-12-31",
        "opening_date": "2013-01-10",
        "interest_rate": 1.25,
        "type": "Prêtimmobilier",
        "borrowed_capital": 140200,
        "repaid_capital": 40200,
        "remaining_capital": 100000
      },
      "savings_details": null,
      "is_pro": false,
      "iban": "FR2420020202260600024M02606"
    },
    //...
  ],
  "pagination": {
    "next_uri": "/v2/accounts?after=MjM0MTUwMA%3D%3D&limit=10"
  }
}
```

### Transactions

*"Get transaction" old response*

```json
{
  "id": 1000013102238,
  "resource_uri": "/v2/transactions/1000013102238",
  "resource_type": "transaction",
  "description": "CB Monop Paris",
  "raw_description": "Paiement Carte 029412 75 monop paris",
  "amount": -9.39,
  "date": "2023-08-22", 
  "updated_at": "2016-02-22T13:27:53Z",
  "currency_code": "EUR",
  "is_deleted": false,
  "category": {
    "id": 168,
    "resource_uri": "/v2/categories/168",
    "resource_type": "category"
  },
  "account": {
    "id": 2341339,
    "resource_uri": "/v2/accounts/2341339",
    "resource_type": "account"
  }, 
  "is_future": false,
  "show_client_side": true
}
```

*"Get transaction" new response*

```json
{
  "id": 1000013102238,
  "clean_description": "CB Monop Paris",
  "bank_description": "Paiement Carte 029412 75 monop paris",
  "amount": -9.39,
  "date": "2023-08-22",
  "booking_date": "2023-08-22",
  "transaction_date": "2023-08-22",
  "value_date": "2023-08-22",  
  "updated_at": "2016-02-22T13:27:53Z",
  "currency_code": "EUR",
  "is_deleted": false,
  "category_id": 168,
  "account_id": 2341339,
  "is_future": false,
  "show_client_side": true
}
```

* `description` is now named `clean_description`
* `raw_description` is now named `bank_description`