Overview
Web Service Description/Definitions
Sample Error Response
Error Messages
Sample Successful Response
Overview
If submitting data via real-time, you must have a Clearinghouse account with real-time access. See: How To Register
See How to Create a Real-Time Account After Registration to add access to an existing PMP Clearinghouse account.
Web Service Description/Definitions
For the most current definitions, please open the WSDL at the following URL:
https://pmpclearinghouse.net/api/v1/realtime/wsdl
Host URL/Target Endpoint/Host: https://pmpclearinghouse.net/api/v1/realtime/action
<soapenv:Envelope
xmlns:soapenv=http://schemas.xmlsoap.org/soap/envelope/
xmlns:pmp="pmp">
<soapenv:Header/>
<soapenv:Body>
<pmp:PMPTransaction>
<Username>Your_UserName</Username>
<DestinationPMP>OK</DestinationPMP>
<Request>TH|4.2b|TEST|01||2016729|111707|P|791787|\\
IS|7229430039|APPRISS GATEWAY|TEST\
PHA|||BC6486054|TEST PHARMACY|1234 BROADWAY||ANYWHERE|NJ|01545|||\
PAT|||||||PATIENT|TEST||||123 MAIN
STREET||ANYWHERE|KY|44306||19521011|F|01|01||\
DSP|00|12456|20160410|0|20160410|00|01|00228298311|10|02|01|01|00|||04|
||||\
PRE||GD0006406|||DOC|GOOD||\
TP|5\
TT|TEST|8\</Request>
<Password>Your_Password#1</Password>
</pmp:PMPTransaction>
</soapenv:Body>
</soapenv:Envelope>
Sample Error Response
<soap:Envelope xmlns:soap=http://schemas.xmlsoap.org/soap/envelope/
xmlns:xsd=http://www.w3.org/2001/XMLSchema xmlns:tns="pmp">
<soap:Body>
<tns:SubmitTransactionResponse>
<TransactionID/>
<TransactionStatus>0</TransactionStatus>
<ErrorMessage>Invalid Credentials</ErrorMessage>
</tns:SubmitTransactionResponse>
</soap:Body>
</soap:Envelope>
Error Messages
Error messages returned from the web service represent a “Fatal Error,” meaning the submission will need to be retransmitted. The following error messages may be returned from the web service. These responses will have a <TransactionStatus> of “0” in the response.
• 'Invalid ASAP Version Specified'
• 'File {filename} has already been uploaded by account {account.name} for destination PMP {Destination_PMP_name}.'
• 'Cannot send file larger than 3 MB. Please use SFTP.'
• 'Invalid Destination PMP. Please be sure to supply a two character state code.'
• 'Account is Not Authorized for Destination PMP.'
• 'Invalid Credentials'
• 'Blank ASAP File'
• 'Unable to upload file.'
• 'Problem attempting to read the file. Please ensure the file is ASCII text and valid ASAP. {exception.message}.'
Sample Successful Response
<soap:Envelope xmlns:soap=http://schemas.xmlsoap.org/soap/envelope/
xmlns:xsd=http://www.w3.org/2001/XMLSchema xmlns:tns="pmp">
<soap:Body>
<tns:SubmitTransactionResponse>
<TransactionID>TEST</TransactionID>
<TransactionStatus>1</TransactionStatus>
<ErrorMessage/>
</tns:SubmitTransactionResponse>
</soap:Body>
</soap:Envelope>
The response for a successful submission will have a Transaction Status of “1” and the <TransactionID> will contain the Transaction Control Number, TH02, of the submission for reference.