Home

PaymentMethods

GET api/Payment/{systemID}/PaymentMethods?patientID={patientID}

Retrieve listing of patient payment methods on file

Special Remarks

PaymentMethodID Field
            
            The returned PaymentMethodID field will change formats based on the type of payment method.  For Credit Cards and FSA cards,
            it will be a unique 4 digit number. Checks will show the check number, Payroll Deduction and Charge Accounts will show the patientID.

Request Information

Parameters

NameDescriptionAdditional information
systemID 
The SystemID of the pharmacy system.

Define this parameter in the request URI.
patientID 
Unique ID of patient in pharmacy system.

Define this parameter in the request URI.
    

Response Codes

    
  • OK (200)
  • NotFound (404)
  • InternalServerError (500)
  • BadRequest (400)
    •     

Response Information

List of Patient Payment Methods

Response body formats

application/json, text/json

Sample: 
[
  {
    "PatientID": "sample string 1",
    "OrderNo": 2,
    "PaymentType": "sample string 3",
    "PaymentTypeDescription": "sample string 4",
    "CardType": "sample string 5",
    "PaymentMethodID": "sample string 6",
    "PaymentInfo": "sample string 7",
    "MaxAmount": 8.0,
    "LastAmountCharged": 9.0,
    "DateLastUsed": "sample string 10",
    "DateLastModified": "sample string 11",
    "DateAdded": "sample string 12",
    "ExpirationDate": "sample string 13",
    "NameOnCard": "sample string 14"
  },
  {
    "PatientID": "sample string 1",
    "OrderNo": 2,
    "PaymentType": "sample string 3",
    "PaymentTypeDescription": "sample string 4",
    "CardType": "sample string 5",
    "PaymentMethodID": "sample string 6",
    "PaymentInfo": "sample string 7",
    "MaxAmount": 8.0,
    "LastAmountCharged": 9.0,
    "DateLastUsed": "sample string 10",
    "DateLastModified": "sample string 11",
    "DateAdded": "sample string 12",
    "ExpirationDate": "sample string 13",
    "NameOnCard": "sample string 14"
  },
  {
    "PatientID": "sample string 1",
    "OrderNo": 2,
    "PaymentType": "sample string 3",
    "PaymentTypeDescription": "sample string 4",
    "CardType": "sample string 5",
    "PaymentMethodID": "sample string 6",
    "PaymentInfo": "sample string 7",
    "MaxAmount": 8.0,
    "LastAmountCharged": 9.0,
    "DateLastUsed": "sample string 10",
    "DateLastModified": "sample string 11",
    "DateAdded": "sample string 12",
    "ExpirationDate": "sample string 13",
    "NameOnCard": "sample string 14"
  }
]

text/javascript

Sample: 
[{"PatientID":"sample string 1","OrderNo":2,"PaymentType":"sample string 3","PaymentTypeDescription":"sample string 4","CardType":"sample string 5","PaymentMethodID":"sample string 6","PaymentInfo":"sample string 7","MaxAmount":8.0,"LastAmountCharged":9.0,"DateLastUsed":"sample string 10","DateLastModified":"sample string 11","DateAdded":"sample string 12","ExpirationDate":"sample string 13","NameOnCard":"sample string 14"},{"PatientID":"sample string 1","OrderNo":2,"PaymentType":"sample string 3","PaymentTypeDescription":"sample string 4","CardType":"sample string 5","PaymentMethodID":"sample string 6","PaymentInfo":"sample string 7","MaxAmount":8.0,"LastAmountCharged":9.0,"DateLastUsed":"sample string 10","DateLastModified":"sample string 11","DateAdded":"sample string 12","ExpirationDate":"sample string 13","NameOnCard":"sample string 14"},{"PatientID":"sample string 1","OrderNo":2,"PaymentType":"sample string 3","PaymentTypeDescription":"sample string 4","CardType":"sample string 5","PaymentMethodID":"sample string 6","PaymentInfo":"sample string 7","MaxAmount":8.0,"LastAmountCharged":9.0,"DateLastUsed":"sample string 10","DateLastModified":"sample string 11","DateAdded":"sample string 12","ExpirationDate":"sample string 13","NameOnCard":"sample string 14"}]

application/xml, text/xml

Sample: 
<ArrayOfPaymentMethod xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/QCFWebAPI.Models">
  <PaymentMethod>
    <CardType>sample string 5</CardType>
    <DateAdded>sample string 12</DateAdded>
    <DateLastModified>sample string 11</DateLastModified>
    <DateLastUsed>sample string 10</DateLastUsed>
    <ExpirationDate>sample string 13</ExpirationDate>
    <LastAmountCharged>9</LastAmountCharged>
    <MaxAmount>8</MaxAmount>
    <NameOnCard>sample string 14</NameOnCard>
    <OrderNo>2</OrderNo>
    <PatientID>sample string 1</PatientID>
    <PaymentInfo>sample string 7</PaymentInfo>
    <PaymentMethodID>sample string 6</PaymentMethodID>
    <PaymentType>sample string 3</PaymentType>
    <PaymentTypeDescription>sample string 4</PaymentTypeDescription>
  </PaymentMethod>
  <PaymentMethod>
    <CardType>sample string 5</CardType>
    <DateAdded>sample string 12</DateAdded>
    <DateLastModified>sample string 11</DateLastModified>
    <DateLastUsed>sample string 10</DateLastUsed>
    <ExpirationDate>sample string 13</ExpirationDate>
    <LastAmountCharged>9</LastAmountCharged>
    <MaxAmount>8</MaxAmount>
    <NameOnCard>sample string 14</NameOnCard>
    <OrderNo>2</OrderNo>
    <PatientID>sample string 1</PatientID>
    <PaymentInfo>sample string 7</PaymentInfo>
    <PaymentMethodID>sample string 6</PaymentMethodID>
    <PaymentType>sample string 3</PaymentType>
    <PaymentTypeDescription>sample string 4</PaymentTypeDescription>
  </PaymentMethod>
  <PaymentMethod>
    <CardType>sample string 5</CardType>
    <DateAdded>sample string 12</DateAdded>
    <DateLastModified>sample string 11</DateLastModified>
    <DateLastUsed>sample string 10</DateLastUsed>
    <ExpirationDate>sample string 13</ExpirationDate>
    <LastAmountCharged>9</LastAmountCharged>
    <MaxAmount>8</MaxAmount>
    <NameOnCard>sample string 14</NameOnCard>
    <OrderNo>2</OrderNo>
    <PatientID>sample string 1</PatientID>
    <PaymentInfo>sample string 7</PaymentInfo>
    <PaymentMethodID>sample string 6</PaymentMethodID>
    <PaymentType>sample string 3</PaymentType>
    <PaymentTypeDescription>sample string 4</PaymentTypeDescription>
  </PaymentMethod>
</ArrayOfPaymentMethod>