Skip to navigation
Manage payment operationsMerchant boardingLegacy boarding

Get boarding app notes and events

Learn how to see an application's notes and events via the Payabli API
View as MarkdownOpen in Claude
Applies to:DevelopersPartners

Deprecation notice: legacy boarding

Legacy boarding is deprecated and will be sunset in Q2 2027 (the “Sunset Date”). After the Sunset Date, legacy boarding endpoints, workflows, and documentation will no longer be available or supported, and requests to them may fail. Until then, legacy boarding remains available but will receive only critical security and stability fixes. No new features will be added.

To avoid disruption, migrate to intelligent boarding before the Sunset Date. See the migration guide for instructions. Questions? Contact your account manager.

This notice is provided for informational purposes. Dates and details are subject to change, and Payabli will provide updates here and through direct communication. Nothing in this notice amends any agreement between you and Payabli.

To access notes and events on a boarding application via the API, you can send a GET request to /Boarding/read/{appId}.

Get app with appid 352
  curl -X GET https://api-sandbox.payabli.com/api/Boarding/read/352 \
    -H 'Authorization: Bearer YOUR_ACCESS_TOKEN'

In the response, the notes associated with the application are returned in the messages array. The application’s events are returned in generalEvents array.

// Response truncated to show only the generalEvents array
"generalEvents": [
    {
        "description": "Created",
        "eventTime": "2022-06-17T16:35:21.1539528+00:00",
        "refData": null,
        "extraData": null,
        "source": null
    },
    {
        "description": "Updated Status",
        "eventTime": "2022-06-17T16:35:22.0854265+00:00",
        "refData": "1",
        "extraData": null,
        "source": null
    }
],

See these related resources to help you get the most out of Payabli.