Update Transaction Details

POST https://{baseUrl}/api/v2/merchant/{merchantId}/updateTransactionDetails

The Authorization Header is required if JWT (JSON Web Token) authentication is enabled in the application configuration (config.server.jwt_enable is true). This header must contain a valid JWT token prefixed with the word "Bearer". The token is used to authenticate the request and verify that the sender is authorized to perform the requested operation.

The Request Body must be an array containing exactly one object. This object includes the details for updating a transaction.

This endpoint is used to update the transaction details for a specific merchant identified by merchantId. The update is performed on the transaction record based on the provided txShieldOICartReference. The updated transaction details are stored in MongoDB and, if applicable, in AWS DynamoDB.

Headers

Name	Value
Content-Type	application/json
Authorization	Bearer <token>

Path Parameters

Name	Description
merchantId	Merchant Id for update transaction

Body

Name	Type	Required	Description
txShieldOICartReference	String	True	A unique reference for the transaction that needs to be updated. This is a mandatory field.
settlementDate	String	True	The date of settlement in ISO 8601 format (Example: YYYY-MM-DDThh:mm ). Maximum length is 25 characters.
settlementCurrency	String	True	The currency of the settlement. Must be a string with a maximum length of 3 characters.
settlementAmount	Number	True	The amount of the settlement. Must be a decimal with up to 2 decimal places, and cannot exceed 13 characters.
details	Object	False	Object containing detailed information about the transaction. Optional but its subfields can have specific requirements.
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.deliveryDetails.physicalFulfillment[].signatureConfirmation	String	False	A signature confirmation for the delivery.
details.digitalServiceDelivery	Array	False	Array containing details about digital service delivery, such as proof of delivery and usage.
details.digitalServiceDelivery[].proofOfDelivery	String	False	Proof that the digital service was delivered.
details.digitalServiceDelivery[].proofOfUsage	String	False	Proof that the digital service was used.
details.digitalServiceDelivery[].locationOfUsage	String	False	Location where the digital service was used.
details.digitalServiceDelivery[].frequencyOfUsage	String	False	Frequency of use of the digital service.
details.digitalServiceDelivery[].notes	String	False	Additional notes related to the digital service delivery.
details.crmDetails	Array	False	Array containing customer relationship management (CRM) details.
details.crmDetails[].dateOfInteraction	String	False	The date of the interaction with the customer.
details.crmDetails[].contactName	String	False	The name of the contact person in the interaction.
details.crmDetails[].notes	String	False	Notes about the interaction.

Update Transaction Details

Update Merchant Transaction based on the txShieldOICartReference sent in.

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

Path parameters

merchantId*string

Merchant Id for update transaction

Body

application/json

the JSON payload

txShieldOICartReferencestring

settlementDatestring (date-time)

settlementCurrencystring

settlementAmountnumber

detailsobject

Response

200400default

Response

Body

application/json

statusstring

Example: "ok"

msgstring

Example: "Transaction has been updated"

Request

JavaScriptCurlPython

const response = await fetch('https://{baseUrl}/api/v2/merchant/{merchantId}/updateTransactionDetails', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify([
      {
        "txShieldOICartReference": "53b09896-cf5b-405b-88e8-2a0f66c41e04",
        "settlementDate": "2020-06-03T20:10:00Z",
        "settlementCurrency": "USD",
        "settlementAmount": 110.11,
        "details": {
          "deliveryDetails": {
            "physicalFulfillment": [
              {
                "shippingCarrierUrl": "http://www.fedex.com",
                "trackingNumber": "11347896123423u42SSAKSDD",
                "dateOfShipment": "2014-11-02T00:00:00Z",
                "dateOfDelivery": "2014-11-03T00:00:00Z",
                "signatureConfirmation": "Signed by family member"
              }
            ],
            "digitalServiceDelivery": [
              {
                "proofOfDelivery": "1 Customer activated account on 20160214",
                "proofOfUsage": "Service connected daily for the last 25 days to update virus database",
                "locationOfUsage": "Los Angeles, CA",
                "frequencyOfUsage": "25",
                "notes": "Customer completed survey on 20160228 stating satisfactory service"
              }
            ]
          },
          "crmDetails": [
            {
              "dateOfInteraction": "2020-06-29T18:45:36Z",
              "contactName": "John Doe",
              "notes": "1 URL for voice recording, refund issued, tech support history"
            }
          ]
        }
      }
    ]),
});
const data = await response.json();

Response

200400

{
  "status": "ok",
  "msg": "Transaction has been updated"
}