PaymentTransaction

Information to communicate the payment transaction.

See http://www.openapplications.org/platform/1.

Element information

Content

• Sequence [1..1]
  from group PaymentIDGroup
  Sequence [0..1]
  1. InstructionID [0..1]    Unique and unambiguous identifier for a payment instruction assigned by the initiating party.
  2. TransactionID [0..1]    Unique and unambiguous identification of a payment transaction, as assigned by any of the parties on the initiating side, which will be passed on throughout the entire end-to-end chain.
  3. RemitID [0..1]    Unique and unambiguous identification of remittance information which is sent separately from the payment initiation information.
  1. Choice [1..1]
     • PaymentPurposeCode [0..1]    The underlying reason for the payment transaction, e.g. a charity payment, or a commerical agreement between the creditor and the debitor. Provided by the code contained.
     • ProprietaryText [0..1]    Provides a roprietary text description.
  2. Choice [1..1]
     • InstructedAmount [0..1]    Amount of money to be transferred between debtor and creditor, before deduction of charges, expressed in the currency of the debtor's account or in another currency.
     • EquivalentAmount [0..1]    Amount of money to be transferred between the debtor and creditor, before deduction of charges, expressed in the currency of the debtor's account and to be transferred into a different currency.
  3. ChequeInstruction [0..1]    Information related to a cheque instruction.
  4. OriginatorParty [0..1]    Identifies the party that originated the purchase of the goods, service or payment.
  5. IntermediaryFinancialParty [0..*]    An agent between the first and final agent. Usage guideline: This information is provided by the initiating party, based on information provided by the creditor or final party. How this information is handled by the first agent will depend on the service level/business practice between initiating party and first agent.
  6. CreditorParty [0..1]    Party that receives an amount of money from the debtor. In the context of the payment model, the creditor is also the credit account owner.
  7. FinalAgentFinancialParty [0..1]    Financial institution that receives the payment transaction on behalf of an account owner, and posts the transaction to the account.
  8. FinalParty [0..1]    Party that is the ultimate beneficiary of the cash transfer.
  9. ChargeBearerCode [0..1]    Specifies if the creditor and/or debtor will bear the charges associated with the processing of the payment transaction.
  10. ExchangeContractReference [0..1]    Unique and unambiguous reference to the foreign exchange contract agreed between the initiating party and the first agent.
  11. RegulatoryReporting [0..*]    Information needed due to regulatory and statutory requirements,.
  12. FinalAgentInstructions [0..1]    Further information related to the processing of the payment instruction, provided by the initiating party, and intended for the final agent.
  13. FirstAgentInstruction [0..1]    Further information related to the processing of the payment instruction, which may need to be acted upon by the first agent, depending on agreement between customer and the first agent. The instruction can relate to a level of service between the customer and the first agent, or can be information required by the first agent.
  14. RemittanceInformation [0..*]    Information supplied to enable the matching of an entry with the items that the payment is intended to settle, eg, commercial invoices in an Accounts Receivable system.
  from group FreeFormTextGroup
  Sequence [0..1]
  1. Description [0..*]    
  2. Note [0..*]    
  15. Status [0..1]    Indicates the status of the associated object by providing the Status Code along with a description and when the status is effective.
  16. RejectionStatus [0..1]    
  17. UserArea [0..1]    Allows the user of OAGIS to extend the specification in order to provide additional information that is not captured in OAGIS.This is done by defining the additional information in XML Schema and referencing the new schema in the xml instance document through the use of namespaces. Once this is done the additional information defined there can be carried in the BOD XML instance document.The Open Applications Group will make best efforts to quickly consider all proposed submissions.The USERAREA is always the last element in all components, except where the component has been extended inline.

Attributes

Used in

• Type TransferPaymentType
• Type CreditTransferPaymentType via extension of TransferPaymentType (Element CreditTransferPayment)
• Type DebitTransferPaymentType via extension of TransferPaymentType (Element DebitTransferPayment)
• Type PaymentStatusOriginalPaymentType via extension of TransferPaymentType (Element PaymentStatusPayment)

Sample instance

