Version Control

VersionDateAuthorComments
3.0-draft5 OB R/W API Team

Separated from main Payment Initiation API page - as only relevant for Domestic Payments.

Changes from Draft4 in Payment Initiation API page:

  • Removed reference to v1.0 scope - and made generic to domestic-payments and domestic-scheduled-payments
  • Removed Transaction Status reference - as this is now embedded in payment-order type sub-pages
  • Reworded guidance on the mapping of the SecondardyIdentification field for additional clarity
  • Updated FPS to ISO 8583 - as is a generic message format
  • Updated ISO 8583 Mapping to only include fields that are passed to the ISO 8583 message
  • Updated BACS to BACS STD18 message format
  • Updated STD18 Mapping to only include fields that are passed to the STD18 message
  • Added section for MT103 message format
  • Updated Initiation/DebtorAccount/Identification field size to Max256Text
  • Updated Initiation/CreditorAccount/Identification field size to Max256Text
3.0-draft6  OB R/W API Team

Draft6 changes:

  • Added mapping for the following fields
    • EndToEndIdentification
    • DebtorAccount/Name
  • Updated the field name for Initiation/InstructedAmount/Amount and Initiation/InstructedAmount/Currency  to /  Interbank Settled Amount
  • Updated the MT103 field for Initiation/CreditorAccount/Identification  to 57A (Account with Institution)
3.0- draft7 OB R/W API Team

Draft7 changes:

  • Added line "CreditorPostalAddress is not supported in FPS & Bacs"
3.0-RC2 OB R/W API TeamNo Change
3.0-RC3 OB R/W API TeamNo Change
3.0 OB R/W API TeamThis is the baseline version. No change from RC3.


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. 

Deviations from the pain.001 XML standard are:

ISO 8583

The ISO 8583 message format is used for the Faster Payments Scheme (FPS).

Execution:

This is the mapping from the Payment API - Initiation section to the relevant FPS scheme fields - with the use of the "SortCodeAccountNumber" account identification SchemeName.

All required fields in the ISO 8583 message can all be generated from the Initiation section of the payload or from the ASPSP - for domestic-payments and domestic-scheduled-payments.

Highlighted in red are the fields which are smaller in size than the corresponding ISO 20022 field.

In the case that a PISP sets up a payment-order consent with a larger field size (e.g., EndToEndIdentification, or InstructedAmount) than the eventual scheme field size - it will be up to the ASPSP to decide whether to reject the payment-order consent or truncate the field. 

Mapping

Name
XPath
Occurrence
Class
ISO8583 BIT
Field Name
Mandatory
Size
EndToEndIdentificationInitiation/EndToEndIdentification1..1Max35Text62END TO END REFERENCE 31
AmountInitiation/InstructedAmount/Amount1..1TotalDigits: 18, FractionDigits: 56AMOUNT 14
IdentificationInitiation/DebtorAccount/Identification1..1Max256Text

42

43

ORIGINATING CREDIT INSTITUTION

ORIGINATING CUSTOMER ACCOUNT NUMBER 

11

34

IdentificationInitiation/CreditorAccount/Identification1..1Max256Text

95

35

BENEFICIARY CREDIT INSTITUTION

BENEFICIARY CUSTOMER ACCOUNT NUMBER 

11

34

NameInitiation/CreditorAccount/Name1..1Max70Text118BENEFICIARY CUSTOMER ACCOUNT NAME 40
SecondaryIdentificationInitiation/CreditorAccount/SecondaryIdentification0..1Max34Text120REFERENCE INFORMATION 18
UnstructuredInitiation/RemittanceInformation/Unstructured0..1Max140Text121REMITTANCE INFORMATION 140
ReferenceInitiation/RemittanceInformation/Reference0..1Max35Text120REFERENCE INFORMATION 18

Notes

BACS STD18

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

Execution:

This is the mapping from the Payment API - Initiation section to the relevant Bacs scheme fields - with the use of the "SortCodeAccountNumber" account identification SchemeName.

All required fields in the BACS STD18 message can all be generated from the Initiation section of the payload or from the ASPSP - for domestic-payments and domestic-scheduled-payments.

Highlighted in red are the fields which are smaller in size than the corresponding ISO 20022 field. 

In the case that a PISP sets up a payment-order consent with a larger field size (e.g., EndToEndIdentification, or InstructedAmount) than the eventual scheme field size - it will be up to the ASPSP to decide whether to reject the payment-order consent or truncate the field. 

Mapping

Name
XPath
Occurrence
Class
STD18 Field
Field Name
Mandatory ?
Size
AmountInitiation/InstructedAmount/Amount1..1TotalDigits: 18, FractionDigits: 58amount in penceM11
IdentificationInitiation/DebtorAccount/Identification1..1Max256Text

5

6

originating sorting code

originating account number

M

M

6

8

IdentificationInitiation/CreditorAccount/Identification1..1Max256Text

1

2

destination sorting code

destination a/c number

M

M

6

8

NameInitiation/CreditorAccount/Name1..1Max70Text11destination account nameM18
SecondaryIdentificationInitiation/CreditorAccount/SecondaryIdentification0..1Max34Text10service user’s referenceM18
ReferenceInitiation/RemittanceInformation/Reference0..1Max35Text10service user’s referenceM18

Notes

MT103

The MT103 message format is used for the CHAPS scheme.

Execution:

This is the mapping from the Initiation section to the relevant CHAPS scheme fields - with the use of the "SortCodeAccountNumber" account identification SchemeName.

All required fields in the CHAPS MT103 message can all be generated from the Initiation section of the payload or from the ASPSP - for domestic-payments and domestic-scheduled-payments.

Highlighted in red are the fields which are smaller in size than the corresponding ISO 20022 field. 

In the case that a PISP sets up a payment-order consent with a larger field size (e.g., EndToEndIdentification, or InstructedAmount) than the eventual scheme field size - it will be up to the ASPSP to decide whether to reject the payment-order consent or truncate the field. 

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

34x

IdentificationInitiation/CreditorAccount/Identification1..1Max256Text

57

59

Account With Institution

Beneficiary Customer

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 Reference35x
UnstructuredInitiation/RemittanceInformation/Unstructured0..1Max140Text70Beneficiary Reference2*35x

Notes