Confirmation

Overview

The /api/v1/customer-payment-confirmation endpoint is used by third-party applications to confirm payment details for a specific case. This endpoint allows the application to confirm that a payment has been made outside of the system and provide the necessary details for the payment.

The endpoint returns a successful response if the payment confirmation is successful.

Base URLs

• Production: https://api.care360-next.carevalidate.com/api/v1/customer-payment-confirmation
• Staging: https://api-staging.care360-next.carevalidate.com/api/v1/customer-payment-confirmation

Method: POST

Authentication

Required Headers

cv-api-key: your-secret-api-key
Content-Type: application/json

Request Body Structure

Field	Type	Required	Description
caseId	string	Yes	Care Validate system Case ID
amount	number	Yes	Amount of the payment (e.g. 50)
description	string	No	Description of the payment (e.g. Payment for Compounded Semaglutide)
paymentDate	string	Yes	Payment date in ISO format YYYY-MM-DD (e.g. 2025-01-01)
status	string	Yes	Supported status. PAID, UNPAID, CANCELED, IN_DISPUTE, LOST_DISPUTE, REFUND, ERROR
validUntil	string	Yes	Payment validity end date in ISO format YYYY-MM-DD (e.g. 2025-02-01)

Request Example

curl -X POST https://api.care360-next.carevalidate.com/api/v1/customer-payment-confirmation
-H "Content-Type:application/json"
-H "CV-Api-Key:<redacted - obtain from CareValidate>"
-d '{
    "caseId": "<redacted - obtain from other API calls>",
    "amount": 50,
    "paymentDate": "2025-01-01",
    "validUntil": "2025-02-01",
    "status": "PAID",
    "description": "Payment for Compounded Semaglutide"
}'

Response Body Structure

{
  "status": 200,
  "success": true
}