Schema documentation for OnlinePaymentAcknowledgement.xsd

Showing:

Annotations

Attributes

Diagrams

Facets

Instances

Used by

No namespace

	Main Schema
	OnlinePaymentAcknowledgement.xsd

	Included Schemas
	CommonElements.xsd

	Elements
	Address Attribute Attributes Errors OnlinePaymentAck OnlinePaymentAckListSubmit OnlinePaymentAcks RestrictionList

	Attribute Groups
	CommonAttributes

Main schema OnlinePaymentAcknowledgement.xsd

[ top ]

Included schema CommonElements.xsd

[ top ]

Element OnlinePaymentAckListSubmit

Diagram

Instance

<OnlinePaymentAckListSubmit Culture="en" EndTime="" ErrorCount="0" LoadFilter="" LoadType="" SiteID="" StartTime="" StatusID="" TransactionID="" Transformed="false" Version="">
  <OnlinePaymentAcks Version="">{1,1}</OnlinePaymentAcks>
  <Errors>{0,1}</Errors>
</OnlinePaymentAckListSubmit>

Attributes

QName

Type

Default

Use

Annotation

Culture

xs:string

optional

EndTime

xs:dateTime

optional

ErrorCount

xs:integer

optional

LoadFilter

xs:string

optional

LoadFilter must indicate the Entity Type.  Only one Entity Type per file is allowed. i.e. “Product”

LoadType

xs:string

required

FULL, FULLBranch, or PARTIAL
Note: partial loads require each record to explicitly declare if it is deprecated or not.  Full loads assume anything not in the load is deprecated.

SiteID

xs:string

optional

StartTime

xs:dateTime

optional

StatusID

xs:integer

optional

TransactionID

xs:string

optional

Transformed

xs:boolean

false

optional

Version

xs:decimal

required

[ top ]

Element OnlinePaymentAcks

Diagram

Used by

Element

OnlinePaymentAckListSubmit

Instance

<OnlinePaymentAcks Version="">
  <OnlinePaymentAck Deprecated="" Version="1.5">{0,unbounded}</OnlinePaymentAck>
</OnlinePaymentAcks>

Attributes

QName	Type	Use
Version	xs:decimal	optional

[ top ]

Element OnlinePaymentAck

Diagram

Used by

Element

OnlinePaymentAcks

Instance

<OnlinePaymentAck Deprecated="" Version="1.5">
  <PaymentSeqNo>{1,1}</PaymentSeqNo>
  <MerchantCode>{1,1}</MerchantCode>
  <FacilitatorTransactionID>{1,1}</FacilitatorTransactionID>
  <PrimaryAccountCode>{1,1}</PrimaryAccountCode>
  <AcquirerTransactionRef>{1,1}</AcquirerTransactionRef>
  <MerchantTransactionRef>{1,1}</MerchantTransactionRef>
  <ProcessedDate>{1,1}</ProcessedDate>
  <ReceiptGenerated>{1,1}</ReceiptGenerated>
  <Errors>{0,1}</Errors>
</OnlinePaymentAck>

Attributes

QName	Type	Default	Use
Deprecated	xs:boolean		optional
Version	xs:decimal	1.5	optional

[ top ]

Element OnlinePaymentAck / PaymentSeqNo

Annotations

Unique Identifier generated by Bdirect – bust be returned on the Ack

Diagram

[ top ]

Element OnlinePaymentAck / MerchantCode

Diagram

Facets

maxLength

[ top ]

Element OnlinePaymentAck / FacilitatorTransactionID

Diagram

[ top ]

Element OnlinePaymentAck / PrimaryAccountCode

Diagram

Facets

maxLength

[ top ]

Element OnlinePaymentAck / AcquirerTransactionRef

Diagram

Facets

maxLength

[ top ]

Element OnlinePaymentAck / MerchantTransactionRef

Diagram

Facets

maxLength

[ top ]

Element OnlinePaymentAck / ProcessedDate

Diagram

[ top ]

