XML Schema Documentation

Table of Contents

top

Schema Document Properties

Target Namespace http://www.paybox.com/PayboxBatchStatus
Element and Attribute Namespaces
  • Global element and attribute declarations belong to this schema's target namespace.
  • By default, local element declarations have no namespace.
  • By default, local attribute declarations have no namespace.

Declared Namespaces

Prefix Namespace
Default namespace http://www.paybox.com/PayboxBatchStatus
xml http://www.w3.org/XML/1998/namespace
xs http://www.w3.org/2001/XMLSchema
Schema Component Representation
<xs:schema targetNamespace="http://www.paybox.com/PayboxBatchStatus" elementFormDefault="unqualified" attributeFormDefault="unqualified">
...
</xs:schema>
top

Global Declarations

Element: Amount

Name Amount
Type Amount_T
Nillable no
Abstract no
Documentation Montant du paiement
Diagram
XML Instance Representation
<Amount> Amount_T </Amount>
Schema Component Representation
<xs:element name="Amount" type="Amount_T"/>
top

Element: Authorization

Name Authorization
Type Authorization_T
Nillable no
Abstract no
Documentation Numero d'autorisation
Diagram
XML Instance Representation
<Authorization> Authorization_T </Authorization>
Schema Component Representation
<xs:element name="Authorization" type="Authorization_T"/>
top

Element: CallId

Name CallId
Type PayboxId_T
Nillable no
Abstract no
Documentation Numero d'appel Paybox
Diagram
XML Instance Representation
<CallId> PayboxId_T </CallId>
Schema Component Representation
<xs:element name="CallId" type="PayboxId_T"/>
top

Element: CardCountryCode

Name CardCountryCode
Type Digits03_T
Nillable no
Abstract no
Documentation Commentaire explicitant le code reponse Paybox
Diagram
XML Instance Representation
<CardCountryCode> Digits03_T </CardCountryCode>
Schema Component Representation
<xs:element name="CardCountryCode" type="Digits03_T"/>
top

Element: Comment

Name Comment
Type Comment_T
Nillable no
Abstract no
Documentation Commentaire explicitant le code reponse Paybox
Diagram
XML Instance Representation
<Comment> Comment_T </Comment>
Schema Component Representation
<xs:element name="Comment" type="Comment_T"/>
top

Element: Currency

Name Currency
Type Currency_T
Nillable no
Abstract no
Documentation Devise du paiement - code ISO 4217 numerique
Diagram
XML Instance Representation
<Currency> Currency_T </Currency>
Schema Component Representation
<xs:element name="Currency" type="Currency_T"/>
top

Element: DateT

Name DateT
Type DateT_T
Nillable no
Abstract no
Documentation Date de creation de la transaction
Diagram
XML Instance Representation
<DateT> DateT_T </DateT>
Schema Component Representation
<xs:element name="DateT" type="DateT_T"/>
top

Element: Merchant

Name Merchant
Type Locally-defined complex type
Nillable no
Abstract no
Documentation Identification du marchant
Diagram
XML Instance Representation
<Merchant
Site="Site_T [1]"
Rank="Rank_T [1]"
PayboxId="PayboxId_T [1]">
Start Sequence [1..*]
<Status> ... </Status> [1]
End Sequence
</Merchant>
Schema Component Representation
<xs:element name="Merchant">
<xs:complexType>
<xs:sequence minOccurs="1" maxOccurs="unbounded">
<xs:element ref="Status"/>
</xs:sequence>
<xs:attribute name="Site" type="Site_T" use="required"/>
<xs:attribute name="Rank" type="Rank_T" use="required"/>
<xs:attribute name="PayboxId" type="PayboxId_T" use="required"/>
</xs:complexType>
</xs:element>
top

Element: OrderRef

Name OrderRef
Type OrderRef_T
Nillable no
Abstract no
Documentation Reference commande, unique pour chaque transaction
Diagram
XML Instance Representation
<OrderRef> OrderRef_T </OrderRef>
Schema Component Representation
<xs:element name="OrderRef" type="OrderRef_T"/>
top

Element: PayboxBatchStatus

Name PayboxBatchStatus
Type Locally-defined complex type
Nillable no
Abstract no
Documentation Identification du lot de transactions et du protocole
Diagram
XML Instance Representation
<PayboxBatchStatus
BatchNumber="BatchNumber_T [1]"
CreatedOn="CreatedOn_T [1]"
Version="Version_T [1]">
<Merchant> ... </Merchant> [1]
</PayboxBatchStatus>
Schema Component Representation
<xs:element name="PayboxBatchStatus">
<xs:complexType>
<xs:sequence minOccurs="1" maxOccurs="1">
<xs:element ref="Merchant"/>
</xs:sequence>
<xs:attribute name="BatchNumber" type="BatchNumber_T" use="required"/>
<xs:attribute name="CreatedOn" type="CreatedOn_T" use="required"/>
<xs:attribute name="Version" type="Version_T" use="required"/>
</xs:complexType>
</xs:element>
top

