Skip to main content

5.6 Checking Order Status

To check the status of an order, merchants can add the REQUEST_ACTION parameter along with the Order ID in the REQUEST_REF_PO_ID parameter.

If REQUEST_REF_PO_ID is not available, merchants can instead use the XTL_ORDER_ID that was sent in the original authorization. Send this value in the REQUEST_REF_PO_ID_XTL parameter.

5.6.1 CCSTATUS 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=CCSTATUS

5.6.2 CCSTATUS 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=CCSTATUS

5.6.3 CCSTATUS 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>
        </TRANSACTION>
        <TRANSACTION TRANS_ID="43502">
        <REQUEST_ACTION>CCREVERSE</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> 
        <CARD_TYPE>VISA BUSINESS</CARD_TYPE> 
        <CARD_PREPAID>0</CARD_PREPAID> 
        <CARD_BANK/>
        <PMT_L4>3762</PMT_L4> 
        <PMT_ID>43333</PMT_L4>
        <PMT_ID_XTL/>
        <PROC_UDF01/>
        <PROC_UDF02/> 
        <PROC_AUTH_RESPONSE>62088</PROC_AUTH_RESPONSE> 
        <PROC_RETRIEVAL_NUM>123456789A</PROC_RETRIEVAL_NUM> <PROC_REFERENCE_NUM/> 
        <AVS_RESPONSE>M</AVS_RESPONSE> 
        <CVV_RESPONSE>M</CVV_RESPONSE>
    </TRANSACTION>
    <TRANSACTION TRANS_ID="43501">
        <REQUEST_ACTION>CCCAPTURE</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> 
        <CARD_TYPE>VISA BUSINESS</CARD_TYPE> 
        <CARD_PREPAID>0</CARD_PREPAID>
        <CARD_BANK/>
        <PMT_L4>3762</PMT_L4>
        <PROC_UDF01/>
        <PROC_UDF02/> 
        <PROC_AUTH_RESPONSE>63106</PROC_AUTH_RESPONSE>
        <PROC_RETRIEVAL_NUM>F56789</PROC_RETRIEVAL_NUM> 
        <PROC_REFERENCE_NUM/> 
        <AVS_RESPONSE>M</AVS_RESPONSE> 
        <CVV_RESPONSE>M</CVV_RESPONSE>
    </TRANSACTION> 
</RESPONSE>

5.6.4 CCSTATUS 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 for line x.
  • PO_LI_COUNT_X – Number of items on line x of 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).

5.6.5 Transaction Status is Pending​

Some authorization requests may have a transaction status of "Pending". This typically occurs if the processor requires the customer to go through an additional step for credit card authentication such as 3-D Secure (e.g., Verified by Visa or Mastercard SecureCode). Merchants should also expect a URL redirect in the PROC_REDIRECT_URL field in the Transaction Processing System response in the case of 3-D Secure authentications.