Element OnlinePaymentAck / ReceiptGenerated

Diagram

[ top ]

Element Errors

Diagram

Used by

Elements

OnlinePaymentAck, OnlinePaymentAckListSubmit

Instance

<Errors>
  <Error>{0,unbounded}</Error>
</Errors>

[ top ]

Element Errors / Error

Diagram

Instance

<Error>
  <ErrorCode>{1,1}</ErrorCode>
  <ErrorRef>{1,1}</ErrorRef>
  <ErrorMsg>{1,1}</ErrorMsg>
  <AdditionalInfo>{0,1}</AdditionalInfo>
</Error>

[ top ]

Element Errors / Error / ErrorCode

Diagram

[ top ]

Element Errors / Error / ErrorRef

Diagram

[ top ]

Element Errors / Error / ErrorMsg

Diagram

[ top ]

Element Errors / Error / AdditionalInfo

Diagram

[ top ]

Element RestrictionList

Diagram

Instance

<RestrictionList>
  <RestrictionCode RestrictionType="">{0,unbounded}</RestrictionCode>
</RestrictionList>

[ top ]

Element RestrictionList / RestrictionCode

Diagram

Attributes

QName

Type

Use

Annotation

RestrictionType

xs:string

required

RestrictTo, Permit, or Deny

[ top ]

Element Attribute

Diagram

Used by

Element

Attributes

Instance

<Attribute Deprecated="" Scope="">
  <EntityCode>{0,1}</EntityCode>
  <Name>{1,1}</Name>
  <Value DataType="">{0,1}</Value>
</Attribute>

Attributes

QName

Type

Use

Annotation

Deprecated

xs:boolean

optional

Scope

xs:string

optional

Public, Private, Admin : defines the visibility of the attribute within the site.  Default determined by the of Entity type.

[ top ]

Element Attribute / EntityCode

Annotations

The code of the entity these attributes belong t  - i.e. ProductItemCode  Field is mandatory if attributes are ssent on a separate file.

Diagram

Facets

maxLength

[ top ]

Element Attribute / Name

Annotations

Name of the Attribute

Diagram

[ top ]

Element Attribute / Value

Annotations

Value of the Attribute, must be the string representation of the appropriate type

Diagram

Attributes

QName	Type	Use
DataType	xs:string	optional

[ top ]

Element Attributes

Annotations

Deprecated at Entity Level..  Please use the separate AttributeList Load File to load entity specific attributes.

Diagram

Instance

<Attributes Version="">
  <Attribute Deprecated="" Scope="">{0,unbounded}</Attribute>
</Attributes>

Attributes

QName	Type	Use
Version	xs:decimal	optional

[ top ]

Element Address

Annotations

Generic Address Element

Diagram

Instance

<Address Type="" Version="">
  <Name>{1,1}</Name>
  <Street1>{1,1}</Street1>
  <Street2>{1,1}</Street2>
  <Suburb>{0,1}</Suburb>
  <City>{1,1}</City>
  <Area>{0,1}</Area>
  <State>{0,1}</State>
  <Country>{0,1}</Country>
  <Other>{0,1}</Other>
  <PostCode>{1,1}</PostCode>
  <GeoRef>{0,1}</GeoRef>
  <Phone>{0,1}</Phone>
  <Fax>{0,1}</Fax>
  <Email>{0,1}</Email>
  <Social>{0,1}</Social>
  <Notes>{0,1}</Notes>
  <TimeZone>{0,1}</TimeZone>
  <TimeZoneName>{0,1}</TimeZoneName>
</Address>

Attributes

QName	Type	Use
Type	restriction of xs:string	optional
Version	xs:decimal	optional

[ top ]

Element Address / Name

Diagram

Facets

maxLength

100

[ top ]

Element Address / Street1

Diagram

Facets

maxLength

100

[ top ]

Element Address / Street2

Diagram

Facets

maxLength

100

[ top ]

Element Address / Suburb

Diagram

Facets

maxLength

[ top ]

Element Address / City

Diagram

