Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

chore!: update required fields in ISO-20022 #187

Draft
wants to merge 1 commit into
base: main
Choose a base branch
from
Draft
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11,995 changes: 6,387 additions & 5,608 deletions docs/fspiop-rest-v2.0-ISO20022-openapi3-snippets.yaml

Large diffs are not rendered by default.

Original file line number Diff line number Diff line change
Expand Up @@ -147,6 +147,7 @@ required:
- DbtrAgt
- CdtrAgt
- Cdtr
- Purp
example:
PmtId:
InstrId: INSTRID
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,223 @@
title: CreditTransferTransaction67
description: >
Provides further details specific to the individual transaction(s) included in
the message.
type: object
properties:
PmtId:
allOf:
- $ref: ./PaymentIdentification13.yaml
- description: >
PaymentIdentification

Set of elements used to reference a payment instruction.
PmtTpInf:
allOf:
- $ref: ./PaymentTypeInformation28.yaml
- description: >
PaymentTypeInformation

Set of elements used to further specify the type of transaction.
UndrlygCstmrCdtTrf:
allOf:
- $ref: ./UnderlyingCustomerCreditTransfer.yaml
- description: >
Underlying Customer Credit Transfer

TBD
IntrBkSttlmAmt:
allOf:
- $ref: ./ActiveCurrencyAndAmount.yaml
- description: >
InterbankSettlementAmount

Amount of money moved between the instructing agent and the instructed agent.
InstdAmt:
allOf:
- $ref: ./ActiveOrHistoricCurrencyAndAmount.yaml
- description: >
InstructedAmount

Amount of money to be moved between the debtor and creditor,
before deduction of charges, expressed in the currency as ordered by the initiating party.
XchgRate:
allOf:
- $ref: ./BaseOneRate.yaml
- description: >
ExchangeRate

Factor used to convert an amount from one currency into another. This reflects the price at
which one currency was bought with another currency.
ChrgBr:
$ref: ./ChargeBearerType1Code.yaml
ChrgsInf:
allOf:
- $ref: ./Charges16.yaml
- description: >
ChargesInformation

Provides information on the charges to be paid by the charge bearer(s) related to the
payment transaction.
Dbtr:
allOf:
- $ref: ./PartyIdentification272.yaml
- description: >
Debtor

Party that owes an amount of money to the (ultimate) creditor.
DbtrAcct:
allOf:
- $ref: ./CashAccount40.yaml
- description: >
DebtorAccount

Unambiguous identification of the account of the debtor to which a debit entry will be made
as a result of the transaction.
DbtrAgt:
allOf:
- $ref: ./BranchAndFinancialInstitutionIdentification8.yaml
- description: >
DebtorAgent

Financial institution servicing an account for the debtor.
CdtrAgt:
allOf:
- $ref: ./BranchAndFinancialInstitutionIdentification8.yaml
- description: >
CreditorAgent

Financial institution servicing an account for the creditor.
Cdtr:
allOf:
- $ref: ./PartyIdentification272.yaml
- description: >
Creditor

Party to which an amount of money is due.
CdtrAcct:
allOf:
- $ref: ./CashAccount40.yaml
- description: >
CreditorAccount

Unambiguous identification of the account of the creditor to which a credit entry will be
posted as a result of the payment transaction.
InstrForCdtrAgt:
allOf:
- $ref: ./InstructionForCreditorAgent3.yaml
- description: >
InstructionForCreditorAgent

Set of elements used to provide information on the remittance advice.
InstrForNxtAgt:
allOf:
- $ref: ./InstructionForNextAgent1.yaml
- description: >
InstructionForNextAgent

Set of elements used to provide information on the remittance advice.
Purp:
allOf:
- $ref: ./Purpose2Choice.yaml
- description: >
Purpose

Underlying reason for the payment transaction.
RgltryRptg:
allOf:
- $ref: ./RegulatoryReporting3.yaml
- description: >
RegulatoryReporting

Information needed due to regulatory and statutory requirements.
Tax:
allOf:
- $ref: ./TaxData1.yaml
- description: >
Tax

