Fund information status

The fund information status depends on the state of the payment account transactions related to the payment link.

Based on the fund information status, you can determine if the payment is successful.

{
            "id": "fdbfa488-f1df-4edc-92a9-27c21111f816",
            "status": "completed",
            "user": {
                "first_name": "John",
                "last_name": "Doe",
                "external_reference": "ext123"
            },
            "link": "https://pay.bridgeapi.io/link/e5464ec214e48240b8e2e313b7689ab8ef058s22v1d2d51d7107fca30c993c25",
            "transactions": [
                {
                    "amount": 100.0,
                    "label": "Shop payment",
                    "end_to_end_id": "AJD-CCVDD",
                    "currency": "EUR",
                    "beneficiary": {
                        "iban": "FR03XXXXXXXXXXXXXXXXXXXX120",
                        "company_name": "Shop"
                    }
                }
            ],
            "fund_information": {
                "status": "paid",
                "payment_account_transactions": [
                    {
                        "id": "01c2dc19-2b9b-5904-a8d3-ddde09adell3",
                        "status": "received",
                        "amount": 100.0
                    }
                ]
            },
            "expired_at": "2023-12-05T22:00:00.000Z",
            "created_at": "2023-11-28T14:20:28.078Z",
            "updated_at": "2023-11-28T14:22:37.769Z"
        },

First the fund information status is unpaid.

When the status changes to underpaid, paid, overpaid it means you have received the money on the payment account.

The following statuses may then appear depending on the circumstances:pending_refund, refunded, partially_refunded and recalled.

underpaid and overpaid statuses are only possible if you get paid with manual transfers. With this payment method, be aware that you can also have a revoked payment link with a paid fund_information status and that you can have multiple payment_account_transactions associated with the same payment link.

When the Payment Link is updated it will trigger a webhook

Here is an example when the Fund information status is paid:

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