Facets

maxLength

[ top ]

Element Address / Area

Diagram

Facets

maxLength

[ top ]

Element Address / State

Diagram

Facets

maxLength

[ top ]

Element Address / Country

Diagram

Facets

maxLength

[ top ]

Element Address / Other

Diagram

Facets

maxLength

[ top ]

Element Address / PostCode

Diagram

Facets

maxLength

[ top ]

Element Address / GeoRef

Diagram

Instance

<GeoRef>
  <Lat>{1,1}</Lat>
  <Long>{1,1}</Long>
</GeoRef>

[ top ]

Element Address / GeoRef / Lat

Diagram

[ top ]

Element Address / GeoRef / Long

Diagram

[ top ]

Element Address / Phone

Diagram

Instance

<Phone>
  <Number Description="" Seq="" Type="">{0,unbounded}</Number>
</Phone>

[ top ]

Element Address / Phone / Number

Diagram

Attributes

QName	Type	Use
Description	restriction of xs:string	optional
Seq	xs:integer	optional
Type	restriction of xs:string	required

[ top ]

Element Address / Fax

Diagram

Instance

<Fax>
  <Number Description="" Seq="" Type="">{0,unbounded}</Number>
</Fax>

[ top ]

Element Address / Fax / Number

Diagram

Attributes

QName	Type	Use
Description	restriction of xs:string	optional
Seq	xs:integer	optional
Type	restriction of xs:string	required

[ top ]

Element Address / Email

Diagram

Instance

<Email>
  <Address Description="" Seq="" Type="">{0,unbounded}</Address>
</Email>

[ top ]

Element Address / Email / Address

Diagram

Attributes

QName	Type	Use
Description	restriction of xs:string	optional
Seq	xs:integer	optional
Type	restriction of xs:string	required

[ top ]

Element Address / Social

Diagram

Instance

<Social>
  <Address Description="" Seq="" Type="">{0,unbounded}</Address>
</Social>

[ top ]

Element Address / Social / Address

Diagram

Attributes

QName	Type	Use
Description	restriction of xs:string	optional
Seq	xs:integer	optional
Type	restriction of xs:string	required

[ top ]

Element Address / Notes

Annotations

Address notes – may be used for special purposes such as delivery address notes

Diagram

[ top ]

Element Address / TimeZone

Annotations

TimeZone Offset. Decimal 9.5 =  “+9:30”        http://wwp.greenwichmeantime.com/info/timezone.htm

Diagram

[ top ]

Element Address / TimeZoneName

Annotations

Name of Time Zone (Microsoft)

Diagram

[ top ]

Attribute OnlinePaymentAck / @Version

Used by

Element

OnlinePaymentAck

[ top ]

Attribute OnlinePaymentAck / @Deprecated

Used by

Element

OnlinePaymentAck

[ top ]

Attribute OnlinePaymentAcks / @Version

Used by

Element

OnlinePaymentAcks

[ top ]

Attribute CommonAttributes / @Culture

Used by

Attribute Group

CommonAttributes

[ top ]

Attribute CommonAttributes / @Version

Used by

Attribute Group

CommonAttributes

[ top ]

Attribute CommonAttributes / @LoadType

Annotations

FULL, FULLBranch, or PARTIAL
Note: partial loads require each record to explicitly declare if it is deprecated or not.  Full loads assume anything not in the load is deprecated.

Used by

Attribute Group

CommonAttributes

[ top ]

Attribute CommonAttributes / @LoadFilter

Annotations

LoadFilter must indicate the Entity Type.  Only one Entity Type per file is allowed. i.e. “Product”

Used by

Attribute Group

CommonAttributes

[ top ]

Attribute CommonAttributes / @TransactionID

Used by

Attribute Group

CommonAttributes

[ top ]

Attribute CommonAttributes / @StartTime

Used by

Attribute Group

CommonAttributes

[ top ]

Attribute CommonAttributes / @EndTime

Used by

Attribute Group

CommonAttributes

[ top ]

