Payment Details Object Error Codes

This document provides a comprehensive reference for validation errors related to the paymentDetails object in the Convenient Checkout API. These errors help identify issues with payment details in API requests and guide you in resolving them.

Quick Reference

• For Payment Details IIAS overview, see the IIAS Payments

Error Codes Summary

Error Code Summary

Error Title Reference	Error Title	HTTP Status	Detail Message	Scenario	Resolution
Payment Details Validation
Payment Details Not Valid	INVALID_REQUEST	400 BAD REQUEST	payment details are not valid	When Qualified Amount is either missing or null	Include a valid qualified amount in the payment details
Qualified + Vision Amount Exceeds Total Amount	INVALID_REQUEST	400 BAD REQUEST	details qualified amount + vision amount cannot be greater than amount	When the sum of qualified amount and vision amount exceeds the total amount	Ensure the sum of qualified and vision amounts is less than or equal to the total amount
Prescription Amount Exceeds Qualified Amount	INVALID_REQUEST	400 BAD REQUEST	details prescription amount cannot be greater than qualified amount	When prescription amount is greater than qualified amount	Ensure prescription amount is less than or equal to qualified amount

---

Error Codes Details

Payment Details Validation

Qualified Amount is either missing or explicitly set to null in the paymentDetails object

Scenario: QualifiedAmount is not passed in Payments Object

Sample Request:

{
  "paymentDetails": {
    "healthcare": {
      "iias": {
        "qualifiedAmount": null,
        "qualifiedAmountDetails": {
          "prescriptionAmount": 100
        }
      },
      "visionAmount": 400
    }
  },
  "metadata": {},
  "partialAuthorization": false
}

Sample Response:

{
  "title": "INVALID_REQUEST",
  "status": 400,
  "detail": "payment details are not valid"
}

Sum of the Qualified Amount and Vision amount must not exceed the Total Amount

Scenario: When the sum of qualified amount and vision amount exceeds the total amount

Sample Request:

{
  "payment": {
    "amount": 1000,
    "merchantTransactionId": "txn123456",
    "paymentDetails": {
      "healthcare": {
        "iias": {
          "qualifiedAmount": 800
        },
        "visionAmount": 300
      }
    }
  },
  "customer": {
    "email": "test@example.com"
  }
}

Sample Response:

{
  "title": "INVALID_REQUEST",
  "status": 400,
  "detail": "details qualified amount + vision amount cannot be greater than amount"
}

Prescription Amount must not exceed the Qualified Amount

Scenario: When prescription amount is greater than qualified amount

Sample Request:

{
  "payment": {
    "amount": 1000,
    "merchantTransactionId": "txn123456",
    "paymentDetails": {
      "healthcare": {
        "iias": {
          "qualifiedAmount": 500
        },
        "prescriptionAmount": 600
      }
    }
  },
  "customer": {
    "email": "test@example.com"
  }
}

Sample Response:

{
  "title": "INVALID_REQUEST",
  "status": 400,
  "detail": "details prescription amount cannot be greater than qualified amount"
}