Provides details on the tax.
VrfctnOfTerms:
$ref: ./CryptographicLockChoice.yaml
required:
- PmtId
- IntrBkSttlmAmt
- ChrgBr
- Dbtr
- DbtrAgt
- CdtrAgt
- Cdtr
- VrfctnOfTerms
example:
PmtId:
InstrId: INSTRID
EndToEndId: ENDTOENDID
PmtTpInf:
LclInstrm:
Cd: CHQB
Prtry: PROPRIETARY
SeqTp: SEQTP
IntrBkSttlmAmt:
ActiveCurrencyAndAmount: 123.45
Ccy: USD
InstdAmt:
ActiveOrHistoricCurrencyAndAmount: 123.45
Ccy: USD
XchgRate: 123.45
ChrgBr: SHAR
ChrgsInf:
Amt:
ActiveOrHistoricCurrencyAndAmount: 123.45
Ccy: USD
Agt:
BrnchId:
Id: BRANCHID
FinInstnId:
BICFI: BICFI
Tp:
Cd: SHAR
Dbtr:
Nm: NAME
PstlAdr:
AdrTp: ADDR
BldgNb: BLDGNB
Ctry: CTRY
TwnNm: TWNNM
PstCd: PSTCD
StrtNm: STRTNM
DbtrAcct:
Id:
IBAN: IBAN
DbtrAgt:
BrnchId:
Id: BRANCHID
FinInstnId:
BICFI: BICFI
CdtrAgt:
BrnchId:
Id: BRANCHID
FinInstnId:
BICFI: BICFI
Cdtr:
Nm: NAME
PstlAdr:
AdrTp: ADDR
BldgNb: BLDGNB
Ctry: CTRY
TwnNm: TWNNM
PstCd: PSTCD
StrtNm: STRTNM
CdtrAcct:
Id:
IBAN: IBAN
InstrForCdtrAgt:
Cd: CODE
InstrForNxtAgt:
Cd: CODE
Purp:
Cd: CASH
RgltryRptg:
Dbtr: TRUE
Cdtr: TRUE
Tax:
Cdtr
Original file line number Diff line number Diff line change
Expand Up @@ -100,6 +100,8 @@ required:
- IntrBkSttlmAmt
- Dbtr
- Cdtr
- UndrlygCstmrCdtTrf
- VrfctnOfTerms
example:
PmtId:
InstrId: INSTRID
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -98,8 +98,10 @@ properties:
required:
- PmtId
- IntrBkSttlmAmt
- UndrlygCstmrCdtTrf
- Dbtr
- Cdtr
- InstrForCdtrAgt
example:
PmtId:
InstrId: INSTRID
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,139 @@
title: CreditTransferTransaction68_FX_Quotes
description: >
Provides further details specific to the individual transaction(s) included in
the message.
type: object
properties:
PmtId:
allOf:
- $ref: ./PaymentIdentification13.yaml
- description: >
PaymentIdentification

Set of elements used to reference a payment instruction.
PmtTpInf:
allOf:
- $ref: ./PaymentTypeInformation28.yaml
- description: >
PaymentTypeInformation

Set of elements used to further specify the type of transaction.
UndrlygCstmrCdtTrf:
allOf:
- $ref: ./UnderlyingCustomerCreditTransfer.yaml
- description: >
Underlying Customer Credit Transfer

TBD
IntrBkSttlmAmt:
allOf:
- $ref: ./ActiveCurrencyAndAmount.yaml
- description: >
InterbankSettlementAmount

Amount of money moved between the instructing agent and the instructed agent.
Dbtr:
allOf:
- $ref: ./BranchAndFinancialInstitutionIdentification8.yaml
- description: >
Debtor

Party that owes an amount of money to the (ultimate) creditor.
DbtrAcct:
allOf:
- $ref: ./CashAccount40.yaml
- description: >
DebtorAccount

Account used to process a payment.
DbtrAgt:
allOf:
- $ref: ./BranchAndFinancialInstitutionIdentification8.yaml
- description: >
DebtorAgent

Financial institution servicing an account for the debtor.
CdtrAgt:
allOf:
- $ref: ./BranchAndFinancialInstitutionIdentification8.yaml
- description: >
CreditorAgent

Financial institution servicing an account for the creditor.
Cdtr:
allOf:
- $ref: ./BranchAndFinancialInstitutionIdentification8.yaml
- description: >
Creditor

Party to which an amount of money is due.
CdtrAcct:
allOf:
- $ref: ./CashAccount40.yaml
- description: >
CreditorAccount

Account to which a credit entry is made.
InstrForCdtrAgt:
allOf:
- $ref: ./InstructionForCreditorAgent3_FX_Quotes.yaml
- description: >
InstructionForCreditorAgent

Set of elements used to provide information on the remittance advice.
Purp:
allOf:
- $ref: ./Purpose2Choice.yaml
- description: >
Purpose

Underlying reason for the payment transaction.
VrfctnOfTerms:
allOf:
- $ref: ./CryptographicLockChoice.yaml
- description: >
VerificationOfTerms

Set of elements used to provide information on the underlying terms of the transaction.
required:
- PmtId
- IntrBkSttlmAmt
- UndrlygCstmrCdtTrf
- Dbtr
- Cdtr
- VrfctnOfTerms
- InstrForCdtrAgt
example:
PmtId:
InstrId: INSTRID
EndToEndId: ENDTOENDID
PmtTpInf:
LclInstrm:
Cd: CHQB
Prtry: PROPRIETARY
IntrBkSttlmAmt:
Amount: 123.45
Ccy: EUR
Dbtr:
Nm: Debtor Name
DbtrAcct:
Id:
IBAN: IBAN
DbtrAgt:
FinInstnId:
BICFI: BICFI
CdtrAgt:
FinInstnId:
BICFI: BICFI
Cdtr:
Nm: Creditor Name
CdtrAcct:
Id:
IBAN: IBAN
InstrForCdtrAgt:
Cd: INSTRUCTION
Purp:
Cd: CHAR
VrfctnOfTerms:
Cntt: CONTENT
CnttTp: PROPRIETARY
Loading