Validate Card Details

POST https://{base_url}/v2/merchant/cartValidation

The Request Body must be an array containing exactly one object. This object includes the details of the transaction and payment information.

This endpoint is used to validate the transaction details provided in a cart. It performs both general validation and mandatory field checks on the transaction data. The endpoint returns a success message if all validations pass, or detailed error messages if any validations fail.

Headers

Name	Value
Content-Type	application/json

Body

Name	Type	Required	Description
arn	String	False	Alphanumeric string with a maximum length of 24 characters.
orderId	String	False	Order ID with a maximum length of 25 characters.
orderDate	String	False	The date of the order in ISO 8601 format. Must be a string and cannot exceed 20 characters.
paymentDescriptor	String	False	Descriptor for the payment, with a maximum length of 25 characters.
authorizationCode	String	False	Alphanumeric code with a maximum length of 6 characters.
authorizationDate	String	False	The date of authorization in ISO 8601 format. Must be a string and cannot exceed 25 characters.
authorizationCurrency	String	False	The currency of the authorization. Must be a string and cannot exceed 3 characters.
authorizationAmount	Number	False	The amount of the authorization. Must be a decimal value with up to 2 decimal places, and cannot exceed 13 characters.
settlementDate	String	False	The date of settlement in ISO 8601 format. Must be a string and cannot exceed 25 characters.
settlementCurrency	String	False	The currency of the settlement. Must be a string and cannot exceed 3 characters.
settleAmount	Number	False	The amount of the settlement. Must be a decimal value with up to 2 decimal places, and cannot exceed 13 characters.
creditCardBin	String	False	The first 6 digits of the credit card number. Must be exactly 6 characters.
creditCardLastFour	String	False	The last 4 digits of the credit card number. Must be exactly 4 characters.
details	Object	False	Additional details related to the transaction.
details.transactionDetail	Object	False	Specific transaction details.
details.transactionDetail.taxAmount	Array	False	Array containing tax amounts.
details.transactionDetail.taxAmountCurrency	Array	False	Array containing tax amount currencies.
details.transactionDetail.shippingAndHandlingAmount	Array	False	Array containing shipping and handling amounts.
details.transactionDetail.shippingAndHandlingCurrency	Array	False	Array containing shipping and handling amount currencies.
details.transactionDetail.totalAmount	Number	False	The total amount of the transaction.
details.transactionDetail.totalAmountCurrency	String	False	The currency of the total amount.
details.transactionDetail.billingAddressDetails	Object	False	Object containing billing address details.
details.transactionDetail.billingAddressDetails.address	Array	False	Array containing billing address lines.
details.transactionDetail.billingAddressDetails.city	String	False	The city of the billing address.
details.transactionDetail.billingAddressDetails.state	String	False	The state of the billing address.
details.transactionDetail.billingAddressDetails.zip	String	False	The ZIP code of the billing address.
details.transactionDetail.billingAddressDetails.country	String	False	The country of the billing address.
details.transactionDetail.shippingAddressDetails	Array	False	Array containing shipping address details.
details.transactionDetail.avsChecked	Boolean	False	Whether AVS was checked or not.
details.transactionDetail.cvvChecked	Boolean	False	Whether CVV was checked or not.
details.transactionDetail.refundAmount	Number	False	The amount refunded.
details.transactionDetail.refundCurrency	String	False	The currency of the refund amount.
details.transactionDetail.dateOfRefund	String	False	The date of the refund in ISO 8601 format.
details.transactionDetail.deviceName	String	False	The name of the device used for the transaction.
details.transactionDetail.deviceId	String	False	The ID of the device used for the transaction.
details.transactionDetail.ipAddress	String	False	The IP address of the device used for the transaction.
details.transactionDetail.termsAndConditions	String	False	URL to the terms and conditions.
details.customerInformation	Object	False	Object containing customer information.
details.customerInformation.firstName	String	False	The first name of the customer.
details.customerInformation.lastName	String	False	The last name of the customer.
details.customerInformation.lengthOfRelationship	String	False	The length of the relationship with the customer.
details.customerInformation.emailAddress	String	False	The email address of the customer.
details.productPurchased	Array	False	Array containing information about the products purchased.
details.productPurchased[].productName	String	False	The name of the product purchased.
details.productPurchased[].productUrl	String	False	The URL of the product purchased.
details.productPurchased[].unitPriceCurrency	String	False	The currency of the unit price.
details.productPurchased[].unitPriceAmount	Object	False	Object containing the unit price amount and currency.
details.productPurchased[].unitPriceAmount.amount	Number	False	The unit price amount of the product.
details.productPurchased[].unitPriceAmount.currency	String	False	The currency of the unit price.
details.productPurchased[].quantity	String	False	The quantity of the product purchased.
details.productPurchased[].industryDetails	Object	False	Object containing industry-specific details such as flight or hotel details.
details.productPurchased[].industryDetails.flightDetails	Array	False	Array containing flight-related details.
details.productPurchased[].industryDetails.hotelDetails	Array	False	Array containing hotel-related details.
details.deliveryDetails	Object	False	Object containing delivery-related details.
details.deliveryDetails.physicalFulfillment	Array	False	Array containing physical fulfillment details, such as shipment and delivery information.
details.deliveryDetails.physicalFulfillment[].shippingCarrierUrl	String	False	The URL of the shipping carrier's tracking page.
details.deliveryDetails.physicalFulfillment[].trackingNumber	String	False	The tracking number provided by the shipping carrier.
details.deliveryDetails.physicalFulfillment[].dateOfShipment	String	False	The date the item was shipped.
details.deliveryDetails.physicalFulfillment[].dateOfDelivery	String	False	The date the item was delivered.
details.crmDetails	Array	False	Array containing customer relationship management (CRM) details.
details.crmDetails[].notes	String	False	Notes about the interaction.
details.attachments	Array	False	Array containing attachments related to the transaction.
details.attachments[].id	String	False	The ID of the attachment.
details.attachments[].fileName	String	False	The file name of the attachment.
details.attachments[].friendlyFileName	String	False	The friendly name of the attachment.
details.attachments[].mimeType	String	False	The MIME type of the attachment.
details.attachments[].receivedDate	String	False	The date the attachment was received.
details.attachments[].fileSource	String	False	The source of the file.
details.attachments[].data	String	False	The base64 encoded data of the attachment

