Search the Aria Knowledgebase for
User Documentation, APIs, SDKs, and more!

 

Home > User Documentation > Direct Post Payment Handler > Returned Key-Value Pairs from the Direct Post Query String

Returned Key-Value Pairs from the Direct Post Query String

Table of contents

Overview

Upon submittal to the Direct Post Payment Handler URL, the handler returns the following key-value pairs to the return URL specified in your configuration set. The key-value pairs returned vary depending on various success or error states. The table below details the possible key-value pairs:

Key

Optional

Expected Value

Comments

<inSessionID>

No

This should be the same session id string that was posted originally to the Direct Post Payment Handler via the Form of Payment Entry Page. 

This session ID may no longer be valid if too much time passed before submitting to the Direct Post Payment Handler. The default time-out period or an Aria-assigned session id is 10 minutes.  An error will be return ed if a time-out has occurred.

<errors>

No

The number of errors encountered by the Direct Post Payment Handler

This should always return 0 if no errors occurred. The most basic error handling can be accomplished by checking if this number is greater than 0.

<error_messages>

Yes

If there are errors, this will return an associative array of “error_key” “error_code” and “error_field” key-value pairs

This will not exist in the query string if there are 0 errors. If this key exists, it can be parsed in to an an associative array of readable error keys (error_key), an error code (error_code), and the offending form field (error_field).  For example, if an error occurred because the end user entered an invalid credit card number in the <cc_no> form field, the error_field will be “cc_no.”  This is useful for focusing and printing error messages adjacent to the offending form field.
 

<invoice_no>

Yes

An Aria-assigned invoice number returned if an invoice was settled.

This invoice number can be used to create a receipt page using various invoice-related API methods such as get_invoice_details. This will not be returned if no invoice processing occurred.

You must to post a comment.
Last modified
08:51, 17 Mar 2016

Tags

Classifications

This page has no classifications.