Element: PaymentHandle

Name PaymentHandle
Type PaymentHandle_T
Nillable no
Abstract no
Documentation 'Pseudo' ou 'jeton' du moyen de paiement recurrent
Diagram
XML Instance Representation
<PaymentHandle> PaymentHandle_T </PaymentHandle>
Schema Component Representation
<xs:element name="PaymentHandle" type="PaymentHandle_T"/>
top

Element: Status

Name Status
Type Locally-defined complex type
Nillable no
Abstract no
Documentation Definition des elements de la transaction
Diagram
XML Instance Representation
<Status
ItemId="PayboxId_T [1]">
Start All [1]
<DateT> ... </DateT> [1]
<TransType> ... </TransType> [0..1]
<SubscriptionType> ... </SubscriptionType> [0..1]
<StatusCode> ... </StatusCode> [1]
<Comment> ... </Comment> [0..1]
<Amount> ... </Amount> [0..1]
<Currency> ... </Currency> [0..1]
<OrderRef> ... </OrderRef> [0..1]
<SubscriptionRef> ... </SubscriptionRef> [0..1]
<CallId> ... </CallId> [0..1]
<TransactionId> ... </TransactionId> [0..1]
<Authorization> ... </Authorization> [0..1]
<PaymentHandle> ... </PaymentHandle> [0..1]
<CardCountryCode> ... </CardCountryCode> [0..1]
End All
</Status>
Schema Component Representation
<xs:element name="Status">
<xs:complexType>
<xs:all>
<xs:element ref="DateT" minOccurs="1" maxOccurs="1"/>
<xs:element ref="TransType" minOccurs="0" maxOccurs="1"/>
<xs:element ref="SubscriptionType" minOccurs="0" maxOccurs="1"/>
<xs:element ref="StatusCode" minOccurs="1" maxOccurs="1"/>
<xs:element ref="Comment" minOccurs="0" maxOccurs="1"/>
<xs:element ref="Amount" minOccurs="0" maxOccurs="1"/>
<xs:element ref="Currency" minOccurs="0" maxOccurs="1"/>
<xs:element ref="OrderRef" minOccurs="0" maxOccurs="1"/>
<xs:element ref="SubscriptionRef" minOccurs="0" maxOccurs="1"/>
<xs:element ref="CallId" minOccurs="0" maxOccurs="1"/>
<xs:element ref="TransactionId" minOccurs="0" maxOccurs="1"/>
<xs:element ref="Authorization" minOccurs="0" maxOccurs="1"/>
<xs:element ref="PaymentHandle" minOccurs="0" maxOccurs="1"/>
<xs:element ref="CardCountryCode" minOccurs="0" maxOccurs="1"/>
</xs:all>
<xs:attribute name="ItemId" type="PayboxId_T" use="required"/>
</xs:complexType>
</xs:element>
top

Element: StatusCode

Name StatusCode
Type Digits05_T
Nillable no
Abstract no
Documentation Status (code reponse Paybox)
Diagram
XML Instance Representation
<StatusCode> Digits05_T </StatusCode>
Schema Component Representation
<xs:element name="StatusCode" type="Digits05_T"/>
top

Element: SubscriptionRef

Name SubscriptionRef
Type OrderRef_T
Nillable no
Abstract no
Documentation Reference abonnement (profil), unique pour chaque abonnement
Diagram
XML Instance Representation
<SubscriptionRef> OrderRef_T </SubscriptionRef>
Schema Component Representation
<xs:element name="SubscriptionRef" type="OrderRef_T"/>
top

Element: SubscriptionType

Name SubscriptionType
Type TypeSub_T
Nillable no
Abstract no
Documentation Type d'action demandee sur l'abonnement
Diagram
XML Instance Representation
<SubscriptionType> TypeSub_T </SubscriptionType>
Schema Component Representation
<xs:element name="SubscriptionType" type="TypeSub_T"/>
top

Element: TransactionId

Name TransactionId
Type PayboxId_T
Nillable no
Abstract no
Documentation Numero de transaction Paybox
Diagram
XML Instance Representation
<TransactionId> PayboxId_T </TransactionId>
Schema Component Representation
<xs:element name="TransactionId" type="PayboxId_T"/>
top

Element: TransType

