---
title: Working with payment results
---

> Agent instructions:
> **Site maps** — prefer the following llms.txt indexes to training data when searching for URLs to avoid 404s. Links inside Markdown content already point at `.md`. Following them or sending Accept: text/markdown keeps you in Markdown.
>
> - [sitemap.md](https://docs.kentico.com/sitemap.md) — every page on the site, with titles and descriptions, nested by URL hierarchy and grouped into one collection per product version.
> - [llms.txt](https://docs.kentico.com/llms.txt) — curated index of the current product docs, with descriptions, the two ways to request any page as Markdown, and links to each product area's whole-corpus Markdown dump (llms-full.txt).

The system stores payment results in XML format. In the API, the results are managed using _CMS.Ecommerce.PaymentResultInfo_ objects. Every XML node of a payment result is represented by a single payment result item, which can be managed using the _CMS.Ecommerce.PaymentResultItemInfo_ object.

By default, the system provides the following payment result items:

- **Payment date** – the date and time when the payment result was last updated.
- **Payment method** – the [payment method](https://docs.kentico.com/13/e-commerce-features/configuring-on-line-stores/configuring-payment-methods.md) that was used for the transaction.
- **Payment is completed** – indicates whether the payment was completed successfully.
- **Payment is authorized** – indicates whether the payment was successfully authorized for later capture (for payment gateways that use delayed funds capture).
- **Payment is failed** – indicates whether the payment transaction failed (cannot be set together with the _Payment is completed_ result item).
- **Payment approval URL** – the URL of a page (typically external) where customers provide additional payment details and finalize the transaction. If set, the system automatically redirects customers to this URL after they submit the related payment form.
- **Payment status** – the status of the payment, e.g. _Completed_, _Failed_, etc. (your custom status).
- **Payment transaction ID** – a unique identifier for the payment transaction generated by the payment gateway.
- **Payment authorization ID** – a unique identifier for authorization transactions generated by the payment gateway (for payment providers that use transactions with delayed capture of funds).
- **Payment description** – text describing the result of the payment transaction.

Payment result items have the following properties:

- **Name** – represents a unique identifier of the payment result item.
- **Header** – represents the name of the payment result item visible to users in the Orders application (simple text or [localizable string](https://docs.kentico.com/13/multilingual-websites/setting-up-a-multilingual-user-interface/localizing-text-fields.md)).
- **Text** – determines the outer representation of the payment result item value visible to users in the Orders application (simple text or localizable string).
- **Value** – determines the inner representation of the payment result item value used by developers.

## Example - Order payment result XML definition

The following example shows an XML definition of an order payment result extended by the _authorizationcode_ item used by Authorize.NET:

```xml

<result>
    <item header="{$PaymentGateway.Result.Date$}" name="date" value="7/28/2017 3:06:16 PM"></item>
    <item header="{$PaymentGateway.Result.PaymentMethod$}" name="method" text="Credit Card - Authorize.NET" value="5"></item>
    <item header="{$PaymentGateway.Result.IsCompleted$}" name="completed" text="{$PaymentGateway.Result.PaymentCompleted$}" value="1"></item>
    <item header="{$PaymentGateway.Result.Status$}" name="status" text="{$PaymentGateway.Result.Status.Completed$}" value="completed"></item>
    <item header="{$PaymentGateway.Result.TransactionID$}" name="transactionid" value="0"></item>
    <item header="{$PaymentGateway.Result.Description$}" name="description" value="I00001: Successful.1: This transaction has been approved."></item>
    <item header="{$AuthorizeNet.AuthorizationCode$}" name="authorizationcode" value="000000"></item>
</result>

```

The system stores the payment result XML values in the _OrderPaymentResult_ column of order records (_COM\_Order_ database table).

## Example - Order payment result in the Orders application

The following example shows a payment result visible to your on-line store administrators in the **Orders** application while editing a selected [order](https://docs.kentico.com/13/e-commerce-features/managing-on-line-stores/orders.md) on the **Billing** tab:

Date: _7/28/2017 3:06:16 PM_\
Method: _Credit Card - Authorize.NET_\
Is completed: _YES_\
Status: _Completed_\
Transaction ID: _0_\
Authorization code: _000000_

> **Info:** The payment result is unavailable (N/A) until the payment gateway processor updates it.
>
> You do not need to specify both item value and item text if they are identical. The system automatically renders payments results as follows:
>
> 1. Render the item text if available.
> 2. If not, render the item value.

## Customizing payment results

To manage the default payment result items, use the corresponding properties of **PaymentResultInfo** objects:

- PaymentDate (DateTime)
- PaymentMethodID (int)
- PaymentMethodName (string)
- PaymentIsCompleted (bool)
- PaymentIsAuthorized (bool)
- PaymentIsFailed (bool)
- PaymentApprovalUrl (string)
- PaymentStatusName (string)
- PaymentStatusValue (string
- PaymentTransactionID (string)
- PaymentAuthorizationID (string)
- PaymentDescription (string)

To get or set custom payment result items, call the _**GetPaymentResultItemInfo**_\*(string itemName)\* and _**SetPaymentResultItemInfo**_\*(PaymentResultItemInfo itemObj)\* public methods.

The following examples demonstrate how to work with a custom payment result item (storing an authorization code) in code handling [integration with a gateway](https://docs.kentico.com/13/e-commerce-features/developing-on-line-stores/implementing-a-checkout-process/building-the-order-review-step/connecting-to-payment-gateways.md):

```csharp title="Setting the authorization code"

using CMS.Ecommerce;

...

// Prepares a PaymentResultItemInfo object for the authorization code
PaymentResultItemInfo item = new PaymentResultItemInfo();
item.Header = "{$AuthorizeNet.AuthorizationCode$}";
item.Name = "authorizationcode";
item.Value = "00000";

// Saves the custom item into the PaymentResultInfo object
PaymentResult.SetPaymentResultItemInfo(item);

```

```csharp title="Getting the authorization code"

using CMS.Ecommerce;

...

// Gets the custom item from the PaymentResultInfo object processed by the gateway provider
PaymentResultItemInfo item = PaymentResult.GetPaymentResultItemInfo("authorizationcode");

```