5. REST Endpoints

REST Application Endpoints

Endpoint http://localhost:8080/swagger-ui/	HTTP Request	Functionality	Request Body
/balance	GET	given BalanceMessage json, will retrieve user balance.	BalanceMessage Body Example
/funds/transfer	POST	given TransferMessage json, will attempt to process the fund transfer.	TransferMessage Body Example
/transfer/status/{messageId}	GET	given a TransferMessage messageId, will return the status of that transfer.	Use URL instead

BalanceMessage Body Example

{
    "accountNumber": 1,
    "routingNumber": 111,
}

Note: response returns error flag set to true when account not registered in database

i.e. Account( accountNumber : 1 , routingNumber : 111 ) nonexistent in database

TransferMessage Body Example

Single Bank Transfer (1 routing present)

{
    "creditor": {
        "accountNumber": 9,
        "routingNumber": 222
    },
    "debtor": {
        "accountNumber": 10,
        "routingNumber": 222
    },
    "date": "03-15-2021",
    "amount": "120.00",
    "memo": "Single bank test"
}

Returns message signifying if the transfer request has been successfully produced to Kafka broker

return includes messageId that can be used to check the /transfer/status/messageId endpoint

Two Bank Transfer (2 routings present)

{
    "creditor": {
        "accountNumber": 1,
        "routingNumber": 111
    },
    "debtor": {
        "accountNumber": 6,
        "routingNumber": 222
    },
    "date": "03-15-2020",
    "amount": "20",
    "memo": "two bank test"
}