AddAttachment Element

Description

AddAttachment can be used to store and associate data (i.e. images and documents) to a prior transaction.

The referenced original transaction must have been approved and must be one of the following:

CreditAuth
CreditOfflineAuth
CreditSale
CreditOfflineSale
CreditReturn
DebitSale
GiftCardSale
GiftCardAddValue
PrePaidAddValue
CheckSale
OverrideFraudDecline

This must be done within three months of the original transaction.

For Document attachment types:

Up to five document attachments are allowed to be associated with a single transaction
Document attachments can be submitted on one or more requests
To replace a document attachment, a new document attachment with the same name can be provided

For other attachment types:

Only one of each attachment type can be associated with a single transaction
Only one of each attachment type can be submitted per request
If a request includes an attachment type that is already associated with a given transaction, it will result in the attachment being replaced

Namespace

http://Hps.Exchange.PosGateway

Type

PosAddAttachmentReqType Complex Type

Diagram

Overview

AddAttachment PosAddAttachmentReqType Complex Type

AddAttachment can be used to store and associate data (i.e. images and documents) to a prior transaction.

The referenced original transaction must have been approved and must be one of the following:

CreditAuth
CreditOfflineAuth
CreditSale
CreditOfflineSale
CreditReturn
DebitSale
GiftCardSale
GiftCardAddValue
PrePaidAddValue
CheckSale
OverrideFraudDecline

This must be done within three months of the original transaction.

For Document attachment types:

Up to five document attachments are allowed to be associated with a single transaction
Document attachments can be submitted on one or more requests
To replace a document attachment, a new document attachment with the same name can be provided

For other attachment types:

Only one of each attachment type can be associated with a single transaction
Only one of each attachment type can be submitted per request
If a request includes an attachment type that is already associated with a given transaction, it will result in the attachment being replaced

Sequence

GatewayTxnId txnIdType Simple Type

Gateway-generated transaction identifier returned in the response of the original transaction. This indicates the transaction to be updated.

Block1 1..5 AttachmentDataType Complex Type

This list will contain one to five sets of attachment data.

All

AttachmentType attachmentTypeType Simple Type

Identifies the attachment type; see the associated Type enumerations for specific values supported.

AttachmentData Restriction of xs:string

The base64 encoded attachment data.

Note: The code limits the maximum size beyond the limit in the schema. The maximum document and image data size allowed is 300K which includes the encoding overhead.

AttachmentFormat attachmentFormatType Simple Type

Identifies the format of the attachment data; see the associated Type enumerations for specific values supported.

AttachmentName optional Restriction of xs:string

A merchant assigned name for the associated attachment.

Source

<xs:element name="AddAttachment" type="PosAddAttachmentReqType" xmlns:xs="http://www.w3.org/2001/XMLSchema">
  <xs:annotation>
    <xs:documentation>
      <p xmlns="http://Hps.Exchange.PosGateway">AddAttachment can be used to store and associate data (i.e. images and documents) to a prior transaction.</p>
      <p xmlns="http://Hps.Exchange.PosGateway">
                            The referenced original transaction must have been approved and must be one of the following:
                            <ul><li>CreditAuth</li><li>CreditOfflineAuth</li><li>CreditSale</li><li>CreditOfflineSale</li><li>CreditReturn</li><li>DebitSale</li><li>GiftCardSale</li><li>GiftCardAddValue</li><li>PrePaidAddValue</li><li>CheckSale</li><li>OverrideFraudDecline</li></ul></p>
      <p xmlns="http://Hps.Exchange.PosGateway">This must be done within three months of the original transaction.</p>
      <p xmlns="http://Hps.Exchange.PosGateway">
                            For Document attachment types:
                            <ul><li>Up to five document attachments are allowed to be associated with a single transaction</li><li>Document attachments can be submitted on one or more requests</li><li>To replace a document attachment, a new document attachment with the same name can be provided</li></ul></p>
      <p xmlns="http://Hps.Exchange.PosGateway">
                            For other attachment types:
                            <ul><li>Only one of each attachment type can be associated with a single transaction</li><li>Only one of each attachment type can be submitted per request</li><li>If a request includes an attachment type that is already associated with a given transaction, it will result in the attachment being replaced</li></ul></p>
    </xs:documentation>
  </xs:annotation>
</xs:element>