GET api/PatientPayments/{id}

Returns the details of a payment made to a patient.

Request Information

URI Parameters

Name	Description	Type	Additional information
id	Unique ID of the payment.	integer	Required

Body Parameters

None.

Response Information

Resource Description

PatientPaymentModel

Name	Description	Type	Additional information
Id	Unique ID of the billpayment.	integer	None.
AccountId	Account ID.	globally unique identifier	None.
CreatedUtc	Created date in Utc.	string	None.
PatientId	Patient ID of the bill payment.	globally unique identifier	None.
PatientExternalId	Patient external ID.	string	None.
PatientFullName	Patient full name	string	None.
PatientBirthday	Patient birthday.	string	None.
PatientComments	Patient comments.	string	None.
ReferenceNumber	Reference number.	string	None.
ReferenceName	Reference name	string	None.
CardholderName	Cardholder name.	string	None.
CardholderAddress1	Cardholder address1.	string	None.
CardholderAddress2	Cardholder address2.	string	None.
CardholderCity	Cardholder city.	string	None.
CardholderState	Cardholder state.	string	None.
CardholderZip	Cardholder zip.	string	None.
CardholderPhoneNumber	Cardholder phone number.	string	None.
CardholderEmail	Cardholder email.	string	None.
CardType	Card type.	string	None.
Last4CardNumber	Last four card number.	string	None.
Amount	Amount.	decimal number	None.
ProcessedAmount	Processed amount.	decimal number	None.
TransactionId	Transaction ID.	string	None.
PatientCommunicationsEmail	Patient communication email.	string	None.
MessageToPracticeId	Message to practice ID.	globally unique identifier	None.
PaymentSuccessful	Payment successful.	boolean	None.
AlreadySent	Message already sent.	boolean	None.
SentOn	Date sent.	string	None.
CardExpiration	Card expiration date.	string	None.

Response Formats

application/json, text/json

Sample:

{
  "Id": 1,
  "AccountId": "9079d8fc-040b-4fa8-a005-496b660cae59",
  "CreatedUtc": "sample string 3",
  "PatientId": "7c265089-523f-4a5a-b06e-70f3f7b32a2a",
  "PatientExternalId": "sample string 5",
  "PatientFullName": "sample string 6",
  "PatientBirthday": "sample string 7",
  "PatientComments": "sample string 8",
  "ReferenceNumber": "sample string 9",
  "ReferenceName": "sample string 10",
  "CardholderName": "sample string 11",
  "CardholderAddress1": "sample string 12",
  "CardholderAddress2": "sample string 13",
  "CardholderCity": "sample string 14",
  "CardholderState": "sample string 15",
  "CardholderZip": "sample string 16",
  "CardholderPhoneNumber": "sample string 17",
  "CardholderEmail": "sample string 18",
  "CardType": "sample string 19",
  "Last4CardNumber": "sample string 20",
  "Amount": 21.0,
  "ProcessedAmount": 22.0,
  "TransactionId": "sample string 23",
  "PatientCommunicationsEmail": "sample string 24",
  "MessageToPracticeId": "ad4bd402-baed-4e7e-9cf3-8d49ed34b1ec",
  "PaymentSuccessful": true,
  "AlreadySent": true,
  "SentOn": "sample string 27",
  "CardExpiration": "sample string 28"
}

application/xml, text/xml

Sample:

<PatientPaymentModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/GlobalPortal.Mobile.Api.Models.BillPayments">
  <AccountId>9079d8fc-040b-4fa8-a005-496b660cae59</AccountId>
  <AlreadySent>true</AlreadySent>
  <Amount>21</Amount>
  <CardExpiration>sample string 28</CardExpiration>
  <CardType>sample string 19</CardType>
  <CardholderAddress1>sample string 12</CardholderAddress1>
  <CardholderAddress2>sample string 13</CardholderAddress2>
  <CardholderCity>sample string 14</CardholderCity>
  <CardholderEmail>sample string 18</CardholderEmail>
  <CardholderName>sample string 11</CardholderName>
  <CardholderPhoneNumber>sample string 17</CardholderPhoneNumber>
  <CardholderState>sample string 15</CardholderState>
  <CardholderZip>sample string 16</CardholderZip>
  <CreatedUtc>sample string 3</CreatedUtc>
  <Id>1</Id>
  <Last4CardNumber>sample string 20</Last4CardNumber>
  <MessageToPracticeId>ad4bd402-baed-4e7e-9cf3-8d49ed34b1ec</MessageToPracticeId>
  <PatientBirthday>sample string 7</PatientBirthday>
  <PatientComments>sample string 8</PatientComments>
  <PatientCommunicationsEmail>sample string 24</PatientCommunicationsEmail>
  <PatientExternalId>sample string 5</PatientExternalId>
  <PatientFullName>sample string 6</PatientFullName>
  <PatientId>7c265089-523f-4a5a-b06e-70f3f7b32a2a</PatientId>
  <PaymentSuccessful>true</PaymentSuccessful>
  <ProcessedAmount>22</ProcessedAmount>
  <ReferenceName>sample string 10</ReferenceName>
  <ReferenceNumber>sample string 9</ReferenceNumber>
  <SentOn>sample string 27</SentOn>
  <TransactionId>sample string 23</TransactionId>
</PatientPaymentModel>