Bridge API Documentation

Bridge Documentation

Welcome to our API documentation!

We're happy to share with you our new API 2021 version! Please check our Product Changelog to see the main updates.

You'll find comprehensive guides and documentation to help you start integration Bridge API as quickly as possible, as well as support if you get stuck.

Let's jump right in!

Get Started

Webhooks events

Banking Synchronization

📘

Please use real items to test the webhooks events

For now our bank test Simulator is not reliable to test the webhooks, please sync other bank accounts to test them.

There are four events available.

1. Item created

This event is triggered at the very beginning of an item creation, when users enter their credentials in Bridge Connect and then click on "Add your account". You can use it, for example, to know if a user quitted the Bridge Connect before the end of the synchronization.

Example:

{
  "content": {
    "item_id": 4568477,
    "user_uuid": "766b2f5d-a942-492c-9ea7-2e5aa88cb672"
  },
  "timestamp": 1612782588323,
  "type": "item.created"
}

2. Account created

This event is triggered when we detect a new account on an item. It can be triggered at the same time as Item created but also later, for example if users opened a new account with their bank.

{
  "content": {
    "account_id": 22908770,
    "balance": 1678.12,
    "item_id": 4568477,
    "user_uuid": "766b2f5d-a942-492c-9ea7-2e5aa88cb672"
  },
  "timestamp": 1612782588323,
  "type": "item.account.created"
}

3. Account updated

This event is triggered each time we detect an update on an account. An update can be:

  • transactions have been added
  • transactions have been deleted
  • transactions have been updated
  • balance has changed

Example:

{
  "content": {
    "account_id": 22908770,
    "balance": 1678.12,
    "item_id": 4568477,
    "nb_deleted_transactions": 0,
    "nb_new_transactions": 15,
    "nb_updated_transactions": 0,
    "user_uuid": "766b2f5d-a942-492c-9ea7-2e5aa88cb672"
  },
  "timestamp": 1612782588323,
  "type": "item.account.updated"
}

4. Item refreshed

Each time an item is refreshed, this event is triggered. You can use it to check if an item's status has changed, or to know right after a refresh that an item is now in error. The field full_refresh indicates you if we fetched the item's full history or not.

Example:

{
  "content": {
    "full_refresh": false,
    "item_id": 4568565,
    "status_code": 1003,
    "status_code_info": "",
    "user_uuid": "766b2f5d-a942-492c-9ea7-2e5aa88cb672"
  },
  "timestamp": 1612783550980,
  "type": "item.refreshed",
}

Payment Initiation

Several events will be available depending on which feature your app uses:

  • 2 events for Payments
  • 1 event for Payment Links
  • 4 events for Transfers

1. Payments - Payment transaction created

This event is triggered when a payment transaction is created.

Example:

{
  "content": {
    "payment_transaction_id" : "15e04e47-7391-4b58-bc98-a334a4e7ad13", 
        "payment_request_id" : "rto4e47-201-4b58-bc98-a924a4e7ad12",
        "payment_link_id" :  "rto4e47-201-4b58-bc98-a924a4e7ad12", // not in response if null
        "client_reference" :  "INV124", // not in response if null
        "end_to_end_id":  "REF1234" // not in response if null
  },
  "timestamp": 1612783550980,
  "type": "payment.transaction.created"
}

2. Payments - Payment transaction updated

This event is triggered when a payment transaction is updated.

Example:

{
  "content": {
    "payment_transaction_id" : "15e04e47-7391-4b58-bc98-a334a4e7ad13", 
        "payment_request_id" : "rto4e47-201-4b58-bc98-a924a4e7ad12",
        "payment_link_id" :  "rto4e47-201-4b58-bc98-a924a4e7ad12", // not in response if null
        "client_reference" :  "INV124", // not in response if null
        "end_to_end_id":  "REF1234", // not in response if null
    "status": "ACSC",
        "status_reason": "MS03"  // not in response if null
  },
  "timestamp": 1612783550980,
  "type": "payment.transaction.updated"
}

3. Payment Links - Payment Link updated

This event is triggered when a Payment Link is updated.

Example:

{
  "content": {
    "payment_link_id": "64e61033-be1e-4dd3-9564-f03e8a5b6874",
    "payment_link_status": "COMPLETED",
    "client_reference": "INV124" // not in response if null
  },
  "timestamp": 1644507383234,
  "type": "payment.link.updated"
}

4. Transfers - Transfer account created

This event is triggered when a new sender account has been detected for an item.

Example:

{
  "content": {
    "item_id": 6365343,
    "sender_account_id": 16623323,
    "support": [
      "BULK_TRANSFER"
    ], // table can be empty
    "user_uuid": "16369a41-6d2b-4750-85cd-60e366fbdcb8"
  },
  "timestamp": 1644508779604,
  "type": "transfer.account.created"
}

5. Transfers - Transfer account updated

This event is triggered when a sender account has been updated (support has changed or account has been deleted).

Example:

{
  "content": {
    "item_id": 6365343,
    "sender_account_id": 16623323,
    "support": [
      "BULK_TRANSFER"
    ], // table can be empty
    "user_uuid": "16369a41-6d2b-4750-85cd-60e366fbdcb8",
    "is_deleted": true,  
  },
  "timestamp": 1644508779604,
  "type": "transfer.account.updated"
}

6. Transfers - Transfer created

This event is triggered when a transfer has been created (when a user confirm the first step of the Bridge Transfer journey).

Example:

{
  "content": {
    "bulk_id": 123456789, // not in response if null
    "client_reference" :  "INV124", // not in response if null
    "item_id": 6106365,
    "transfer_id": "1b86bc9a-3585-4927-8520-f0de7cfed5bd",
    "user_uuid": "16369a41-6d2b-4750-85cd-60e366fbdcb8"
  },
  "timestamp": 1644506317422,
  "type": "transfer.created"
}

7. Transfers - Transfer updated

This event is triggered when a transfer has been updated.

Example:

{
  "content": {
    "item_id": 6106365,
    "status": "initiated",
    "transfer_id": "1b86bc9a-3585-4927-8520-f0de7cfed5bd",
    "user_uuid": "16369a41-6d2b-4750-85cd-60e366fbdcb8"
  },
  "timestamp": 1644506320488,
  "type": "transfer.updated"
}

Updated 3 months ago


Webhooks events


Suggested Edits are limited on API Reference Pages

You can only suggest edits to Markdown body content, but not to the API spec.