Payment Gateway Responses

The Kibo Composable Commerce Platform (KCCP) uses payment gateways to process credit card transactions. To process credit card transactions on your storefront, you must set up a payment gateway and then assign that gateway to payment types.

You can set up a payment gateway in Admin, on the System > Settings > Payment Gateways page. Refer to Payment Gateways in the Guides section for more information.

Payment information is stored in the commerce/orders/payments resource. Under the interactions object on this resource, you can view the specific gateway response information that is included on the payment:

"interactions": [
    {
        ...
        "gatewayAuthCode": "string",
        "gatewayAVSCodes": "string",
        "gatewayCVV2Codes": "string",
        "gatewayInteractionId": "int",
        "gatewayResponseCode": "string",
        "gatewayResponseData": [
            {
                "key": "string",
                "value": "string"
            }
        ],
        "gatewayResponseText": "string",
        "gatewayTransactionId": "string"
        ...
    }
]

Each gateway returns this information in a format that is unique to the gateway. Refer to the following sections for more information about the gatewayResponseCode, and gatewayResponseData values.

Gateway Response Code and Text

Each payment gateway returns specific gateway response codes and text that are unique to the payment gateway. The response code is stored in the gatewayResponseCode property and the response text is stored in the gatewayResponseText property.

For example, a response code of 32 from Authorize.Net would be displayed as:

"gatewayResponseCode": 32,
"gatewayResponseText": "The merchant password is invalid or not present."

Refer to your specific payment gateway's documentation for details about their specific response codes.

Kibo displays the gateway response code and text in Admin, under the payments section on an order:

Gateway Response Data

Kibo captures additional response data that's unique to each gateway in the payment object. This response data is displayed as a list of key value pairs.

For example, the gateway response data from the CyberSource payment gateway might appear as the following:

"gatewayResponseData": [
    {
        "key": "authorizationCode",
        "value": "888888"
    },
    {
        "key": "authorizationXID",
        "value": ""
    },
    {
        "key": "transactionId",
        "value": ""
    },
    {
        "key": "authReasonCode",
        "value": "100"
    },
    {
        "key": "authorizationRequestId",
        "value": "4744772545266244701017"
    },
    {
        "key": "authorizationRequestToken",
        "value": "Ahj/7wSTATbyUwmMjMtZESDdixYMmDZpJqM7ESfXcJcivVUNwClyK9VQ3aQN1IMPMMmkmW6QHJwZwJyYCbeSmExkZlrIDQDO"
    },
    {
        "key": "reasonCode",
        "value": "100"
    }
]

KCCP captures a default set of response data for each payment gateway. If you need to capture additional data for your gateway, contact Kibo Support.