Freeze¶

Once bank completed process freeze balance at bank side, bank need to invoke this endpoint to acknowledge bill freeze status to OONE. (5.0 in overall diagram)

Implemented by: OONE · Called by: Partner bank

Operation¶

Description	Value
URL	`https://{URL}/v1/Freeze`
Method	`POST`

Headers¶

Key	Value	Remark
Accept	application/json
Content-Type	application/json
Authorization	Bearer	{token} from get token endpoint

Request Payload¶

Field	Type	Required	Remark
`txn`	`string`	yes	Transaction number
`refNo`	`string`	yes	Reference number from bank side
`transDate`	`dateTime (ISO 8601)`	yes	Transaction date
`effectiveDate`	`dateTime (ISO 8601)`	yes	Expired freeze bill date -- e.g. X Bank has policy 30 days to block bill so that bill will automate unfreeze in that amount of days if no settle was invoke from OONE.

Example Request Payload¶

{
    "txn": "F1008XX",
    "refNo": "XX011FT",
    "transDate": "2022-04-07T18:51:30.992Z",
    "effectiveDate": "2022-05-07T18:51:30.992Z"
}

Response Payload¶

Field	Type	Remark
`code`	`string`	Response code
`message`	`string`	Response message

Example Response Payload¶

{
    "code": "00",
    "message": "Success"
}

Response Codes (Failed)¶

Code	Type	Error	Remark
101	FreezeException	Bill {X} not exists!	{X} Bill number
102	FreezeException	Bill {X} was in {Y} status!	{Y} status like Frozen, Paid ...
103	FreezeException	Bill {X} was over due date!	{X} Bill number