POST web_api/JPMLinkInquiryPost

Send a new request to the gScan OCR service for processing.

Request Information

URI Parameters

None.

Body Parameters

The new request to be processed should be included in the body formatted as an JPMLinkInquiryRequest Object.

JPMLinkInquiryRequest
NameDescriptionTypeAdditional information
header

Header

None.

message

Message

None.

payload

Payload

None.

Request Formats

application/json, text/json

Sample:
{
  "header": {
    "sndrId": {
      "value": "sample string 1",
      "type": "sample string 2"
    },
    "rcvrId": [
      {
        "value": "sample string 1",
        "type": "sample string 2"
      },
      {
        "value": "sample string 1",
        "type": "sample string 2"
      }
    ]
  },
  "message": {
    "PmtInf": {
      "Cdtr": {
        "Nm": "sample string 1"
      },
      "CdtrAcct": {
        "Id": {
          "value": "sample string 1",
          "type": "sample string 2"
        }
      },
      "CdtrAgt": {
        "FinInstnId": {
          "BICFI": "sample string 1"
        }
      },
      "CdtrAgtAcct": {
        "Id": {
          "value": "sample string 1",
          "type": "sample string 2"
        }
      },
      "Dbtr": {
        "Nm": "sample string 1"
      },
      "DbtrAcct": {
        "Id": {
          "value": "sample string 1",
          "type": "sample string 2"
        }
      },
      "DbtrAgt": {
        "FinInstnId": {
          "BICFI": "sample string 1"
        }
      },
      "DbtrAgtAcct": {
        "Id": {
          "value": "sample string 1",
          "type": "sample string 2"
        }
      }
    }
  },
  "payload": {
    "reqFlds": {
      "Cdtr": {
        "queries": [
          {
            "qry": "sample string 1"
          },
          {
            "qry": "sample string 1"
          }
        ]
      },
      "Dbtr": {
        "queries": [
          {
            "qry": "sample string 1"
          },
          {
            "qry": "sample string 1"
          }
        ]
      }
    },
    "AcctTrnActivity": {
      "AcctTrnActivityDateUTC": "sample string 1"
    },
    "reqRef": "sample string 1"
  }
}

application/xml, text/xml

Sample:
<JPMLinkInquiryRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/VerificationServicesApi.JPMLinkSchemaClasses">
  <header>
    <rcvrId>
      <Id>
        <type>sample string 2</type>
        <value>sample string 1</value>
      </Id>
      <Id>
        <type>sample string 2</type>
        <value>sample string 1</value>
      </Id>
    </rcvrId>
    <sndrId>
      <type>sample string 2</type>
      <value>sample string 1</value>
    </sndrId>
  </header>
  <message>
    <PmtInf>
      <Cdtr>
        <Nm>sample string 1</Nm>
      </Cdtr>
      <CdtrAcct>
        <Id>
          <type>sample string 2</type>
          <value>sample string 1</value>
        </Id>
      </CdtrAcct>
      <CdtrAgt>
        <FinInstnId>
          <BICFI>sample string 1</BICFI>
        </FinInstnId>
      </CdtrAgt>
      <CdtrAgtAcct>
        <Id>
          <type>sample string 2</type>
          <value>sample string 1</value>
        </Id>
      </CdtrAgtAcct>
      <Dbtr>
        <Nm>sample string 1</Nm>
      </Dbtr>
      <DbtrAcct>
        <Id>
          <type>sample string 2</type>
          <value>sample string 1</value>
        </Id>
      </DbtrAcct>
      <DbtrAgt>
        <FinInstnId>
          <BICFI>sample string 1</BICFI>
        </FinInstnId>
      </DbtrAgt>
      <DbtrAgtAcct>
        <Id>
          <type>sample string 2</type>
          <value>sample string 1</value>
        </Id>
      </DbtrAgtAcct>
    </PmtInf>
  </message>
  <payload>
    <AcctTrnActivity>
      <AcctTrnActivityDateUTC>sample string 1</AcctTrnActivityDateUTC>
    </AcctTrnActivity>
    <reqFlds>
      <Cdtr>
        <queries>
          <Query>
            <qry>sample string 1</qry>
          </Query>
          <Query>
            <qry>sample string 1</qry>
          </Query>
        </queries>
      </Cdtr>
      <Dbtr>
        <queries>
          <Query>
            <qry>sample string 1</qry>
          </Query>
          <Query>
            <qry>sample string 1</qry>
          </Query>
        </queries>
      </Dbtr>
    </reqFlds>
    <reqRef>sample string 1</reqRef>
  </payload>
</JPMLinkInquiryRequest>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

The response to the request will be posted back to the listening API on JPMLink platform.

Object

None.

Response Formats

application/json, text/json

Sample:
{}

application/xml, text/xml

Sample:
<z:anyType xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns:z="http://schemas.microsoft.com/2003/10/Serialization/" />