PayConexDecryptxShieldConexTECS Platform
API Reference
Request SandboxContact Us

Updating Transaction Metadata

Overview

The PayConex™ V4 API allows some of the transaction metadata to be updated. The update process ensures that transaction records can be accurately maintained and reflect necessary changes post-authorization or after Transaction Initialization.

This may occur when a customer wants to update/change the following fields:

ParameterTypeDescriptionExample
descriptionstringThe description for a transaction"one-time purchase #10"
customerobjectCustomer data including, name, email, phone, billingAddress.See Customer.
shippingAddressobjectConsists of a set of shipping fields such as "address1", "adress2", etc.See Shipping Address.
level3objectLevel 3 profile data such as: status, transactionSaleTaxRate, etc.See Level 3.
level3ProfileNamestringThe name of the Level3 Profile for processing a transaction. See Level 2 and Level 3 Transaction Processing."MyLevel3ProfileName"
itemsarrayLine Item detail for the level 3 data or the level 3 profile name.See Items.
cvmobjectAvailable only for CP transactions. The CVM information such as the method and signature data.See CVM.

📘

Also see

For the comprehensive reference, see API Reference.

Example Request

For example, we update a sale transaction with the request below.

PATCH /api/v4/accounts/{accountId}/payments/{transactionId}

📘

Note

  • {accountId} value in the path is the PayConex™ account ID number.
  • {transactionId} value in the path is the transactionId to update.
{
  "description": "updated transaction description",
  "level3": {
    "summaryCommodityCode": "8013",
    "shipFromZip": "12346"
  },
  "customer": {
    "name": "Alice",
    "billingAddress": {
      "address1": "address1",
      "address2": "address2",
      "city": "Huntsville",
      "state": "AL",
      "zip": "35649",
      "country": "USA",
      "company": "Acme Inc."
    }
  },
  "shippingAddress": {
    "address1": "address1",
    "address2": "address2",
    "city": "Huntsville",
    "state": "AL",
    "zip": "35649",
    "country": "USA",
    "company": "Acme Inc.",
    "recipient": "Alice Smith"
  },
  "items": [
    {
      "commodityCode": "09.02.10",
      "description": "High-resolution camera module",
      "productCode": "ABC123",
      "quantity": "112.4595",
      "unitOfMeasure": "units",
      "unitCost": "12.50"
    },
    {
      "commodityCode": "07.03.05",
      "description": "Bluetooth Headphones",
      "productCode": "XYZ456",
      "quantity": "75.0000",
      "unitOfMeasure": "pieces",
      "unitCost": "49.99"
    }
  ]
}

*Required Scopes: pcx:payments:*, pcx:payments:update

Once the update is completed, we get the transaction metadata with this structure in response: Getting Transaction Metadata.

📘

Tracing

For developers to effectively track updated actions, this request ensures that an "action": "update" entry is added to the trace.history of the transaction metadata.