Name TransType
Type TypeTrans_T
Nillable no
Abstract no
Documentation Type de transaction
Diagram
XML Instance Representation
<TransType> TypeTrans_T </TransType>
Schema Component Representation
<xs:element name="TransType" type="TypeTrans_T"/>
top

Global Definitions

Simple Type: Amount_T

Super-types: xs:decimal < Amount_T (by restriction)
Sub-types: None
Name Amount_T
Content
  • Base XSD Type: decimal
  • total no. of digits = 10
  • no. of fraction digits = 2
Diagram
Schema Component Representation
<xs:simpleType name="Amount_T">
<xs:restriction base="xs:decimal">
<xs:totalDigits value="10"/>
<xs:fractionDigits value="2"/>
</xs:restriction>
</xs:simpleType>
top

Simple Type: Authorization_T

Super-types: xs:string < Authorization_T (by restriction)
Sub-types: None
Name Authorization_T
Content
  • Base XSD Type: string
  • pattern = [0-9]{0,10}
Diagram
Schema Component Representation
<xs:simpleType name="Authorization_T">
<xs:restriction base="xs:string">
<xs:pattern value="[0-9]{0,10}"/>
</xs:restriction>
</xs:simpleType>
top

Simple Type: BatchNumber_T

Super-types: xs:positiveInteger < BatchNumber_T (by restriction)
Sub-types: None
Name BatchNumber_T
Content
  • Base XSD Type: positiveInteger
Diagram
Schema Component Representation
<xs:simpleType name="BatchNumber_T">
<xs:restriction base="xs:positiveInteger"/>
</xs:simpleType>
top

Simple Type: Comment_T

Super-types: xs:normalizedString < Comment_T (by restriction)
Sub-types: None
Name Comment_T
Content
  • Base XSD Type: normalizedString
  • length <= 100
Diagram
Schema Component Representation
<xs:simpleType name="Comment_T">
<xs:restriction base="xs:normalizedString">
<xs:maxLength value="100"/>
</xs:restriction>
</xs:simpleType>
top

Simple Type: CreatedOn_T

Super-types: xs:dateTime < CreatedOn_T (by restriction)
Sub-types: None
Name CreatedOn_T
Content
  • Base XSD Type: dateTime
Diagram
Schema Component Representation
<xs:simpleType name="CreatedOn_T">
<xs:restriction base="xs:dateTime"/>
</xs:simpleType>
top

Simple Type: Currency_T

Super-types: xs:string < Currency_T (by restriction)
Sub-types: None
Name Currency_T
Content
  • Base XSD Type: string
  • pattern = [0-9]{3}
Diagram
Schema Component Representation
<xs:simpleType name="Currency_T">
<xs:restriction base="xs:string">
<xs:pattern value="[0-9]{3}"/>
</xs:restriction>
</xs:simpleType>
top

Simple Type: DateT_T

Super-types: xs:dateTime < DateT_T (by restriction)
Sub-types: None
Name DateT_T
Content
  • Base XSD Type: dateTime
Diagram
Schema Component Representation
<xs:simpleType name="DateT_T">
<xs:restriction base="xs:dateTime"/>
</xs:simpleType>
top

Simple Type: Digits03_T

Super-types: xs:string < Digits03_T (by restriction)
Sub-types:
Name Digits03_T
Content
  • Base XSD Type: string
  • pattern = [0-9]{3}
Diagram
Schema Component Representation
<xs:simpleType name="Digits03_T">
<xs:restriction base="xs:string">
<xs:pattern value="[0-9]{3}"/>
</xs:restriction>
</xs:simpleType>
top

Simple Type: Digits05_T

Super-types: xs:string < Digits05_T (by restriction)
Sub-types:
Name Digits05_T
Content
  • Base XSD Type: string
  • pattern = [0-9]{5}
Diagram
Schema Component Representation
<xs:simpleType name="Digits05_T">
<xs:restriction base="xs:string">
<xs:pattern value="[0-9]{5}"/>
</xs:restriction>
</xs:simpleType>
top

Simple Type: Digits07_T

Super-types: xs:string < Digits07_T (by restriction)
Sub-types:
Name Digits07_T
Content
  • Base XSD Type: string
  • pattern = [0-9]{7}
Diagram
Schema Component Representation
<xs:simpleType name="Digits07_T">
<xs:restriction base="xs:string">
<xs:pattern value="[0-9]{7}"/>
</xs:restriction>
</xs:simpleType>
top

Simple Type: OrderRef_T

Super-types: xs:normalizedString < OrderRef_T (by restriction)
Sub-types: None
Name OrderRef_T
Content
  • Base XSD Type: normalizedString
  • length >= 1
  • Whitespace policy: collapse