<PaymentTransaction>
   <InstructionID>normalizedString</InstructionID>
   <TransactionID>normalizedString</TransactionID>
   <RemitID>normalizedString</RemitID>
   <PaymentPurposeCode>normalizedString</PaymentPurposeCode>
   <InstructedAmount currencyID="AED">1.0</InstructedAmount>
   <ChequeInstruction>
      <ChequeNumber>normalizedString</ChequeNumber>
      <DeliveryMethodCode>normalizedString</DeliveryMethodCode>
      <ChequeFromParty>
         <PartyIDs>...
         </PartyIDs>
         <AccountID>normalizedString</AccountID>
         <Name>string</Name>
         <Location>...
         </Location>
         <Contact>...
         </Contact>
         <UserArea>
            <!--any element-->
         </UserArea>
      </ChequeFromParty>
      <DeliverToParty>
         <PartyIDs>...
         </PartyIDs>
         <AccountID>normalizedString</AccountID>
         <Name>string</Name>
         <Location>...
         </Location>
         <Contact>...
         </Contact>
         <UserArea>
            <!--any element-->
         </UserArea>
      </DeliverToParty>
      <PriorityCode>normalizedString</PriorityCode>
      <ChequeMaturityDate>2000-01-01</ChequeMaturityDate>
      <ChequeFormsCode>normalizedString</ChequeFormsCode>
      <ChequeMemoFieldText>string</ChequeMemoFieldText>
      <RegionalClearingZoneID>normalizedString</RegionalClearingZoneID>
      <UserArea>
         <!--any element-->
      </UserArea>
   </ChequeInstruction>
   <OriginatorParty>
      <PartyIDs>
         <ID>normalizedString</ID>
         <TaxID>normalizedString</TaxID>
         <DUNSID>normalizedString</DUNSID>
         <CAGEID>normalizedString</CAGEID>
         <DODAACID>normalizedString</DODAACID>
         <BICID>normalizedString</BICID>
      </PartyIDs>
      <AccountID>normalizedString</AccountID>
      <Name>string</Name>
      <Location>
         <ID>normalizedString</ID>
         <Name>string</Name>
         <Directions>string</Directions>
         <Coordinate>...
         </Coordinate>
         <Address>...
         </Address>
         <Description>string</Description>
         <Note>string</Note>
         <UserArea>
            <!--any element-->
         </UserArea>
      </Location>
      <Contact>
         <ID>normalizedString</ID>
         <Name>string</Name>
         <JobTitle>string</JobTitle>
         <Responsibility>string</Responsibility>
         <DepartmentName>string</DepartmentName>
         <Communication>...
         </Communication>
         <Preference>...
         </Preference>
         <UserArea>
            <!--any element-->
         </UserArea>
      </Contact>
      <UserArea>
         <!--any element-->
      </UserArea>
   </OriginatorParty>
   <IntermediaryFinancialParty>
      <PartyIDs>
         <ID>normalizedString</ID>
         <TaxID>normalizedString</TaxID>
         <DUNSID>normalizedString</DUNSID>
         <CAGEID>normalizedString</CAGEID>
         <DODAACID>normalizedString</DODAACID>
         <BICID>normalizedString</BICID>
      </PartyIDs>
      <AccountID>normalizedString</AccountID>
      <Name>string</Name>
      <Location>
         <ID>normalizedString</ID>
         <Name>string</Name>
         <Directions>string</Directions>
         <Coordinate>...
         </Coordinate>
         <Address>...
         </Address>
         <Description>string</Description>
         <Note>string</Note>
         <UserArea>
            <!--any element-->
         </UserArea>
      </Location>
      <Contact>
         <ID>normalizedString</ID>
         <Name>string</Name>
         <JobTitle>string</JobTitle>
         <Responsibility>string</Responsibility>
         <DepartmentName>string</DepartmentName>
         <Communication>...
         </Communication>
         <Preference>...
         </Preference>
         <UserArea>
            <!--any element-->
         </UserArea>
      </Contact>
      <ClearingSystemMemberID>normalizedString</ClearingSystemMemberID>
      <BranchParty>
         <PartyIDs>...
         </PartyIDs>
         <AccountID>normalizedString</AccountID>
         <Name>string</Name>
         <Location>...
         </Location>
         <Contact>...
         </Contact>
         <UserArea>
            <!--any element-->
         </UserArea>
      </BranchParty>
      <FinancialAccount>
         <ID>normalizedString</ID>
         <AccountIDs>...
         </AccountIDs>
         <CurrencyCode>AED</CurrencyCode>
         <Name>string</Name>
         <Type>normalizedString</Type>
         <UserArea>
            <!--any element-->
         </UserArea>
      </FinancialAccount>
      <CountryCode>normalizedString</CountryCode>
      <UserArea>
         <!--any element-->
      </UserArea>
   </IntermediaryFinancialParty>
   <CreditorParty>
      <PartyIDs>
         <ID>normalizedString</ID>
         <TaxID>normalizedString</TaxID>
         <DUNSID>normalizedString</DUNSID>
         <CAGEID>normalizedString</CAGEID>
         <DODAACID>normalizedString</DODAACID>
         <BICID>normalizedString</BICID>
      </PartyIDs>
      <AccountID>normalizedString</AccountID>
      <Name>string</Name>
      <Location>
         <ID>normalizedString</ID>
         <Name>string</Name>
         <Directions>string</Directions>
         <Coordinate>...
         </Coordinate>
         <Address>...
         </Address>
         <Description>string</Description>
         <Note>string</Note>
         <UserArea>
            <!--any element-->
         </UserArea>
      </Location>
      <Contact>
         <ID>normalizedString</ID>
         <Name>string</Name>
         <JobTitle>string</JobTitle>
         <Responsibility>string</Responsibility>
         <DepartmentName>string</DepartmentName>
         <Communication>...
         </Communication>
         <Preference>...
         </Preference>
         <UserArea>
            <!--any element-->
         </UserArea>
      </Contact>
      <CustomerAccountID>normalizedString</CustomerAccountID>
      <CountryCode>normalizedString</CountryCode>
      <FinancialAccount>
         <ID>normalizedString</ID>
         <AccountIDs>...
         </AccountIDs>
         <CurrencyCode>AED</CurrencyCode>
         <Name>string</Name>
         <Type>normalizedString</Type>
         <UserArea>
            <!--any element-->
         </UserArea>
      </FinancialAccount>
      <UserArea>
         <!--any element-->
      </UserArea>
   </CreditorParty>
   <FinalAgentFinancialParty>
      <PartyIDs>
         <ID>normalizedString</ID>
         <TaxID>normalizedString</TaxID>
         <DUNSID>normalizedString</DUNSID>
         <CAGEID>normalizedString</CAGEID>
         <DODAACID>normalizedString</DODAACID>
         <BICID>normalizedString</BICID>
      </PartyIDs>
      <AccountID>normalizedString</AccountID>
      <Name>string</Name>
      <Location>
         <ID>normalizedString</ID>
         <Name>string</Name>
         <Directions>string</Directions>
         <Coordinate>...
         </Coordinate>
         <Address>...
         </Address>
         <Description>string</Description>
         <Note>string</Note>
         <UserArea>
            <!--any element-->
         </UserArea>
      </Location>
      <Contact>
         <ID>normalizedString</ID>
         <Name>string</Name>
         <JobTitle>string</JobTitle>
         <Responsibility>string</Responsibility>
         <DepartmentName>string</DepartmentName>
         <Communication>...
         </Communication>
         <Preference>...
         </Preference>
         <UserArea>
            <!--any element-->
         </UserArea>
      </Contact>
      <ClearingSystemMemberID>normalizedString</ClearingSystemMemberID>
      <BranchParty>
         <PartyIDs>...
         </PartyIDs>
         <AccountID>normalizedString</AccountID>
         <Name>string</Name>
         <Location>...
         </Location>
         <Contact>...
         </Contact>
         <UserArea>
            <!--any element-->
         </UserArea>
      </BranchParty>
      <FinancialAccount>
         <ID>normalizedString</ID>
         <AccountIDs>...
         </AccountIDs>
         <CurrencyCode>AED</CurrencyCode>
         <Name>string</Name>
         <Type>normalizedString</Type>
         <UserArea>
            <!--any element-->
         </UserArea>
      </FinancialAccount>
      <CountryCode>normalizedString</CountryCode>
      <UserArea>
         <!--any element-->
      </UserArea>
   </FinalAgentFinancialParty>
   <FinalParty>
      <PartyIDs>
         <ID>normalizedString</ID>
         <TaxID>normalizedString</TaxID>
         <DUNSID>normalizedString</DUNSID>
         <CAGEID>normalizedString</CAGEID>
         <DODAACID>normalizedString</DODAACID>
         <BICID>normalizedString</BICID>
      </PartyIDs>
      <AccountID>normalizedString</AccountID>
      <Name>string</Name>
      <Location>
         <ID>normalizedString</ID>
         <Name>string</Name>
         <Directions>string</Directions>
         <Coordinate>...
         </Coordinate>
         <Address>...
         </Address>
         <Description>string</Description>
         <Note>string</Note>
         <UserArea>
            <!--any element-->
         </UserArea>
      </Location>
      <Contact>
         <ID>normalizedString</ID>
         <Name>string</Name>
         <JobTitle>string</JobTitle>
         <Responsibility>string</Responsibility>
         <DepartmentName>string</DepartmentName>
         <Communication>...
         </Communication>
         <Preference>...
         </Preference>
         <UserArea>
            <!--any element-->
         </UserArea>
      </Contact>
      <UserArea>
         <!--any element-->
      </UserArea>
   </FinalParty>
   <ChargeBearerCode>normalizedString</ChargeBearerCode>
   <ExchangeContractReference>
      <DocumentID>
         <ID>normalizedString</ID>
         <RevisionID>normalizedString</RevisionID>
         <VariationID>normalizedString</VariationID>
      </DocumentID>
      <AlternateDocumentID>
         <ID>normalizedString</ID>
         <RevisionID>normalizedString</RevisionID>
         <VariationID>normalizedString</VariationID>
      </AlternateDocumentID>
      <DocumentDateTime>2000-01-01</DocumentDateTime>
      <Description>string</Description>
      <Note>string</Note>
      <StatusCode>normalizedString</StatusCode>
      <Status>
         <Code>normalizedString</Code>
         <Description>string</Description>
         <EffectiveDateTime>2000-01-01</EffectiveDateTime>
         <ReasonCode>normalizedString</ReasonCode>
         <Reason>string</Reason>
         <TimePeriod>...
         </TimePeriod>
         <UserArea>
            <!--any element-->
         </UserArea>
      </Status>
      <UserArea>
         <!--any element-->
      </UserArea>
   </ExchangeContractReference>
   <RegulatoryReporting>
      <Code>normalizedString</Code>
      <Amount currencyID="AED">1.0</Amount>
      <Note>string</Note>
      <UserArea>
         <!--any element-->
      </UserArea>
   </RegulatoryReporting>
   <FinalAgentInstructions>
      <FinalAgentInstructionCode>normalizedString</FinalAgentInstructionCode>
      <ProprietaryText>string</ProprietaryText>
      <UserArea>
         <!--any element-->
      </UserArea>
   </FinalAgentInstructions>
   <FirstAgentInstruction>
      <ProprietaryText>string</ProprietaryText>
      <DebitPurposeText>string</DebitPurposeText>
      <RemitLocationMethodCode>normalizedString</RemitLocationMethodCode>
      <RemitLocationURI>http://www.example.com/</RemitLocationURI>
      <RemitLocationPostalAddress>
         <ID>normalizedString</ID>
         <FormatCode>normalizedString</FormatCode>
         <AttentionOfName>string</AttentionOfName>
         <CareOfName>string</CareOfName>
         <AddressLine>string</AddressLine>
         <CitySubDivisionName>string</CitySubDivisionName>
         <CityName>string</CityName>
         <CountrySubDivisionCode>normalizedString</CountrySubDivisionCode>
         <CountryCode>normalizedString</CountryCode>
         <PostalCode>normalizedString</PostalCode>
         <Status>...
         </Status>
         <Preference>...
         </Preference>
         <UserArea>
            <!--any element-->
         </UserArea>
      </RemitLocationPostalAddress>
      <PaymentTransactionTax>
         <CreditorTaxID>normalizedString</CreditorTaxID>
         <CreditorTaxType>normalizedString</CreditorTaxType>
         <DebtorTaxID>normalizedString</DebtorTaxID>
         <TaxReferenceNumber>normalizedString</TaxReferenceNumber>
         <TotalTaxableBaseAmount currencyID="AED">1.0</TotalTaxableBaseAmount>
         <TotalTaxAmount currencyID="AED">1.0</TotalTaxAmount>
         <Tax>...
         </Tax>
         <UserArea>
            <!--any element-->
         </UserArea>
      </PaymentTransactionTax>
      <UserArea>
         <!--any element-->
      </UserArea>
   </FirstAgentInstruction>
   <RemittanceInformation>
      <ID>normalizedString</ID>
      <UnstructuredRemittanceText>string</UnstructuredRemittanceText>
      <UserArea>
         <!--any element-->
      </UserArea>
   </RemittanceInformation>
   <Description>string</Description>
   <Note>string</Note>
   <Status>
      <Code>normalizedString</Code>
      <Description>string</Description>
      <EffectiveDateTime>2000-01-01</EffectiveDateTime>
      <ReasonCode>normalizedString</ReasonCode>
      <Reason>string</Reason>
      <TimePeriod>
         <InclusiveIndicator>true</InclusiveIndicator>
         <StartDateTime>2000-01-01</StartDateTime>
         <Duration>P1Y2M3DT10H</Duration>
      </TimePeriod>
      <UserArea>
         <!--any element-->
      </UserArea>
   </Status>
   <RejectionStatus>
      <Code>normalizedString</Code>
      <Description>string</Description>
      <EffectiveDateTime>2000-01-01</EffectiveDateTime>
      <ReasonCode>normalizedString</ReasonCode>
      <Reason>string</Reason>
      <TimePeriod>
         <InclusiveIndicator>true</InclusiveIndicator>
         <StartDateTime>2000-01-01</StartDateTime>
         <Duration>P1Y2M3DT10H</Duration>
      </TimePeriod>
      <UserArea>
         <!--any element-->
      </UserArea>
   </RejectionStatus>
   <UserArea>
      <!--any element-->
   </UserArea>
</PaymentTransaction>