Request attributes - payment at online booking
| Attribute | Format | Required? | Example | Description |
|---|---|---|---|---|
patient.firstName |
string | Yes | Emily | First name of patient |
patient.lastName |
string | Yes | Test | Last name |
patient.refId |
string | Yes | 12DB612A-2CBB-4FFA-B195-1F930F0A2E8B | An optional unique patient reference as set by you. This can be used to save patient details for future payments instead of setting firstName lastName and other patient details. Additionally the refId can be used within the PMS to pre-populate details entered during the online checkout experience including tokenised card information |
patient.email |
string | Yes | fahad.rahman@medipass.io | Email address |
patient.mobile |
string | 0491 570 006 | Mobile number | |
patient.dobString |
string | Yes | 1990-01-01 | Date of birth in YYYY-MM-DD format |
providerNumber |
string | Yes | 2429581T | Medicare registered provider number |
invoiceReference |
string | Y | PMSTest123 | Invoice unique reference - should align to invoice/transaction number set in the PMS and as shown to the provider. |
callbackOrigin |
string | C*(if using checkout SDK) | https://medipass.com.au | The URL of the booking website. |
sendReceipt |
boolean | "true" or "false" | If set to true, will automatically email a payment receipt. | |
| For each item | Itemised charges can be displayed to patients. To set, each item as object in nonClaimableItems array | |||
nonClaimableItems.serviceDate |
string | Yes | 2020-06-16 | Service date for invoice. If blank, auto populates to current date |
nonClaimableItems.reference |
string | Yes | 01 | Reference for the non claimable item |
nonClaimableItems.chargeAmount |
string | Yes | $55.00 | Price for service |