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: ReadOnly
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.
    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.
    type
    References: Account Activity.Account Activity CL
    XML Representation: attribute
    Attributes: CreateOnly
    Default Value AP
    Represents the type of account activity.
    amount
    References: Account Transaction.Amount
    XML Representation: attribute
    Attributes: Required
    Default Value
    Amount of the transaction in cents (without a decimal point).
    taxAmount
    References: Account Transaction.Tax Amount
    XML Representation: attribute
    Attributes:
    Default Value
    Amount of the tax for the transaction.
    holderName
    References: Capture Info.Holder Name
    XML Representation: attribute
    Attributes: CreateOnly
    Default Value
    Pattern: NAME
    Name of bank account or credit card holder.

    Name of a payment card or bank account holder. The value is a concatenation of the firstName and lastName field values separated by a space.
    accountType
    References: Asset Transaction.Transaction CL
    XML Representation: attribute
    Attributes: CreateOnly
    Default Value
    Enumeration of possible asset transaction processing modes available in the system.
    accountNumber
    References: Capture Info.Account Number
    XML Representation: attribute
    Attributes: CreateOnly
    Default Value
    Encoded credit card number or bank account number.
    accountAccessory
    References: Capture Info.Accessory
    XML Representation: attribute
    Attributes: CreateOnly
    Default Value
    Pattern: NUMERIC
    Expiration date of the card or bank routing number.
    accountData
    References: Capture Info.Track Data
    XML Representation: attribute
    Attributes: CreateOnly
    Default Value
    The date must be submitted in yyyy-MM-dd format.
    csc
    References: Capture Info.CVV2
    XML Representation: attribute
    Attributes: CreateOnly
    Default Value
    Pattern: NUMERIC
    CVV2 security code of the credit card.
    token
    References: Capture Info.Token Code
    XML Representation: attribute
    Attributes: CreateOnly
    Default Value
    Pattern: TOKEN
    Token generated for the provided payment information.
    street
    References: Capture Info.Street
    XML Representation: attribute
    Attributes: CreateOnly
    Default Value
    Pattern: STREET
    Street mailing address of the cardholder.
    city
    References: Capture Info.City
    XML Representation: attribute
    Attributes: CreateOnly
    Default Value
    Pattern: ALPHANUMERIC_EXTENDED
    City mailing address of the cardholder.
    state
    References: Capture Info.State
    XML Representation: attribute
    Attributes: CreateOnly
    Default Value
    State mailing address of the cardholder.
    zipCode
    References: Capture Info.ZIP Code
    XML Representation: attribute
    Attributes: CreateOnly
    Default Value
    ZIP/postal code of mailing address of the cardholder.
    email
    References: Capture Info.Email
    XML Representation: attribute
    Attributes: CreateOnly
    Default Value
    Pattern: EMAIL
    Email address associated with the cardholder.
    phone
    References: Capture Info.Phone
    XML Representation: attribute
    Attributes: CreateOnly
    Default Value
    Pattern: NUMERIC
    Phone number associated with mailing address of the cardholder.
    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.
    dueDate
    References: Account Transaction.Due Date
    XML Representation: attribute
    Attributes: CreateOnly
    Default Value
    Date when the transaction becomes effective.

    **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.
    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.
    note
    References: Account Transaction.Note
    XML Representation: attribute
    Attributes: CreateOnly
    Default Value
    Pattern: TEXT
    Description of the transaction.
    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 © TidyPay. All Rights Reserved.
    All Logos and Trademarks used or mentioned on this page are copyrighted property of their respective owners and are used for display purposes only.