ProcessingRequest

Type:  Struct
Abstract:  no
Status:  Active
Java Class:  ProcessingRequest
Represents information included in processing request sent to a processor.
Available Fields:
id
References: Asset Transaction.Id
XML Representation: attribute
Attributes:
Default Value
Identifier of the object used for references; auto-incremented integer value.

**create Unique ProcessingRequest ID generated by the system.

  • exists
    • Unique ProcessingRequest ID generated by the system.

  • echo
    • Unique ProcessingRequest ID used for filtering ProcessingRequest records.
    holderName
    References: Capture Info.Holder Name
    XML Representation: attribute
    Attributes: CreateOnly
    Default Value
    Pattern: NAME
    Name of bank account or credit card holder.

    **create Combined values of the firstName and lastName in the Customer.

  • exists
    • Combined values of the firstName and lastName in the Customer.

  • echo
    • Echo value from the request.
    accountData
    References: Capture Info.Track Data
    XML Representation: attribute
    Attributes: CreateOnly
    Default Value
  • create
    • Track/EMV data or manually keyed number of a payment card.

  • exists
    • Track/EMV data or manually keyed number of a payment card.

  • echo
    • Echo value from the request.
    accountNumber
    References: Capture Info.Account Number
    XML Representation: attribute
    Attributes: CreateOnly
    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. <div class="info legacy"> For more information see Conditions determined by account data. </div>
  • exists
    • Number of a payment card or bank account. <div class="info legacy"> For more information see Conditions determined by account data. </div>
  • echo
    • Number of a payment card or bank account used as a search criteria to limit results.
    accountAccessory
    References: Capture Info.Accessory
    XML Representation: attribute
    Attributes: CreateOnly
    Default Value
    Pattern: NUMERIC
    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.

  • exists
    • Card expiration date or bank routing number.

  • echo
    • Card expiration date or bank routing number used as a search criteria to limit results.
    taxAmount
    References: Account Transaction.Tax Amount
    XML Representation: attribute
    Attributes:
    Default Value
    Amount of the tax for the transaction.
    token
    References: Capture Info.Token Code
    XML Representation: attribute
    Attributes: CreateOnly
    Default Value
    Pattern: TOKEN
    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.
    csc
    References: Capture Info.CVV2
    XML Representation: attribute
    Attributes: CreateOnly
    Default Value
    Pattern: NUMERIC
    CVV2 security code of the credit card.

    **create CVV2 security code of the credit card that will be used for the transaction processing.

  • exists
    • CVV2 security code of the credit card used for the transaction processing.

  • echo
    • CVV2 security code of the credit card used as a search criteria to limit results.
    street
    References: Capture Info.Street
    XML Representation: attribute
    Attributes: CreateOnly
    Default Value
    Pattern: STREET
    Street mailing address of the cardholder.

    **create Street address of the Customer.

  • exists
    • Street address of the Customer.

  • echo
    • Street address of the Customer object used for filtering ProcessingRequest records.
    city
    References: Capture Info.City
    XML Representation: attribute
    Attributes: CreateOnly
    Default Value
    Pattern: ALPHANUMERIC_EXTENDED
    City mailing address of the cardholder.

    **create City of the Customer.

  • exists
    • City of the Customer.

  • echo
    • City of the Customer used for filtering ProcessingRequest records.
    state
    References: Capture Info.State
    XML Representation: attribute
    Attributes: CreateOnly
    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 Customer used for filtering ProcessingRequest records.
    zipCode
    References: Capture Info.ZIP Code
    XML Representation: attribute
    Attributes: CreateOnly
    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/postal code of the Customer used for filtering ProcessingRequest records.
    countryCode
    References: Capture Info.Country Code
    XML Representation: attribute
    Attributes: CreateOnly
    Default Value US
    Pattern: ALPHA
    Country code of the mailing address of the cardholder.

    **create Country code of the Customer.

  • exists
    • Country code of the Customer.

  • echo
    • Country code of the Customer used for filtering ProcessingRequest records.
    phone
    References: Capture Info.Phone
    XML Representation: attribute
    Attributes: CreateOnly
    Default Value
    Pattern: NUMERIC
    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 ProcessingRequest records.
    email
    References: Capture Info.Email
    XML Representation: attribute
    Attributes: CreateOnly
    Default Value
    Pattern: EMAIL
    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 ProcessingRequest records.
    dueDate
    Type: Date
    XML Representation: attribute
    Attributes: CreateOnly
    Default Value
  • create
    • Date when the ProcessingRequest is expected to be completed.

  • exists
    • Date when the ProcessingRequest is expected to be completed.

  • echo
    • Date used for filtering records.
    type
    References: Account Activity.Account Activity CL
    XML Representation: attribute
    Attributes: CreateOnly
    Default Value AP
    Represents the type of account activity.

    **create Type of a ProcessingRequest that will be created. <div class="info legacy"> For more information see Account Activity Classifier. </div>
  • exists
    • Type of a ProcessingRequest. <div class="info legacy"> For more information see Account Activity Classifier. </div>
  • echo
    • Type of a ProcessingRequest used for the search criteria to limit results.
    accountType
    References: Asset Transaction.Transaction CL
    XML Representation: attribute
    Attributes: CreateOnly
    Default Value
    Enumeration of possible asset transaction processing modes available in the system.

    **create Type of a payment method to be used. <div class="info legacy"> For more information see Asset Transaction Classifier. </div>
  • exists
    • Type of a payment method used. <div class="info legacy"> For more information see Asset Transaction Classifier. </div>
  • echo
    • Type of a payment method used for the search criteria to limit results.
    creatorCode
    References: Account Transaction.Ref Creator Code
    XML Representation: attribute
    Attributes: CreateOnly
    Default Value
    Pattern: CODE
    Code of the user that created the account transaction.

    **create Identifier of a user (provided by an integrator) initiating the request.
    Note: This field typically references a user within your system whose actions resulted in this request. Defaults to your API's userName if no value is provided.


  • exists
    • Identifier of a user (provided by an integrator) initiating the request.
    Note: This field typically references a user within your system whose actions resulted in this request. Defaults to your API's userName if no value is provided.


  • echo
    • Identifier of a user (provided by an integrator) used for filtering ProcessingRequest records.
    amount
    References: Account Transaction.Amount
    XML Representation: attribute
    Attributes: Required
    Default Value
    Amount of the transaction in cents (without a decimal point).

    **create Amount (in cents) of the ProcessingRequest.

  • exists
    • Amount (in cents) of the ProcessingRequest.

  • echo
    • Amount (in cents) of the ProcessingRequest used for filtering records.
    note
    References: Account Transaction.Note
    XML Representation: attribute
    Attributes: CreateOnly
    Default Value
    Pattern: TEXT
    Description of the transaction.

    **create Any additional details associated with a ProcessingRequest.

  • exists
    • Any additional details associated with a ProcessingRequest.

  • echo
    • Echo value from the request.
    accountId
    References: Account Activity.Merchant Account Code
    XML Representation: attribute
    Attributes:
    Default Value
    Code of Merchant Account to which instance of this object is attributed to. Depending on the context, Merchant Account Code field may contain either Merchant Code or Merchant Account Code.
    The field is primarily used for data partitioning and data management, to make it easy to determine the ownership of a record within the database.


    **create Merchant account will be associated with ProcessingRequest.
    Note: If your API user is associated to more than one merchant account or group of merchant accounts, you can specify the merchant account ID for the ~find operation to reduce the data set in the API response. <br> <br> Your API credentials may be associated with more than one accountId.


  • exists
    • Merchant account associated with ProcessingRequest.
    Note: If your API user is associated to more than one merchant account or group of merchant accounts, you can specify the merchant account ID for the ~find operation to reduce the data set in the API response. <br> <br> Your API credentials may be associated with more than one accountId.


  • echo
    • Merchant account associated with ProcessingRequest used for filtering records.
    code
    Type: String
    XML Representation: attribute
    Attributes: CreateOnly
    Default Value
    Pattern: CODE
  • create
    • Unique ProcessingRequest ID supplied by external/user's system.
    Note: Optional secondary identifier. Typically this field is a reference to an ID in your own system to cross-reference it within our system. If not provided, the system will use the object 'id' generated at the time of object creation.
    <div class="info legacy"> For more information see Reference Field Type. </div>

  • exists
    • Unique ProcessingRequest ID supplied by external/user's system.
    Note: Optional secondary identifier. Typically this field is a reference to an ID in your own system to cross-reference it within our system. If not provided, the system will use the object 'id' generated at the time of object creation.
    <div class="info legacy"> For more information see Reference Field Type. </div>

  • echo
    • Unique ProcessingRequest ID used for filtering ProcessingRequest records.
    feeAmount
    References: Account Transaction.Fee Amount
    XML Representation: attribute
    Attributes:
    Default Value
  • create
    • Fee amount (in cents) that will be associated with the transaction processing.

  • exists
    • Fee amount (in cents) associated with the transaction processing.

  • echo
    • Fee amount (in cents) used for filtering ProcessingRequest records.
    invoiceList
    References: Account Transaction.Invoice List
    XML Representation: attribute
    Attributes:
    Default Value
    Pattern: NUMERIC
  • create
    • List of invoice references that are expected to be covered by this transaction.

  • exists
    • List of invoice references that are expected to be covered by this transaction.

  • echo
    • List of invoice references used for filtering records.

    XML Sample:

    <object accountId="2001"  amount=""  countryCode="US" />
    "<object accountId=\"2001\" amount=\"\" countryCode=\"US\" />"

    JSON Sample:

    {
  "accountId": 2001,
  "amount": "",
  "countryCode": "US"
}

    XURL Sample:

    ?accountId=2001&amount=&countryCode=US&
    accountId=2001
    amount=
    countryCode=US
    Copyright © United Thinkers. (UniPay - Payment Gateway Software)
    All Logos and Trademarks used or mentioned on this page are copyrighted property of their respective owners and are used for display purposes only.