Validate Transaction Details

Merchant Cart Validation

POSThttps://{baseUrl}/api/v2/merchant/cartValidation

Body

application/json

the JSON payload

arnstring

orderIdstring

orderDatestring (date-time)

paymentDescriptorstring

authorizationCodestring

authorizationDatestring (date-time)

authorizationCurrencystring

authorizationAmountnumber

settlementDatestring (date-time)

settlementCurrencystring

settlementAmountnumber

creditCardBinstring

detailsobject

Response

200400default

Successful Response

Body

application/json

statusstring

Example: "ok"

msgstring

Example: "Validation successfully"

Request

JavaScriptCurlPython

const response = await fetch('https://{baseUrl}/api/v2/merchant/cartValidation', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify([
      {
        "arn": "24692163176000409618961",
        "orderId": "3235354",
        "orderDate": "2020-06-03T20:10:00Z",
        "paymentDescriptor": "AASFD*1715341234",
        "authorizationCode": "352837",
        "authorizationDate": "2020-06-03T20:10:00Z",
        "authorizationCurrency": "USD",
        "authorizationAmount": 110.11,
        "settlementDate": "2020-06-03T20:10:00Z",
        "settlementCurrency": "USD",
        "settlementAmount": 110.11,
        "creditCardBin": "435600",
        "details": {
          "transactionDetail": {
            "taxAmount": [
              1.99
            ],
            "taxAmountCurrency": [
              "USD"
            ],
            "shippingAndHandlingAmount": [
              1.99
            ],
            "shippingAndHandlingCurrency": [
              "USD"
            ],
            "totalAmount": 19.99,
            "totalAmountCurrency": "USD",
            "billingAddressDetails": {
              "address": [
                "2144 Easton Dr"
              ],
              "city": "New York",
              "state": "NY",
              "zip": "14490",
              "country": "USA"
            },
            "shippingAddressDetails": [
              {
                "address": [
                  "2144 Easton Dr"
                ],
                "city": "New York",
                "state": "NY",
                "zip": "14490",
                "country": "USA"
              }
            ],
            "avsChecked": true,
            "cvvChecked": true,
            "refundAmount": 34.25,
            "refundCurrency": "USD",
            "dateOfRefund": "2020-06-29T18:45:36Z",
            "deviceName": "Johns Phone",
            "deviceId": "12313212-asdfa-123123",
            "ipAddress": "192.168.50.123",
            "termsAndConditions": "http://www.example.com/legal/terms.html"
          },
          "customerInformation": {
            "firstName": "John",
            "lastName": "Doe",
            "lengthOfRelationship": "3",
            "emailAddress": "[e-mail]"
          },
          "productPurchased": [
            {
              "productName": "Z 12 Month Antivirus Protection 1",
              "productUrl": "http://www.example.com/store/sku/16309",
              "unitPriceCurrency": "USD",
              "unitPriceAmount": {
                "amount": 100.25,
                "currency": "USD"
              },
              "quantity": "1",
              "industryDetails": {
                "flightDetails": [
                  {
                    "memberRewardsNumber": "LP33767",
                    "manifest": "#317-14-CA"
                  }
                ],
                "hotelDetails": [
                  {
                    "reservationNumber": "39743KLM",
                    "reservationDate": "2020-06-29T18:45:36Z",
                    "checkInDate": "2020-06-29T18:45:36Z",
                    "checkOutDate": "2020-06-29T18:45:36Z",
                    "memberRewardsNumber": "37350112"
                  }
                ]
              }
            }
          ],
          "deliveryDetails": {
            "physicalFulfillment": [
              {
                "shippingCarrierUrl": "http://www.fedex.com",
                "trackingNumber": "11347896123423u42SSAKSDD",
                "dateOfShipment": "2014-11-02T00:00:00Z",
                "dateOfDelivery": "2014-11-03T00:00:00Z"
              }
            ]
          },
          "crmDetails": [
            {
              "notes": "1 URL for voicerecording, refund issued, tech support history"
            }
          ],
          "attachments": [
            {
              "id": "217446",
              "fileName": "license_draft.pdf",
              "friendlyFileName": "license.pdf",
              "mimeType": "application/pdf",
              "receivedDate": "2020-06-29T18:45:36Z",
              "fileSource": "uploaded by customer",
              "data": "WW91IGRhdGEu"
            }
          ]
        }
      }
    ]),
});
const data = await response.json();

Response

200400default

{
  "status": "ok",
  "msg": "Validation successfully"
}