Resources and URI Structure

Resources are the banking business objects, such as users, accounts, transfers, files, transactions, and statements. Resources may either be collections or instances that are stored in collections.

The API typically returns data in JSON format.

Uniform Resource Indicators (URIs)

Each resource, whether it is a collection or an instance, has a unique URI which serves as the address of that resource.

Each individual resource has a resource ID which is a string consisting of ASCII characters that uniquely identify an instance. For example, each banking account is uniquely identified by its accountId.

Note: An accountId is not the same as the account number. Account numbers are not used in URIs for security reasons.

The HTTP verbs GET, POST, PATCH and DELETE describe the action performed during the request. Think of GET as an alias for “Read”, POST as an alias for “Create”, PATCH as an alias for “Update”, and DELETE for “Erase.” For example:

• Read POST /transfers as “Create a new resource within the transfers collection”
• Read PUT /users/u123 as “Update user u123”

Resource URI Structure

The URIs follow a consistent structure that reflects the resources of each API.