PaymentStatusPayment

Element information

Content

• Sequence [1..1]
  from type IdentificationType
  ID [0..*]    Is the Identifiers of the given instance of an entity within the scope of the integration. The schemeAgencyID attribute identifies the party that provided or knows this party by the given identifier.
  IDSet [0..*]    
  from type TransferPaymentBaseType
  RequestedExecutionDateTime [0..1]    Date at which the initiating party requests that the payment instruction be executed. If payment by check, the date when the check is required to be generated by the bank.
  FirstAgentPaymentMethodCode [0..1]    Specifies the transfer method that will be used by the first agent to transfer the funds to the creditor. IST limits these values to CreditTransfer (TRF) and Checque (CHK).
  DebtorParty [0..1]    Party that owes an amount of money to the creditor. In the context of the payment model, the debtor is also the debit account owner.
  FirstAgentParty [0..1]    Financial institution that receives the payment transaction from the account owner or authorized party and processes the instruction.
  from group FreeFormTextGroup
  Description [0..*]    
  Note [0..*]    
  PaymentTransaction [0..*]    Information to communicate the payment transaction.
  1. Extension [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 Extension is always the last element in all components, except where the component has been extended inline.

Attributes

Used in

• Type PaymentStatusType (Element PaymentStatus)

Sample instance

<PaymentStatusPayment>
   <ID/>
   <IDSet>
      <ID/>
   </IDSet>
   <RequestedExecutionDateTime></RequestedExecutionDateTime>
   <FirstAgentPaymentMethodCode>token</FirstAgentPaymentMethodCode>
   <DebtorParty>
      <ID/>
      <PartyIDSet>
         <ID/>
      </PartyIDSet>
      <TaxIDSet>
         <ID/>
      </TaxIDSet>
      <TaxID>normalizedString</TaxID>
      <DUNSID>normalizedString</DUNSID>
      <CAGEID>normalizedString</CAGEID>
      <DODAACID>normalizedString</DODAACID>
      <BICID>normalizedString</BICID>
      <SCACID>normalizedString</SCACID>
      <AccountID>normalizedString</AccountID>
      <Name/>
      <Location>
         <ID/>
         <IDSet>...
         </IDSet>
         <Name/>
         <Directions/>
         <Coordinate>...
         </Coordinate>
         <Address>...
         </Address>
         <Contact>...
         </Contact>
         <Communication>...
         </Communication>
         <PostalAddress>...
         </PostalAddress>
         <PhysicalAddress>...
         </PhysicalAddress>
         <Description/>
         <Note/>
         <TimeZoneCode>M0100</TimeZoneCode>
         <AvailableTimePeriod>..................
         </AvailableTimePeriod>
         <LocationEquipmentSpecification>...
         </LocationEquipmentSpecification>
         <EffectiveTimePeriod>..................
         </EffectiveTimePeriod>
         <Extension>.......................................
         </Extension>
      </Location>
      <Contact>
         <ID/>
         <IDSet>...
         </IDSet>
         <PersonName>...
         </PersonName>
         <RoleCode>normalizedString</RoleCode>
         <JobTitle/>
         <Responsibility/>
         <OrganizationUnitID>normalizedString</OrganizationUnitID>
         <Communication>...
         </Communication>
         <TelephoneCommunication>...
         </TelephoneCommunication>
         <EMailAddressCommunication>...
         </EMailAddressCommunication>
         <InternetAddressCommunication>...
         </InternetAddressCommunication>
         <Preference>...
         </Preference>
         <EffectiveTimePeriod>..................
         </EffectiveTimePeriod>
         <Extension>.......................................
         </Extension>
      </Contact>
      <CustomerAccountID>normalizedString</CustomerAccountID>
      <CountryCode>token</CountryCode>
      <FinancialAccount>
         <ID/>
         <BBANID>normalizedString</BBANID>
         <IBANID>normalizedString</IBANID>
         <UPICID>normalizedString</UPICID>
         <AccountIDs>...
         </AccountIDs>
         <CurrencyCode>token</CurrencyCode>
         <Name/>
         <Extension>.......................................
         </Extension>
      </FinancialAccount>
      <Extension>
         <AnyExtension>
            <!--any element-->
         </AnyExtension>
         <Amount/>
         <Code/>
         <DateTime></DateTime>
         <ID/>
         <Indicator>true</Indicator>
         <Measure/>
         <Name/>
         <Number>1.0</Number>
         <Quantity/>
         <Text/>
         <Time></Time>
         <ValueText>string</ValueText>
      </Extension>
   </DebtorParty>
   <FirstAgentParty>
      <ID/>
      <PartyIDSet>
         <ID/>
      </PartyIDSet>
      <TaxIDSet>
         <ID/>
      </TaxIDSet>
      <TaxID>normalizedString</TaxID>
      <DUNSID>normalizedString</DUNSID>
      <CAGEID>normalizedString</CAGEID>
      <DODAACID>normalizedString</DODAACID>
      <BICID>normalizedString</BICID>
      <SCACID>normalizedString</SCACID>
      <AccountID>normalizedString</AccountID>
      <Name/>
      <Location>
         <ID/>
         <IDSet>...
         </IDSet>
         <Name/>
         <Directions/>
         <Coordinate>...
         </Coordinate>
         <Address>...
         </Address>
         <Contact>...
         </Contact>
         <Communication>...
         </Communication>
         <PostalAddress>...
         </PostalAddress>
         <PhysicalAddress>...
         </PhysicalAddress>
         <Description/>
         <Note/>
         <TimeZoneCode>M0100</TimeZoneCode>
         <AvailableTimePeriod>..................
         </AvailableTimePeriod>
         <LocationEquipmentSpecification>...
         </LocationEquipmentSpecification>
         <EffectiveTimePeriod>..................
         </EffectiveTimePeriod>
         <Extension>.......................................
         </Extension>
      </Location>
      <Contact>
         <ID/>
         <IDSet>...
         </IDSet>
         <PersonName>...
         </PersonName>
         <RoleCode>normalizedString</RoleCode>
         <JobTitle/>
         <Responsibility/>
         <OrganizationUnitID>normalizedString</OrganizationUnitID>
         <Communication>...
         </Communication>
         <TelephoneCommunication>...
         </TelephoneCommunication>
         <EMailAddressCommunication>...
         </EMailAddressCommunication>
         <InternetAddressCommunication>...
         </InternetAddressCommunication>
         <Preference>...
         </Preference>
         <EffectiveTimePeriod>..................
         </EffectiveTimePeriod>
         <Extension>.......................................
         </Extension>
      </Contact>
      <ClearingSystemMemberID>normalizedString</ClearingSystemMemberID>
      <BranchParty>
         <ID/>
         <PartyIDSet>...
         </PartyIDSet>
         <TaxIDSet>...
         </TaxIDSet>
         <TaxID>normalizedString</TaxID>
         <DUNSID>normalizedString</DUNSID>
         <CAGEID>normalizedString</CAGEID>
         <DODAACID>normalizedString</DODAACID>
         <BICID>normalizedString</BICID>
         <SCACID>normalizedString</SCACID>
         <AccountID>normalizedString</AccountID>
         <Name/>
         <Location>...
         </Location>
         <Contact>...
         </Contact>
         <Extension>.......................................
         </Extension>
      </BranchParty>
      <FinancialAccount>
         <ID/>
         <BBANID>normalizedString</BBANID>
         <IBANID>normalizedString</IBANID>
         <UPICID>normalizedString</UPICID>
         <AccountIDs>...
         </AccountIDs>
         <CurrencyCode>token</CurrencyCode>
         <Name/>
         <Extension>.......................................
         </Extension>
      </FinancialAccount>
      <CountryCode>token</CountryCode>
      <Extension>
         <AnyExtension>
            <!--any element-->
         </AnyExtension>
         <Amount/>
         <Code/>
         <DateTime></DateTime>
         <ID/>
         <Indicator>true</Indicator>
         <Measure/>
         <Name/>
         <Number>1.0</Number>
         <Quantity/>
         <Text/>
         <Time></Time>
         <ValueText>string</ValueText>
      </Extension>
   </FirstAgentParty>
   <Description/>
   <Note/>
   <PaymentTransaction>
      <ID/>
      <IDSet>
         <ID/>
      </IDSet>
      <InstructionID>normalizedString</InstructionID>
      <TransactionID>normalizedString</TransactionID>
      <RemitID>normalizedString</RemitID>
      <PaymentPurposeCode>token</PaymentPurposeCode>
      <Proprietary/>
      <InstructedAmount/>
      <EquivalentAmount/>
      <CheckInstruction>
         <ID/>
         <IDSet>...
         </IDSet>
         <CheckNumberID>normalizedString</CheckNumberID>
         <DeliveryMethodCode>token</DeliveryMethodCode>
         <CheckFromParty>...
         </CheckFromParty>
         <DeliverToParty>...
         </DeliverToParty>
         <PriorityCode>normalizedString</PriorityCode>
         <CheckMaturityDate></CheckMaturityDate>
         <CheckFormsCode>normalizedString</CheckFormsCode>
         <CheckMemoFieldText/>
         <RegionalClearingZoneID>normalizedString</RegionalClearingZoneID>
         <Extension>.......................................
         </Extension>
      </CheckInstruction>
      <OriginatorParty>
         <ID/>
         <PartyIDSet>...
         </PartyIDSet>
         <TaxIDSet>...
         </TaxIDSet>
         <TaxID>normalizedString</TaxID>
         <DUNSID>normalizedString</DUNSID>
         <CAGEID>normalizedString</CAGEID>
         <DODAACID>normalizedString</DODAACID>
         <BICID>normalizedString</BICID>
         <SCACID>normalizedString</SCACID>
         <AccountID>normalizedString</AccountID>
         <Name/>
         <Location>...
         </Location>
         <Contact>...
         </Contact>
         <Extension>.......................................
         </Extension>
      </OriginatorParty>
      <IntermediaryFinancialParty>
         <ID/>
         <PartyIDSet>...
         </PartyIDSet>
         <TaxIDSet>...
         </TaxIDSet>
         <TaxID>normalizedString</TaxID>
         <DUNSID>normalizedString</DUNSID>
         <CAGEID>normalizedString</CAGEID>
         <DODAACID>normalizedString</DODAACID>
         <BICID>normalizedString</BICID>
         <SCACID>normalizedString</SCACID>
         <AccountID>normalizedString</AccountID>
         <Name/>
         <Location>...
         </Location>
         <Contact>...
         </Contact>
         <ClearingSystemMemberID>normalizedString</ClearingSystemMemberID>
         <BranchParty>...
         </BranchParty>
         <FinancialAccount>...
         </FinancialAccount>
         <CountryCode>token</CountryCode>
         <Extension>.......................................
         </Extension>
      </IntermediaryFinancialParty>
      <CreditorParty>
         <ID/>
         <PartyIDSet>...
         </PartyIDSet>
         <TaxIDSet>...
         </TaxIDSet>
         <TaxID>normalizedString</TaxID>
         <DUNSID>normalizedString</DUNSID>
         <CAGEID>normalizedString</CAGEID>
         <DODAACID>normalizedString</DODAACID>
         <BICID>normalizedString</BICID>
         <SCACID>normalizedString</SCACID>
         <AccountID>normalizedString</AccountID>
         <Name/>
         <Location>...
         </Location>
         <Contact>...
         </Contact>
         <CustomerAccountID>normalizedString</CustomerAccountID>
         <CountryCode>token</CountryCode>
         <FinancialAccount>...
         </FinancialAccount>
         <Extension>.......................................
         </Extension>
      </CreditorParty>
      <FinalAgentFinancialParty>
         <ID/>
         <PartyIDSet>...
         </PartyIDSet>
         <TaxIDSet>...
         </TaxIDSet>
         <TaxID>normalizedString</TaxID>
         <DUNSID>normalizedString</DUNSID>
         <CAGEID>normalizedString</CAGEID>
         <DODAACID>normalizedString</DODAACID>
         <BICID>normalizedString</BICID>
         <SCACID>normalizedString</SCACID>
         <AccountID>normalizedString</AccountID>
         <Name/>
         <Location>...
         </Location>
         <Contact>...
         </Contact>
         <ClearingSystemMemberID>normalizedString</ClearingSystemMemberID>
         <BranchParty>...
         </BranchParty>
         <FinancialAccount>...
         </FinancialAccount>
         <CountryCode>token</CountryCode>
         <Extension>.......................................
         </Extension>
      </FinalAgentFinancialParty>
      <FinalParty>
         <ID/>
         <PartyIDSet>...
         </PartyIDSet>
         <TaxIDSet>...
         </TaxIDSet>
         <TaxID>normalizedString</TaxID>
         <DUNSID>normalizedString</DUNSID>
         <CAGEID>normalizedString</CAGEID>
         <DODAACID>normalizedString</DODAACID>
         <BICID>normalizedString</BICID>
         <SCACID>normalizedString</SCACID>
         <AccountID>normalizedString</AccountID>
         <Name/>
         <Location>...
         </Location>
         <Contact>...
         </Contact>
         <Extension>.......................................
         </Extension>
      </FinalParty>
      <ChargeBearerCode>token</ChargeBearerCode>
      <ExchangeContractReference>
         <ID/>
         <RevisionID>normalizedString</RevisionID>
         <VariationID>normalizedString</VariationID>
         <DocumentIDSet>...
         </DocumentIDSet>
         <DocumentDateTime></DocumentDateTime>
         <Description/>
         <Note/>
         <Status>...
         </Status>
         <LineNumberID/>
         <LineIDSet>...
         </LineIDSet>
         <Extension>.......................................
         </Extension>
      </ExchangeContractReference>
      <RegulatoryReporting>
         <ID/>
         <IDSet>...
         </IDSet>
         <Code/>
         <Amount/>
         <Note/>
         <Extension>.......................................
         </Extension>
      </RegulatoryReporting>
      <FinalAgentInstruction>
         <ID/>
         <IDSet>...
         </IDSet>
         <Proprietary/>
         <Extension>.......................................
         </Extension>
      </FinalAgentInstruction>
      <FirstAgentInstruction>
         <ID/>
         <IDSet>...
         </IDSet>
         <Proprietary/>
         <DebitPurposeReason/>
         <RemitLocationMethodCode>token</RemitLocationMethodCode>
         <RemitLocationURI>normalizedString</RemitLocationURI>
         <RemitLocationPostalAddress>...
         </RemitLocationPostalAddress>
         <PaymentTransactionTax>...
         </PaymentTransactionTax>
         <Extension>.......................................
         </Extension>
      </FirstAgentInstruction>
      <Remittance>
         <ID/>
         <IDSet>...
         </IDSet>
         <UnstructuredRemittanceText/>
         <StructuredRemittance>...
         </StructuredRemittance>
         <Extension>.......................................
         </Extension>
      </Remittance>
      <Description/>
      <Note/>
      <Status>
         <ID/>
         <IDSet>...
         </IDSet>
         <Code/>
         <Description/>
         <ReasonCode>normalizedString</ReasonCode>
         <Reason/>
         <EffectiveTimePeriod>..................
         </EffectiveTimePeriod>
         <Extension>.......................................
         </Extension>
      </Status>
      <RejectionStatus>
         <ID/>
         <IDSet>...
         </IDSet>
         <Code/>
         <Description/>
         <ReasonCode>normalizedString</ReasonCode>
         <Reason/>
         <EffectiveTimePeriod>..................
         </EffectiveTimePeriod>
         <Extension>.......................................
         </Extension>
      </RejectionStatus>
      <Extension>
         <AnyExtension>
            <!--any element-->
         </AnyExtension>
         <Amount/>
         <Code/>
         <DateTime></DateTime>
         <ID/>
         <Indicator>true</Indicator>
         <Measure/>
         <Name/>
         <Number>1.0</Number>
         <Quantity/>
         <Text/>
         <Time></Time>
         <ValueText>string</ValueText>
      </Extension>
   </PaymentTransaction>
   <Extension>
      <AnyExtension>
         <!--any element-->
      </AnyExtension>
      <Amount/>
      <Code/>
      <DateTime></DateTime>
      <ID/>
      <Indicator>true</Indicator>
      <Measure/>
      <Name/>
      <Number>1.0</Number>
      <Quantity/>
      <Text/>
      <Time></Time>
      <ValueText>string</ValueText>
   </Extension>
</PaymentStatusPayment>