Upload Transaction Batch

POST https://{base_url}/v2/merchant/{merchantId}/uploadTransactionBatch

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
Authorization	Bearer <token>

Path Parameters

Name	Description
merchantId	Merchant Id for transaction batch upload

Body

Name	Type	Required	Description
transactionDate	Datetime (ISO 8601 format)	True	Date and time when the order was placed.
paymentDescriptor	String	True	Payment descriptor as it appears on the customer's statement.
cardBin	String	True	First six digits of the credit card used for the transaction.
cardLast4	String	True	Last four digits of the credit card used for the transaction.
receipt	Object	True	Contains detailed information about the receipt
receipt.paymentInformation	Object	True	Contains detailed information about the payment information
receipt.paymentInformation.paymentTotalAmount	Object	True	Contains detailed information about the payment total amount
receipt.paymentInformation.paymentTotalAmount.amount	Number	True	The payment amount
receipt.paymentInformation.paymentTotalAmount.currency	String	True	The payment currency
customerInformation	Object	True	Contains detailed information about the customer information
customerInformation.accountId	String	True	The account id of customer
customerInformation.emailAddress	String	True	The email address of customer
merchantInformation	Object	True	Contains detailed information about the merchant information
merchantInformation.merchantName	String	True	The merchant name
merchantInformation.merchantUrl	String	True	The merchant url
merchantInformation.merchantContactPhone	String	True	The merchant contact phone
merchantInformation.storeDetails.storeName	String	True	The store name
deliveryAddress	Object	True	Contains detailed information about the delivery address
deliveryAddress.address1	String	True	The delivery address
deliveryAddress.city	String	True	The delivery city
deliveryAddress.region	String	True	The delivery region
deliveryAddress.postalCode	String	True	The delivery postal code
deliveryAddress.country	String	True	The delivery country
device	Object	True	Contains detailed information about the device
device.deviceId	String	True	The device id
device.ipAddress	String	True	The device ip address
device.deviceFingerprint	String	True	The device fingerprint

Upload Transaction Batch

Upload a batch of merchant transactions as JSON.

POSThttps://{baseUrl}/api/v2/merchant/{merchantId}/uploadTransactionBatch

Authorization

bearerAuth

Path parameters

merchantId*string

Merchant Id for transaction batch upload

Body

application/json

transactionDatestring (date-time)

Date of the transaction

Example: "2024-10-29T10:00:00Z"

cardBinstring

First 6 digits of the credit card

Example: "435600"

cardLast4string

Last 4 digits of the credit card

Example: "1234"

paymentDescriptorstring

Payment descriptor on the cardholder's bank statement

Example: "TEST*MERCHANT1234"

receiptobject

merchantInformationobject

customerInformationobject

deliveryAddressobject

deviceobject

Response

200400401500

Successful Response

Body

application/json

msgstring

Example: "Transactions processed"

resultsarray of object

Request

JavaScriptCurlPython

const response = await fetch('https://{baseUrl}/api/v2/merchant/{merchantId}/uploadTransactionBatch', {
    method: 'POST',
    headers: {
      "Authorization": "Bearer JWT",
      "Content-Type": "application/json"
    },
    body: JSON.stringify([
      {
        "transactionDate": "2024-10-29T10:00:00Z",
        "cardBin": "435600",
        "cardLast4": "1234",
        "paymentDescriptor": "TEST*MERCHANT1234",
        "receipt": {
          "paymentInformation": {
            "paymentTotalAmount": {
              "amount": 99.99,
              "currency": "USD"
            }
          },
          "productsPurchasedList": [
            {
              "productDescription": "Premium Annual Subscription",
              "deliveryDetails": {
                "deliveryStatus": "DELIVERED"
              }
            }
          ]
        },
        "merchantInformation": {
          "merchantName": "Test Merchant Services",
          "merchantUrl": "https://www.testmerchant.com",
          "merchantContactPhone": "[phone]",
          "storeDetails": {
            "storeName": "Test Store Online"
          }
        },
        "customerInformation": {
          "accountId": "CUST12345",
          "emailAddress": "[e-mail]"
        },
        "deliveryAddress": {
          "address1": "123 Test Street",
          "city": "Test City",
          "region": "TC",
          "postalCode": "12345",
          "country": "USA"
        },
        "device": {
          "deviceId": "TEST123456789012345",
          "ipAddress": "192.168.1.1",
          "deviceFingerprint": "abcd1234efgh5678"
        }
      }
    ]),
});
const data = await response.json();

Response

200400401500

{
  "msg": "Transactions processed",
  "results": [
    {
      "status": "success",
      "txShieldOICartReference": "text",
      "msg": "text"
    }
  ]
}