API Reference

Create Payment and Orders

post
https://patient-api.portals.care/v2/checkout//payments

Verifies payment confirmation for the specified cart and, if successful, creates one or more final orders based on the cart's contents.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required

The unique identifier of the cart to process payment for.

Body Params
string
required

The URL to redirect the patient to after payment confirmation (e.g., for 3D Secure).

string

The ID of the saved payment method to use. This field is optional and is ignored if the cart already has a paymentIntentId set.

shippingAddress
object
required

The full shipping address for the order.

pharmacyAddress
object

The address of a third-party pharmacy for prescription fulfillment, if applicable.

boolean

A boolean indicating whether the prescription should be transferred out to the specified pharmacy.

string

The coupon code to apply during checkout finalization.

boolean

A flag indicating if the provided shippingAddress is new and should be saved to the patient's profile.

string

The unique identifier of the group the resulting order(s) should be assigned to.

boolean

A flag indicating that this request is being made after a redirect from a 3D Secure confirmation, typically as a fallback if the webhook failed.

Headers
string
required

A Valid JWT Authentication token.

string

Your unique Organization ID. This header is only required when using a custom portal domain, otherwise it is optional.

Responses

Updated 4 months ago

Language
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 4 months ago