Versions Compared

Old Version 1

changes.mady.by.user Freddi Gyara

Saved on

compared with

New Version Current

changes.mady.by.user Freddi Gyara

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Table of Contents
outlinetrue

...

VersionDateAuthorComments
3.0 OB R/W API TeamThis is the baseline version. No change from RC3.
3.1-draft1 OB R/W API Team

This is the initial draft version for 3.1.

Errata

  • Grammatical Fixes
3.1 RC1 OB R/W API Team

RC1 Changes:

  • Updated enumerations to use full UK.OBIE namespace.
3.1OB R/W API Team

Version 3.1 final release.

No changes from Version 3.1 RC1


ISO 20022

The Initiation section of the Payment API payloads is based on the ISO 20022 pain.001 XML standard and we have used ISO 20022 message elements or components where possible. However, has been adapted for APIs based as per our design principles. 

...

  • If the Initiation/CreditorAccount/SecondaryIdentification field is populated - this field must be mapped to field 120 REFERENCE INFORMATION as this will be used for the Creditor Agent to identify the account (i.e., the roll numbers in the building society context).
  • However, if the Initiation/CreditorAccount/SecondaryIdentification is not populated then field 120 REFERENCE INFORMATION must be populated with the Initiation/RemittanceInformation/Reference field.
  • If both Initiation/CreditorAccount/SecondaryIdentification and Initiation/RemittanceInformation/Reference are populated by the PISP, only the SecondaryIdentification will be mapped to field 120 REFERENCE INFORMATION. Whether the Initiation/RemittanceInformation/Reference is used in any other ASPSP systems is for the ASPSP to decide.
  • Field 116 ORIGINATING CUSTOMER ACCOUNT NAME must be populated from the ASPSP's system of record
  • Where the Initiation/DebtorAccount/SchemeName field is populated with "UK.OBIE.SortCodeAccountNumber", the Initiation/DebtorAccount/Identification field will be populated with a 14 digit field comprised of a 6 digit Sort Code (mapped to field 42 ORIGINATING CREDIT INSTITUTION) and 8 digit Account Number (mapped to field 43 ORIGINATING CUSTOMER ACCOUNT NUMBER)
  • Where the Initiation/CreditorAccount/SchemeName field is populated with "UK.OBIE.SortCodeAccountNumber", the Initiation/CreditorAccount/Identification field will be populated with a 14 digit field comprised of a 6 digit Sort Code (mapped to field 95 BENEFICIARY CREDIT INSTITUTION) and 8 digit Account Number (mapped to field 35 BENEFICIARY CUSTOMER ACCOUNT NUMBER)
  • CreditorPostalAddress is not supported in FPS .

BACS STD18

The BACS STD18 message format is used for the BACS scheme.

...

  • If the Initiation/CreditorAccount/SecondaryIdentification field is populated, this must be mapped to field 10 service user's reference as this will be used for the Creditor Agent to identify the account (i.e., the roll numbers in the building society context).
  • However, if the /CreditorAccount/SecondaryIdentification is not populated then 10 service user's reference must be populated with the Initiation/RemittanceInformation/Reference field.
  • If both Initiation/CreditorAccount/SecondaryIdentification and Initiation/RemittanceInformation/Reference are populated by the PISP, only the SecondaryIdentification will be mapped to field 10 service user's reference. Whether the Initiation/RemittanceInformation/Reference is used in any other ASPSP systems is for the ASPSP to decide.
  • Field 9 service user's name must be populated from the ASPSP's system of record.
  • Where the Initiation/DebtorAccount/SchemeName field is populated with "UK.OBIE.SortCodeAccountNumber", the Initiation/DebtorAccount/Identification field will be populated with a 14 digit field comprised of a 6 digit Sort Code (mapped to field 5 originating sorting code) and 8 digit Account Number (mapped to field 6 originating account number).
  • Where the Initiation/CreditorAccount/SchemeName field is populated with "UK.OBIE.SortCodeAccountNumber", the Initiation/CreditorAccount/Identification field will be populated with a 14 digit field comprised of a 6 digit Sort Code (mapped to field 1 destination sorting code) and 8 digit Account Number (mapped to field 2 destination a/c number)
  • CreditorPostalAddress is not supported in BACS.

MT103

The MT103 message format is used for the CHAPS scheme.

...

Mapping

Name
XPath
Occurrence
Class
MT103 Field
Field Name
Mandatory
Size
AmountInitiation/InstructedAmount/Amount1..1TotalDigits: 18, FractionDigits: 532AValue Date / Currency /  Interbank Settled AmountM15n
CurrencyInitiation/InstructedAmount/Currency1..1

ActiveOrHistoricCurrencyCode

"GBP"

32AValue Date / Currency / Interbank Settled AmountM3x
IdentificationInitiation/DebtorAccount/Identification1..1Max256Text

50K

Ordering Customer

M 

34x

IdentificationInitiation/CreditorAccount/Identification1..1Max256Text

57

59

Account With Institution

Beneficiary Customer

M 

M 

6n

8n

NameInitiation/CreditorAccount/Name1..1Max70Text59Beneficiary CustomerM

35x

StreetNameInitiation/CreditorPostalAddress/StreetName0..1Max70Text59Beneficiary CustomerO35x
BuildingNumberInitiation/CreditorPostalAddress/BuildingNumber0..1Max16Text59Beneficiary CustomerO

35x

PostCodeInitiation/CreditorPostalAddress/PostCode0..1Max16Text59Beneficiary CustomerO35x
EndToEndIdentificationInitiation/EndToEndIdentification1..1Max35Text70Beneficiary ReferenceM35x
ReferenceInitiation/RemittanceInformation/Reference0..1Max35Text70Beneficiary ReferenceO 35x
UnstructuredInitiation/RemittanceInformation/Unstructured0..1Max140Text70Beneficiary ReferenceO 2*35x

Notes

  • The Value Date must be a valid BoE business day. It must be a valid date expressed as YYMMDD and is populated by the ASPSP.
  • Details for field 50K (Ordering Customer) relating to the Debtor's Name and Address must be populated from the ASPSP's system of record.
  • Where the Initiation/DebtorAccount/SchemeName field is populated with "UK.OBIE.SortCodeAccountNumber", the Initiation/DebtorAccount/Identification field will be populated with a 14 digit field comprised of a 6 digit Sort Code (mapped to field 50K Ordering Customer).
  • Where the Initiation/CreditorAccount/SchemeName field is populated with "UK.OBIE.SortCodeAccountNumber", the Initiation/CreditorAccount/Identification field will be populated with a 14 digit field comprised of a 6 digit Sort Code (mapped to field 57 Account With Institution) and 8 digit Account Number (mapped to field 59F Beneficiary Customer).
  • Beneficiary Customer Address (59) - there are only 3 fields of length 35 available in the MT103 message for the CreditorPostalAddress these will be mapped from:
    • Initiation/CreditorPostalAddress/StreetName.
    • Initiation/CreditorPostalAddress/BuildingNumber.
    • Initiation/CreditorPostalAddress/PostCode.
  • Beneficiary Reference (70) - this MT103 field has 4 fields of length 35 to be mapped with:
    • /ROC/ and EndToEndIndentification
      /RFB/ and RemittanceInformation/Reference (only 16 chars supported)
      RemittanceInformation/Unstructured

...