Message Format Nov2016

Default Messages Nov 2016

Status: Implemented in next branch

These are the requests that return zero or one entity:

Value of name Key	Additional Keys in Request	Keys in Response
getAccount	accountId bankId	balanceAmount bankId balanceCurrency iban accountId label number type
getBank	bankId	accountId bankId logo name url
getTransaction	accountId bankId transactionId	accountId newBalanceAmount newBalanceCurrency bankId completedDate description transactionId counterparty postedDate type amount currency
createTransaction	accountId amount currency counterpartyCurrency counterpartyId transactionType

These are the requests that return zero or many entities:

Value of name Key	Additional Keys in Request	Response is an Array of JSON Objects with Keys
getAccounts	bankId	as in getAccount above
getBanks		as in getBank above
getTransactions	accountId bankId	as in getTransaction above

All requests may include the user key that refers to the owner of the queried entities. When the user key is present the query is altered in a way that is defined by the south side. The basic understanding is that a query without a user key is anonymous. A query with a user key requests only entities that relate to the given user in some way defined by the south.

#####Get Transaction These keys in the response have JSON objects as value

Key	Keys in Value
counterparty	counterpartyName counterpartyId

The completed and posted keys are timestamps with this pattern: "yyyy-MM-dd'T'HH:mm:ss.SSSZ".

#####Save Transaction The response is a single JSON string, the transaction id.

#####User Information The following user related keys may be sent:

Key	Description
username	The username that the user uses to login in
userId	The UUID used by OBP API to reference the user