Add payment method

POST {{url}}/{{tenantName}}/{{instanceName}}/payment/patients/{{patientId}}/payment-methods

Create Payment Method for Patient

This endpoint allows the user to create a payment method for a specific patient.

Request

  • Method: POST

  • URL: {{url}}/{{tenantName}}/{{instanceName}}/payment/patients/{{patientId}}/payment-methods

  • Body:

    • paymentMethodId (string, required): The ID of the payment method, e.g. pm_...

Response

The response for this request is a JSON object with the following schema:

{
  "status": "string",
  "message": "string",
  "data": {
    "paymentMethodId": "string",
    // other properties...
  }
}

  • status (string): The status of the response.

  • message (string): A message indicating the result of the request.

  • data (object): An object containing the details of the created payment method, including the paymentMethodId.

Request Body

{"paymentMethodId"=>"stripe_payment_method_id"}