Guidelines

URL Structure

URLs are designed to be easily read and construct. This facilitates discovery and eases the API adoption. Paths follow the structure: [resource]/[resource-id]/[sub-resource]/[sub-resource-id], where [resource]/[resource-id] details the resource, and [resource]/[resource-id]/[sub-resource]/[sub-resource-id] details the sub-resource.

Canonical Identifier

In addition to friendly URLs, resources expose an URL that contains a unique stable identifier. The stable identifier is called resource Id, and it is returned on the response when a new resource is created. If the banking core the API is connected to does not provide this unique identifier, we create it overlaying different resource values. For intance, in some cores we produce the accountId using this overlay rule: BranchCode-AccountType-AccountSubtype-AccountNumber.