IPrimeSuiteAPI REST API Documentation


PostPayments


Method: POST

URI Template: https://api-test.greenwaymedical.com/Integration/RESTv1.0/PrimeSuiteAPIService/Patient/Billing/PostPayments

Request Format: Xml or Json

Request XML Example (schema): 

<?xml version="1.0" encoding="utf-16"?>
<PaymentRequest>
  <Header>
    <SourceSiteID>String Content</SourceSiteID>
    <DestinationSiteID>String Content</DestinationSiteID>
    <PrimeSuiteUserID>0</PrimeSuiteUserID>
  </Header>
  <Credentials>
    <PrimeSuiteCredential>
      <PrimeSuiteSiteId>String Content</PrimeSuiteSiteId>
      <PrimeSuiteUserName>String Content</PrimeSuiteUserName>
      <PrimeSuiteUserPassword>String Content</PrimeSuiteUserPassword>
      <PrimeSuiteUserAlias>String Content</PrimeSuiteUserAlias>
    </PrimeSuiteCredential>
    <VendorCredential>
      <VendorLogin>String Content</VendorLogin>
      <VendorPassword>String Content</VendorPassword>
    </VendorCredential>
  </Credentials>
  <PatientID>0</PatientID>
  <VisitID>0</VisitID>
  <Copay>0</Copay>
  <Balance>0</Balance>
  <PrePay>0</PrePay>
  <PaymentMethod>0</PaymentMethod>
  <PaymentSupplier>0</PaymentSupplier>
  <CheckRefNum>0</CheckRefNum>
  <Note>String Content</Note>
</PaymentRequest>

Request Json Example (schema): 

{
  "Header": {
    "SourceSiteID": "String Content",
    "DestinationSiteID": "String Content",
    "PrimeSuiteUserID": 0
  },
  "Credentials": {
    "PrimeSuiteCredential": {
      "PrimeSuiteSiteId": "String Content",
      "PrimeSuiteUserName": "String Content",
      "PrimeSuiteUserPassword": "String Content",
      "PrimeSuiteUserAlias": "String Content"
    },
    "VendorCredential": {
      "VendorLogin": "String Content",
      "VendorPassword": "String Content"
    }
  },
  "PatientID": 0,
  "VisitID": 0,
  "Copay": 0.0,
  "Balance": 0.0,
  "PrePay": 0.0,
  "PaymentMethod": 0,
  "PaymentSupplier": 0,
  "CheckRefNum": 0,
  "Note": "String Content"
}

Response Format: Xml

Response XML Example (schema):

<?xml version="1.0" encoding="utf-16"?>
<PaymentResponse>
  <PaymentPostedErrorStatus>String Content</PaymentPostedErrorStatus>
  <PaymentPostedStatus>String Content</PaymentPostedStatus>
</PaymentResponse>

Response Format: Json

Response Example (schema):

{
  "PaymentPostedErrorStatus": "String Content",
  "PaymentPostedStatus": "String Content"
}