Diagram
Schema Component Representation
<xs:simpleType name="OrderRef_T">
<xs:restriction base="xs:normalizedString">
<xs:minLength value="1"/>
<xs:maxLength value="250"/>
<xs:whiteSpace value="collapse"/>
</xs:restriction>
</xs:simpleType>
top

Simple Type: PayboxId_T

Super-types: xs:positiveInteger < PayboxId_T (by restriction)
Sub-types: None
Name PayboxId_T
Content
  • Base XSD Type: positiveInteger
Diagram
Schema Component Representation
<xs:simpleType name="PayboxId_T">
<xs:restriction base="xs:positiveInteger"/>
</xs:simpleType>
top

Simple Type: PaymentHandle_T

Super-types: xs:normalizedString < PaymentHandle_T (by restriction)
Sub-types: None
Name PaymentHandle_T
Content
  • Base XSD Type: normalizedString
  • length <= 16
Diagram
Schema Component Representation
<xs:simpleType name="PaymentHandle_T">
<xs:restriction base="xs:normalizedString">
<xs:maxLength value="16"/>
</xs:restriction>
</xs:simpleType>
top

Simple Type: Rank_T

Super-types: xs:string < Digits03_T (by restriction) < Rank_T (by restriction)
Sub-types: None
Name Rank_T
Content
  • Base XSD Type: string
  • pattern = [0-9]{3}
Diagram
Schema Component Representation
<xs:simpleType name="Rank_T">
<xs:restriction base="Digits03_T"/>
</xs:simpleType>
top

Simple Type: Site_T

Super-types: xs:string < Digits07_T (by restriction) < Site_T (by restriction)
Sub-types: None
Name Site_T
Content
  • Base XSD Type: string
  • pattern = [0-9]{7}
Diagram
Schema Component Representation
<xs:simpleType name="Site_T">
<xs:restriction base="Digits07_T"/>
</xs:simpleType>
top

Simple Type: Subscription_T

Super-types: xs:boolean < Subscription_T (by restriction)
Sub-types: None
Name Subscription_T
Content
  • Base XSD Type: boolean
Diagram
Schema Component Representation
<xs:simpleType name="Subscription_T">
<xs:restriction base="xs:boolean"/>
</xs:simpleType>
top

Simple Type: TypeSub_T

Super-types: xs:string < TypeSub_T (by restriction)
Sub-types: None
Name TypeSub_T
Content
  • Base XSD Type: string
  • value comes from list: {'New'|'Update'|'Cancellation'}
Diagram
Schema Component Representation
<xs:simpleType name="TypeSub_T">
<xs:restriction base="xs:string">
<xs:enumeration value="New"/>
<xs:enumeration value="Update"/>
<xs:enumeration value="Cancellation"/>
</xs:restriction>
</xs:simpleType>
top

Simple Type: TypeTrans_T

Super-types: xs:string < TypeTrans_T (by restriction)
Sub-types: None
Name TypeTrans_T
Content
  • Base XSD Type: string
  • value comes from list: {'Authorization'|'Debit'|'AutoCapture'|'Credit'|'Cancellation'|'Existence'|'Forced'|'Update'|'Refound'}
Diagram
Schema Component Representation
<xs:simpleType name="TypeTrans_T">
<xs:restriction base="xs:string">
<xs:enumeration value="Authorization"/>
<-- 1 auto seule -->
<xs:enumeration value="Debit"/>
<-- 2 capture suite autorisation prealable -->
<xs:enumeration value="AutoCapture"/>
<-- 3 auto + capture -->
<xs:enumeration value="Credit"/>
<-- 4 credit -->
<xs:enumeration value="Cancellation"/>
<-- 5 annulation -->
<xs:enumeration value="Existence"/>
<-- 11 verification existence transaction -->
<xs:enumeration value="Forced"/>
<-- 12 transaction sans auto -->
<xs:enumeration value="Update"/>
<-- 13 modification du montant -->
<xs:enumeration value="Refound"/>
<-- 14 remboursement -->
</xs:restriction>
</xs:simpleType>
top

Simple Type: Version_T

Super-types: xs:string < Digits05_T (by restriction) < Version_T (by restriction)
Sub-types: None
Name Version_T
Content
  • Base XSD Type: string
  • pattern = [0-9]{5}
Diagram
Schema Component Representation
<xs:simpleType name="Version_T">
<xs:restriction base="Digits05_T"/>
</xs:simpleType>
top

Legend

Complex Type:

Schema Component Type

AusAddress

Schema Component Name
Super-types: Address < AusAddress (by extension)
Sub-types:
  • QLDAddress (by restriction)
