POST api/Lean/LeanWebHook

Request Information

URI Parameters

None.

Body Parameters

LeanPayLoad
NameDescriptionTypeAdditional information
payload

Payload

None.

type

string

None.

message

string

None.

timestamp

date

None.

event_id

string

None.

Request Formats

application/json, text/json

Sample:
{
  "payload": {
    "id": "sample string 1",
    "customer_id": "sample string 2",
    "app_user_id": "sample string 3",
    "permissions": [
      "sample string 1",
      "sample string 2"
    ],
    "bank_details": {
      "name": "sample string 1",
      "identifier": "sample string 2",
      "logo": "sample string 3",
      "main_color": "sample string 4",
      "background_color": "sample string 5"
    }
  },
  "type": "sample string 1",
  "message": "sample string 2",
  "timestamp": "2021-10-13T22:36:11.896362+00:00",
  "event_id": "sample string 4"
}

application/xml, text/xml

Sample:
<LeanPayLoad xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Bankiom.API.Controllers">
  <event_id>sample string 4</event_id>
  <message>sample string 2</message>
  <payload>
    <app_user_id>sample string 3</app_user_id>
    <bank_details>
      <background_color>sample string 5</background_color>
      <identifier>sample string 2</identifier>
      <logo>sample string 3</logo>
      <main_color>sample string 4</main_color>
      <name>sample string 1</name>
    </bank_details>
    <customer_id>sample string 2</customer_id>
    <id>sample string 1</id>
    <permissions xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:string>sample string 1</d3p1:string>
      <d3p1:string>sample string 2</d3p1:string>
    </permissions>
  </payload>
  <timestamp>2021-10-13T22:36:11.896362+00:00</timestamp>
  <type>sample string 1</type>
</LeanPayLoad>

application/x-www-form-urlencoded

Sample:

Failed to generate the sample for media type 'application/x-www-form-urlencoded'. Cannot use formatter 'JQueryMvcFormUrlEncodedFormatter' to write type 'LeanPayLoad'.

Response Information

Resource Description

OperationStatusOfBoolean
NameDescriptionTypeAdditional information
Result

boolean

None.

HasNoData

boolean

None.

ErrorMsg

string

None.

Succeeded

boolean

None.

AlreadyExists

boolean

None.

NotFound

boolean

None.

Error

Exception

None.

Response Formats

application/json, text/json

Sample:
{
  "Result": true,
  "HasNoData": true,
  "ErrorMsg": "sample string 3",
  "Succeeded": true,
  "AlreadyExists": true,
  "NotFound": true,
  "Error": {
    "ClassName": "System.Exception",
    "Message": null,
    "Data": null,
    "InnerException": null,
    "HelpURL": "sample string 1",
    "StackTraceString": null,
    "RemoteStackTraceString": null,
    "RemoteStackIndex": 0,
    "ExceptionMethod": null,
    "HResult": 3,
    "Source": "sample string 2",
    "WatsonBuckets": null
  }
}

application/xml, text/xml

Sample:
<OperationStatusOfboolean xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Bankiom.DataLayer.Common">
  <AlreadyExists>true</AlreadyExists>
  <Error xmlns:d2p1="http://schemas.datacontract.org/2004/07/System">
    <ClassName xmlns:d3p1="http://www.w3.org/2001/XMLSchema" i:type="d3p1:string" xmlns="">System.Exception</ClassName>
    <Message i:nil="true" xmlns="" />
    <Data i:nil="true" xmlns="" />
    <InnerException i:nil="true" xmlns="" />
    <HelpURL xmlns:d3p1="http://www.w3.org/2001/XMLSchema" i:type="d3p1:string" xmlns="">sample string 1</HelpURL>
    <StackTraceString i:nil="true" xmlns="" />
    <RemoteStackTraceString i:nil="true" xmlns="" />
    <RemoteStackIndex xmlns:d3p1="http://www.w3.org/2001/XMLSchema" i:type="d3p1:int" xmlns="">0</RemoteStackIndex>
    <ExceptionMethod i:nil="true" xmlns="" />
    <HResult xmlns:d3p1="http://www.w3.org/2001/XMLSchema" i:type="d3p1:int" xmlns="">3</HResult>
    <Source xmlns:d3p1="http://www.w3.org/2001/XMLSchema" i:type="d3p1:string" xmlns="">sample string 2</Source>
    <WatsonBuckets i:nil="true" xmlns="" />
  </Error>
  <ErrorMsg>sample string 3</ErrorMsg>
  <HasNoData>true</HasNoData>
  <NotFound>true</NotFound>
  <Result>true</Result>
  <Succeeded>true</Succeeded>
</OperationStatusOfboolean>