LogoLogo
PayShield - Order Insight / TxFind
PayShield - Order Insight / TxFind
  • Overview
    • Overview
  • Integration
    • Integration Overview
    • Merchant Integration
    • Provider Integration
  • Provider
    • Verifi Provider Search
    • EMS Provider Search
  • Merchant
    • Store Transaction Details
    • Update Transaction Details
    • Validate Cart Details
    • Upload Transaction Batch
    • Upload Transaction Batch File
    • Get Merchant Descriptors
  • Cart
    • cart Flag alert received
    • cart Flag chargeback received
    • get all cart attachment data and related meta data
Powered by GitBook
On this page
Edit on GitHub
  1. Merchant

Validate Cart 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

PreviousUpdate Transaction DetailsNextUpload Transaction Batch

Last updated 12 days ago

  • Headers
  • Body
  • POSTValidate Transaction Details

Validate Transaction Details

post

Merchant Cart Validation

Authorizations
Body
cardBinstring · min: 6 · max: 8Required

First 6 or 8 digits of the card used in the transaction. Must be numeric.

Pattern: ^[0-9]+$
cardLast4string · min: 4 · max: 4Required

Last 4 digits of the card used in the transaction. Must be numeric.

Pattern: ^[0-9]+$
transactionDatestring · date-timeRequired

The date and time of the transaction in ISO 8601 format. Must be earlier than today.

paymentDescriptorstring · max: 25Required

Payment descriptor identifying the transaction.

arnstring · max: 24Optional

Acquirer Reference Number.

authCodestring · max: 6Optional

Authorization code for the transaction.

recipientCustomerNamestring · max: 20Optional

Name of the recipient customer.

Responses
200
Successful Response
application/json
400
Error
application/json
default
Error Payload
application/json
post
POST /api/v2/merchant/cartValidation HTTP/1.1
Host: {baseurl}
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 5769

