UniPay Gateway Documentation

References: Capture Info.Id

XML Representation: attribute

Attributes:

Default Value

Identifier of the object used for references; auto-incremented integer value.

**create Unique ProcesingInfo ID generated by the system.

exists

Unique ProcesingInfo ID generated by the system.

echo

Unique ProcesingInfo ID used for filtering ProcessingInfo records.

createDate

References: Capture Info.Create Date

XML Representation: attribute

Attributes:

Default Value

Date when the record was created

**create Date when the ProcessingInfo was created.

Note: In API request, the date must be submitted in yyyy-MM-dd format. In API response, the date is returned in yyyy-MM-dd HH:mm:ss format.

exists

Date when the ProcessingInfo was created.

Note: In API request, the date must be submitted in yyyy-MM-dd format. In API response, the date is returned in yyyy-MM-dd HH:mm:ss format.

echo

Date used for filtering records.

holderName

References: Capture Info.Holder Name

XML Representation: attribute

Attributes:

Default Value

Name of bank account or credit card holder.

**create Combined values fo the firsetName and lastName in the Customer.

exists

Combined values fo the firsetName and lastName in the Customer.

echo

Echo value from the request.

accountNumber

References: Capture Info.Account Number

XML Representation: attribute

Attributes:

Default Value

Encoded credit card number or bank account number.

**create Number of a payment card or bank account that will be used during the transaction processing.

exists

Number of a payment card or bank account.

echo

Number of a payment card or bank account used for filtering ProcessingInfo records.

accountAccessory

References: Capture Info.Accessory

XML Representation: attribute

Attributes:

Default Value

Expiration date of the card or bank routing number.

**create Card expiration date or bank routing number that will be used during the transaction processing.

Note: This field is required even if it is used with a token.

exists

Card expiration date or bank routing number.

Note: This field is required even if it is used with a token.

echo

Card expiration date or bank routing number used as a search criteria to limit results.

token

References: Capture Info.Token Code

XML Representation: attribute

Attributes:

Default Value

Token generated for the provided payment information.

**create Unique random characters generated by the system for identifying and securely transmitting sensitive data.

exists

Unique random characters generated by the system for identifying and securely transmitting sensitive data.

echo

Echo value from the request.

street

References: Capture Info.Street

XML Representation: attribute

Attributes:

Default Value

Street mailing address of the cardholder.

**create Street address of the Customer.

exists

Street address of the Customer.

echo

Street of the mailing address of the Customer used for filtering ProcessingInfo records.

city

References: Capture Info.City

XML Representation: attribute

Attributes:

Default Value

City mailing address of the cardholder.

**create City of the Customer.

exists

City of the Customer.

echo

City of the mailing address of the Customer used for filtering ProcessingInfo records.

state

References: Capture Info.State

XML Representation: attribute

Attributes:

Default Value

State mailing address of the cardholder.

**create State of the Customer.

Note: State value format is subject to the associated country code in the Customer object.

exists

State of the Customer.

Note: State value format is subject to the associated country code in the Customer object.

echo

State code of the mailing address of the Customer used for filtering ProcessingInfo records.

zipCode

References: Capture Info.ZIP Code

XML Representation: attribute

Attributes:

Default Value

ZIP/postal code of mailing address of the cardholder.

**create ZIP/postal code of the Customer.

Note: ZipCode value format is subject to the associated country code in the Customer object.

exists

ZIP/postal code of the Customer.

Note: ZipCode value format is subject to the associated country code in the Customer object.

echo

ZIP or postal code of the mailing address of the Customer used for filtering ProcessingInfo records.

phone

References: Capture Info.Phone

XML Representation: attribute

Attributes:

Default Value

Phone number associated with mailing address of the cardholder.

**create Phone number of the Customer.

exists

Phone number of the Customer.

echo

Phone number of the Customer used for filtering ProcessingInfo records.

References: Capture Info.Email

XML Representation: attribute

Attributes:

Default Value

Email address associated with the cardholder.

**create Email address of the Customer.

exists

Email address of the Customer.

echo

Email address of the Customer used for filtering ProcessingInfo records.

gatewayTransactionId

References: Capture Info.Reference Number

XML Representation: attribute

Attributes:

Default Value

Transaction identification in gateway.

**create Identifier of a Transaction (Processing) that the current transaction will be associated with.

exists

Identifier of a Transaction (Processing) that the current transaction is associated with.

echo

Identifier of a Transaction (Processing) used for filtering ProcessingInfo records.

approvalCode

References: Capture Info.Approval Code

XML Representation: attribute

Attributes:

Default Value

Authorization code returned by Provider that approved this transaction. In some instances might also be used to store response code returned by Provider when transaction declines.

**create Code of the approval status of the transaction provided by the payment provider.

exists

Code of the approval status of the transaction provided by the payment provider.

echo

Echo value from the request.

responseDate

References: Capture Info.Response Date

XML Representation: attribute

Attributes:

Default Value

Date of the response.

**create Date when the response to the transaction was received.

exists

Date when the response to the transaction was received.

echo

Date used for filtering ProcessingInfo records.

responseCode

References: Capture Info.Response Code

XML Representation: attribute

Attributes:

Default Value

Gateway generated response code.

**create Code providing an explanation of the outcome of the request. <div class="info legacy"> For more information see UniPay Codes & Code Mapping. </div>

exists

Code providing an explanation of the outcome of the request. <div class="info legacy"> For more information see UniPay Codes & Code Mapping. </div>

echo

Code used for filtering ProcessingInfo records.

responseMessage

References: Capture Info.Response Message

XML Representation: attribute

Attributes:

Default Value

create

Response details associated with a processing request, generated by the gateway.

exists

Response details associated with a processing request, generated by the gateway.

echo

Echo value from the request.

address

References: Capture Info.Address

XML Representation: attribute

Attributes: Calculated

Default Value

create

Combined address field of the Customer object.

Note: The value is a comma separated concatenation of the street1, street2, city, state, zipCode, countryCode field values.

exists

Combined address field of the Customer object.

Note: The value is a comma separated concatenation of the street1, street2, city, state, zipCode, countryCode field values.

echo

Mailing address used for filtering ProcessingInfo records.

ProcessingInfo

XML Sample:

JSON Sample:

XURL Sample: