Key Concepts

Transactive's API has:

• a limited number of configuration entities, which you use to tailor Transactive to your needs
• a potentially unlimited number of operational entities, which are the result of your business activities

Configuration Entities

Organizations

Details about your contractual relationship(s) (currently only one allowed) with Transactive, including approved products, pricing and limitations/constraints if applicable.

Contacts

Members of your staff that are allowed access to Transactive.

Applications

System principals (programs/apps, not humans) that are allowed access to Transactive.

Accounts

Your Transactive virtual bank account(s), to and from which Payments are routed, and from which fees are paid. Each Account has a balance and a list of entries. Each entry can be traced to a single Payment.

Activities

Activities occur on an account. Activities include deposit, fee, payout, transfer out and reversal.

Authorities

Role-oriented permissions, used to control what Contacts and Applications can do and see.

Account Whitelists

Permission to direct payments to, and receive payments from, specific bank accounts.

Stats

How long the API has been running. Stats requires no permissions, so it can be pinged to check if the system is alive.

Webhooks

URLs/endpoints in your own software system(s). Transactive will send event notifications to these Webhooks, e.g. the arrival of an inbound Payment.

Operational Entities

Payments

Transfers of funds to and from your Accounts.

Entries

Payment-related principal or fee amounts posted to Accounts. A Payment may result in multiple entries in multiple Accounts.

Events

Significant Payment events, e.g. the arrival of a new inbound Payment.