[
  {
    "transactionDate": "2025-01-01T12:00:00Z",
    "cardBin": "411111",
    "cardLast4": "1111",
    "paymentDescriptor": "EXAMPLE MERCHANT",
    "arn": "12345678901234567890",
    "authCode": "123456",
    "receipt": {
      "orderDate": "2023-01-27T19:11:28Z",
      "orderNumber": "53212X",
      "purchaseCategory": "MERCHANDISE",
      "invoiceNumber": "BBB23243432",
      "subTotalAmount": {
        "amount": 247.5,
        "currency": "USD"
      },
      "taxAmount": {
        "amount": 23,
        "currency": "USD"
      },
      "taxDescription": "CA state 8%",
      "shippingAndHandlingAmount": {
        "amount": 40,
        "currency": "USD"
      },
      "orderTotalAmount": {
        "amount": 310.5,
        "currency": "USD"
      },
      "paymentInformation": {
        "paymentMethod": "VISA xxxxxxxxxxxx1111",
        "billingName": "Joe Customer",
        "billingAddressDetails": {
          "address1": "5670 Wilshire Blvd",
          "address2": "Suite 2200",
          "city": "Los Angeles",
          "region": "CA",
          "postalCode": "90036",
          "country": "USA"
        },
        "paymentSubTotalAmount": {
          "amount": 247.5,
          "currency": "USD"
        },
        "paymentTotalBeforeTax": {
          "amount": 287.5,
          "currency": "USD"
        },
        "paymentTaxAmount": {
          "amount": 23,
          "currency": "USD"
        },
        "paymentTaxDescription": "CA state 8%",
        "paymentTotalAmount": {
          "amount": 123.45,
          "currency": "USD"
        },
        "cvvChecked": true
      },
      "productsPurchasedList": [
        {
          "productType": "ELECTRONICS",
          "productDescription": "ABC Smart Watch, Fitness Tracker and Health Monitor",
          "productUrl": "https://www.verifi.com/product/7366",
          "artistOrSeller": "QualityElectronics",
          "unitPriceAmount": {
            "amount": 100.25,
            "currency": "USD"
          },
          "quantity": 1,
          "deliveryDetails": {
            "shippingCarrier": "UPS",
            "dateOfShipment": "2023-01-27T19:11:28Z",
            "dateOfDelivery": "2023-01-29T11:44:00Z",
            "otherStatusDescription": "DELIVERED: Left at front door",
            "trackingNumber": "1Z9999999999999999",
            "deliveryStatus": "OTHER"
          }
        }
      ]
    },
    "merchantInformation": {
      "merchantName": "Example Merchant LLC",
      "merchantUrl": "https://www.examplemerchant.com",
      "websiteUrl": "https://www.examplemerchantsale.com",
      "merchantContactPhone": "+18005551234",
      "merchantAddress": {
        "address1": "5670 Wilshire Blvd",
        "address2": "Suite 2200",
        "city": "Los Angeles",
        "region": "CA",
        "postalCode": "90036",
        "country": "USA"
      },
      "termsAndConditions": "https://www.examplemerchant.com/terms-of-use/",
      "storeDetails": {
        "storeName": "Example Store Location",
        "storeContactPhone": "+13236555789",
        "storeLocation": {
          "geoLocation": {
            "latitude": "34.0620",
            "longitude": "-118.3521"
          },
          "locationAddress": {
            "address1": "5670 Wilshire Blvd",
            "address2": "Suite 2200",
            "city": "Los Angeles",
            "region": "CA",
            "postalCode": "90036",
            "country": "USA"
          }
        }
      }
    },
    "customerInformation": {
      "accountId": "CUST-12345",
      "emailAddress": "customer@example.com",
      "firstName": "John",
      "lastName": "Doe",
      "lengthOfRelationship": "4"
    },
    "deliveryAddress": {
      "address1": "123 Main Street",
      "address2": "Suite 2200",
      "city": "Anytown",
      "region": "ST",
      "postalCode": "12345",
      "country": "USA"
    },
    "device": {
      "deviceId": "a1b2c3d4e5f6g7h8i9j0",
      "deviceType": "Mobile",
      "deviceName": "John's iPhone",
      "ipAddress": "192.168.1.1",
      "deviceFingerprint": "xyz-device-fingerprint-123",
      "deviceLocation": {
        "geoLocation": {
          "latitude": "34.0620",
          "longitude": "-118.3521"
        },
        "locationAddress": {
          "address1": "5670 Wilshire Blvd",
          "address2": "Suite 2200",
          "city": "Los Angeles",
          "region": "CA",
          "postalCode": "90036",
          "country": "USA"
        }
      }
    },
    "flightDetails": {
      "reservationNumber": "CSX-09283",
      "reservationDate": "2023-01-30T19:11:28Z",
      "memberRewardsNumber": "U1985932",
      "memberRewardsName": "Joe Customer",
      "passengerName1": "Joe Customer",
      "passengerName2": "Maria Customer",
      "passengerName3": "John Customer",
      "passengerName4": "Philip Customer",
      "passengerName5": "Tracy Customer",
      "itinerary": "ORD to LAX Premium Economy",
      "additionalRelatedPurchases": 0,
      "flightManifestName": "Joe Customer",
      "flightManifestDateOfBirth": "1990-01-15T00:00:00Z",
      "travelUtilizationIndicator": true,
      "travelInsurance": "https://www.example.com/link/283737",
      "reservationReceivedFrom": "Joe Customer",
      "termsAndConditions": "https://www.example.com/terms-of-use/"
    },
    "hotelDetails": {
      "reservationNumber": "M3928472",
      "reservationDate": "2023-01-30T19:11:28Z",
      "memberRewardsNumber": "JC8377-HKP",
      "memberRewardsNameRegistered": "Joe Customer",
      "checkInDate": "2023-01-29T19:11:28Z",
      "checkOutDate": "2023-01-30T07:12:45Z",
      "lengthOfStay": 1,
      "hotelRoomType": "KING GARDEN VIEW",
      "travelInsurance": "https://www.example.com/policy/insurance",
      "reservationReceivedFrom": "Joe Customer",
      "termsAndConditions": "https://www.example.com/terms-of-use/"
    },
    "carRentalDetails": {
      "reservationNumber": "C2837472",
      "reservationDate": "2023-01-30T19:11:28Z",
      "memberRewardsNumber": "REW028842",
      "memberRewardsName": "Joe Customer",
      "carRentalVehicleDescription": "Ford Bronco Sport - Blue",
      "carRentalPickupDate": "2023-01-30T19:11:28Z",
      "carRentalPickupLocation": {
        "geoLocation": {
          "latitude": "34.0522",
          "longitude": "-118.2437"
        },
        "locationAddress": {
          "address1": "5670 Wilshire Blvd",
          "address2": "Suite 2200",
          "city": "Los Angeles",
          "region": "CA",
          "postalCode": "90036",
          "country": "USA"
        }
      },
      "carRentalDropOffDate": "2023-01-30T19:11:28Z",
      "carRentalDropOffLocation": {
        "geoLocation": {
          "latitude": "34.0522",
          "longitude": "-118.2437"
        },
        "locationAddress": {
          "address1": "5670 Wilshire Blvd",
          "address2": "Suite 2200",
          "city": "Los Angeles",
          "region": "CA",
          "postalCode": "90036",
          "country": "USA"
        }
      },
      "travelInsurance": "https://www.example.com/insurance",
      "reservationReceivedFrom": "Joe Customer",
      "termsAndConditions": "https://www.example.com/terms-of-use/"
    },
    "rideShareDetails": {
      "pickupLocation": {
        "geoLocation": {
          "latitude": "34.0620",
          "longitude": "-118.3521"
        },
        "locationAddress": {
          "address1": "5670 Wilshire Blvd",
          "address2": "Suite 2200",
          "city": "Los Angeles",
          "region": "CA",
          "postalCode": "90036",
          "country": "USA"
        }
      },
      "dropOffLocation": {
        "geoLocation": {
          "latitude": "34.0620",
          "longitude": "-118.3521"
        },
        "locationAddress": {
          "address1": "5670 Wilshire Blvd",
          "address2": "Suite 2200",
          "city": "Los Angeles",
          "region": "CA",
          "postalCode": "90036",
          "country": "USA"
        }
      },
      "dateOfTrip": "2023-01-30T19:11:28Z",
      "totalAmount": {
        "amount": 100.25,
        "currency": "USD"
      },
      "vehicleDescription": "Toyota Corolla 4DR - Silver",
      "termsAndConditions": "https://www.example.com/terms-of-use/"
    }
  }
]
{
  "status": "ok",
  "msg": "Validation successfully"
}