If this schema component is a type definition, its type hierarchy is shown in a gray-bordered box.
Name AusAddress
Abstract no
The table above displays the properties of this schema component.
XML Instance Representation
<... country="Australia" >
<unitNo> string </unitNo> [0..1]
<houseNo> string </houseNo> [1]
<street> string </street> [1]
Start Choice [1]
<city> string </city> [1]
<town> string </town> [1]
End Choice
<state> AusStates </state> [1]
<postcode> string <<pattern = [1-9][0-9]{3}>> </postcode> [1] ?
</...>

The XML Instance Representation table above shows the schema component's content as an XML instance.

Schema Component Representation
<complexType name="AusAddress">
<complexContent>
<extension base="Address">
<sequence>
<element name="state" type="AusStates"/>
<element name="postcode">
<simpleType>
<restriction base="string">
<pattern value="[1-9][0-9]{3}"/>
</restriction>
</simpleType>
</element>
</sequence>
<attribute name="country" type="string" fixed="Australia"/>
</extension>
</complexContent>
</complexType>
The Schema Component Representation table above displays the underlying XML representation of the schema component. (Annotations are not shown.)
top

Glossary

Abstract (Applies to complex type definitions and element declarations). An abstract element or complex type cannot used to validate an element instance. If there is a reference to an abstract element, only element declarations that can substitute the abstract element can be used to validate the instance. For references to abstract type definitions, only derived types can be used.

All Model Group Child elements can be provided in any order in instances. See: http://www.w3.org/TR/xmlschema-1/#element-all.

Choice Model Group Only one from the list of child elements and model groups can be provided in instances. See: http://www.w3.org/TR/xmlschema-1/#element-choice.

Collapse Whitespace Policy Replace tab, line feed, and carriage return characters with space character (Unicode character 32). Then, collapse contiguous sequences of space characters into single space character, and remove leading and trailing space characters.

Disallowed Substitutions (Applies to element declarations). If substitution is specified, then substitution group members cannot be used in place of the given element declaration to validate element instances. If derivation methods, e.g. extension, restriction, are specified, then the given element declaration will not validate element instances that have types derived from the element declaration's type using the specified derivation methods. Normally, element instances can override their declaration's type by specifying an xsi:type attribute.

Key Constraint Like Uniqueness Constraint, but additionally requires that the specified value(s) must be provided. See: http://www.w3.org/TR/xmlschema-1/#cIdentity-constraint_Definitions.

Key Reference Constraint Ensures that the specified value(s) must match value(s) from a Key Constraint or Uniqueness Constraint. See: http://www.w3.org/TR/xmlschema-1/#cIdentity-constraint_Definitions.

Model Group Groups together element content, specifying the order in which the element content can occur and the number of times the group of element content may be repeated. See: http://www.w3.org/TR/xmlschema-1/#Model_Groups.

Nillable (Applies to element declarations). If an element declaration is nillable, instances can use the xsi:nil attribute. The xsi:nil attribute is the boolean attribute, nil, from the http://www.w3.org/2001/XMLSchema-instance namespace. If an element instance has an xsi:nil attribute set to true, it can be left empty, even though its element declaration may have required content.

Notation A notation is used to identify the format of a piece of data. Values of elements and attributes that are of type, NOTATION, must come from the names of declared notations. See: http://www.w3.org/TR/xmlschema-1/#cNotation_Declarations.

Preserve Whitespace Policy Preserve whitespaces exactly as they appear in instances.

Prohibited Derivations (Applies to type definitions). Derivation methods that cannot be used to create sub-types from a given type definition.

Prohibited Substitutions (Applies to complex type definitions). Prevents sub-types that have been derived using the specified derivation methods from validating element instances in place of the given type definition.

Replace Whitespace Policy Replace tab, line feed, and carriage return characters with space character (Unicode character 32).

Sequence Model Group Child elements and model groups must be provided in the specified order in instances. See: http://www.w3.org/TR/xmlschema-1/#element-sequence.

Substitution Group Elements that are members of a substitution group can be used wherever the head element of the substitution group is referenced.

Substitution Group Exclusions (Applies to element declarations). Prohibits element declarations from nominating themselves as being able to substitute a given element declaration, if they have types that are derived from the original element's type using the specified derivation methods.

Target Namespace The target namespace identifies the namespace that components in this schema belongs to. If no target namespace is provided, then the schema components do not belong to any namespace.

Uniqueness Constraint Ensures uniqueness of an element/attribute value, or a combination of values, within a specified scope. See: http://www.w3.org/TR/xmlschema-1/#cIdentity-constraint_Definitions.

top