End of flow Notify

Version: 3.0.0

Method

POST

Url

https://{YOUR_SERVICE_URL}/(end_of_flow_notify: 17)

This API endpoint is responsible for notify the initiator VASP when the receiver not response for long time, cancel the request or the verification expired time exceeded, you will get notify from GTR service

Authentication

No authentication

Path Parameters

No path parameters

Query Parameters

No query parameters

Request Body (Required)

Schema

[+]basicMessage

OptionalObject

[+]finalStateInfo

OptionalObject

[+]notifyResult

OptionalObject

Example

{
  "finalStateInfo": {
    "reason": "for address book verify purpose",
    "reasonType": "ADDRESS_BOOK_VERIFY"
  },
  "notifyResult": {
    "verifyStage": "string",
    "verifyStatus": 0,
    "verifyMessage": "string"
  },
  "basicMessage": {
    "originatorVaspCode": "string",
    "beneficiaryVaspCode": "string",
    "initiatorVaspCode": "string",
    "requestId": "string",
    "receiverVaspCode": "string",
    "verificationDirection": 0
  }
}

Responses

Status HTTP Status: 200, VerifyStatus: 100000

default response

JSON Content

Schema

[+]data

OptionalObject

verifyMessage

OptionalString

verifyStatus

OptionalInteger (int32)

Example

{
  "verifyStatus": 100000,
  "verifyMessage": "Verify Success"
}