POST appointments/initiate-payment
Request Information
URI Parameters
None.
Body Parameters
AppointmentPaymentRequestDto| Name | Description | Type | Additional information |
|---|---|---|---|
| PaymentGatewayId | globally unique identifier |
None. |
|
| DoctorClinicId | globally unique identifier |
None. |
|
| SessionID | globally unique identifier |
None. |
|
| TimeSlot | string |
None. |
|
| TimeSlotType | integer |
None. |
|
| Patient | PatientDto |
None. |
Request Formats
application/json, text/json
Sample:
{
"PaymentGatewayId": "9b13957e-8c5e-4f07-9c26-be5155677071",
"DoctorClinicId": "104834f7-efc3-4acc-b5e7-ba073030c34f",
"SessionID": "a8f0cebc-2751-4b41-bbbb-b1ccf7df2468",
"TimeSlot": "sample string 4",
"TimeSlotType": 5,
"Patient": {
"ID": "dc0d33cb-5bef-4cef-81f9-92218316250e",
"EMR": "sample string 2",
"Name": {
"Initial": "sample string 1",
"FirstName": "sample string 2",
"MiddleName": "sample string 3",
"LastName": "sample string 4",
"FullName": "sample string 2 sample string 3 sample string 4"
},
"FatherName": {
"Initial": "sample string 1",
"FirstName": "sample string 2",
"MiddleName": "sample string 3",
"LastName": "sample string 4",
"FullName": "sample string 2 sample string 3 sample string 4"
},
"Gender": 64,
"GenderName": "sample string 4",
"Age": {
"Year": 1,
"Month": 2
},
"Email": "sample string 5",
"MobileNo": {
"IsdCode": "sample string 1",
"AccessNumber": "sample string 2"
},
"Address": "sample string 6",
"Place": "sample string 7"
}
}
application/xml, text/xml
Sample:
<AppointmentPaymentRequestDto xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ZoeLife.BusinessEntities">
<DoctorClinicId>104834f7-efc3-4acc-b5e7-ba073030c34f</DoctorClinicId>
<Patient>
<Address>sample string 6</Address>
<Age xmlns:d3p1="http://schemas.datacontract.org/2004/07/ZoeLife.BusinessEntities.Common.Dtos">
<d3p1:Month>2</d3p1:Month>
<d3p1:Year>1</d3p1:Year>
</Age>
<EMR>sample string 2</EMR>
<Email>sample string 5</Email>
<FatherName xmlns:d3p1="http://schemas.datacontract.org/2004/07/ZoeLife.BusinessEntities.Common.Dtos">
<d3p1:FirstName>sample string 2</d3p1:FirstName>
<d3p1:Initial>sample string 1</d3p1:Initial>
<d3p1:LastName>sample string 4</d3p1:LastName>
<d3p1:MiddleName>sample string 3</d3p1:MiddleName>
</FatherName>
<Gender>64</Gender>
<GenderName>sample string 4</GenderName>
<ID>dc0d33cb-5bef-4cef-81f9-92218316250e</ID>
<MobileNo xmlns:d3p1="http://schemas.datacontract.org/2004/07/ZoeLife.BusinessEntities.Common.Dtos">
<d3p1:AccessNumber>sample string 2</d3p1:AccessNumber>
<d3p1:IsdCode>sample string 1</d3p1:IsdCode>
</MobileNo>
<Name xmlns:d3p1="http://schemas.datacontract.org/2004/07/ZoeLife.BusinessEntities.Common.Dtos">
<d3p1:FirstName>sample string 2</d3p1:FirstName>
<d3p1:Initial>sample string 1</d3p1:Initial>
<d3p1:LastName>sample string 4</d3p1:LastName>
<d3p1:MiddleName>sample string 3</d3p1:MiddleName>
</Name>
<Place>sample string 7</Place>
</Patient>
<PaymentGatewayId>9b13957e-8c5e-4f07-9c26-be5155677071</PaymentGatewayId>
<SessionID>a8f0cebc-2751-4b41-bbbb-b1ccf7df2468</SessionID>
<TimeSlot>sample string 4</TimeSlot>
<TimeSlotType>5</TimeSlotType>
</AppointmentPaymentRequestDto>
application/x-www-form-urlencoded
Sample:
Sample not available.
Response Information
Resource Description
ResultOfAppointmentPaymentResponseDto| Name | Description | Type | Additional information |
|---|---|---|---|
| Data | AppointmentPaymentResponseDto |
None. |
|
| Messages | Collection of string |
None. |
|
| Succeeded | boolean |
None. |
Response Formats
application/json, text/json
Sample:
{
"Data": {
"MTR": "sample string 1",
"Amount": 2.1,
"PatientName": "sample string 3",
"PatientMobile": "sample string 4",
"PatientEmail": "sample string 5",
"AppointmentTimeLockId": "9c595649-e5a2-46ec-b572-8cf82b963382"
},
"Messages": [
"sample string 1",
"sample string 2"
],
"Succeeded": true
}
application/xml, text/xml
Sample:
<ResultOfAppointmentPaymentResponseDto6MSA0GaG xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ZoeLife.Shared.Wrapper">
<Messages xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d2p1:string>sample string 1</d2p1:string>
<d2p1:string>sample string 2</d2p1:string>
</Messages>
<Succeeded>true</Succeeded>
<Data xmlns:d2p1="http://schemas.datacontract.org/2004/07/ZoeLife.BusinessEntities">
<d2p1:Amount>2.1</d2p1:Amount>
<d2p1:AppointmentTimeLockId>9c595649-e5a2-46ec-b572-8cf82b963382</d2p1:AppointmentTimeLockId>
<d2p1:MTR>sample string 1</d2p1:MTR>
<d2p1:PatientEmail>sample string 5</d2p1:PatientEmail>
<d2p1:PatientMobile>sample string 4</d2p1:PatientMobile>
<d2p1:PatientName>sample string 3</d2p1:PatientName>
</Data>
</ResultOfAppointmentPaymentResponseDto6MSA0GaG>