Attribute CommonAttributes / @SiteID

Used by

Attribute Group

CommonAttributes

[ top ]

Attribute CommonAttributes / @StatusID

Used by

Attribute Group

CommonAttributes

[ top ]

Attribute CommonAttributes / @ErrorCount

Used by

Attribute Group

CommonAttributes

[ top ]

Attribute CommonAttributes / @Transformed

Used by

Attribute Group

CommonAttributes

[ top ]

Attribute RestrictionList / RestrictionCode / @RestrictionType

Annotations

RestrictTo, Permit, or Deny

Used by

Element

RestrictionList/RestrictionCode

[ top ]

Attribute Attribute / Value / @DataType

Used by

Element

Attribute/Value

[ top ]

Attribute Attribute / @Deprecated

Used by

Element

Attribute

[ top ]

Attribute Attribute / @Scope

Annotations

Public, Private, Admin : defines the visibility of the attribute within the site.  Default determined by the of Entity type.

Used by

Element

Attribute

[ top ]

Attribute Attributes / @Version

Used by

Element

Attributes

[ top ]

Attribute Address / Phone / Number / @Type

Facets

enumeration	business
enumeration	other
enumeration	mobile
enumeration	work
enumeration	home

Used by

Element

Address/Phone/Number

[ top ]

Attribute Address / Phone / Number / @Seq

Used by

Element

Address/Phone/Number

[ top ]

Attribute Address / Phone / Number / @Description

Facets

maxLength

Used by

Element

Address/Phone/Number

[ top ]

Attribute Address / Fax / Number / @Type

Facets

enumeration	business
enumeration	other
enumeration	work
enumeration	home

Used by

Element

Address/Fax/Number

[ top ]

Attribute Address / Fax / Number / @Seq

Used by

Element

Address/Fax/Number

[ top ]

Attribute Address / Fax / Number / @Description

Facets

maxLength

Used by

Element

Address/Fax/Number

[ top ]

Attribute Address / Email / Address / @Type

Facets

enumeration	business
enumeration	other
enumeration	work
enumeration	personal

Used by

Element

Address/Email/Address

[ top ]

Attribute Address / Email / Address / @Seq

Used by

Element

Address/Email/Address

[ top ]

Attribute Address / Email / Address / @Description

Facets

maxLength

100

Used by

Element

Address/Email/Address

[ top ]

Attribute Address / Social / Address / @Type

Facets

enumeration	other
enumeration	lynkedin
enumeration	skype
enumeration	im
enumeration	twitter
enumeration	facebook
enumeration	website

Used by

Element

Address/Social/Address

[ top ]

Attribute Address / Social / Address / @Seq

Used by

Element

Address/Social/Address

[ top ]

Attribute Address / Social / Address / @Description

Facets

maxLength

100

Used by

Element

Address/Social/Address

[ top ]

Attribute Address / @Type

Facets

enumeration	business
enumeration	other
enumeration	physical
enumeration	postal
enumeration	delivery
enumeration	home
enumeration	work

Used by

Element

Address

[ top ]

Attribute Address / @Version

Used by

Element

Address

[ top ]

Attribute Group CommonAttributes

Diagram

Used by

Element

OnlinePaymentAckListSubmit

Attributes

QName

Type

Default

Use

Annotation

Culture

xs:string

optional

EndTime

xs:dateTime

optional

ErrorCount

xs:integer

optional

LoadFilter

xs:string

optional

LoadFilter must indicate the Entity Type.  Only one Entity Type per file is allowed. i.e. “Product”

LoadType

xs:string

required

FULL, FULLBranch, or PARTIAL
Note: partial loads require each record to explicitly declare if it is deprecated or not.  Full loads assume anything not in the load is deprecated.

SiteID

xs:string

optional

StartTime

xs:dateTime

optional

StatusID

xs:integer

optional

TransactionID

xs:string

optional

Transformed

xs:boolean

false

optional

Version

xs:decimal

required

[ top ]

Showing:

Table of Contents