Skip to main content

5.7 Updating Order Data

"CCTRANSUPDATE" can be used to update data on specific elements of an order. Currently, only TRANS_CUST_RECEIPT is available for updating. To update an order with a receipt, merchants must set the REQUEST_ACTION parameter to "CCTRANSUPDATE" along with a reference to the order, either in the REQUEST_REF_PO_ID parameter (referencing the PO_ID of a previous order) or in the REQUEST_REF_PO_ID_XTL parameter (referencing the XTL_ORDER_ID of a previous order).

5.7.1 CCTRANSUPDATE Request Example using REQUEST_REF_PO_ID

/pmt_service.cfm?req_password=P5ssword1&site_id=1234&request_ref_po_id=1234567&request_response_format=JSON&req_username=test1%40example.net&request_api_version=4.4&request_action= CCTRANSUPDATE&mbshp_id_xtl=1502&trans_customer_receipt=aHR0cHM6Ly9udXRyaXN5cy5yZWMudHJhbnNfaWQyMzQ=

5.7.2 CCTRANSUPDATE Request Example using REQUEST_REF_PO_ID_XTL

/pmt_service.cfm?req_password=P5ssword1&site_id=1234&request_ref_po_id_xtl=order123&request_response_format=JSON&req_username=test1%40example.net&request_api_version=4.4&request_action=CCTRANSUPDATE&mbshp_id_xtl=1502&trans_customer_receipt=aHR0cHM6Ly9udXRyaXN5cy5yZWMudHJhbnNfaWQyMzQ=

5.7.3 CCTRANSUPDATE Response Example

The following response example shows that the order was captured and then reversed. Merchants can refer to TRANS_STATUS_NAME to check the status of a specific transaction request.

<RESPONSE>
<TRANSACTION TRANS_ID="43500">
<REQUEST_ACTION>CCAUTHORIZE</REQUEST_ACTION>
<TRANS_STATUS_NAME>APPROVED</TRANS_STATUS_NAME>
<TRANS_VALUE>10</TRANS_VALUE>
<CUST_ID>1500</CUST_ID>
<XTL_CUST_ID/>
<PO_ID>1234567</PO_ID>
<XTL_ORDER_ID> order123</XTL_ORDER_ID>
<BATCH_ID>1001</BATCH_ID>
<PROC_NAME>Test Processor</PROC_NAME>
<MERCH_ACCT_ID>100</MERCH_ACCT_ID>
<CARD_BRAND_NAME>Visa</CARD_BRAND_NAME>
<PMT_L4>3762</PMT_L4>
<PROC_UDF01/>
<PROC_UDF02/>
<PROC_AUTH_RESPONSE>46177</PROC_AUTH_RESPONSE>
<PROC_RETRIEVAL_NUM>56789AB</PROC_RETRIEVAL_NUM>
<PROC_REFERENCE_NUM/>
<AVS_RESPONSE>M</AVS_RESPONSE>
<CVV_RESPONSE>M</CVV_RESPONSE>
<MBSHP_ID_XTL>1502</MBSHP_ID_XTL>
</TRANSACTION>
</RESPONSE>

5.7.4 CCTRANSUPDATE Response Fields

  • TRANS_ID – Unique transaction ID.
  • REQUEST_ACTION – This will return the Service Request Action that the merchant sent in the transaction request.
  • TRANS_STATUS_NAME – Transaction status.
  • TRANS_VALUE – Total transaction amount across all line items.
  • CUST_ID – Customer ID.
  • XTL_CUST_ID – Merchant's customer ID.
  • PO_ID – Purchase order ID.
  • XTL_ORDER_ID – Merchant's order ID.
  • BATCH_ID – Cutoff batch ID.
  • PROC_NAME – Processor name.
  • MERCH_ACCT_ID – Merchant bank account ID.
  • CARD_BRAND_NAME – Bank account or credit card type (Example: "Mastercard").
  • PMT_L4 – Payment account or last 4 digits of the credit card.
  • PMT_ID – Payment ID.
  • PMT_ID_XTL – External payment ID.
  • PROC_UDF01 – Processor user-defined field #1.
  • PROC_UDF02 – Processor user-defined field #2.
  • PROC_AUTH_RESPONSE – Processor authorization response code.
  • PROC_RETRIEVAL_NUM – Processor retrieval number or GUID.
  • PROC_REFERENCE_NUM – Processor reference number.
  • AVS_RESPONSE – Address Verification Service response code.
  • CVV_RESPONSE – CVV response code.
  • REQUEST_API_VERSION – Payment service API version (4.4).
  • PO_LI_ID_X – Purchase order line item ID.
  • PO_LI_COUNT_X – Number of line items in the purchase order.
  • PO_LI_AMOUNT_X – Total value of items on line x.
  • PO_LI_PROD_ID_X – Product ID of the item on line x.
  • MBSHP_ID – Membership ID (returned in membership transactions).
  • MBSHP_ID_XTL – Customer membership ID, received by the merchant.