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.

Update Transaction Details

post

Update Merchant Transaction based on the txShieldOICartReference

Authorizations

Path parameters

merchantIdstringrequired

Merchant Id for update transaction

Body

txShieldOICartReferencestringrequired

The unique reference for the transaction to be updated.

cardBinstringoptional

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

cardLast4stringoptional

Last 4 digits of the card used in the transaction.

receiptobjectoptional

customerInformationobjectoptional

Responses

application/json

application/json

application/json

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://{baseUrl}/api/v2/merchant/{merchantId}/updateTransactionDetails' \
  --header 'Authorization: Bearer JWT' \
  --header 'Content-Type: application/json' \
  --data '[
    {
      "txShieldOICartReference": "b1eb8c8f-6812-4596-9b53-6073631363c8",
      "cardBin": "511111",
      "cardLast4": "2222",
      "receipt": {
        "productsPurchasedList": [
          {
            "productDescription": "Updated Product Description",
            "deliveryDetails": {
              "deliveryStatus": "DELIVERED",
              "dateOfShipment": "2025-01-05T09:00:00Z"
            }
          }
        ]
      },
      "customerInformation": {
        "emailAddress": "[e-mail]"
      }
    }
  ]'

application/json

200

400

403

404

500

200

{
  "status": "ok",
  "msg": "Transaction has been updated",
  "txShieldOICartReference": "b1eb8c8f-6812-4596-9b53-6073631363c8"
}

Successful update