Version | Date | Author | Comments |
---|---|---|---|
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:
| |
3.0-draft6 | OB R/W API Team | Draft6 changes:
| |
3.0- draft7 | OB R/W API Team | Draft7 changes:
| |
3.0-RC2 | OB R/W API Team | No Change | |
3.0-RC3 | OB R/W API Team | No Change | |
3.0 | OB R/W API Team | This is the baseline version. No change from RC3. |
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:
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.
Name | XPath | Occurrence | Class | ISO8583 BIT | Field Name | Mandatory | Size |
---|---|---|---|---|---|---|---|
EndToEndIdentification | Initiation/EndToEndIdentification | 1..1 | Max35Text | 62 | END TO END REFERENCE | O | 31 |
Amount | Initiation/InstructedAmount/Amount | 1..1 | TotalDigits: 18, FractionDigits: 5 | 6 | AMOUNT | M | 14 |
Identification | Initiation/DebtorAccount/Identification | 1..1 | Max256Text | 42 43 | ORIGINATING CREDIT INSTITUTION ORIGINATING CUSTOMER ACCOUNT NUMBER | M M | 11 34 |
Identification | Initiation/CreditorAccount/Identification | 1..1 | Max256Text | 95 35 | BENEFICIARY CREDIT INSTITUTION BENEFICIARY CUSTOMER ACCOUNT NUMBER | M M | 11 34 |
Name | Initiation/CreditorAccount/Name | 1..1 | Max70Text | 118 | BENEFICIARY CUSTOMER ACCOUNT NAME | O | 40 |
SecondaryIdentification | Initiation/CreditorAccount/SecondaryIdentification | 0..1 | Max34Text | 120 | REFERENCE INFORMATION | O | 18 |
Unstructured | Initiation/RemittanceInformation/Unstructured | 0..1 | Max140Text | 121 | REMITTANCE INFORMATION | O | 140 |
Reference | Initiation/RemittanceInformation/Reference | 0..1 | Max35Text | 120 | REFERENCE INFORMATION | O | 18 |
Notes
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.
Name | XPath | Occurrence | Class | STD18 Field | Field Name | Mandatory ? | Size |
---|---|---|---|---|---|---|---|
Amount | Initiation/InstructedAmount/Amount | 1..1 | TotalDigits: 18, FractionDigits: 5 | 8 | amount in pence | M | 11 |
Identification | Initiation/DebtorAccount/Identification | 1..1 | Max256Text | 5 6 | originating sorting code originating account number | M M | 6 8 |
Identification | Initiation/CreditorAccount/Identification | 1..1 | Max256Text | 1 2 | destination sorting code destination a/c number | M M | 6 8 |
Name | Initiation/CreditorAccount/Name | 1..1 | Max70Text | 11 | destination account name | M | 18 |
SecondaryIdentification | Initiation/CreditorAccount/SecondaryIdentification | 0..1 | Max34Text | 10 | service user’s reference | M | 18 |
Reference | Initiation/RemittanceInformation/Reference | 0..1 | Max35Text | 10 | service user’s reference | M | 18 |
Notes
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.
Name | XPath | Occurrence | Class | MT103 Field | Field Name | Mandatory | Size |
---|---|---|---|---|---|---|---|
Amount | Initiation/InstructedAmount/Amount | 1..1 | TotalDigits: 18, FractionDigits: 5 | 32A | Value Date / Currency / Interbank Settled Amount | M | 15n |
Currency | Initiation/InstructedAmount/Currency | 1..1 | ActiveOrHistoricCurrencyCode "GBP" | 32A | Value Date / Currency / Interbank Settled Amount | M | 3x |
Identification | Initiation/DebtorAccount/Identification | 1..1 | Max256Text | 50K | Ordering Customer | M | 34x |
Identification | Initiation/CreditorAccount/Identification | 1..1 | Max256Text | 57 59 | Account With Institution Beneficiary Customer | M M | 6n 8n |
Name | Initiation/CreditorAccount/Name | 1..1 | Max70Text | 59 | Beneficiary Customer | M | 35x |
StreetName | Initiation/CreditorPostalAddress/StreetName | 0..1 | Max70Text | 59 | Beneficiary Customer | O | 35x |
BuildingNumber | Initiation/CreditorPostalAddress/BuildingNumber | 0..1 | Max16Text | 59 | Beneficiary Customer | O | 35x |
PostCode | Initiation/CreditorPostalAddress/PostCode | 0..1 | Max16Text | 59 | Beneficiary Customer | O | 35x |
EndToEndIdentification | Initiation/EndToEndIdentification | 1..1 | Max35Text | 70 | Beneficiary Reference | M | 35x |
Reference | Initiation/RemittanceInformation/Reference | 0..1 | Max35Text | 70 | Beneficiary Reference | O | 35x |
Unstructured | Initiation/RemittanceInformation/Unstructured | 0..1 | Max140Text | 70 | Beneficiary Reference | O | 2*35x |
Notes