Scroll down for code samples, example requests and responses. Select a language for code samples from the tabs above or the mobile navigation menu.
Onboarding
OAuth2 API Access
If you would like to use our APIs to access the data of our customers, with their consent, you will need to get in touch with us by sending an email to openbanking@equalsmoney.com.
It's a manual on-boarding process, but to speed things up, please have the following information ready
Company Details
Contact Email
Company Name
Company Registration Number
Company Address - Street
Company Address - City
Company Address - Postcode
Company Address - Country
Technical Point of Contact - First Name
Technical Point of Contact - Last Name
Technical Point of Contact - Phone Number
Type of Access - AISP and/or PISP
National Competent Authority
(OPTIONAL) eIDAS Certificate
OAuth2 Application Details - most of these will be displayed to the user when asking for consent
Application Name
Redirect URL
Privacy Policy URL
Terms of Service URL
Client Website URL
Logo URL
Contact Email Address
RS256 Public Key
Security
OAuth2 Authorization Code Flow
The authorization code flow begins with the client directing the user to the /auth endpoint. In this request, the client requests the offline and accounts access. Without offline, the resulting response would not contain the refresh_token
At this point, the user will be asked to enter their credentials and complete the authentication. After that, we will ask the user to consent to the required permissions.
Once the user authenticates and grants consent, we will return a response to your app at the indicated redirect_uri.
Now that you've acquired an authorization_code and have been granted permission by the user, you can redeem the code for an access_token to the desired resource. Do this by sending a POST request to the /token endpoint:
After a successful request, you should now get an access_token and a refresh_token that you can use to make API calls and get back the data of the consenting user.
oAuth2 authentication. OAuth flow, it is required when the PSU needs to perform SCA with the ASPSP when a TPP wants to access an ASPSP resource owned by the PSU
x-fapi-auth-date: The time when the PSU last logged in with the TPP.
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below:
Sun, 10 Sep 2017 19:43:31 UTC
# You can also use wget
curl -X POST https://develop-api.fairfx.io/open-banking/proxy/cob/v3.1/aasp/application \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer {access-token}'
x-fapi-auth-date: The time when the PSU last logged in with the TPP.
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below:
Sun, 10 Sep 2017 19:43:31 UTC
x-fapi-auth-date: The time when the PSU last logged in with the TPP.
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below:
Sun, 10 Sep 2017 19:43:31 UTC
# You can also use wget
curl -X GET https://develop-api.fairfx.io/open-banking/proxy/cob/v3.1/aisp/child-accounts \
-H 'Accept: application/json' \
-H 'Authorization: Bearer {access-token}'
# You can also use wget
curl -X GET https://develop-api.fairfx.io/open-banking/proxy/cob/v3.1/aisp/child-accounts/{ownerID} \
-H 'Accept: application/json' \
-H 'Authorization: Bearer {access-token}'
# You can also use wget
curl -X POST https://develop-api.fairfx.io/open-banking/proxy/cob/v3.1/aisp/close-account \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer {access-token}'
# You can also use wget
curl -X POST https://develop-api.fairfx.io/open-banking/proxy/cob/v3.1/aisp/create-account \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer {access-token}'
Making new UK domestic payments and obtaining information about existing payments
Get the domestic payment information of a single payment consent
Code samples
# You can also use wget
curl -X GET https://develop-api.fairfx.io/open-banking/proxy/cob/v3.1/pisp/domestic-payments-by-consent/{consentId} \
-H 'Accept: application/json' \
-H 'Authorization: Bearer {access-token}'
x-fapi-auth-date: The time when the PSU last logged in with the TPP.
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below:
Sun, 10 Sep 2017 19:43:31 UTC
x-idempotency-key: Every request will be processed only once per x-idempotency-key. The
Idempotency Key will be valid for 24 hours.
x-fapi-auth-date: The time when the PSU last logged in with the TPP.
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below:
Sun, 10 Sep 2017 19:43:31 UTC
x-fapi-auth-date: The time when the PSU last logged in with the TPP.
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below:
Sun, 10 Sep 2017 19:43:31 UTC
x-idempotency-key: Every request will be processed only once per x-idempotency-key. The
Idempotency Key will be valid for 24 hours.
x-fapi-auth-date: The time when the PSU last logged in with the TPP.
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below:
Sun, 10 Sep 2017 19:43:31 UTC
x-fapi-auth-date: The time when the PSU last logged in with the TPP.
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below:
Sun, 10 Sep 2017 19:43:31 UTC
x-fapi-auth-date: The time when the PSU last logged in with the TPP.
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below:
Sun, 10 Sep 2017 19:43:31 UTC
x-fapi-auth-date: The time when the PSU last logged in with the TPP.
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below:
Sun, 10 Sep 2017 19:43:31 UTC
x-fapi-auth-date: The time when the PSU last logged in with the TPP.
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below:
Sun, 10 Sep 2017 19:43:31 UTC
x-fapi-auth-date: The time when the PSU last logged in with the TPP.
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below:
Sun, 10 Sep 2017 19:43:31 UTC
x-fapi-auth-date: The time when the PSU last logged in with the TPP.
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below:
Sun, 10 Sep 2017 19:43:31 UTC
x-fapi-auth-date: The time when the PSU last logged in with the TPP.
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below:
Sun, 10 Sep 2017 19:43:31 UTC
The UTC ISO 8601 Date Time to filter transactions FROM
toBookingDateTime
query
string(date-time)
false
The UTC ISO 8601 Date Time to filter transactions TO
Detailed descriptions
x-fapi-auth-date: The time when the PSU last logged in with the TPP.
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below:
Sun, 10 Sep 2017 19:43:31 UTC
fromBookingDateTime: The UTC ISO 8601 Date Time to filter transactions FROM
NB Time component is optional - set to 00:00:00 for just Date.
If the Date Time contains a timezone, the ASPSP must ignore the timezone component.
toBookingDateTime: The UTC ISO 8601 Date Time to filter transactions TO
NB Time component is optional - set to 00:00:00 for just Date.
If the Date Time contains a timezone, the ASPSP must ignore the timezone component.
Subscribing to and replaying webhook notifications
Request webhook events to be resent
Code samples
# You can also use wget
curl -X POST https://develop-api.fairfx.io/open-banking/proxy/cob/v3.1/webhook/replay \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer {access-token}'
Create a new subscription to a particular webhook event type
Code samples
# You can also use wget
curl -X POST https://develop-api.fairfx.io/open-banking/proxy/cob/v3.1/webhook/setup \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer {access-token}'
A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 "Codes for the representation of currencies and funds".
Properties
Name
Type
Required
Restrictions
Description
anonymous
string
false
none
A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 "Codes for the representation of currencies and funds".
BuildingNumber
"string"
Number that identifies the position of a building on a street.
Properties
Name
Type
Required
Restrictions
Description
anonymous
string
false
none
Number that identifies the position of a building on a street.
CountryCode
"string"
Nation with its own government.
Properties
Name
Type
Required
Restrictions
Description
anonymous
string
false
none
Nation with its own government.
CountrySubDivision
"string"
Identifies a subdivision of a country such as state, region, county.
Properties
Name
Type
Required
Restrictions
Description
anonymous
string
false
none
Identifies a subdivision of a country such as state, region, county.
Department
"string"
Identification of a division of a large organisation or building.
Properties
Name
Type
Required
Restrictions
Description
anonymous
string
false
none
Identification of a division of a large organisation or building.
File
{}
Properties
None
ISODateTime
"2020-10-23T10:23:58Z"
All dates in the JSON payloads are represented in ISO 8601 date-time format.
All date-time fields in responses must include the timezone. An example is below:
2017-04-05T10:43:07+00:00
Properties
Name
Type
Required
Restrictions
Description
anonymous
string(date-time)
false
none
All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00
Identification
"string"
Identification assigned by an institution to identify an account. This identification is known by the account owner.
Properties
Name
Type
Required
Restrictions
Description
anonymous
string
false
none
Identification assigned by an institution to identify an account. This identification is known by the account owner.
All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00
All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00
OBActiveCurrencyAndAmount_SimpleType
"string"
A number of monetary units specified in an active currency where the unit of currency is explicit and compliant with ISO 4217.
Properties
Name
Type
Required
Restrictions
Description
anonymous
string
false
none
A number of monetary units specified in an active currency where the unit of currency is explicit and compliant with ISO 4217.
A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 "Codes for the representation of currencies and funds".
OBAddressTypeCode
"Business"
Identifies the nature of the postal address.
Properties
Name
Type
Required
Restrictions
Description
anonymous
string
false
none
Identifies the nature of the postal address.
Enumerated Values
Property
Value
anonymous
Business
anonymous
Correspondence
anonymous
DeliveryTo
anonymous
MailTo
anonymous
POBox
anonymous
Postal
anonymous
Residential
anonymous
Statement
OBChargeBearerType1Code
"BorneByCreditor"
Specifies which party/parties will bear the charges associated with the processing of the payment transaction.
Properties
Name
Type
Required
Restrictions
Description
anonymous
string
false
none
Specifies which party/parties will bear the charges associated with the processing of the payment transaction.
A description of the error that occurred. e.g., 'A mandatory field isn't supplied' or 'RequestedExecutionDateTime must be in future' OBIE doesn't standardise this field
Path
string
false
none
Recommended but optional reference to the JSON Path of the field with error, e.g., Data.Initiation.InstructedAmount.Currency
Url
string
false
none
URL to help remediate the problem, or provide more information, or to API Reference, or help etc
Name of the identification scheme, in a coded form as published in an external list.
Properties
Name
Type
Required
Restrictions
Description
anonymous
string
false
none
Name of the identification scheme, in a coded form as published in an external list.
OBExternalLocalInstrument1Code
"string"
User community specific instrument.
Usage: This element is used to specify a local instrument, local clearing option and/or further qualify the service or service level.
Properties
Name
Type
Required
Restrictions
Description
anonymous
string
false
none
User community specific instrument. Usage: This element is used to specify a local instrument, local clearing option and/or further qualify the service or service level.
OB: Unique identification as assigned by the ASPSP to uniquely identify the consent resource.
» Initiation
object
true
none
The Initiation payload is sent by the initiating party to the ASPSP. It is used to request movement of funds from the debtor account to a creditor for a single domestic payment.
»» InstructionIdentification
string
true
none
Unique identification as assigned by an instructing party for an instructed party to unambiguously identify the instruction. Usage: the instruction identification is a point to point reference that can be used between the instructing party and the instructed party to refer to the individual instruction. It can be included in several messages related to the instruction.
»» EndToEndIdentification
string
true
none
Unique identification assigned by the initiating party to unambiguously identify the transaction. This identification is passed on, unchanged, throughout the entire end-to-end chain. Usage: The end-to-end identification can be used for reconciliation or to link tasks relating to the transaction. It can be included in several messages related to the transaction. OB: The Faster Payments Scheme can only access 31 characters for the EndToEndIdentification field.
User community specific instrument. Usage: This element is used to specify a local instrument, local clearing option and/or further qualify the service or service level.
»» InstructedAmount
object
true
none
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. Usage: This amount has to be transported unchanged through the transaction chain.
A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 "Codes for the representation of currencies and funds".
»» DebtorAccount
object
false
none
Unambiguous identification of the account of the debtor to which a debit entry will be made as a result of the transaction.
Identification assigned by an institution to identify an account. This identification is known by the account owner.
»»» Name
string
false
none
The account name is the name or names of the account owner(s) represented at an account level, as displayed by the ASPSP's online channels. Note, the account name is not the product name or the nickname of the account.
This is secondary identification of the account, as assigned by the account servicing institution. This can be used by building societies to additionally identify accounts with a roll number (in addition to a sort code and account number combination).
»» CreditorAccount
object
true
none
Unambiguous identification of the account of the creditor to which a credit entry will be posted as a result of the payment transaction.
Identification assigned by an institution to identify an account. This identification is known by the account owner.
»»» Name
string
true
none
The account name is the name or names of the account owner(s) represented at an account level. Note, the account name is not the product name or the nickname of the account. OB: ASPSPs may carry out name validation for Confirmation of Payee, but it is not mandatory.
This is secondary identification of the account, as assigned by the account servicing institution. This can be used by building societies to additionally identify accounts with a roll number (in addition to a sort code and account number combination).
Information that locates and identifies a specific address, as defined by postal services.
»» RemittanceInformation
object
false
none
Information supplied to enable the matching of an entry with the items that the transfer is intended to settle, such as commercial invoices in an accounts' receivable system.
»»» Unstructured
string
false
none
Information supplied to enable the matching/reconciliation of an entry with the items that the payment is intended to settle, such as commercial invoices in an accounts' receivable system, in an unstructured form.
»»» Reference
string
false
none
Unique reference, as assigned by the creditor, to unambiguously refer to the payment transaction. Usage: If available, the initiating party should provide this reference in the structured remittance information, to enable reconciliation by the creditor upon receipt of the amount of money. If the business context requires the use of a creditor reference or a payment remit identification, and only one identifier can be passed through the end-to-end chain, the creditor's reference or payment remittance identification should be quoted in the end-to-end transaction identification. OB: The Faster Payments Scheme can only accept 18 characters for the ReferenceInformation field - which is where this ISO field will be mapped.
The Initiation payload is sent by the initiating party to the ASPSP. It is used to request movement of funds from the debtor account to a creditor for a single domestic payment.
»» InstructionIdentification
string
true
none
Unique identification as assigned by an instructing party for an instructed party to unambiguously identify the instruction. Usage: the instruction identification is a point to point reference that can be used between the instructing party and the instructed party to refer to the individual instruction. It can be included in several messages related to the instruction.
»» EndToEndIdentification
string
true
none
Unique identification assigned by the initiating party to unambiguously identify the transaction. This identification is passed on, unchanged, throughout the entire end-to-end chain. Usage: The end-to-end identification can be used for reconciliation or to link tasks relating to the transaction. It can be included in several messages related to the transaction. OB: The Faster Payments Scheme can only access 31 characters for the EndToEndIdentification field.
User community specific instrument. Usage: This element is used to specify a local instrument, local clearing option and/or further qualify the service or service level.
»» InstructedAmount
object
true
none
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. Usage: This amount has to be transported unchanged through the transaction chain.
A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 "Codes for the representation of currencies and funds".
»» DebtorAccount
object
false
none
Unambiguous identification of the account of the debtor to which a debit entry will be made as a result of the transaction.
Identification assigned by an institution to identify an account. This identification is known by the account owner.
»»» Name
string
false
none
The account name is the name or names of the account owner(s) represented at an account level, as displayed by the ASPSP's online channels. Note, the account name is not the product name or the nickname of the account.
This is secondary identification of the account, as assigned by the account servicing institution. This can be used by building societies to additionally identify accounts with a roll number (in addition to a sort code and account number combination).
»» CreditorAccount
object
true
none
Unambiguous identification of the account of the creditor to which a credit entry will be posted as a result of the payment transaction.
Identification assigned by an institution to identify an account. This identification is known by the account owner.
»»» Name
string
true
none
The account name is the name or names of the account owner(s) represented at an account level. Note, the account name is not the product name or the nickname of the account. OB: ASPSPs may carry out name validation for Confirmation of Payee, but it is not mandatory.
This is secondary identification of the account, as assigned by the account servicing institution. This can be used by building societies to additionally identify accounts with a roll number (in addition to a sort code and account number combination).
Information that locates and identifies a specific address, as defined by postal services.
»» RemittanceInformation
object
false
none
Information supplied to enable the matching of an entry with the items that the transfer is intended to settle, such as commercial invoices in an accounts' receivable system.
»»» Unstructured
string
false
none
Information supplied to enable the matching/reconciliation of an entry with the items that the payment is intended to settle, such as commercial invoices in an accounts' receivable system, in an unstructured form.
»»» Reference
string
false
none
Unique reference, as assigned by the creditor, to unambiguously refer to the payment transaction. Usage: If available, the initiating party should provide this reference in the structured remittance information, to enable reconciliation by the creditor upon receipt of the amount of money. If the business context requires the use of a creditor reference or a payment remit identification, and only one identifier can be passed through the end-to-end chain, the creditor's reference or payment remittance identification should be quoted in the end-to-end transaction identification. OB: The Faster Payments Scheme can only accept 18 characters for the ReferenceInformation field - which is where this ISO field will be mapped.
Additional information that can not be captured in the structured fields and/or any other specific block.
» Authorisation
object
false
none
The authorisation type request from the TPP.
»» AuthorisationType
string
true
none
Type of authorisation flow requested.
»» CompletionDateTime
string(date-time)
false
none
Date and time at which the requested authorisation flow must be completed.All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00
» SCASupportData
object
false
none
Supporting Data provided by TPP, when requesting SCA Exemption.
»» RequestedSCAExemptionType
string
false
none
This field allows a PISP to request specific SCA Exemption for a Payment Initiation
»» AppliedAuthenticationApproach
string
false
none
Specifies a character string with a maximum length of 40 characters. Usage: This field indicates whether the PSU was subject to SCA performed by the TPP
»» ReferencePaymentOrderId
string
false
none
Specifies a character string with a maximum length of 140 characters. Usage: If the payment is recurring then the transaction identifier of the previous payment occurrence so that the ASPSP can verify that the PISP, amount and the payee are the same as the previous occurrence.
OB: Unique identification as assigned by the ASPSP to uniquely identify the consent resource.
» CreationDateTime
string(date-time)
true
none
Date and time at which the resource was created.All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00
» Status
string
true
none
Specifies the status of consent resource in code form.
» StatusUpdateDateTime
string(date-time)
true
none
Date and time at which the resource status was updated.All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00
» CutOffDateTime
string(date-time)
false
none
Specified cut-off date and time for the payment consent.All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00
» ExpectedExecutionDateTime
string(date-time)
false
none
Expected execution date and time for the payment resource.All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00
» ExpectedSettlementDateTime
string(date-time)
false
none
Expected settlement date and time for the payment resource.All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00
The Initiation payload is sent by the initiating party to the ASPSP. It is used to request movement of funds from the debtor account to a creditor for a single domestic payment.
»» InstructionIdentification
string
true
none
Unique identification as assigned by an instructing party for an instructed party to unambiguously identify the instruction. Usage: the instruction identification is a point to point reference that can be used between the instructing party and the instructed party to refer to the individual instruction. It can be included in several messages related to the instruction.
»» EndToEndIdentification
string
true
none
Unique identification assigned by the initiating party to unambiguously identify the transaction. This identification is passed on, unchanged, throughout the entire end-to-end chain. Usage: The end-to-end identification can be used for reconciliation or to link tasks relating to the transaction. It can be included in several messages related to the transaction. OB: The Faster Payments Scheme can only access 31 characters for the EndToEndIdentification field.
User community specific instrument. Usage: This element is used to specify a local instrument, local clearing option and/or further qualify the service or service level.
»» InstructedAmount
object
true
none
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. Usage: This amount has to be transported unchanged through the transaction chain.
A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 "Codes for the representation of currencies and funds".
»» DebtorAccount
object
false
none
Unambiguous identification of the account of the debtor to which a debit entry will be made as a result of the transaction.
Identification assigned by an institution to identify an account. This identification is known by the account owner.
»»» Name
string
false
none
The account name is the name or names of the account owner(s) represented at an account level, as displayed by the ASPSP's online channels. Note, the account name is not the product name or the nickname of the account.
This is secondary identification of the account, as assigned by the account servicing institution. This can be used by building societies to additionally identify accounts with a roll number (in addition to a sort code and account number combination).
»» CreditorAccount
object
true
none
Unambiguous identification of the account of the creditor to which a credit entry will be posted as a result of the payment transaction.
Identification assigned by an institution to identify an account. This identification is known by the account owner.
»»» Name
string
true
none
The account name is the name or names of the account owner(s) represented at an account level. Note, the account name is not the product name or the nickname of the account. OB: ASPSPs may carry out name validation for Confirmation of Payee, but it is not mandatory.
This is secondary identification of the account, as assigned by the account servicing institution. This can be used by building societies to additionally identify accounts with a roll number (in addition to a sort code and account number combination).
Information that locates and identifies a specific address, as defined by postal services.
»» RemittanceInformation
object
false
none
Information supplied to enable the matching of an entry with the items that the transfer is intended to settle, such as commercial invoices in an accounts' receivable system.
»»» Unstructured
string
false
none
Information supplied to enable the matching/reconciliation of an entry with the items that the payment is intended to settle, such as commercial invoices in an accounts' receivable system, in an unstructured form.
»»» Reference
string
false
none
Unique reference, as assigned by the creditor, to unambiguously refer to the payment transaction. Usage: If available, the initiating party should provide this reference in the structured remittance information, to enable reconciliation by the creditor upon receipt of the amount of money. If the business context requires the use of a creditor reference or a payment remit identification, and only one identifier can be passed through the end-to-end chain, the creditor's reference or payment remittance identification should be quoted in the end-to-end transaction identification. OB: The Faster Payments Scheme can only accept 18 characters for the ReferenceInformation field - which is where this ISO field will be mapped.
Additional information that can not be captured in the structured fields and/or any other specific block.
» Authorisation
object
false
none
The authorisation type request from the TPP.
»» AuthorisationType
string
true
none
Type of authorisation flow requested.
»» CompletionDateTime
string(date-time)
false
none
Date and time at which the requested authorisation flow must be completed.All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00
» SCASupportData
object
false
none
Supporting Data provided by TPP, when requesting SCA Exemption.
»» RequestedSCAExemptionType
string
false
none
This field allows a PISP to request specific SCA Exemption for a Payment Initiation
»» AppliedAuthenticationApproach
string
false
none
Specifies a character string with a maximum length of 40 characters. Usage: This field indicates whether the PSU was subject to SCA performed by the TPP
»» ReferencePaymentOrderId
string
false
none
Specifies a character string with a maximum length of 140 characters. Usage: If the payment is recurring then the transaction identifier of the previous payment occurrence so that the ASPSP can verify that the PISP, amount and the payee are the same as the previous occurrence.
OB: Unique identification as assigned by the ASPSP to uniquely identify the domestic payment resource.
» ConsentId
string
true
none
OB: Unique identification as assigned by the ASPSP to uniquely identify the consent resource.
» CreationDateTime
string(date-time)
true
none
Date and time at which the message was created.All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00
» Status
string
true
none
Specifies the status of the payment information group.
» StatusUpdateDateTime
string(date-time)
true
none
Date and time at which the resource status was updated.All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00
» ExpectedExecutionDateTime
string(date-time)
false
none
Expected execution date and time for the payment resource.All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00
» ExpectedSettlementDateTime
string(date-time)
false
none
Expected settlement date and time for the payment resource.All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00
The Initiation payload is sent by the initiating party to the ASPSP. It is used to request movement of funds from the debtor account to a creditor for a single domestic payment.
»» InstructionIdentification
string
true
none
Unique identification as assigned by an instructing party for an instructed party to unambiguously identify the instruction. Usage: the instruction identification is a point to point reference that can be used between the instructing party and the instructed party to refer to the individual instruction. It can be included in several messages related to the instruction.
»» EndToEndIdentification
string
true
none
Unique identification assigned by the initiating party to unambiguously identify the transaction. This identification is passed on, unchanged, throughout the entire end-to-end chain. Usage: The end-to-end identification can be used for reconciliation or to link tasks relating to the transaction. It can be included in several messages related to the transaction. OB: The Faster Payments Scheme can only access 31 characters for the EndToEndIdentification field.
User community specific instrument. Usage: This element is used to specify a local instrument, local clearing option and/or further qualify the service or service level.
»» InstructedAmount
object
true
none
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. Usage: This amount has to be transported unchanged through the transaction chain.
A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 "Codes for the representation of currencies and funds".
»» DebtorAccount
object
false
none
Unambiguous identification of the account of the debtor to which a debit entry will be made as a result of the transaction.
Identification assigned by an institution to identify an account. This identification is known by the account owner.
»»» Name
string
false
none
The account name is the name or names of the account owner(s) represented at an account level, as displayed by the ASPSP's online channels. Note, the account name is not the product name or the nickname of the account.
This is secondary identification of the account, as assigned by the account servicing institution. This can be used by building societies to additionally identify accounts with a roll number (in addition to a sort code and account number combination).
»» CreditorAccount
object
true
none
Unambiguous identification of the account of the creditor to which a credit entry will be posted as a result of the payment transaction.
Identification assigned by an institution to identify an account. This identification is known by the account owner.
»»» Name
string
true
none
The account name is the name or names of the account owner(s) represented at an account level. Note, the account name is not the product name or the nickname of the account. OB: ASPSPs may carry out name validation for Confirmation of Payee, but it is not mandatory.
This is secondary identification of the account, as assigned by the account servicing institution. This can be used by building societies to additionally identify accounts with a roll number (in addition to a sort code and account number combination).
Information that locates and identifies a specific address, as defined by postal services.
»» RemittanceInformation
object
false
none
Information supplied to enable the matching of an entry with the items that the transfer is intended to settle, such as commercial invoices in an accounts' receivable system.
»»» Unstructured
string
false
none
Information supplied to enable the matching/reconciliation of an entry with the items that the payment is intended to settle, such as commercial invoices in an accounts' receivable system, in an unstructured form.
»»» Reference
string
false
none
Unique reference, as assigned by the creditor, to unambiguously refer to the payment transaction. Usage: If available, the initiating party should provide this reference in the structured remittance information, to enable reconciliation by the creditor upon receipt of the amount of money. If the business context requires the use of a creditor reference or a payment remit identification, and only one identifier can be passed through the end-to-end chain, the creditor's reference or payment remittance identification should be quoted in the end-to-end transaction identification. OB: The Faster Payments Scheme can only accept 18 characters for the ReferenceInformation field - which is where this ISO field will be mapped.
Additional information that can not be captured in the structured fields and/or any other specific block.
» MultiAuthorisation
object
false
none
The multiple authorisation flow response from the ASPSP.
»» Status
string
true
none
Specifies the status of the authorisation flow in code form.
»» NumberRequired
integer
false
none
Number of authorisations required for payment order (total required at the start of the multi authorisation journey).
»» NumberReceived
integer
false
none
Number of authorisations received.
»» LastUpdateDateTime
string(date-time)
false
none
Last date and time at the authorisation flow was updated.All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00
»» ExpirationDateTime
string(date-time)
false
none
Date and time at which the requested authorisation flow must be completed.All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00
OB: Unique identification as assigned by the ASPSP to uniquely identify the consent resource.
» Initiation
object
true
none
The Initiation payload is sent by the initiating party to the ASPSP. It is used to request movement of funds from the debtor account to a creditor for a single scheduled domestic payment.
»» InstructionIdentification
string
true
none
Unique identification as assigned by an instructing party for an instructed party to unambiguously identify the instruction. Usage: the instruction identification is a point to point reference that can be used between the instructing party and the instructed party to refer to the individual instruction. It can be included in several messages related to the instruction.
»» EndToEndIdentification
string
false
none
Unique identification assigned by the initiating party to unambiguously identify the transaction. This identification is passed on, unchanged, throughout the entire end-to-end chain. Usage: The end-to-end identification can be used for reconciliation or to link tasks relating to the transaction. It can be included in several messages related to the transaction. OB: The Faster Payments Scheme can only access 31 characters for the EndToEndIdentification field.
User community specific instrument. Usage: This element is used to specify a local instrument, local clearing option and/or further qualify the service or service level.
»» RequestedExecutionDateTime
string(date-time)
true
none
Date at which the initiating party requests the clearing agent to process the payment. Usage: This is the date on which the debtor's account is to be debited.All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00
»» InstructedAmount
object
true
none
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. Usage: This amount has to be transported unchanged through the transaction chain.
A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 "Codes for the representation of currencies and funds".
»» DebtorAccount
object
false
none
Unambiguous identification of the account of the debtor to which a debit entry will be made as a result of the transaction.
Identification assigned by an institution to identify an account. This identification is known by the account owner.
»»» Name
string
false
none
The account name is the name or names of the account owner(s) represented at an account level, as displayed by the ASPSP's online channels. Note, the account name is not the product name or the nickname of the account.
This is secondary identification of the account, as assigned by the account servicing institution. This can be used by building societies to additionally identify accounts with a roll number (in addition to a sort code and account number combination).
»» CreditorAccount
object
true
none
Unambiguous identification of the account of the creditor to which a credit entry will be posted as a result of the payment transaction.
Identification assigned by an institution to identify an account. This identification is known by the account owner.
»»» Name
string
true
none
The account name is the name or names of the account owner(s) represented at an account level. Note, the account name is not the product name or the nickname of the account. OB: ASPSPs may carry out name validation for Confirmation of Payee, but it is not mandatory.
This is secondary identification of the account, as assigned by the account servicing institution. This can be used by building societies to additionally identify accounts with a roll number (in addition to a sort code and account number combination).
Information that locates and identifies a specific address, as defined by postal services.
»» RemittanceInformation
object
false
none
Information supplied to enable the matching of an entry with the items that the transfer is intended to settle, such as commercial invoices in an accounts' receivable system.
»»» Unstructured
string
false
none
Information supplied to enable the matching/reconciliation of an entry with the items that the payment is intended to settle, such as commercial invoices in an accounts' receivable system, in an unstructured form.
»»» Reference
string
false
none
Unique reference, as assigned by the creditor, to unambiguously refer to the payment transaction. Usage: If available, the initiating party should provide this reference in the structured remittance information, to enable reconciliation by the creditor upon receipt of the amount of money. If the business context requires the use of a creditor reference or a payment remit identification, and only one identifier can be passed through the end-to-end chain, the creditor's reference or payment remittance identification should be quoted in the end-to-end transaction identification. OB: The Faster Payments Scheme can only accept 18 characters for the ReferenceInformation field - which is where this ISO field will be mapped.
The Initiation payload is sent by the initiating party to the ASPSP. It is used to request movement of funds from the debtor account to a creditor for a single scheduled domestic payment.
»» InstructionIdentification
string
true
none
Unique identification as assigned by an instructing party for an instructed party to unambiguously identify the instruction. Usage: the instruction identification is a point to point reference that can be used between the instructing party and the instructed party to refer to the individual instruction. It can be included in several messages related to the instruction.
»» EndToEndIdentification
string
false
none
Unique identification assigned by the initiating party to unambiguously identify the transaction. This identification is passed on, unchanged, throughout the entire end-to-end chain. Usage: The end-to-end identification can be used for reconciliation or to link tasks relating to the transaction. It can be included in several messages related to the transaction. OB: The Faster Payments Scheme can only access 31 characters for the EndToEndIdentification field.
User community specific instrument. Usage: This element is used to specify a local instrument, local clearing option and/or further qualify the service or service level.
»» RequestedExecutionDateTime
string(date-time)
true
none
Date at which the initiating party requests the clearing agent to process the payment. Usage: This is the date on which the debtor's account is to be debited.All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00
»» InstructedAmount
object
true
none
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. Usage: This amount has to be transported unchanged through the transaction chain.
A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 "Codes for the representation of currencies and funds".
»» DebtorAccount
object
false
none
Unambiguous identification of the account of the debtor to which a debit entry will be made as a result of the transaction.
Identification assigned by an institution to identify an account. This identification is known by the account owner.
»»» Name
string
false
none
The account name is the name or names of the account owner(s) represented at an account level, as displayed by the ASPSP's online channels. Note, the account name is not the product name or the nickname of the account.
This is secondary identification of the account, as assigned by the account servicing institution. This can be used by building societies to additionally identify accounts with a roll number (in addition to a sort code and account number combination).
»» CreditorAccount
object
true
none
Unambiguous identification of the account of the creditor to which a credit entry will be posted as a result of the payment transaction.
Identification assigned by an institution to identify an account. This identification is known by the account owner.
»»» Name
string
true
none
The account name is the name or names of the account owner(s) represented at an account level. Note, the account name is not the product name or the nickname of the account. OB: ASPSPs may carry out name validation for Confirmation of Payee, but it is not mandatory.
This is secondary identification of the account, as assigned by the account servicing institution. This can be used by building societies to additionally identify accounts with a roll number (in addition to a sort code and account number combination).
Information that locates and identifies a specific address, as defined by postal services.
»» RemittanceInformation
object
false
none
Information supplied to enable the matching of an entry with the items that the transfer is intended to settle, such as commercial invoices in an accounts' receivable system.
»»» Unstructured
string
false
none
Information supplied to enable the matching/reconciliation of an entry with the items that the payment is intended to settle, such as commercial invoices in an accounts' receivable system, in an unstructured form.
»»» Reference
string
false
none
Unique reference, as assigned by the creditor, to unambiguously refer to the payment transaction. Usage: If available, the initiating party should provide this reference in the structured remittance information, to enable reconciliation by the creditor upon receipt of the amount of money. If the business context requires the use of a creditor reference or a payment remit identification, and only one identifier can be passed through the end-to-end chain, the creditor's reference or payment remittance identification should be quoted in the end-to-end transaction identification. OB: The Faster Payments Scheme can only accept 18 characters for the ReferenceInformation field - which is where this ISO field will be mapped.
Additional information that can not be captured in the structured fields and/or any other specific block.
» Authorisation
object
false
none
The authorisation type request from the TPP.
»» AuthorisationType
string
true
none
Type of authorisation flow requested.
»» CompletionDateTime
string(date-time)
false
none
Date and time at which the requested authorisation flow must be completed.All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00
» SCASupportData
object
false
none
Supporting Data provided by TPP, when requesting SCA Exemption.
»» RequestedSCAExemptionType
string
false
none
This field allows a PISP to request specific SCA Exemption for a Payment Initiation
»» AppliedAuthenticationApproach
string
false
none
Specifies a character string with a maximum length of 40 characters. Usage: This field indicates whether the PSU was subject to SCA performed by the TPP
»» ReferencePaymentOrderId
string
false
none
Specifies a character string with a maximum length of 140 characters. Usage: If the payment is recurring then the transaction identifier of the previous payment occurrence so that the ASPSP can verify that the PISP, amount and the payee are the same as the previous occurrence.
OB: Unique identification as assigned by the ASPSP to uniquely identify the consent resource.
» CreationDateTime
string(date-time)
true
none
Date and time at which the resource was created.All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00
» Status
string
true
none
Specifies the status of consent resource in code form.
» StatusUpdateDateTime
string(date-time)
true
none
Date and time at which the consent resource status was updated.All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00
» Permission
string
true
none
Specifies the Open Banking service request types.
» CutOffDateTime
string(date-time)
false
none
Specified cut-off date and time for the payment consent.All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00
» ExpectedExecutionDateTime
string(date-time)
false
none
Expected execution date and time for the payment resource.All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00
» ExpectedSettlementDateTime
string(date-time)
false
none
Expected settlement date and time for the payment resource.All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00
The Initiation payload is sent by the initiating party to the ASPSP. It is used to request movement of funds from the debtor account to a creditor for a single scheduled domestic payment.
»» InstructionIdentification
string
true
none
Unique identification as assigned by an instructing party for an instructed party to unambiguously identify the instruction. Usage: the instruction identification is a point to point reference that can be used between the instructing party and the instructed party to refer to the individual instruction. It can be included in several messages related to the instruction.
»» EndToEndIdentification
string
false
none
Unique identification assigned by the initiating party to unambiguously identify the transaction. This identification is passed on, unchanged, throughout the entire end-to-end chain. Usage: The end-to-end identification can be used for reconciliation or to link tasks relating to the transaction. It can be included in several messages related to the transaction. OB: The Faster Payments Scheme can only access 31 characters for the EndToEndIdentification field.
User community specific instrument. Usage: This element is used to specify a local instrument, local clearing option and/or further qualify the service or service level.
»» RequestedExecutionDateTime
string(date-time)
true
none
Date at which the initiating party requests the clearing agent to process the payment. Usage: This is the date on which the debtor's account is to be debited.All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00
»» InstructedAmount
object
true
none
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. Usage: This amount has to be transported unchanged through the transaction chain.
A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 "Codes for the representation of currencies and funds".
»» DebtorAccount
object
false
none
Unambiguous identification of the account of the debtor to which a debit entry will be made as a result of the transaction.
Identification assigned by an institution to identify an account. This identification is known by the account owner.
»»» Name
string
false
none
The account name is the name or names of the account owner(s) represented at an account level, as displayed by the ASPSP's online channels. Note, the account name is not the product name or the nickname of the account.
This is secondary identification of the account, as assigned by the account servicing institution. This can be used by building societies to additionally identify accounts with a roll number (in addition to a sort code and account number combination).
»» CreditorAccount
object
true
none
Unambiguous identification of the account of the creditor to which a credit entry will be posted as a result of the payment transaction.
Identification assigned by an institution to identify an account. This identification is known by the account owner.
»»» Name
string
true
none
The account name is the name or names of the account owner(s) represented at an account level. Note, the account name is not the product name or the nickname of the account. OB: ASPSPs may carry out name validation for Confirmation of Payee, but it is not mandatory.
This is secondary identification of the account, as assigned by the account servicing institution. This can be used by building societies to additionally identify accounts with a roll number (in addition to a sort code and account number combination).
Information that locates and identifies a specific address, as defined by postal services.
»» RemittanceInformation
object
false
none
Information supplied to enable the matching of an entry with the items that the transfer is intended to settle, such as commercial invoices in an accounts' receivable system.
»»» Unstructured
string
false
none
Information supplied to enable the matching/reconciliation of an entry with the items that the payment is intended to settle, such as commercial invoices in an accounts' receivable system, in an unstructured form.
»»» Reference
string
false
none
Unique reference, as assigned by the creditor, to unambiguously refer to the payment transaction. Usage: If available, the initiating party should provide this reference in the structured remittance information, to enable reconciliation by the creditor upon receipt of the amount of money. If the business context requires the use of a creditor reference or a payment remit identification, and only one identifier can be passed through the end-to-end chain, the creditor's reference or payment remittance identification should be quoted in the end-to-end transaction identification. OB: The Faster Payments Scheme can only accept 18 characters for the ReferenceInformation field - which is where this ISO field will be mapped.
Additional information that can not be captured in the structured fields and/or any other specific block.
» Authorisation
object
false
none
The authorisation type request from the TPP.
»» AuthorisationType
string
true
none
Type of authorisation flow requested.
»» CompletionDateTime
string(date-time)
false
none
Date and time at which the requested authorisation flow must be completed.All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00
» SCASupportData
object
false
none
Supporting Data provided by TPP, when requesting SCA Exemption.
»» RequestedSCAExemptionType
string
false
none
This field allows a PISP to request specific SCA Exemption for a Payment Initiation
»» AppliedAuthenticationApproach
string
false
none
Specifies a character string with a maximum length of 40 characters. Usage: This field indicates whether the PSU was subject to SCA performed by the TPP
»» ReferencePaymentOrderId
string
false
none
Specifies a character string with a maximum length of 140 characters. Usage: If the payment is recurring then the transaction identifier of the previous payment occurrence so that the ASPSP can verify that the PISP, amount and the payee are the same as the previous occurrence.
OB: Unique identification as assigned by the ASPSP to uniquely identify the domestic schedule payment resource.
» ConsentId
string
true
none
OB: Unique identification as assigned by the ASPSP to uniquely identify the consent resource.
» CreationDateTime
string(date-time)
true
none
Date and time at which the message was created.All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00
» Status
string
true
none
Specifies the status of the payment order resource.
» StatusUpdateDateTime
string(date-time)
true
none
Date and time at which the resource status was updated.All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00
» ExpectedExecutionDateTime
string(date-time)
false
none
Expected execution date and time for the payment resource.All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00
» ExpectedSettlementDateTime
string(date-time)
false
none
Expected settlement date and time for the payment resource.All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00
The Initiation payload is sent by the initiating party to the ASPSP. It is used to request movement of funds from the debtor account to a creditor for a single scheduled domestic payment.
»» InstructionIdentification
string
true
none
Unique identification as assigned by an instructing party for an instructed party to unambiguously identify the instruction. Usage: the instruction identification is a point to point reference that can be used between the instructing party and the instructed party to refer to the individual instruction. It can be included in several messages related to the instruction.
»» EndToEndIdentification
string
false
none
Unique identification assigned by the initiating party to unambiguously identify the transaction. This identification is passed on, unchanged, throughout the entire end-to-end chain. Usage: The end-to-end identification can be used for reconciliation or to link tasks relating to the transaction. It can be included in several messages related to the transaction. OB: The Faster Payments Scheme can only access 31 characters for the EndToEndIdentification field.
User community specific instrument. Usage: This element is used to specify a local instrument, local clearing option and/or further qualify the service or service level.
»» RequestedExecutionDateTime
string(date-time)
true
none
Date at which the initiating party requests the clearing agent to process the payment. Usage: This is the date on which the debtor's account is to be debited.All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00
»» InstructedAmount
object
true
none
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. Usage: This amount has to be transported unchanged through the transaction chain.
A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 "Codes for the representation of currencies and funds".
»» DebtorAccount
object
false
none
Unambiguous identification of the account of the debtor to which a debit entry will be made as a result of the transaction.
Identification assigned by an institution to identify an account. This identification is known by the account owner.
»»» Name
string
false
none
The account name is the name or names of the account owner(s) represented at an account level, as displayed by the ASPSP's online channels. Note, the account name is not the product name or the nickname of the account.
This is secondary identification of the account, as assigned by the account servicing institution. This can be used by building societies to additionally identify accounts with a roll number (in addition to a sort code and account number combination).
»» CreditorAccount
object
true
none
Unambiguous identification of the account of the creditor to which a credit entry will be posted as a result of the payment transaction.
Identification assigned by an institution to identify an account. This identification is known by the account owner.
»»» Name
string
true
none
The account name is the name or names of the account owner(s) represented at an account level. Note, the account name is not the product name or the nickname of the account. OB: ASPSPs may carry out name validation for Confirmation of Payee, but it is not mandatory.
This is secondary identification of the account, as assigned by the account servicing institution. This can be used by building societies to additionally identify accounts with a roll number (in addition to a sort code and account number combination).
Information that locates and identifies a specific address, as defined by postal services.
»» RemittanceInformation
object
false
none
Information supplied to enable the matching of an entry with the items that the transfer is intended to settle, such as commercial invoices in an accounts' receivable system.
»»» Unstructured
string
false
none
Information supplied to enable the matching/reconciliation of an entry with the items that the payment is intended to settle, such as commercial invoices in an accounts' receivable system, in an unstructured form.
»»» Reference
string
false
none
Unique reference, as assigned by the creditor, to unambiguously refer to the payment transaction. Usage: If available, the initiating party should provide this reference in the structured remittance information, to enable reconciliation by the creditor upon receipt of the amount of money. If the business context requires the use of a creditor reference or a payment remit identification, and only one identifier can be passed through the end-to-end chain, the creditor's reference or payment remittance identification should be quoted in the end-to-end transaction identification. OB: The Faster Payments Scheme can only accept 18 characters for the ReferenceInformation field - which is where this ISO field will be mapped.
Additional information that can not be captured in the structured fields and/or any other specific block.
» MultiAuthorisation
object
false
none
The multiple authorisation flow response from the ASPSP.
»» Status
string
true
none
Specifies the status of the authorisation flow in code form.
»» NumberRequired
integer
false
none
Number of authorisations required for payment order (total required at the start of the multi authorisation journey).
»» NumberReceived
integer
false
none
Number of authorisations received.
»» LastUpdateDateTime
string(date-time)
false
none
Last date and time at the authorisation flow was updated.All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00
»» ExpirationDateTime
string(date-time)
false
none
Date and time at which the requested authorisation flow must be completed.All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00
OB: Unique identification as assigned by the ASPSP to uniquely identify the consent resource.
» Initiation
object
true
none
The Initiation payload is sent by the initiating party to the ASPSP. It is used to request movement of funds from the debtor account to a creditor for a domestic standing order.
»» Frequency
string
true
none
Individual Definitions: EvryDay - Every day EvryWorkgDay - Every working day IntrvlWkDay - An interval specified in weeks (01 to 09), and the day within the week (01 to 07) WkInMnthDay - A monthly interval, specifying the week of the month (01 to 05) and day within the week (01 to 07) IntrvlMnthDay - An interval specified in months (between 01 to 06, 12, 24), specifying the day within the month (-5 to -1, 1 to 31) QtrDay - Quarterly (either ENGLISH, SCOTTISH, or RECEIVED). ENGLISH = Paid on the 25th March, 24th June, 29th September and 25th December. SCOTTISH = Paid on the 2nd February, 15th May, 1st August and 11th November. RECEIVED = Paid on the 20th March, 19th June, 24th September and 20th December. Individual Patterns: EvryDay (ScheduleCode) EvryWorkgDay (ScheduleCode) IntrvlWkDay:IntervalInWeeks:DayInWeek (ScheduleCode + IntervalInWeeks + DayInWeek) WkInMnthDay:WeekInMonth:DayInWeek (ScheduleCode + WeekInMonth + DayInWeek) IntrvlMnthDay:IntervalInMonths:DayInMonth (ScheduleCode + IntervalInMonths + DayInMonth) QtrDay: + either (ENGLISH, SCOTTISH or RECEIVED) ScheduleCode + QuarterDay The regular expression for this element combines five smaller versions for each permitted pattern. To aid legibility - the components are presented individually here: EvryDay EvryWorkgDay IntrvlWkDay:0[1-9]:0[1-7] WkInMnthDay:0[1-5]:0[1-7] IntrvlMnthDay:(0[1-6]
»» Reference
string
false
none
Unique reference, as assigned by the creditor, to unambiguously refer to the payment transaction. Usage: If available, the initiating party should provide this reference in the structured remittance information, to enable reconciliation by the creditor upon receipt of the amount of money. If the business context requires the use of a creditor reference or a payment remit identification, and only one identifier can be passed through the end-to-end chain, the creditor's reference or payment remittance identification should be quoted in the end-to-end transaction identification.
»» NumberOfPayments
string
false
none
Number of the payments that will be made in completing this frequency sequence including any executed since the sequence start date.
»» FirstPaymentDateTime
string(date-time)
true
none
The date on which the first payment for a Standing Order schedule will be made.All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00
»» RecurringPaymentDateTime
string(date-time)
false
none
The date on which the first recurring payment for a Standing Order schedule will be made. Usage: This must be populated only if the first recurring date is different to the first payment date.All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00
»» FinalPaymentDateTime
string(date-time)
false
none
The date on which the final payment for a Standing Order schedule will be made.All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00
A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 "Codes for the representation of currencies and funds".
A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 "Codes for the representation of currencies and funds".
A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 "Codes for the representation of currencies and funds".
»» DebtorAccount
object
false
none
Provides the details to identify the debtor account.
Identification assigned by an institution to identify an account. This identification is known by the account owner.
»»» Name
string
false
none
The account name is the name or names of the account owner(s) represented at an account level, as displayed by the ASPSP's online channels. Note, the account name is not the product name or the nickname of the account.
This is secondary identification of the account, as assigned by the account servicing institution. This can be used by building societies to additionally identify accounts with a roll number (in addition to a sort code and account number combination).
»» CreditorAccount
object
true
none
Identification assigned by an institution to identify an account. This identification is known by the account owner.
Identification assigned by an institution to identify an account. This identification is known by the account owner.
»»» Name
string
true
none
The account name is the name or names of the account owner(s) represented at an account level. Note, the account name is not the product name or the nickname of the account. OB: ASPSPs may carry out name validation for Confirmation of Payee, but it is not mandatory.
This is secondary identification of the account, as assigned by the account servicing institution. This can be used by building societies to additionally identify accounts with a roll number (in addition to a sort code and account number combination).
The Initiation payload is sent by the initiating party to the ASPSP. It is used to request movement of funds from the debtor account to a creditor for a domestic standing order.
»» Frequency
string
true
none
Individual Definitions: EvryDay - Every day EvryWorkgDay - Every working day IntrvlWkDay - An interval specified in weeks (01 to 09), and the day within the week (01 to 07) WkInMnthDay - A monthly interval, specifying the week of the month (01 to 05) and day within the week (01 to 07) IntrvlMnthDay - An interval specified in months (between 01 to 06, 12, 24), specifying the day within the month (-5 to -1, 1 to 31) QtrDay - Quarterly (either ENGLISH, SCOTTISH, or RECEIVED). ENGLISH = Paid on the 25th March, 24th June, 29th September and 25th December. SCOTTISH = Paid on the 2nd February, 15th May, 1st August and 11th November. RECEIVED = Paid on the 20th March, 19th June, 24th September and 20th December. Individual Patterns: EvryDay (ScheduleCode) EvryWorkgDay (ScheduleCode) IntrvlWkDay:IntervalInWeeks:DayInWeek (ScheduleCode + IntervalInWeeks + DayInWeek) WkInMnthDay:WeekInMonth:DayInWeek (ScheduleCode + WeekInMonth + DayInWeek) IntrvlMnthDay:IntervalInMonths:DayInMonth (ScheduleCode + IntervalInMonths + DayInMonth) QtrDay: + either (ENGLISH, SCOTTISH or RECEIVED) ScheduleCode + QuarterDay The regular expression for this element combines five smaller versions for each permitted pattern. To aid legibility - the components are presented individually here: EvryDay EvryWorkgDay IntrvlWkDay:0[1-9]:0[1-7] WkInMnthDay:0[1-5]:0[1-7] IntrvlMnthDay:(0[1-6]
»» Reference
string
false
none
Unique reference, as assigned by the creditor, to unambiguously refer to the payment transaction. Usage: If available, the initiating party should provide this reference in the structured remittance information, to enable reconciliation by the creditor upon receipt of the amount of money. If the business context requires the use of a creditor reference or a payment remit identification, and only one identifier can be passed through the end-to-end chain, the creditor's reference or payment remittance identification should be quoted in the end-to-end transaction identification.
»» NumberOfPayments
string
false
none
Number of the payments that will be made in completing this frequency sequence including any executed since the sequence start date.
»» FirstPaymentDateTime
string(date-time)
true
none
The date on which the first payment for a Standing Order schedule will be made.All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00
»» RecurringPaymentDateTime
string(date-time)
false
none
The date on which the first recurring payment for a Standing Order schedule will be made. Usage: This must be populated only if the first recurring date is different to the first payment date.All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00
»» FinalPaymentDateTime
string(date-time)
false
none
The date on which the final payment for a Standing Order schedule will be made.All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00
A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 "Codes for the representation of currencies and funds".
A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 "Codes for the representation of currencies and funds".
A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 "Codes for the representation of currencies and funds".
»» DebtorAccount
object
false
none
Provides the details to identify the debtor account.
Identification assigned by an institution to identify an account. This identification is known by the account owner.
»»» Name
string
false
none
The account name is the name or names of the account owner(s) represented at an account level, as displayed by the ASPSP's online channels. Note, the account name is not the product name or the nickname of the account.
This is secondary identification of the account, as assigned by the account servicing institution. This can be used by building societies to additionally identify accounts with a roll number (in addition to a sort code and account number combination).
»» CreditorAccount
object
true
none
Identification assigned by an institution to identify an account. This identification is known by the account owner.
Identification assigned by an institution to identify an account. This identification is known by the account owner.
»»» Name
string
true
none
The account name is the name or names of the account owner(s) represented at an account level. Note, the account name is not the product name or the nickname of the account. OB: ASPSPs may carry out name validation for Confirmation of Payee, but it is not mandatory.
This is secondary identification of the account, as assigned by the account servicing institution. This can be used by building societies to additionally identify accounts with a roll number (in addition to a sort code and account number combination).
Additional information that can not be captured in the structured fields and/or any other specific block.
» Authorisation
object
false
none
The authorisation type request from the TPP.
»» AuthorisationType
string
true
none
Type of authorisation flow requested.
»» CompletionDateTime
string(date-time)
false
none
Date and time at which the requested authorisation flow must be completed.All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00
» SCASupportData
object
false
none
Supporting Data provided by TPP, when requesting SCA Exemption.
»» RequestedSCAExemptionType
string
false
none
This field allows a PISP to request specific SCA Exemption for a Payment Initiation
»» AppliedAuthenticationApproach
string
false
none
Specifies a character string with a maximum length of 40 characters. Usage: This field indicates whether the PSU was subject to SCA performed by the TPP
»» ReferencePaymentOrderId
string
false
none
Specifies a character string with a maximum length of 140 characters. Usage: If the payment is recurring then the transaction identifier of the previous payment occurrence so that the ASPSP can verify that the PISP, amount and the payee are the same as the previous occurrence.
OB: Unique identification as assigned by the ASPSP to uniquely identify the consent resource.
» CreationDateTime
string(date-time)
true
none
Date and time at which the resource was created.All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00
» Status
string
true
none
Specifies the status of consent resource in code form.
» StatusUpdateDateTime
string(date-time)
true
none
Date and time at which the resource status was updated.All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00
» Permission
string
true
none
Specifies the Open Banking service request types.
» CutOffDateTime
string(date-time)
false
none
Specified cut-off date and time for the payment consent.All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00
The Initiation payload is sent by the initiating party to the ASPSP. It is used to request movement of funds from the debtor account to a creditor for a domestic standing order.
»» Frequency
string
true
none
Individual Definitions: EvryDay - Every day EvryWorkgDay - Every working day IntrvlWkDay - An interval specified in weeks (01 to 09), and the day within the week (01 to 07) WkInMnthDay - A monthly interval, specifying the week of the month (01 to 05) and day within the week (01 to 07) IntrvlMnthDay - An interval specified in months (between 01 to 06, 12, 24), specifying the day within the month (-5 to -1, 1 to 31) QtrDay - Quarterly (either ENGLISH, SCOTTISH, or RECEIVED). ENGLISH = Paid on the 25th March, 24th June, 29th September and 25th December. SCOTTISH = Paid on the 2nd February, 15th May, 1st August and 11th November. RECEIVED = Paid on the 20th March, 19th June, 24th September and 20th December. Individual Patterns: EvryDay (ScheduleCode) EvryWorkgDay (ScheduleCode) IntrvlWkDay:IntervalInWeeks:DayInWeek (ScheduleCode + IntervalInWeeks + DayInWeek) WkInMnthDay:WeekInMonth:DayInWeek (ScheduleCode + WeekInMonth + DayInWeek) IntrvlMnthDay:IntervalInMonths:DayInMonth (ScheduleCode + IntervalInMonths + DayInMonth) QtrDay: + either (ENGLISH, SCOTTISH or RECEIVED) ScheduleCode + QuarterDay The regular expression for this element combines five smaller versions for each permitted pattern. To aid legibility - the components are presented individually here: EvryDay EvryWorkgDay IntrvlWkDay:0[1-9]:0[1-7] WkInMnthDay:0[1-5]:0[1-7] IntrvlMnthDay:(0[1-6]
»» Reference
string
false
none
Unique reference, as assigned by the creditor, to unambiguously refer to the payment transaction. Usage: If available, the initiating party should provide this reference in the structured remittance information, to enable reconciliation by the creditor upon receipt of the amount of money. If the business context requires the use of a creditor reference or a payment remit identification, and only one identifier can be passed through the end-to-end chain, the creditor's reference or payment remittance identification should be quoted in the end-to-end transaction identification.
»» NumberOfPayments
string
false
none
Number of the payments that will be made in completing this frequency sequence including any executed since the sequence start date.
»» FirstPaymentDateTime
string(date-time)
true
none
The date on which the first payment for a Standing Order schedule will be made.All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00
»» RecurringPaymentDateTime
string(date-time)
false
none
The date on which the first recurring payment for a Standing Order schedule will be made. Usage: This must be populated only if the first recurring date is different to the first payment date.All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00
»» FinalPaymentDateTime
string(date-time)
false
none
The date on which the final payment for a Standing Order schedule will be made.All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00
A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 "Codes for the representation of currencies and funds".
A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 "Codes for the representation of currencies and funds".
A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 "Codes for the representation of currencies and funds".
»» DebtorAccount
object
false
none
Provides the details to identify the debtor account.
Identification assigned by an institution to identify an account. This identification is known by the account owner.
»»» Name
string
false
none
The account name is the name or names of the account owner(s) represented at an account level, as displayed by the ASPSP's online channels. Note, the account name is not the product name or the nickname of the account.
This is secondary identification of the account, as assigned by the account servicing institution. This can be used by building societies to additionally identify accounts with a roll number (in addition to a sort code and account number combination).
»» CreditorAccount
object
true
none
Identification assigned by an institution to identify an account. This identification is known by the account owner.
Identification assigned by an institution to identify an account. This identification is known by the account owner.
»»» Name
string
true
none
The account name is the name or names of the account owner(s) represented at an account level. Note, the account name is not the product name or the nickname of the account. OB: ASPSPs may carry out name validation for Confirmation of Payee, but it is not mandatory.
This is secondary identification of the account, as assigned by the account servicing institution. This can be used by building societies to additionally identify accounts with a roll number (in addition to a sort code and account number combination).
Additional information that can not be captured in the structured fields and/or any other specific block.
» Authorisation
object
false
none
The authorisation type request from the TPP.
»» AuthorisationType
string
true
none
Type of authorisation flow requested.
»» CompletionDateTime
string(date-time)
false
none
Date and time at which the requested authorisation flow must be completed.All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00
» SCASupportData
object
false
none
Supporting Data provided by TPP, when requesting SCA Exemption.
»» RequestedSCAExemptionType
string
false
none
This field allows a PISP to request specific SCA Exemption for a Payment Initiation
»» AppliedAuthenticationApproach
string
false
none
Specifies a character string with a maximum length of 40 characters. Usage: This field indicates whether the PSU was subject to SCA performed by the TPP
»» ReferencePaymentOrderId
string
false
none
Specifies a character string with a maximum length of 140 characters. Usage: If the payment is recurring then the transaction identifier of the previous payment occurrence so that the ASPSP can verify that the PISP, amount and the payee are the same as the previous occurrence.
OB: Unique identification as assigned by the ASPSP to uniquely identify the domestic standing order resource.
» ConsentId
string
true
none
OB: Unique identification as assigned by the ASPSP to uniquely identify the consent resource.
» CreationDateTime
string(date-time)
true
none
Date and time at which the resource was created.All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00
» Status
string
true
none
Specifies the status of the payment order resource.
» StatusUpdateDateTime
string(date-time)
true
none
Date and time at which the resource status was updated.All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00
The Initiation payload is sent by the initiating party to the ASPSP. It is used to request movement of funds from the debtor account to a creditor for a domestic standing order.
»» Frequency
string
true
none
Individual Definitions: EvryDay - Every day EvryWorkgDay - Every working day IntrvlWkDay - An interval specified in weeks (01 to 09), and the day within the week (01 to 07) WkInMnthDay - A monthly interval, specifying the week of the month (01 to 05) and day within the week (01 to 07) IntrvlMnthDay - An interval specified in months (between 01 to 06, 12, 24), specifying the day within the month (-5 to -1, 1 to 31) QtrDay - Quarterly (either ENGLISH, SCOTTISH, or RECEIVED). ENGLISH = Paid on the 25th March, 24th June, 29th September and 25th December. SCOTTISH = Paid on the 2nd February, 15th May, 1st August and 11th November. RECEIVED = Paid on the 20th March, 19th June, 24th September and 20th December. Individual Patterns: EvryDay (ScheduleCode) EvryWorkgDay (ScheduleCode) IntrvlWkDay:IntervalInWeeks:DayInWeek (ScheduleCode + IntervalInWeeks + DayInWeek) WkInMnthDay:WeekInMonth:DayInWeek (ScheduleCode + WeekInMonth + DayInWeek) IntrvlMnthDay:IntervalInMonths:DayInMonth (ScheduleCode + IntervalInMonths + DayInMonth) QtrDay: + either (ENGLISH, SCOTTISH or RECEIVED) ScheduleCode + QuarterDay The regular expression for this element combines five smaller versions for each permitted pattern. To aid legibility - the components are presented individually here: EvryDay EvryWorkgDay IntrvlWkDay:0[1-9]:0[1-7] WkInMnthDay:0[1-5]:0[1-7] IntrvlMnthDay:(0[1-6]
»» Reference
string
false
none
Unique reference, as assigned by the creditor, to unambiguously refer to the payment transaction. Usage: If available, the initiating party should provide this reference in the structured remittance information, to enable reconciliation by the creditor upon receipt of the amount of money. If the business context requires the use of a creditor reference or a payment remit identification, and only one identifier can be passed through the end-to-end chain, the creditor's reference or payment remittance identification should be quoted in the end-to-end transaction identification.
»» NumberOfPayments
string
false
none
Number of the payments that will be made in completing this frequency sequence including any executed since the sequence start date.
»» FirstPaymentDateTime
string(date-time)
true
none
The date on which the first payment for a Standing Order schedule will be made.All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00
»» RecurringPaymentDateTime
string(date-time)
false
none
The date on which the first recurring payment for a Standing Order schedule will be made. Usage: This must be populated only if the first recurring date is different to the first payment date.All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00
»» FinalPaymentDateTime
string(date-time)
false
none
The date on which the final payment for a Standing Order schedule will be made.All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00
A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 "Codes for the representation of currencies and funds".
A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 "Codes for the representation of currencies and funds".
A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 "Codes for the representation of currencies and funds".
»» DebtorAccount
object
false
none
Provides the details to identify the debtor account.
Identification assigned by an institution to identify an account. This identification is known by the account owner.
»»» Name
string
false
none
The account name is the name or names of the account owner(s) represented at an account level, as displayed by the ASPSP's online channels. Note, the account name is not the product name or the nickname of the account.
This is secondary identification of the account, as assigned by the account servicing institution. This can be used by building societies to additionally identify accounts with a roll number (in addition to a sort code and account number combination).
»» CreditorAccount
object
true
none
Identification assigned by an institution to identify an account. This identification is known by the account owner.
Identification assigned by an institution to identify an account. This identification is known by the account owner.
»»» Name
string
true
none
The account name is the name or names of the account owner(s) represented at an account level. Note, the account name is not the product name or the nickname of the account. OB: ASPSPs may carry out name validation for Confirmation of Payee, but it is not mandatory.
This is secondary identification of the account, as assigned by the account servicing institution. This can be used by building societies to additionally identify accounts with a roll number (in addition to a sort code and account number combination).
Additional information that can not be captured in the structured fields and/or any other specific block.
» MultiAuthorisation
object
false
none
The multiple authorisation flow response from the ASPSP.
»» Status
string
true
none
Specifies the status of the authorisation flow in code form.
»» NumberRequired
integer
false
none
Number of authorisations required for payment order (total required at the start of the multi authorisation journey).
»» NumberReceived
integer
false
none
Number of authorisations received.
»» LastUpdateDateTime
string(date-time)
false
none
Last date and time at the authorisation flow was updated.All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00
»» ExpirationDateTime
string(date-time)
false
none
Date and time at which the requested authorisation flow must be completed.All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00
OB: Unique identification as assigned by the ASPSP to uniquely identify the consent resource.
» Initiation
object
true
none
The Initiation payload is sent by the initiating party to the ASPSP. It is used to request movement of funds using a payment file.
»» FileType
string
true
none
Specifies the payment file type.
»» FileHash
string
true
none
A base64 encoding of a SHA256 hash of the file to be uploaded.
»» FileReference
string
false
none
Reference for the file.
»» NumberOfTransactions
string
false
none
Number of individual transactions contained in the payment information group.
»» ControlSum
number
false
none
Total of all individual amounts included in the group, irrespective of currencies.
»» RequestedExecutionDateTime
string(date-time)
false
none
Date at which the initiating party requests the clearing agent to process the payment. Usage: This is the date on which the debtor's account is to be debited.All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00
User community specific instrument. Usage: This element is used to specify a local instrument, local clearing option and/or further qualify the service or service level.
»» DebtorAccount
object
false
none
Unambiguous identification of the account of the debtor to which a debit entry will be made as a result of the transaction.
Identification assigned by an institution to identify an account. This identification is known by the account owner.
»»» Name
string
false
none
The account name is the name or names of the account owner(s) represented at an account level, as displayed by the ASPSP's online channels. Note, the account name is not the product name or the nickname of the account.
This is secondary identification of the account, as assigned by the account servicing institution. This can be used by building societies to additionally identify accounts with a roll number (in addition to a sort code and account number combination).
»» RemittanceInformation
object
false
none
Information supplied to enable the matching of an entry with the items that the transfer is intended to settle, such as commercial invoices in an accounts' receivable system.
»»» Unstructured
string
false
none
Information supplied to enable the matching/reconciliation of an entry with the items that the payment is intended to settle, such as commercial invoices in an accounts' receivable system, in an unstructured form.
»»» Reference
string
false
none
Unique reference, as assigned by the creditor, to unambiguously refer to the payment transaction. Usage: If available, the initiating party should provide this reference in the structured remittance information, to enable reconciliation by the creditor upon receipt of the amount of money. If the business context requires the use of a creditor reference or a payment remit identification, and only one identifier can be passed through the end-to-end chain, the creditor's reference or payment remittance identification should be quoted in the end-to-end transaction identification. OB: The Faster Payments Scheme can only accept 18 characters for the ReferenceInformation field - which is where this ISO field will be mapped.
The Initiation payload is sent by the initiating party to the ASPSP. It is used to request movement of funds using a payment file.
»» FileType
string
true
none
Specifies the payment file type.
»» FileHash
string
true
none
A base64 encoding of a SHA256 hash of the file to be uploaded.
»» FileReference
string
false
none
Reference for the file.
»» NumberOfTransactions
string
false
none
Number of individual transactions contained in the payment information group.
»» ControlSum
number
false
none
Total of all individual amounts included in the group, irrespective of currencies.
»» RequestedExecutionDateTime
string(date-time)
false
none
Date at which the initiating party requests the clearing agent to process the payment. Usage: This is the date on which the debtor's account is to be debited.All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00
User community specific instrument. Usage: This element is used to specify a local instrument, local clearing option and/or further qualify the service or service level.
»» DebtorAccount
object
false
none
Unambiguous identification of the account of the debtor to which a debit entry will be made as a result of the transaction.
Identification assigned by an institution to identify an account. This identification is known by the account owner.
»»» Name
string
false
none
The account name is the name or names of the account owner(s) represented at an account level, as displayed by the ASPSP's online channels. Note, the account name is not the product name or the nickname of the account.
This is secondary identification of the account, as assigned by the account servicing institution. This can be used by building societies to additionally identify accounts with a roll number (in addition to a sort code and account number combination).
»» RemittanceInformation
object
false
none
Information supplied to enable the matching of an entry with the items that the transfer is intended to settle, such as commercial invoices in an accounts' receivable system.
»»» Unstructured
string
false
none
Information supplied to enable the matching/reconciliation of an entry with the items that the payment is intended to settle, such as commercial invoices in an accounts' receivable system, in an unstructured form.
»»» Reference
string
false
none
Unique reference, as assigned by the creditor, to unambiguously refer to the payment transaction. Usage: If available, the initiating party should provide this reference in the structured remittance information, to enable reconciliation by the creditor upon receipt of the amount of money. If the business context requires the use of a creditor reference or a payment remit identification, and only one identifier can be passed through the end-to-end chain, the creditor's reference or payment remittance identification should be quoted in the end-to-end transaction identification. OB: The Faster Payments Scheme can only accept 18 characters for the ReferenceInformation field - which is where this ISO field will be mapped.
Additional information that can not be captured in the structured fields and/or any other specific block.
» Authorisation
object
false
none
The authorisation type request from the TPP.
»» AuthorisationType
string
true
none
Type of authorisation flow requested.
»» CompletionDateTime
string(date-time)
false
none
Date and time at which the requested authorisation flow must be completed.All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00
» SCASupportData
object
false
none
Supporting Data provided by TPP, when requesting SCA Exemption.
»» RequestedSCAExemptionType
string
false
none
This field allows a PISP to request specific SCA Exemption for a Payment Initiation
»» AppliedAuthenticationApproach
string
false
none
Specifies a character string with a maximum length of 40 characters. Usage: This field indicates whether the PSU was subject to SCA performed by the TPP
»» ReferencePaymentOrderId
string
false
none
Specifies a character string with a maximum length of 140 characters. Usage: If the payment is recurring then the transaction identifier of the previous payment occurrence so that the ASPSP can verify that the PISP, amount and the payee are the same as the previous occurrence.
OB: Unique identification as assigned by the ASPSP to uniquely identify the consent resource.
» CreationDateTime
string(date-time)
true
none
Date and time at which the resource was created.All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00
» Status
string
true
none
Specifies the status of consent resource in code form.
» StatusUpdateDateTime
string(date-time)
true
none
Date and time at which the consent resource status was updated.All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00
» CutOffDateTime
string(date-time)
false
none
Specified cut-off date and time for the payment consent.All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00
The Initiation payload is sent by the initiating party to the ASPSP. It is used to request movement of funds using a payment file.
»» FileType
string
true
none
Specifies the payment file type.
»» FileHash
string
true
none
A base64 encoding of a SHA256 hash of the file to be uploaded.
»» FileReference
string
false
none
Reference for the file.
»» NumberOfTransactions
string
false
none
Number of individual transactions contained in the payment information group.
»» ControlSum
number
false
none
Total of all individual amounts included in the group, irrespective of currencies.
»» RequestedExecutionDateTime
string(date-time)
false
none
Date at which the initiating party requests the clearing agent to process the payment. Usage: This is the date on which the debtor's account is to be debited.All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00
User community specific instrument. Usage: This element is used to specify a local instrument, local clearing option and/or further qualify the service or service level.
»» DebtorAccount
object
false
none
Unambiguous identification of the account of the debtor to which a debit entry will be made as a result of the transaction.
Identification assigned by an institution to identify an account. This identification is known by the account owner.
»»» Name
string
false
none
The account name is the name or names of the account owner(s) represented at an account level, as displayed by the ASPSP's online channels. Note, the account name is not the product name or the nickname of the account.
This is secondary identification of the account, as assigned by the account servicing institution. This can be used by building societies to additionally identify accounts with a roll number (in addition to a sort code and account number combination).
»» RemittanceInformation
object
false
none
Information supplied to enable the matching of an entry with the items that the transfer is intended to settle, such as commercial invoices in an accounts' receivable system.
»»» Unstructured
string
false
none
Information supplied to enable the matching/reconciliation of an entry with the items that the payment is intended to settle, such as commercial invoices in an accounts' receivable system, in an unstructured form.
»»» Reference
string
false
none
Unique reference, as assigned by the creditor, to unambiguously refer to the payment transaction. Usage: If available, the initiating party should provide this reference in the structured remittance information, to enable reconciliation by the creditor upon receipt of the amount of money. If the business context requires the use of a creditor reference or a payment remit identification, and only one identifier can be passed through the end-to-end chain, the creditor's reference or payment remittance identification should be quoted in the end-to-end transaction identification. OB: The Faster Payments Scheme can only accept 18 characters for the ReferenceInformation field - which is where this ISO field will be mapped.
Additional information that can not be captured in the structured fields and/or any other specific block.
» Authorisation
object
false
none
The authorisation type request from the TPP.
»» AuthorisationType
string
true
none
Type of authorisation flow requested.
»» CompletionDateTime
string(date-time)
false
none
Date and time at which the requested authorisation flow must be completed.All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00
» SCASupportData
object
false
none
Supporting Data provided by TPP, when requesting SCA Exemption.
»» RequestedSCAExemptionType
string
false
none
This field allows a PISP to request specific SCA Exemption for a Payment Initiation
»» AppliedAuthenticationApproach
string
false
none
Specifies a character string with a maximum length of 40 characters. Usage: This field indicates whether the PSU was subject to SCA performed by the TPP
»» ReferencePaymentOrderId
string
false
none
Specifies a character string with a maximum length of 140 characters. Usage: If the payment is recurring then the transaction identifier of the previous payment occurrence so that the ASPSP can verify that the PISP, amount and the payee are the same as the previous occurrence.
OB: Unique identification as assigned by the ASPSP to uniquely identify the file payment resource.
» ConsentId
string
true
none
OB: Unique identification as assigned by the ASPSP to uniquely identify the consent resource.
» CreationDateTime
string(date-time)
true
none
Date and time at which the message was created.All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00
» Status
string
true
none
Specifies the status of the payment order resource.
» StatusUpdateDateTime
string(date-time)
true
none
Date and time at which the resource status was updated.All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00
The Initiation payload is sent by the initiating party to the ASPSP. It is used to request movement of funds using a payment file.
»» FileType
string
true
none
Specifies the payment file type.
»» FileHash
string
true
none
A base64 encoding of a SHA256 hash of the file to be uploaded.
»» FileReference
string
false
none
Reference for the file.
»» NumberOfTransactions
string
false
none
Number of individual transactions contained in the payment information group.
»» ControlSum
number
false
none
Total of all individual amounts included in the group, irrespective of currencies.
»» RequestedExecutionDateTime
string(date-time)
false
none
Date at which the initiating party requests the clearing agent to process the payment. Usage: This is the date on which the debtor's account is to be debited.All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00
User community specific instrument. Usage: This element is used to specify a local instrument, local clearing option and/or further qualify the service or service level.
»» DebtorAccount
object
false
none
Unambiguous identification of the account of the debtor to which a debit entry will be made as a result of the transaction.
Identification assigned by an institution to identify an account. This identification is known by the account owner.
»»» Name
string
false
none
The account name is the name or names of the account owner(s) represented at an account level, as displayed by the ASPSP's online channels. Note, the account name is not the product name or the nickname of the account.
This is secondary identification of the account, as assigned by the account servicing institution. This can be used by building societies to additionally identify accounts with a roll number (in addition to a sort code and account number combination).
»» RemittanceInformation
object
false
none
Information supplied to enable the matching of an entry with the items that the transfer is intended to settle, such as commercial invoices in an accounts' receivable system.
»»» Unstructured
string
false
none
Information supplied to enable the matching/reconciliation of an entry with the items that the payment is intended to settle, such as commercial invoices in an accounts' receivable system, in an unstructured form.
»»» Reference
string
false
none
Unique reference, as assigned by the creditor, to unambiguously refer to the payment transaction. Usage: If available, the initiating party should provide this reference in the structured remittance information, to enable reconciliation by the creditor upon receipt of the amount of money. If the business context requires the use of a creditor reference or a payment remit identification, and only one identifier can be passed through the end-to-end chain, the creditor's reference or payment remittance identification should be quoted in the end-to-end transaction identification. OB: The Faster Payments Scheme can only accept 18 characters for the ReferenceInformation field - which is where this ISO field will be mapped.
Additional information that can not be captured in the structured fields and/or any other specific block.
» MultiAuthorisation
object
false
none
The multiple authorisation flow response from the ASPSP.
»» Status
string
true
none
Specifies the status of the authorisation flow in code form.
»» NumberRequired
integer
false
none
Number of authorisations required for payment order (total required at the start of the multi authorisation journey).
»» NumberReceived
integer
false
none
Number of authorisations received.
»» LastUpdateDateTime
string(date-time)
false
none
Last date and time at the authorisation flow was updated.All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00
»» ExpirationDateTime
string(date-time)
false
none
Date and time at which the requested authorisation flow must be completed.All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00
Date and time at which the funds availability check was generated.All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00
»» FundsAvailable
boolean
true
none
Flag to indicate the availability of funds given the Amount in the consent request.
OB: Unique identification as assigned by the ASPSP to uniquely identify the consent resource.
» Initiation
object
true
none
The Initiation payload is sent by the initiating party to the ASPSP. It is used to request movement of funds from the debtor account to a creditor for a single international payment.
»» InstructionIdentification
string
true
none
Unique identification as assigned by an instructing party for an instructed party to unambiguously identify the instruction. Usage: the instruction identification is a point to point reference that can be used between the instructing party and the instructed party to refer to the individual instruction. It can be included in several messages related to the instruction.
»» EndToEndIdentification
string
true
none
Unique identification assigned by the initiating party to unambiguously identify the transaction. This identification is passed on, unchanged, throughout the entire end-to-end chain. Usage: The end-to-end identification can be used for reconciliation or to link tasks relating to the transaction. It can be included in several messages related to the transaction. OB: The Faster Payments Scheme can only access 31 characters for the EndToEndIdentification field.
User community specific instrument. Usage: This element is used to specify a local instrument, local clearing option and/or further qualify the service or service level.
»» InstructionPriority
string
false
none
Indicator of the urgency or order of importance that the instructing party would like the instructed party to apply to the processing of the instruction.
»» Purpose
string
false
none
Specifies the external purpose code in the format of character string with a maximum length of 4 characters. The list of valid codes is an external code list published separately. External code sets can be downloaded from www.iso20022.org.
Specifies which party/parties will bear the charges associated with the processing of the payment transaction.
»» CurrencyOfTransfer
string
true
none
Specifies the currency of the to be transferred amount, which is different from the currency of the debtor's account.
»» InstructedAmount
object
true
none
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. Usage: This amount has to be transported unchanged through the transaction chain.
A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 "Codes for the representation of currencies and funds".
»» ExchangeRateInformation
object
false
none
Provides details on the currency exchange rate and contract.
»»» UnitCurrency
string
true
none
Currency in which the rate of exchange is expressed in a currency exchange. In the example 1GBP = xxxCUR, the unit currency is GBP.
»»» ExchangeRate
number
false
none
The factor used for conversion of an amount from one currency to another. This reflects the price at which one currency was bought with another currency.
»»» RateType
string
true
none
Specifies the type used to complete the currency exchange.
»»» ContractIdentification
string
false
none
Unique and unambiguous reference to the foreign exchange contract agreed between the initiating party/creditor and the debtor agent.
»» DebtorAccount
object
false
none
Unambiguous identification of the account of the debtor to which a debit entry will be made as a result of the transaction.
Identification assigned by an institution to identify an account. This identification is known by the account owner.
»»» Name
string
false
none
The account name is the name or names of the account owner(s) represented at an account level, as displayed by the ASPSP's online channels. Note, the account name is not the product name or the nickname of the account.
This is secondary identification of the account, as assigned by the account servicing institution. This can be used by building societies to additionally identify accounts with a roll number (in addition to a sort code and account number combination).
»» Creditor
object
false
none
Party to which an amount of money is due.
»»» Name
string
false
none
Name by which a party is known and which is usually used to identify that party.
Identification assigned by an institution to identify an account. This identification is known by the account owner.
»»» Name
string
true
none
The account name is the name or names of the account owner(s) represented at an account level. Note, the account name is not the product name or the nickname of the account. OB: ASPSPs may carry out name validation for Confirmation of Payee, but it is not mandatory.
This is secondary identification of the account, as assigned by the account servicing institution. This can be used by building societies to additionally identify accounts with a roll number (in addition to a sort code and account number combination).
»» RemittanceInformation
object
false
none
Information supplied to enable the matching of an entry with the items that the transfer is intended to settle, such as commercial invoices in an accounts' receivable system.
»»» Unstructured
string
false
none
Information supplied to enable the matching/reconciliation of an entry with the items that the payment is intended to settle, such as commercial invoices in an accounts' receivable system, in an unstructured form.
»»» Reference
string
false
none
Unique reference, as assigned by the creditor, to unambiguously refer to the payment transaction. Usage: If available, the initiating party should provide this reference in the structured remittance information, to enable reconciliation by the creditor upon receipt of the amount of money. If the business context requires the use of a creditor reference or a payment remit identification, and only one identifier can be passed through the end-to-end chain, the creditor's reference or payment remittance identification should be quoted in the end-to-end transaction identification. OB: The Faster Payments Scheme can only accept 18 characters for the ReferenceInformation field - which is where this ISO field will be mapped.
The Initiation payload is sent by the initiating party to the ASPSP. It is used to request movement of funds from the debtor account to a creditor for a single international payment.
»» InstructionIdentification
string
true
none
Unique identification as assigned by an instructing party for an instructed party to unambiguously identify the instruction. Usage: the instruction identification is a point to point reference that can be used between the instructing party and the instructed party to refer to the individual instruction. It can be included in several messages related to the instruction.
»» EndToEndIdentification
string
true
none
Unique identification assigned by the initiating party to unambiguously identify the transaction. This identification is passed on, unchanged, throughout the entire end-to-end chain. Usage: The end-to-end identification can be used for reconciliation or to link tasks relating to the transaction. It can be included in several messages related to the transaction. OB: The Faster Payments Scheme can only access 31 characters for the EndToEndIdentification field.
User community specific instrument. Usage: This element is used to specify a local instrument, local clearing option and/or further qualify the service or service level.
»» InstructionPriority
string
false
none
Indicator of the urgency or order of importance that the instructing party would like the instructed party to apply to the processing of the instruction.
»» Purpose
string
false
none
Specifies the external purpose code in the format of character string with a maximum length of 4 characters. The list of valid codes is an external code list published separately. External code sets can be downloaded from www.iso20022.org.
Specifies which party/parties will bear the charges associated with the processing of the payment transaction.
»» CurrencyOfTransfer
string
true
none
Specifies the currency of the to be transferred amount, which is different from the currency of the debtor's account.
»» InstructedAmount
object
true
none
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. Usage: This amount has to be transported unchanged through the transaction chain.
A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 "Codes for the representation of currencies and funds".
»» ExchangeRateInformation
object
false
none
Provides details on the currency exchange rate and contract.
»»» UnitCurrency
string
true
none
Currency in which the rate of exchange is expressed in a currency exchange. In the example 1GBP = xxxCUR, the unit currency is GBP.
»»» ExchangeRate
number
false
none
The factor used for conversion of an amount from one currency to another. This reflects the price at which one currency was bought with another currency.
»»» RateType
string
true
none
Specifies the type used to complete the currency exchange.
»»» ContractIdentification
string
false
none
Unique and unambiguous reference to the foreign exchange contract agreed between the initiating party/creditor and the debtor agent.
»» DebtorAccount
object
false
none
Unambiguous identification of the account of the debtor to which a debit entry will be made as a result of the transaction.
Identification assigned by an institution to identify an account. This identification is known by the account owner.
»»» Name
string
false
none
The account name is the name or names of the account owner(s) represented at an account level, as displayed by the ASPSP's online channels. Note, the account name is not the product name or the nickname of the account.
This is secondary identification of the account, as assigned by the account servicing institution. This can be used by building societies to additionally identify accounts with a roll number (in addition to a sort code and account number combination).
»» Creditor
object
false
none
Party to which an amount of money is due.
»»» Name
string
false
none
Name by which a party is known and which is usually used to identify that party.
Identification assigned by an institution to identify an account. This identification is known by the account owner.
»»» Name
string
true
none
The account name is the name or names of the account owner(s) represented at an account level. Note, the account name is not the product name or the nickname of the account. OB: ASPSPs may carry out name validation for Confirmation of Payee, but it is not mandatory.
This is secondary identification of the account, as assigned by the account servicing institution. This can be used by building societies to additionally identify accounts with a roll number (in addition to a sort code and account number combination).
»» RemittanceInformation
object
false
none
Information supplied to enable the matching of an entry with the items that the transfer is intended to settle, such as commercial invoices in an accounts' receivable system.
»»» Unstructured
string
false
none
Information supplied to enable the matching/reconciliation of an entry with the items that the payment is intended to settle, such as commercial invoices in an accounts' receivable system, in an unstructured form.
»»» Reference
string
false
none
Unique reference, as assigned by the creditor, to unambiguously refer to the payment transaction. Usage: If available, the initiating party should provide this reference in the structured remittance information, to enable reconciliation by the creditor upon receipt of the amount of money. If the business context requires the use of a creditor reference or a payment remit identification, and only one identifier can be passed through the end-to-end chain, the creditor's reference or payment remittance identification should be quoted in the end-to-end transaction identification. OB: The Faster Payments Scheme can only accept 18 characters for the ReferenceInformation field - which is where this ISO field will be mapped.
Additional information that can not be captured in the structured fields and/or any other specific block.
» Authorisation
object
false
none
The authorisation type request from the TPP.
»» AuthorisationType
string
true
none
Type of authorisation flow requested.
»» CompletionDateTime
string(date-time)
false
none
Date and time at which the requested authorisation flow must be completed.All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00
» SCASupportData
object
false
none
Supporting Data provided by TPP, when requesting SCA Exemption.
»» RequestedSCAExemptionType
string
false
none
This field allows a PISP to request specific SCA Exemption for a Payment Initiation
»» AppliedAuthenticationApproach
string
false
none
Specifies a character string with a maximum length of 40 characters. Usage: This field indicates whether the PSU was subject to SCA performed by the TPP
»» ReferencePaymentOrderId
string
false
none
Specifies a character string with a maximum length of 140 characters. Usage: If the payment is recurring then the transaction identifier of the previous payment occurrence so that the ASPSP can verify that the PISP, amount and the payee are the same as the previous occurrence.
OB: Unique identification as assigned by the ASPSP to uniquely identify the consent resource.
» CreationDateTime
string(date-time)
true
none
Date and time at which the resource was created.All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00
» Status
string
true
none
Specifies the status of consent resource in code form.
» StatusUpdateDateTime
string(date-time)
true
none
Date and time at which the resource status was updated.All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00
» CutOffDateTime
string(date-time)
false
none
Specified cut-off date and time for the payment consent.All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00
» ExpectedExecutionDateTime
string(date-time)
false
none
Expected execution date and time for the payment resource.All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00
» ExpectedSettlementDateTime
string(date-time)
false
none
Expected settlement date and time for the payment resource.All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00
Further detailed information on the exchange rate that has been used in the payment transaction.
»» UnitCurrency
string
true
none
Currency in which the rate of exchange is expressed in a currency exchange. In the example 1GBP = xxxCUR, the unit currency is GBP.
»» ExchangeRate
number
true
none
The factor used for conversion of an amount from one currency to another. This reflects the price at which one currency was bought with another currency.
»» RateType
string
true
none
Specifies the type used to complete the currency exchange.
»» ContractIdentification
string
false
none
Unique and unambiguous reference to the foreign exchange contract agreed between the initiating party/creditor and the debtor agent.
»» ExpirationDateTime
string(date-time)
false
none
Specified date and time the exchange rate agreement will expire.All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00
» Initiation
object
true
none
The Initiation payload is sent by the initiating party to the ASPSP. It is used to request movement of funds from the debtor account to a creditor for a single international payment.
»» InstructionIdentification
string
true
none
Unique identification as assigned by an instructing party for an instructed party to unambiguously identify the instruction. Usage: the instruction identification is a point to point reference that can be used between the instructing party and the instructed party to refer to the individual instruction. It can be included in several messages related to the instruction.
»» EndToEndIdentification
string
true
none
Unique identification assigned by the initiating party to unambiguously identify the transaction. This identification is passed on, unchanged, throughout the entire end-to-end chain. Usage: The end-to-end identification can be used for reconciliation or to link tasks relating to the transaction. It can be included in several messages related to the transaction. OB: The Faster Payments Scheme can only access 31 characters for the EndToEndIdentification field.
User community specific instrument. Usage: This element is used to specify a local instrument, local clearing option and/or further qualify the service or service level.
»» InstructionPriority
string
false
none
Indicator of the urgency or order of importance that the instructing party would like the instructed party to apply to the processing of the instruction.
»» Purpose
string
false
none
Specifies the external purpose code in the format of character string with a maximum length of 4 characters. The list of valid codes is an external code list published separately. External code sets can be downloaded from www.iso20022.org.
Specifies which party/parties will bear the charges associated with the processing of the payment transaction.
»» CurrencyOfTransfer
string
true
none
Specifies the currency of the to be transferred amount, which is different from the currency of the debtor's account.
»» InstructedAmount
object
true
none
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. Usage: This amount has to be transported unchanged through the transaction chain.
A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 "Codes for the representation of currencies and funds".
»» ExchangeRateInformation
object
false
none
Provides details on the currency exchange rate and contract.
»»» UnitCurrency
string
true
none
Currency in which the rate of exchange is expressed in a currency exchange. In the example 1GBP = xxxCUR, the unit currency is GBP.
»»» ExchangeRate
number
false
none
The factor used for conversion of an amount from one currency to another. This reflects the price at which one currency was bought with another currency.
»»» RateType
string
true
none
Specifies the type used to complete the currency exchange.
»»» ContractIdentification
string
false
none
Unique and unambiguous reference to the foreign exchange contract agreed between the initiating party/creditor and the debtor agent.
»» DebtorAccount
object
false
none
Unambiguous identification of the account of the debtor to which a debit entry will be made as a result of the transaction.
Identification assigned by an institution to identify an account. This identification is known by the account owner.
»»» Name
string
false
none
The account name is the name or names of the account owner(s) represented at an account level, as displayed by the ASPSP's online channels. Note, the account name is not the product name or the nickname of the account.
This is secondary identification of the account, as assigned by the account servicing institution. This can be used by building societies to additionally identify accounts with a roll number (in addition to a sort code and account number combination).
»» Creditor
object
false
none
Party to which an amount of money is due.
»»» Name
string
false
none
Name by which a party is known and which is usually used to identify that party.
Identification assigned by an institution to identify an account. This identification is known by the account owner.
»»» Name
string
true
none
The account name is the name or names of the account owner(s) represented at an account level. Note, the account name is not the product name or the nickname of the account. OB: ASPSPs may carry out name validation for Confirmation of Payee, but it is not mandatory.
This is secondary identification of the account, as assigned by the account servicing institution. This can be used by building societies to additionally identify accounts with a roll number (in addition to a sort code and account number combination).
»» RemittanceInformation
object
false
none
Information supplied to enable the matching of an entry with the items that the transfer is intended to settle, such as commercial invoices in an accounts' receivable system.
»»» Unstructured
string
false
none
Information supplied to enable the matching/reconciliation of an entry with the items that the payment is intended to settle, such as commercial invoices in an accounts' receivable system, in an unstructured form.
»»» Reference
string
false
none
Unique reference, as assigned by the creditor, to unambiguously refer to the payment transaction. Usage: If available, the initiating party should provide this reference in the structured remittance information, to enable reconciliation by the creditor upon receipt of the amount of money. If the business context requires the use of a creditor reference or a payment remit identification, and only one identifier can be passed through the end-to-end chain, the creditor's reference or payment remittance identification should be quoted in the end-to-end transaction identification. OB: The Faster Payments Scheme can only accept 18 characters for the ReferenceInformation field - which is where this ISO field will be mapped.
Additional information that can not be captured in the structured fields and/or any other specific block.
» Authorisation
object
false
none
The authorisation type request from the TPP.
»» AuthorisationType
string
true
none
Type of authorisation flow requested.
»» CompletionDateTime
string(date-time)
false
none
Date and time at which the requested authorisation flow must be completed.All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00
» SCASupportData
object
false
none
Supporting Data provided by TPP, when requesting SCA Exemption.
»» RequestedSCAExemptionType
string
false
none
This field allows a PISP to request specific SCA Exemption for a Payment Initiation
»» AppliedAuthenticationApproach
string
false
none
Specifies a character string with a maximum length of 40 characters. Usage: This field indicates whether the PSU was subject to SCA performed by the TPP
»» ReferencePaymentOrderId
string
false
none
Specifies a character string with a maximum length of 140 characters. Usage: If the payment is recurring then the transaction identifier of the previous payment occurrence so that the ASPSP can verify that the PISP, amount and the payee are the same as the previous occurrence.
OB: Unique identification as assigned by the ASPSP to uniquely identify the international payment resource.
» ConsentId
string
true
none
OB: Unique identification as assigned by the ASPSP to uniquely identify the consent resource.
» CreationDateTime
string(date-time)
true
none
Date and time at which the message was created.All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00
» Status
string
true
none
Specifies the status of the payment information group.
» StatusUpdateDateTime
string(date-time)
true
none
Date and time at which the resource status was updated.All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00
» ExpectedExecutionDateTime
string(date-time)
false
none
Expected execution date and time for the payment resource.All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00
» ExpectedSettlementDateTime
string(date-time)
false
none
Expected settlement date and time for the payment resource.All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00
Further detailed information on the exchange rate that has been used in the payment transaction.
»» UnitCurrency
string
true
none
Currency in which the rate of exchange is expressed in a currency exchange. In the example 1GBP = xxxCUR, the unit currency is GBP.
»» ExchangeRate
number
true
none
The factor used for conversion of an amount from one currency to another. This reflects the price at which one currency was bought with another currency.
»» RateType
string
true
none
Specifies the type used to complete the currency exchange.
»» ContractIdentification
string
false
none
Unique and unambiguous reference to the foreign exchange contract agreed between the initiating party/creditor and the debtor agent.
»» ExpirationDateTime
string(date-time)
false
none
Specified date and time the exchange rate agreement will expire.All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00
» Initiation
object
true
none
The Initiation payload is sent by the initiating party to the ASPSP. It is used to request movement of funds from the debtor account to a creditor for a single international payment.
»» InstructionIdentification
string
true
none
Unique identification as assigned by an instructing party for an instructed party to unambiguously identify the instruction. Usage: the instruction identification is a point to point reference that can be used between the instructing party and the instructed party to refer to the individual instruction. It can be included in several messages related to the instruction.
»» EndToEndIdentification
string
true
none
Unique identification assigned by the initiating party to unambiguously identify the transaction. This identification is passed on, unchanged, throughout the entire end-to-end chain. Usage: The end-to-end identification can be used for reconciliation or to link tasks relating to the transaction. It can be included in several messages related to the transaction. OB: The Faster Payments Scheme can only access 31 characters for the EndToEndIdentification field.
User community specific instrument. Usage: This element is used to specify a local instrument, local clearing option and/or further qualify the service or service level.
»» InstructionPriority
string
false
none
Indicator of the urgency or order of importance that the instructing party would like the instructed party to apply to the processing of the instruction.
»» Purpose
string
false
none
Specifies the external purpose code in the format of character string with a maximum length of 4 characters. The list of valid codes is an external code list published separately. External code sets can be downloaded from www.iso20022.org.
Specifies which party/parties will bear the charges associated with the processing of the payment transaction.
»» CurrencyOfTransfer
string
true
none
Specifies the currency of the to be transferred amount, which is different from the currency of the debtor's account.
»» InstructedAmount
object
true
none
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. Usage: This amount has to be transported unchanged through the transaction chain.
A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 "Codes for the representation of currencies and funds".
»» ExchangeRateInformation
object
false
none
Provides details on the currency exchange rate and contract.
»»» UnitCurrency
string
true
none
Currency in which the rate of exchange is expressed in a currency exchange. In the example 1GBP = xxxCUR, the unit currency is GBP.
»»» ExchangeRate
number
false
none
The factor used for conversion of an amount from one currency to another. This reflects the price at which one currency was bought with another currency.
»»» RateType
string
true
none
Specifies the type used to complete the currency exchange.
»»» ContractIdentification
string
false
none
Unique and unambiguous reference to the foreign exchange contract agreed between the initiating party/creditor and the debtor agent.
»» DebtorAccount
object
false
none
Unambiguous identification of the account of the debtor to which a debit entry will be made as a result of the transaction.
Identification assigned by an institution to identify an account. This identification is known by the account owner.
»»» Name
string
false
none
The account name is the name or names of the account owner(s) represented at an account level, as displayed by the ASPSP's online channels. Note, the account name is not the product name or the nickname of the account.
This is secondary identification of the account, as assigned by the account servicing institution. This can be used by building societies to additionally identify accounts with a roll number (in addition to a sort code and account number combination).
»» Creditor
object
false
none
Party to which an amount of money is due.
»»» Name
string
false
none
Name by which a party is known and which is usually used to identify that party.
Identification assigned by an institution to identify an account. This identification is known by the account owner.
»»» Name
string
true
none
The account name is the name or names of the account owner(s) represented at an account level. Note, the account name is not the product name or the nickname of the account. OB: ASPSPs may carry out name validation for Confirmation of Payee, but it is not mandatory.
This is secondary identification of the account, as assigned by the account servicing institution. This can be used by building societies to additionally identify accounts with a roll number (in addition to a sort code and account number combination).
»» RemittanceInformation
object
false
none
Information supplied to enable the matching of an entry with the items that the transfer is intended to settle, such as commercial invoices in an accounts' receivable system.
»»» Unstructured
string
false
none
Information supplied to enable the matching/reconciliation of an entry with the items that the payment is intended to settle, such as commercial invoices in an accounts' receivable system, in an unstructured form.
»»» Reference
string
false
none
Unique reference, as assigned by the creditor, to unambiguously refer to the payment transaction. Usage: If available, the initiating party should provide this reference in the structured remittance information, to enable reconciliation by the creditor upon receipt of the amount of money. If the business context requires the use of a creditor reference or a payment remit identification, and only one identifier can be passed through the end-to-end chain, the creditor's reference or payment remittance identification should be quoted in the end-to-end transaction identification. OB: The Faster Payments Scheme can only accept 18 characters for the ReferenceInformation field - which is where this ISO field will be mapped.
Additional information that can not be captured in the structured fields and/or any other specific block.
» MultiAuthorisation
object
false
none
The multiple authorisation flow response from the ASPSP.
»» Status
string
true
none
Specifies the status of the authorisation flow in code form.
»» NumberRequired
integer
false
none
Number of authorisations required for payment order (total required at the start of the multi authorisation journey).
»» NumberReceived
integer
false
none
Number of authorisations received.
»» LastUpdateDateTime
string(date-time)
false
none
Last date and time at the authorisation flow was updated.All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00
»» ExpirationDateTime
string(date-time)
false
none
Date and time at which the requested authorisation flow must be completed.All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00
OB: Unique identification as assigned by the ASPSP to uniquely identify the consent resource.
» Initiation
object
true
none
The Initiation payload is sent by the initiating party to the ASPSP. It is used to request movement of funds from the debtor account to a creditor for a single scheduled international payment.
»» InstructionIdentification
string
true
none
Unique identification as assigned by an instructing party for an instructed party to unambiguously identify the instruction. Usage: the instruction identification is a point to point reference that can be used between the instructing party and the instructed party to refer to the individual instruction. It can be included in several messages related to the instruction.
»» EndToEndIdentification
string
false
none
Unique identification assigned by the initiating party to unambiguously identify the transaction. This identification is passed on, unchanged, throughout the entire end-to-end chain. Usage: The end-to-end identification can be used for reconciliation or to link tasks relating to the transaction. It can be included in several messages related to the transaction. OB: The Faster Payments Scheme can only access 31 characters for the EndToEndIdentification field.
User community specific instrument. Usage: This element is used to specify a local instrument, local clearing option and/or further qualify the service or service level.
»» InstructionPriority
string
false
none
Indicator of the urgency or order of importance that the instructing party would like the instructed party to apply to the processing of the instruction.
»» Purpose
string
false
none
Specifies the external purpose code in the format of character string with a maximum length of 4 characters. The list of valid codes is an external code list published separately. External code sets can be downloaded from www.iso20022.org.
Specifies which party/parties will bear the charges associated with the processing of the payment transaction.
»» RequestedExecutionDateTime
string(date-time)
true
none
Date at which the initiating party requests the clearing agent to process the payment. Usage: This is the date on which the debtor's account is to be debited.All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00
»» CurrencyOfTransfer
string
true
none
Specifies the currency of the to be transferred amount, which is different from the currency of the debtor's account.
»» InstructedAmount
object
true
none
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. Usage: This amount has to be transported unchanged through the transaction chain.
A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 "Codes for the representation of currencies and funds".
»» ExchangeRateInformation
object
false
none
Provides details on the currency exchange rate and contract.
»»» UnitCurrency
string
true
none
Currency in which the rate of exchange is expressed in a currency exchange. In the example 1GBP = xxxCUR, the unit currency is GBP.
»»» ExchangeRate
number
false
none
The factor used for conversion of an amount from one currency to another. This reflects the price at which one currency was bought with another currency.
»»» RateType
string
true
none
Specifies the type used to complete the currency exchange.
»»» ContractIdentification
string
false
none
Unique and unambiguous reference to the foreign exchange contract agreed between the initiating party/creditor and the debtor agent.
»» DebtorAccount
object
false
none
Unambiguous identification of the account of the debtor to which a debit entry will be made as a result of the transaction.
Identification assigned by an institution to identify an account. This identification is known by the account owner.
»»» Name
string
false
none
The account name is the name or names of the account owner(s) represented at an account level, as displayed by the ASPSP's online channels. Note, the account name is not the product name or the nickname of the account.
This is secondary identification of the account, as assigned by the account servicing institution. This can be used by building societies to additionally identify accounts with a roll number (in addition to a sort code and account number combination).
»» Creditor
object
false
none
Party to which an amount of money is due.
»»» Name
string
false
none
Name by which a party is known and which is usually used to identify that party.
Identification assigned by an institution to identify an account. This identification is known by the account owner.
»»» Name
string
true
none
The account name is the name or names of the account owner(s) represented at an account level. Note, the account name is not the product name or the nickname of the account. OB: ASPSPs may carry out name validation for Confirmation of Payee, but it is not mandatory.
This is secondary identification of the account, as assigned by the account servicing institution. This can be used by building societies to additionally identify accounts with a roll number (in addition to a sort code and account number combination).
»» RemittanceInformation
object
false
none
Information supplied to enable the matching of an entry with the items that the transfer is intended to settle, such as commercial invoices in an accounts' receivable system.
»»» Unstructured
string
false
none
Information supplied to enable the matching/reconciliation of an entry with the items that the payment is intended to settle, such as commercial invoices in an accounts' receivable system, in an unstructured form.
»»» Reference
string
false
none
Unique reference, as assigned by the creditor, to unambiguously refer to the payment transaction. Usage: If available, the initiating party should provide this reference in the structured remittance information, to enable reconciliation by the creditor upon receipt of the amount of money. If the business context requires the use of a creditor reference or a payment remit identification, and only one identifier can be passed through the end-to-end chain, the creditor's reference or payment remittance identification should be quoted in the end-to-end transaction identification. OB: The Faster Payments Scheme can only accept 18 characters for the ReferenceInformation field - which is where this ISO field will be mapped.
The Initiation payload is sent by the initiating party to the ASPSP. It is used to request movement of funds from the debtor account to a creditor for a single scheduled international payment.
»» InstructionIdentification
string
true
none
Unique identification as assigned by an instructing party for an instructed party to unambiguously identify the instruction. Usage: the instruction identification is a point to point reference that can be used between the instructing party and the instructed party to refer to the individual instruction. It can be included in several messages related to the instruction.
»» EndToEndIdentification
string
false
none
Unique identification assigned by the initiating party to unambiguously identify the transaction. This identification is passed on, unchanged, throughout the entire end-to-end chain. Usage: The end-to-end identification can be used for reconciliation or to link tasks relating to the transaction. It can be included in several messages related to the transaction. OB: The Faster Payments Scheme can only access 31 characters for the EndToEndIdentification field.
User community specific instrument. Usage: This element is used to specify a local instrument, local clearing option and/or further qualify the service or service level.
»» InstructionPriority
string
false
none
Indicator of the urgency or order of importance that the instructing party would like the instructed party to apply to the processing of the instruction.
»» Purpose
string
false
none
Specifies the external purpose code in the format of character string with a maximum length of 4 characters. The list of valid codes is an external code list published separately. External code sets can be downloaded from www.iso20022.org.
Specifies which party/parties will bear the charges associated with the processing of the payment transaction.
»» RequestedExecutionDateTime
string(date-time)
true
none
Date at which the initiating party requests the clearing agent to process the payment. Usage: This is the date on which the debtor's account is to be debited.All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00
»» CurrencyOfTransfer
string
true
none
Specifies the currency of the to be transferred amount, which is different from the currency of the debtor's account.
»» InstructedAmount
object
true
none
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. Usage: This amount has to be transported unchanged through the transaction chain.
A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 "Codes for the representation of currencies and funds".
»» ExchangeRateInformation
object
false
none
Provides details on the currency exchange rate and contract.
»»» UnitCurrency
string
true
none
Currency in which the rate of exchange is expressed in a currency exchange. In the example 1GBP = xxxCUR, the unit currency is GBP.
»»» ExchangeRate
number
false
none
The factor used for conversion of an amount from one currency to another. This reflects the price at which one currency was bought with another currency.
»»» RateType
string
true
none
Specifies the type used to complete the currency exchange.
»»» ContractIdentification
string
false
none
Unique and unambiguous reference to the foreign exchange contract agreed between the initiating party/creditor and the debtor agent.
»» DebtorAccount
object
false
none
Unambiguous identification of the account of the debtor to which a debit entry will be made as a result of the transaction.
Identification assigned by an institution to identify an account. This identification is known by the account owner.
»»» Name
string
false
none
The account name is the name or names of the account owner(s) represented at an account level, as displayed by the ASPSP's online channels. Note, the account name is not the product name or the nickname of the account.
This is secondary identification of the account, as assigned by the account servicing institution. This can be used by building societies to additionally identify accounts with a roll number (in addition to a sort code and account number combination).
»» Creditor
object
false
none
Party to which an amount of money is due.
»»» Name
string
false
none
Name by which a party is known and which is usually used to identify that party.
Identification assigned by an institution to identify an account. This identification is known by the account owner.
»»» Name
string
true
none
The account name is the name or names of the account owner(s) represented at an account level. Note, the account name is not the product name or the nickname of the account. OB: ASPSPs may carry out name validation for Confirmation of Payee, but it is not mandatory.
This is secondary identification of the account, as assigned by the account servicing institution. This can be used by building societies to additionally identify accounts with a roll number (in addition to a sort code and account number combination).
»» RemittanceInformation
object
false
none
Information supplied to enable the matching of an entry with the items that the transfer is intended to settle, such as commercial invoices in an accounts' receivable system.
»»» Unstructured
string
false
none
Information supplied to enable the matching/reconciliation of an entry with the items that the payment is intended to settle, such as commercial invoices in an accounts' receivable system, in an unstructured form.
»»» Reference
string
false
none
Unique reference, as assigned by the creditor, to unambiguously refer to the payment transaction. Usage: If available, the initiating party should provide this reference in the structured remittance information, to enable reconciliation by the creditor upon receipt of the amount of money. If the business context requires the use of a creditor reference or a payment remit identification, and only one identifier can be passed through the end-to-end chain, the creditor's reference or payment remittance identification should be quoted in the end-to-end transaction identification. OB: The Faster Payments Scheme can only accept 18 characters for the ReferenceInformation field - which is where this ISO field will be mapped.
Additional information that can not be captured in the structured fields and/or any other specific block.
» Authorisation
object
false
none
The authorisation type request from the TPP.
»» AuthorisationType
string
true
none
Type of authorisation flow requested.
»» CompletionDateTime
string(date-time)
false
none
Date and time at which the requested authorisation flow must be completed.All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00
» SCASupportData
object
false
none
Supporting Data provided by TPP, when requesting SCA Exemption.
»» RequestedSCAExemptionType
string
false
none
This field allows a PISP to request specific SCA Exemption for a Payment Initiation
»» AppliedAuthenticationApproach
string
false
none
Specifies a character string with a maximum length of 40 characters. Usage: This field indicates whether the PSU was subject to SCA performed by the TPP
»» ReferencePaymentOrderId
string
false
none
Specifies a character string with a maximum length of 140 characters. Usage: If the payment is recurring then the transaction identifier of the previous payment occurrence so that the ASPSP can verify that the PISP, amount and the payee are the same as the previous occurrence.
OB: Unique identification as assigned by the ASPSP to uniquely identify the consent resource.
» CreationDateTime
string(date-time)
true
none
Date and time at which the resource was created.All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00
» Status
string
true
none
Specifies the status of consent resource in code form.
» StatusUpdateDateTime
string(date-time)
true
none
Date and time at which the resource status was updated.All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00
» Permission
string
true
none
Specifies the Open Banking service request types.
» CutOffDateTime
string(date-time)
false
none
Specified cut-off date and time for the payment consent.All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00
» ExpectedExecutionDateTime
string(date-time)
false
none
Expected execution date and time for the payment resource.All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00
» ExpectedSettlementDateTime
string(date-time)
false
none
Expected settlement date and time for the payment resource.All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00
Further detailed information on the exchange rate that has been used in the payment transaction.
»» UnitCurrency
string
true
none
Currency in which the rate of exchange is expressed in a currency exchange. In the example 1GBP = xxxCUR, the unit currency is GBP.
»» ExchangeRate
number
true
none
The factor used for conversion of an amount from one currency to another. This reflects the price at which one currency was bought with another currency.
»» RateType
string
true
none
Specifies the type used to complete the currency exchange.
»» ContractIdentification
string
false
none
Unique and unambiguous reference to the foreign exchange contract agreed between the initiating party/creditor and the debtor agent.
»» ExpirationDateTime
string(date-time)
false
none
Specified date and time the exchange rate agreement will expire.All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00
» Initiation
object
true
none
The Initiation payload is sent by the initiating party to the ASPSP. It is used to request movement of funds from the debtor account to a creditor for a single scheduled international payment.
»» InstructionIdentification
string
true
none
Unique identification as assigned by an instructing party for an instructed party to unambiguously identify the instruction. Usage: the instruction identification is a point to point reference that can be used between the instructing party and the instructed party to refer to the individual instruction. It can be included in several messages related to the instruction.
»» EndToEndIdentification
string
false
none
Unique identification assigned by the initiating party to unambiguously identify the transaction. This identification is passed on, unchanged, throughout the entire end-to-end chain. Usage: The end-to-end identification can be used for reconciliation or to link tasks relating to the transaction. It can be included in several messages related to the transaction. OB: The Faster Payments Scheme can only access 31 characters for the EndToEndIdentification field.
User community specific instrument. Usage: This element is used to specify a local instrument, local clearing option and/or further qualify the service or service level.
»» InstructionPriority
string
false
none
Indicator of the urgency or order of importance that the instructing party would like the instructed party to apply to the processing of the instruction.
»» Purpose
string
false
none
Specifies the external purpose code in the format of character string with a maximum length of 4 characters. The list of valid codes is an external code list published separately. External code sets can be downloaded from www.iso20022.org.
Specifies which party/parties will bear the charges associated with the processing of the payment transaction.
»» RequestedExecutionDateTime
string(date-time)
true
none
Date at which the initiating party requests the clearing agent to process the payment. Usage: This is the date on which the debtor's account is to be debited.All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00
»» CurrencyOfTransfer
string
true
none
Specifies the currency of the to be transferred amount, which is different from the currency of the debtor's account.
»» InstructedAmount
object
true
none
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. Usage: This amount has to be transported unchanged through the transaction chain.
A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 "Codes for the representation of currencies and funds".
»» ExchangeRateInformation
object
false
none
Provides details on the currency exchange rate and contract.
»»» UnitCurrency
string
true
none
Currency in which the rate of exchange is expressed in a currency exchange. In the example 1GBP = xxxCUR, the unit currency is GBP.
»»» ExchangeRate
number
false
none
The factor used for conversion of an amount from one currency to another. This reflects the price at which one currency was bought with another currency.
»»» RateType
string
true
none
Specifies the type used to complete the currency exchange.
»»» ContractIdentification
string
false
none
Unique and unambiguous reference to the foreign exchange contract agreed between the initiating party/creditor and the debtor agent.
»» DebtorAccount
object
false
none
Unambiguous identification of the account of the debtor to which a debit entry will be made as a result of the transaction.
Identification assigned by an institution to identify an account. This identification is known by the account owner.
»»» Name
string
false
none
The account name is the name or names of the account owner(s) represented at an account level, as displayed by the ASPSP's online channels. Note, the account name is not the product name or the nickname of the account.
This is secondary identification of the account, as assigned by the account servicing institution. This can be used by building societies to additionally identify accounts with a roll number (in addition to a sort code and account number combination).
»» Creditor
object
false
none
Party to which an amount of money is due.
»»» Name
string
false
none
Name by which a party is known and which is usually used to identify that party.
Identification assigned by an institution to identify an account. This identification is known by the account owner.
»»» Name
string
true
none
The account name is the name or names of the account owner(s) represented at an account level. Note, the account name is not the product name or the nickname of the account. OB: ASPSPs may carry out name validation for Confirmation of Payee, but it is not mandatory.
This is secondary identification of the account, as assigned by the account servicing institution. This can be used by building societies to additionally identify accounts with a roll number (in addition to a sort code and account number combination).
»» RemittanceInformation
object
false
none
Information supplied to enable the matching of an entry with the items that the transfer is intended to settle, such as commercial invoices in an accounts' receivable system.
»»» Unstructured
string
false
none
Information supplied to enable the matching/reconciliation of an entry with the items that the payment is intended to settle, such as commercial invoices in an accounts' receivable system, in an unstructured form.
»»» Reference
string
false
none
Unique reference, as assigned by the creditor, to unambiguously refer to the payment transaction. Usage: If available, the initiating party should provide this reference in the structured remittance information, to enable reconciliation by the creditor upon receipt of the amount of money. If the business context requires the use of a creditor reference or a payment remit identification, and only one identifier can be passed through the end-to-end chain, the creditor's reference or payment remittance identification should be quoted in the end-to-end transaction identification. OB: The Faster Payments Scheme can only accept 18 characters for the ReferenceInformation field - which is where this ISO field will be mapped.
Additional information that can not be captured in the structured fields and/or any other specific block.
» Authorisation
object
false
none
The authorisation type request from the TPP.
»» AuthorisationType
string
true
none
Type of authorisation flow requested.
»» CompletionDateTime
string(date-time)
false
none
Date and time at which the requested authorisation flow must be completed.All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00
» SCASupportData
object
false
none
Supporting Data provided by TPP, when requesting SCA Exemption.
»» RequestedSCAExemptionType
string
false
none
This field allows a PISP to request specific SCA Exemption for a Payment Initiation
»» AppliedAuthenticationApproach
string
false
none
Specifies a character string with a maximum length of 40 characters. Usage: This field indicates whether the PSU was subject to SCA performed by the TPP
»» ReferencePaymentOrderId
string
false
none
Specifies a character string with a maximum length of 140 characters. Usage: If the payment is recurring then the transaction identifier of the previous payment occurrence so that the ASPSP can verify that the PISP, amount and the payee are the same as the previous occurrence.
OB: Unique identification as assigned by the ASPSP to uniquely identify the international scheduled payment resource.
» ConsentId
string
true
none
OB: Unique identification as assigned by the ASPSP to uniquely identify the consent resource.
» CreationDateTime
string(date-time)
true
none
Date and time at which the message was created.All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00
» Status
string
true
none
Specifies the status of the payment order resource.
» StatusUpdateDateTime
string(date-time)
true
none
Date and time at which the resource status was updated.All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00
» ExpectedExecutionDateTime
string(date-time)
false
none
Expected execution date and time for the payment resource.All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00
» ExpectedSettlementDateTime
string(date-time)
false
none
Expected settlement date and time for the payment resource.All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00
Further detailed information on the exchange rate that has been used in the payment transaction.
»» UnitCurrency
string
true
none
Currency in which the rate of exchange is expressed in a currency exchange. In the example 1GBP = xxxCUR, the unit currency is GBP.
»» ExchangeRate
number
true
none
The factor used for conversion of an amount from one currency to another. This reflects the price at which one currency was bought with another currency.
»» RateType
string
true
none
Specifies the type used to complete the currency exchange.
»» ContractIdentification
string
false
none
Unique and unambiguous reference to the foreign exchange contract agreed between the initiating party/creditor and the debtor agent.
»» ExpirationDateTime
string(date-time)
false
none
Specified date and time the exchange rate agreement will expire.All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00
» Initiation
object
true
none
The Initiation payload is sent by the initiating party to the ASPSP. It is used to request movement of funds from the debtor account to a creditor for a single scheduled international payment.
»» InstructionIdentification
string
true
none
Unique identification as assigned by an instructing party for an instructed party to unambiguously identify the instruction. Usage: the instruction identification is a point to point reference that can be used between the instructing party and the instructed party to refer to the individual instruction. It can be included in several messages related to the instruction.
»» EndToEndIdentification
string
false
none
Unique identification assigned by the initiating party to unambiguously identify the transaction. This identification is passed on, unchanged, throughout the entire end-to-end chain. Usage: The end-to-end identification can be used for reconciliation or to link tasks relating to the transaction. It can be included in several messages related to the transaction. OB: The Faster Payments Scheme can only access 31 characters for the EndToEndIdentification field.
User community specific instrument. Usage: This element is used to specify a local instrument, local clearing option and/or further qualify the service or service level.
»» InstructionPriority
string
false
none
Indicator of the urgency or order of importance that the instructing party would like the instructed party to apply to the processing of the instruction.
»» Purpose
string
false
none
Specifies the external purpose code in the format of character string with a maximum length of 4 characters. The list of valid codes is an external code list published separately. External code sets can be downloaded from www.iso20022.org.
Specifies which party/parties will bear the charges associated with the processing of the payment transaction.
»» RequestedExecutionDateTime
string(date-time)
true
none
Date at which the initiating party requests the clearing agent to process the payment. Usage: This is the date on which the debtor's account is to be debited.All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00
»» CurrencyOfTransfer
string
true
none
Specifies the currency of the to be transferred amount, which is different from the currency of the debtor's account.
»» InstructedAmount
object
true
none
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. Usage: This amount has to be transported unchanged through the transaction chain.
A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 "Codes for the representation of currencies and funds".
»» ExchangeRateInformation
object
false
none
Provides details on the currency exchange rate and contract.
»»» UnitCurrency
string
true
none
Currency in which the rate of exchange is expressed in a currency exchange. In the example 1GBP = xxxCUR, the unit currency is GBP.
»»» ExchangeRate
number
false
none
The factor used for conversion of an amount from one currency to another. This reflects the price at which one currency was bought with another currency.
»»» RateType
string
true
none
Specifies the type used to complete the currency exchange.
»»» ContractIdentification
string
false
none
Unique and unambiguous reference to the foreign exchange contract agreed between the initiating party/creditor and the debtor agent.
»» DebtorAccount
object
false
none
Unambiguous identification of the account of the debtor to which a debit entry will be made as a result of the transaction.
Identification assigned by an institution to identify an account. This identification is known by the account owner.
»»» Name
string
false
none
The account name is the name or names of the account owner(s) represented at an account level, as displayed by the ASPSP's online channels. Note, the account name is not the product name or the nickname of the account.
This is secondary identification of the account, as assigned by the account servicing institution. This can be used by building societies to additionally identify accounts with a roll number (in addition to a sort code and account number combination).
»» Creditor
object
false
none
Party to which an amount of money is due.
»»» Name
string
false
none
Name by which a party is known and which is usually used to identify that party.
Identification assigned by an institution to identify an account. This identification is known by the account owner.
»»» Name
string
true
none
The account name is the name or names of the account owner(s) represented at an account level. Note, the account name is not the product name or the nickname of the account. OB: ASPSPs may carry out name validation for Confirmation of Payee, but it is not mandatory.
This is secondary identification of the account, as assigned by the account servicing institution. This can be used by building societies to additionally identify accounts with a roll number (in addition to a sort code and account number combination).
»» RemittanceInformation
object
false
none
Information supplied to enable the matching of an entry with the items that the transfer is intended to settle, such as commercial invoices in an accounts' receivable system.
»»» Unstructured
string
false
none
Information supplied to enable the matching/reconciliation of an entry with the items that the payment is intended to settle, such as commercial invoices in an accounts' receivable system, in an unstructured form.
»»» Reference
string
false
none
Unique reference, as assigned by the creditor, to unambiguously refer to the payment transaction. Usage: If available, the initiating party should provide this reference in the structured remittance information, to enable reconciliation by the creditor upon receipt of the amount of money. If the business context requires the use of a creditor reference or a payment remit identification, and only one identifier can be passed through the end-to-end chain, the creditor's reference or payment remittance identification should be quoted in the end-to-end transaction identification. OB: The Faster Payments Scheme can only accept 18 characters for the ReferenceInformation field - which is where this ISO field will be mapped.
Additional information that can not be captured in the structured fields and/or any other specific block.
» MultiAuthorisation
object
false
none
The multiple authorisation flow response from the ASPSP.
»» Status
string
true
none
Specifies the status of the authorisation flow in code form.
»» NumberRequired
integer
false
none
Number of authorisations required for payment order (total required at the start of the multi authorisation journey).
»» NumberReceived
integer
false
none
Number of authorisations received.
»» LastUpdateDateTime
string(date-time)
false
none
Last date and time at the authorisation flow was updated.All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00
»» ExpirationDateTime
string(date-time)
false
none
Date and time at which the requested authorisation flow must be completed.All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00
OB: Unique identification as assigned by the ASPSP to uniquely identify the consent resource.
» Initiation
object
true
none
The Initiation payload is sent by the initiating party to the ASPSP. It is used to request movement of funds from the debtor account to a creditor for an international standing order.
»» Frequency
string
true
none
Individual Definitions: EvryDay - Every day EvryWorkgDay - Every working day IntrvlWkDay - An interval specified in weeks (01 to 09), and the day within the week (01 to 07) WkInMnthDay - A monthly interval, specifying the week of the month (01 to 05) and day within the week (01 to 07) IntrvlMnthDay - An interval specified in months (between 01 to 06, 12, 24), specifying the day within the month (-5 to -1, 1 to 31) QtrDay - Quarterly (either ENGLISH, SCOTTISH, or RECEIVED). ENGLISH = Paid on the 25th March, 24th June, 29th September and 25th December. SCOTTISH = Paid on the 2nd February, 15th May, 1st August and 11th November. RECEIVED = Paid on the 20th March, 19th June, 24th September and 20th December. Individual Patterns: EvryDay (ScheduleCode) EvryWorkgDay (ScheduleCode) IntrvlWkDay:IntervalInWeeks:DayInWeek (ScheduleCode + IntervalInWeeks + DayInWeek) WkInMnthDay:WeekInMonth:DayInWeek (ScheduleCode + WeekInMonth + DayInWeek) IntrvlMnthDay:IntervalInMonths:DayInMonth (ScheduleCode + IntervalInMonths + DayInMonth) QtrDay: + either (ENGLISH, SCOTTISH or RECEIVED) ScheduleCode + QuarterDay The regular expression for this element combines five smaller versions for each permitted pattern. To aid legibility - the components are presented individually here: EvryDay EvryWorkgDay IntrvlWkDay:0[1-9]:0[1-7] WkInMnthDay:0[1-5]:0[1-7] IntrvlMnthDay:(0[1-6]
»» Reference
string
false
none
Unique reference, as assigned by the creditor, to unambiguously refer to the payment transaction. Usage: If available, the initiating party should provide this reference in the structured remittance information, to enable reconciliation by the creditor upon receipt of the amount of money. If the business context requires the use of a creditor reference or a payment remit identification, and only one identifier can be passed through the end-to-end chain, the creditor's reference or payment remittance identification should be quoted in the end-to-end transaction identification.
»» NumberOfPayments
string
false
none
Number of the payments that will be made in completing this frequency sequence including any executed since the sequence start date.
»» FirstPaymentDateTime
string(date-time)
true
none
The date on which the first payment for a Standing Order schedule will be made.All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00
»» FinalPaymentDateTime
string(date-time)
false
none
The date on which the final payment for a Standing Order schedule will be made.All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00
»» Purpose
string
false
none
Specifies the external purpose code in the format of character string with a maximum length of 4 characters. The list of valid codes is an external code list published separately. External code sets can be downloaded from www.iso20022.org.
Specifies which party/parties will bear the charges associated with the processing of the payment transaction.
»» CurrencyOfTransfer
string
true
none
Specifies the currency of the to be transferred amount, which is different from the currency of the debtor's account.
»» InstructedAmount
object
true
none
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. Usage: This amount has to be transported unchanged through the transaction chain.
A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 "Codes for the representation of currencies and funds".
»» DebtorAccount
object
false
none
Provides the details to identify the debtor account.
Identification assigned by an institution to identify an account. This identification is known by the account owner.
»»» Name
string
false
none
The account name is the name or names of the account owner(s) represented at an account level, as displayed by the ASPSP's online channels. Note, the account name is not the product name or the nickname of the account.
This is secondary identification of the account, as assigned by the account servicing institution. This can be used by building societies to additionally identify accounts with a roll number (in addition to a sort code and account number combination).
»» Creditor
object
false
none
Party to which an amount of money is due.
»»» Name
string
false
none
Name by which a party is known and which is usually used to identify that party.
Information that locates and identifies a specific address, as defined by postal services.
»» CreditorAgent
object
false
none
Party that manages the account on behalf of the account owner, that is manages the registration and booking of entries on the account, calculates balances on the account and provides information about the account. This is the servicer of the beneficiary account.
»»» SchemeName
string
false
none
Name of the identification scheme, in a coded form as published in an external list.
»»» Identification
string
false
none
Unique and unambiguous identification of the servicing institution.
»»» Name
string
false
none
Name by which an agent is known and which is usually used to identify that agent.
Identification assigned by an institution to identify an account. This identification is known by the account owner.
»»» Name
string
true
none
The account name is the name or names of the account owner(s) represented at an account level. Note, the account name is not the product name or the nickname of the account. OB: ASPSPs may carry out name validation for Confirmation of Payee, but it is not mandatory.
This is secondary identification of the account, as assigned by the account servicing institution. This can be used by building societies to additionally identify accounts with a roll number (in addition to a sort code and account number combination).
The Initiation payload is sent by the initiating party to the ASPSP. It is used to request movement of funds from the debtor account to a creditor for an international standing order.
»» Frequency
string
true
none
Individual Definitions: EvryDay - Every day EvryWorkgDay - Every working day IntrvlWkDay - An interval specified in weeks (01 to 09), and the day within the week (01 to 07) WkInMnthDay - A monthly interval, specifying the week of the month (01 to 05) and day within the week (01 to 07) IntrvlMnthDay - An interval specified in months (between 01 to 06, 12, 24), specifying the day within the month (-5 to -1, 1 to 31) QtrDay - Quarterly (either ENGLISH, SCOTTISH, or RECEIVED). ENGLISH = Paid on the 25th March, 24th June, 29th September and 25th December. SCOTTISH = Paid on the 2nd February, 15th May, 1st August and 11th November. RECEIVED = Paid on the 20th March, 19th June, 24th September and 20th December. Individual Patterns: EvryDay (ScheduleCode) EvryWorkgDay (ScheduleCode) IntrvlWkDay:IntervalInWeeks:DayInWeek (ScheduleCode + IntervalInWeeks + DayInWeek) WkInMnthDay:WeekInMonth:DayInWeek (ScheduleCode + WeekInMonth + DayInWeek) IntrvlMnthDay:IntervalInMonths:DayInMonth (ScheduleCode + IntervalInMonths + DayInMonth) QtrDay: + either (ENGLISH, SCOTTISH or RECEIVED) ScheduleCode + QuarterDay The regular expression for this element combines five smaller versions for each permitted pattern. To aid legibility - the components are presented individually here: EvryDay EvryWorkgDay IntrvlWkDay:0[1-9]:0[1-7] WkInMnthDay:0[1-5]:0[1-7] IntrvlMnthDay:(0[1-6]
»» Reference
string
false
none
Unique reference, as assigned by the creditor, to unambiguously refer to the payment transaction. Usage: If available, the initiating party should provide this reference in the structured remittance information, to enable reconciliation by the creditor upon receipt of the amount of money. If the business context requires the use of a creditor reference or a payment remit identification, and only one identifier can be passed through the end-to-end chain, the creditor's reference or payment remittance identification should be quoted in the end-to-end transaction identification.
»» NumberOfPayments
string
false
none
Number of the payments that will be made in completing this frequency sequence including any executed since the sequence start date.
»» FirstPaymentDateTime
string(date-time)
true
none
The date on which the first payment for a Standing Order schedule will be made.All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00
»» FinalPaymentDateTime
string(date-time)
false
none
The date on which the final payment for a Standing Order schedule will be made.All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00
»» Purpose
string
false
none
Specifies the external purpose code in the format of character string with a maximum length of 4 characters. The list of valid codes is an external code list published separately. External code sets can be downloaded from www.iso20022.org.
Specifies which party/parties will bear the charges associated with the processing of the payment transaction.
»» CurrencyOfTransfer
string
true
none
Specifies the currency of the to be transferred amount, which is different from the currency of the debtor's account.
»» InstructedAmount
object
true
none
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. Usage: This amount has to be transported unchanged through the transaction chain.
A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 "Codes for the representation of currencies and funds".
»» DebtorAccount
object
false
none
Provides the details to identify the debtor account.
Identification assigned by an institution to identify an account. This identification is known by the account owner.
»»» Name
string
false
none
The account name is the name or names of the account owner(s) represented at an account level, as displayed by the ASPSP's online channels. Note, the account name is not the product name or the nickname of the account.
This is secondary identification of the account, as assigned by the account servicing institution. This can be used by building societies to additionally identify accounts with a roll number (in addition to a sort code and account number combination).
»» Creditor
object
false
none
Party to which an amount of money is due.
»»» Name
string
false
none
Name by which a party is known and which is usually used to identify that party.
Information that locates and identifies a specific address, as defined by postal services.
»» CreditorAgent
object
false
none
Party that manages the account on behalf of the account owner, that is manages the registration and booking of entries on the account, calculates balances on the account and provides information about the account. This is the servicer of the beneficiary account.
»»» SchemeName
string
false
none
Name of the identification scheme, in a coded form as published in an external list.
»»» Identification
string
false
none
Unique and unambiguous identification of the servicing institution.
»»» Name
string
false
none
Name by which an agent is known and which is usually used to identify that agent.
Identification assigned by an institution to identify an account. This identification is known by the account owner.
»»» Name
string
true
none
The account name is the name or names of the account owner(s) represented at an account level. Note, the account name is not the product name or the nickname of the account. OB: ASPSPs may carry out name validation for Confirmation of Payee, but it is not mandatory.
This is secondary identification of the account, as assigned by the account servicing institution. This can be used by building societies to additionally identify accounts with a roll number (in addition to a sort code and account number combination).
Additional information that can not be captured in the structured fields and/or any other specific block.
» Authorisation
object
false
none
The authorisation type request from the TPP.
»» AuthorisationType
string
true
none
Type of authorisation flow requested.
»» CompletionDateTime
string(date-time)
false
none
Date and time at which the requested authorisation flow must be completed.All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00
» SCASupportData
object
false
none
Supporting Data provided by TPP, when requesting SCA Exemption.
»» RequestedSCAExemptionType
string
false
none
This field allows a PISP to request specific SCA Exemption for a Payment Initiation
»» AppliedAuthenticationApproach
string
false
none
Specifies a character string with a maximum length of 40 characters. Usage: This field indicates whether the PSU was subject to SCA performed by the TPP
»» ReferencePaymentOrderId
string
false
none
Specifies a character string with a maximum length of 140 characters. Usage: If the payment is recurring then the transaction identifier of the previous payment occurrence so that the ASPSP can verify that the PISP, amount and the payee are the same as the previous occurrence.
OB: Unique identification as assigned by the ASPSP to uniquely identify the consent resource.
» CreationDateTime
string(date-time)
true
none
Date and time at which the resource was created.All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00
» Status
string
true
none
Specifies the status of resource in code form.
» StatusUpdateDateTime
string(date-time)
true
none
Date and time at which the resource status was updated.All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00
» Permission
string
true
none
Specifies the Open Banking service request types.
» CutOffDateTime
string(date-time)
false
none
Specified cut-off date and time for the payment consent.All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00
The Initiation payload is sent by the initiating party to the ASPSP. It is used to request movement of funds from the debtor account to a creditor for an international standing order.
»» Frequency
string
true
none
Individual Definitions: EvryDay - Every day EvryWorkgDay - Every working day IntrvlWkDay - An interval specified in weeks (01 to 09), and the day within the week (01 to 07) WkInMnthDay - A monthly interval, specifying the week of the month (01 to 05) and day within the week (01 to 07) IntrvlMnthDay - An interval specified in months (between 01 to 06, 12, 24), specifying the day within the month (-5 to -1, 1 to 31) QtrDay - Quarterly (either ENGLISH, SCOTTISH, or RECEIVED). ENGLISH = Paid on the 25th March, 24th June, 29th September and 25th December. SCOTTISH = Paid on the 2nd February, 15th May, 1st August and 11th November. RECEIVED = Paid on the 20th March, 19th June, 24th September and 20th December. Individual Patterns: EvryDay (ScheduleCode) EvryWorkgDay (ScheduleCode) IntrvlWkDay:IntervalInWeeks:DayInWeek (ScheduleCode + IntervalInWeeks + DayInWeek) WkInMnthDay:WeekInMonth:DayInWeek (ScheduleCode + WeekInMonth + DayInWeek) IntrvlMnthDay:IntervalInMonths:DayInMonth (ScheduleCode + IntervalInMonths + DayInMonth) QtrDay: + either (ENGLISH, SCOTTISH or RECEIVED) ScheduleCode + QuarterDay The regular expression for this element combines five smaller versions for each permitted pattern. To aid legibility - the components are presented individually here: EvryDay EvryWorkgDay IntrvlWkDay:0[1-9]:0[1-7] WkInMnthDay:0[1-5]:0[1-7] IntrvlMnthDay:(0[1-6]
»» Reference
string
false
none
Unique reference, as assigned by the creditor, to unambiguously refer to the payment transaction. Usage: If available, the initiating party should provide this reference in the structured remittance information, to enable reconciliation by the creditor upon receipt of the amount of money. If the business context requires the use of a creditor reference or a payment remit identification, and only one identifier can be passed through the end-to-end chain, the creditor's reference or payment remittance identification should be quoted in the end-to-end transaction identification.
»» NumberOfPayments
string
false
none
Number of the payments that will be made in completing this frequency sequence including any executed since the sequence start date.
»» FirstPaymentDateTime
string(date-time)
true
none
The date on which the first payment for a Standing Order schedule will be made.All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00
»» FinalPaymentDateTime
string(date-time)
false
none
The date on which the final payment for a Standing Order schedule will be made.All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00
»» Purpose
string
false
none
Specifies the external purpose code in the format of character string with a maximum length of 4 characters. The list of valid codes is an external code list published separately. External code sets can be downloaded from www.iso20022.org.
Specifies which party/parties will bear the charges associated with the processing of the payment transaction.
»» CurrencyOfTransfer
string
true
none
Specifies the currency of the to be transferred amount, which is different from the currency of the debtor's account.
»» InstructedAmount
object
true
none
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. Usage: This amount has to be transported unchanged through the transaction chain.
A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 "Codes for the representation of currencies and funds".
»» DebtorAccount
object
false
none
Provides the details to identify the debtor account.
Identification assigned by an institution to identify an account. This identification is known by the account owner.
»»» Name
string
false
none
The account name is the name or names of the account owner(s) represented at an account level, as displayed by the ASPSP's online channels. Note, the account name is not the product name or the nickname of the account.
This is secondary identification of the account, as assigned by the account servicing institution. This can be used by building societies to additionally identify accounts with a roll number (in addition to a sort code and account number combination).
»» Creditor
object
false
none
Party to which an amount of money is due.
»»» Name
string
false
none
Name by which a party is known and which is usually used to identify that party.
Information that locates and identifies a specific address, as defined by postal services.
»» CreditorAgent
object
false
none
Party that manages the account on behalf of the account owner, that is manages the registration and booking of entries on the account, calculates balances on the account and provides information about the account. This is the servicer of the beneficiary account.
»»» SchemeName
string
false
none
Name of the identification scheme, in a coded form as published in an external list.
»»» Identification
string
false
none
Unique and unambiguous identification of the servicing institution.
»»» Name
string
false
none
Name by which an agent is known and which is usually used to identify that agent.
Identification assigned by an institution to identify an account. This identification is known by the account owner.
»»» Name
string
true
none
The account name is the name or names of the account owner(s) represented at an account level. Note, the account name is not the product name or the nickname of the account. OB: ASPSPs may carry out name validation for Confirmation of Payee, but it is not mandatory.
This is secondary identification of the account, as assigned by the account servicing institution. This can be used by building societies to additionally identify accounts with a roll number (in addition to a sort code and account number combination).
Additional information that can not be captured in the structured fields and/or any other specific block.
» Authorisation
object
false
none
The authorisation type request from the TPP.
»» AuthorisationType
string
true
none
Type of authorisation flow requested.
»» CompletionDateTime
string(date-time)
false
none
Date and time at which the requested authorisation flow must be completed.All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00
» SCASupportData
object
false
none
Supporting Data provided by TPP, when requesting SCA Exemption.
»» RequestedSCAExemptionType
string
false
none
This field allows a PISP to request specific SCA Exemption for a Payment Initiation
»» AppliedAuthenticationApproach
string
false
none
Specifies a character string with a maximum length of 40 characters. Usage: This field indicates whether the PSU was subject to SCA performed by the TPP
»» ReferencePaymentOrderId
string
false
none
Specifies a character string with a maximum length of 140 characters. Usage: If the payment is recurring then the transaction identifier of the previous payment occurrence so that the ASPSP can verify that the PISP, amount and the payee are the same as the previous occurrence.
OB: Unique identification as assigned by the ASPSP to uniquely identify the international standing order resource.
» ConsentId
string
true
none
OB: Unique identification as assigned by the ASPSP to uniquely identify the consent resource.
» CreationDateTime
string(date-time)
true
none
Date and time at which the resource was created.All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00
» Status
string
true
none
Specifies the status of resource in code form.
» StatusUpdateDateTime
string(date-time)
true
none
Date and time at which the resource status was updated.All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00
The Initiation payload is sent by the initiating party to the ASPSP. It is used to request movement of funds from the debtor account to a creditor for an international standing order.
»» Frequency
string
true
none
Individual Definitions: EvryDay - Every day EvryWorkgDay - Every working day IntrvlWkDay - An interval specified in weeks (01 to 09), and the day within the week (01 to 07) WkInMnthDay - A monthly interval, specifying the week of the month (01 to 05) and day within the week (01 to 07) IntrvlMnthDay - An interval specified in months (between 01 to 06, 12, 24), specifying the day within the month (-5 to -1, 1 to 31) QtrDay - Quarterly (either ENGLISH, SCOTTISH, or RECEIVED). ENGLISH = Paid on the 25th March, 24th June, 29th September and 25th December. SCOTTISH = Paid on the 2nd February, 15th May, 1st August and 11th November. RECEIVED = Paid on the 20th March, 19th June, 24th September and 20th December. Individual Patterns: EvryDay (ScheduleCode) EvryWorkgDay (ScheduleCode) IntrvlWkDay:IntervalInWeeks:DayInWeek (ScheduleCode + IntervalInWeeks + DayInWeek) WkInMnthDay:WeekInMonth:DayInWeek (ScheduleCode + WeekInMonth + DayInWeek) IntrvlMnthDay:IntervalInMonths:DayInMonth (ScheduleCode + IntervalInMonths + DayInMonth) QtrDay: + either (ENGLISH, SCOTTISH or RECEIVED) ScheduleCode + QuarterDay The regular expression for this element combines five smaller versions for each permitted pattern. To aid legibility - the components are presented individually here: EvryDay EvryWorkgDay IntrvlWkDay:0[1-9]:0[1-7] WkInMnthDay:0[1-5]:0[1-7] IntrvlMnthDay:(0[1-6]
»» Reference
string
false
none
Unique reference, as assigned by the creditor, to unambiguously refer to the payment transaction. Usage: If available, the initiating party should provide this reference in the structured remittance information, to enable reconciliation by the creditor upon receipt of the amount of money. If the business context requires the use of a creditor reference or a payment remit identification, and only one identifier can be passed through the end-to-end chain, the creditor's reference or payment remittance identification should be quoted in the end-to-end transaction identification.
»» NumberOfPayments
string
false
none
Number of the payments that will be made in completing this frequency sequence including any executed since the sequence start date.
»» FirstPaymentDateTime
string(date-time)
true
none
The date on which the first payment for a Standing Order schedule will be made.All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00
»» FinalPaymentDateTime
string(date-time)
false
none
The date on which the final payment for a Standing Order schedule will be made.All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00
»» Purpose
string
false
none
Specifies the external purpose code in the format of character string with a maximum length of 4 characters. The list of valid codes is an external code list published separately. External code sets can be downloaded from www.iso20022.org.
Specifies which party/parties will bear the charges associated with the processing of the payment transaction.
»» CurrencyOfTransfer
string
true
none
Specifies the currency of the to be transferred amount, which is different from the currency of the debtor's account.
»» InstructedAmount
object
true
none
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. Usage: This amount has to be transported unchanged through the transaction chain.
A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 "Codes for the representation of currencies and funds".
»» DebtorAccount
object
false
none
Provides the details to identify the debtor account.
Identification assigned by an institution to identify an account. This identification is known by the account owner.
»»» Name
string
false
none
The account name is the name or names of the account owner(s) represented at an account level, as displayed by the ASPSP's online channels. Note, the account name is not the product name or the nickname of the account.
This is secondary identification of the account, as assigned by the account servicing institution. This can be used by building societies to additionally identify accounts with a roll number (in addition to a sort code and account number combination).
»» Creditor
object
false
none
Party to which an amount of money is due.
»»» Name
string
false
none
Name by which a party is known and which is usually used to identify that party.
Information that locates and identifies a specific address, as defined by postal services.
»» CreditorAgent
object
false
none
Party that manages the account on behalf of the account owner, that is manages the registration and booking of entries on the account, calculates balances on the account and provides information about the account. This is the servicer of the beneficiary account.
»»» SchemeName
string
false
none
Name of the identification scheme, in a coded form as published in an external list.
»»» Identification
string
false
none
Unique and unambiguous identification of the servicing institution.
»»» Name
string
false
none
Name by which an agent is known and which is usually used to identify that agent.
Identification assigned by an institution to identify an account. This identification is known by the account owner.
»»» Name
string
true
none
The account name is the name or names of the account owner(s) represented at an account level. Note, the account name is not the product name or the nickname of the account. OB: ASPSPs may carry out name validation for Confirmation of Payee, but it is not mandatory.
This is secondary identification of the account, as assigned by the account servicing institution. This can be used by building societies to additionally identify accounts with a roll number (in addition to a sort code and account number combination).
Additional information that can not be captured in the structured fields and/or any other specific block.
» MultiAuthorisation
object
false
none
The multiple authorisation flow response from the ASPSP.
»» Status
string
true
none
Specifies the status of the authorisation flow in code form.
»» NumberRequired
integer
false
none
Number of authorisations required for payment order (total required at the start of the multi authorisation journey).
»» NumberReceived
integer
false
none
Number of authorisations received.
»» LastUpdateDateTime
string(date-time)
false
none
Last date and time at the authorisation flow was updated.All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00
»» ExpirationDateTime
string(date-time)
false
none
Date and time at which the requested authorisation flow must be completed.All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00
Unique identifier for the transaction within an servicing institution. This identifier is both unique and immutable.
»» Status
string
true
none
Status of a transfe, as assigned by the transaction administrator.
»» StatusUpdateDateTime
string(date-time)
true
none
Date and time at which the status was assigned to the transfer.All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00
»» StatusDetail
object
false
none
Payment status details as per underlying Payment Rail.
User community specific instrument. Usage: This element is used to specify a local instrument, local clearing option and/or further qualify the service or service level.
»»» Status
string
true
none
Status of a transfer, as assigned by the transaction administrator.
»»» StatusReason
string
false
none
Reason Code provided for the status of a transfer.
Identifier consisting of a group of letters and/or numbers that is added to a postal address to assist the sorting of mail.
Properties
Name
Type
Required
Restrictions
Description
anonymous
string
false
none
Identifier consisting of a group of letters and/or numbers that is added to a postal address to assist the sorting of mail.
SecondaryIdentification
"string"
This is secondary identification of the account, as assigned by the account servicing institution.
This can be used by building societies to additionally identify accounts with a roll number (in addition to a sort code and account number combination).
Properties
Name
Type
Required
Restrictions
Description
anonymous
string
false
none
This is secondary identification of the account, as assigned by the account servicing institution. This can be used by building societies to additionally identify accounts with a roll number (in addition to a sort code and account number combination).
StreetName
"string"
Name of a street or thoroughfare.
Properties
Name
Type
Required
Restrictions
Description
anonymous
string
false
none
Name of a street or thoroughfare.
SubDepartment
"string"
Identification of a sub-division of a large organisation or building.
Properties
Name
Type
Required
Restrictions
Description
anonymous
string
false
none
Identification of a sub-division of a large organisation or building.
TownName
"string"
Name of a built-up area, with defined boundaries, and a local government.
Properties
Name
Type
Required
Restrictions
Description
anonymous
string
false
none
Name of a built-up area, with defined boundaries, and a local government.
AccountId
"string"
A unique and immutable identifier used to identify the account resource. This identifier has no meaning to the account owner.
Properties
Name
Type
Required
Restrictions
Description
anonymous
string
false
none
A unique and immutable identifier used to identify the account resource. This identifier has no meaning to the account owner.
ActiveOrHistoricCurrencyCode_0
"string"
Identification of the currency in which the account is held.
Usage: Currency should only be used in case one and the same account number covers several currencies
and the initiating party needs to identify which currency needs to be used for settlement on the account.
Properties
Name
Type
Required
Restrictions
Description
anonymous
string
false
none
Identification of the currency in which the account is held. Usage: Currency should only be used in case one and the same account number covers several currencies and the initiating party needs to identify which currency needs to be used for settlement on the account.
ActiveOrHistoricCurrencyCode_1
"string"
A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 "Codes for the representation of currencies and funds".
Properties
Name
Type
Required
Restrictions
Description
anonymous
string
false
none
A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 "Codes for the representation of currencies and funds".
AddressLine
"string"
Information that locates and identifies a specific address for a transaction entry, that is presented in free format text.
Properties
Name
Type
Required
Restrictions
Description
anonymous
string
false
none
Information that locates and identifies a specific address for a transaction entry, that is presented in free format text.
BeneficiaryId
"string"
A unique and immutable identifier used to identify the beneficiary resource. This identifier has no meaning to the account owner.
Properties
Name
Type
Required
Restrictions
Description
anonymous
string
false
none
A unique and immutable identifier used to identify the beneficiary resource. This identifier has no meaning to the account owner.
BookingDateTime
"2020-10-23T10:23:58Z"
Date and time when a transaction entry is posted to an account on the account servicer's books.
Usage: Booking date is the expected booking date, unless the status is booked, in which case it is the actual booking date.All dates in the JSON payloads are represented in ISO 8601 date-time format.
All date-time fields in responses must include the timezone. An example is below:
2017-04-05T10:43:07+00:00
Properties
Name
Type
Required
Restrictions
Description
anonymous
string(date-time)
false
none
Date and time when a transaction entry is posted to an account on the account servicer's books. Usage: Booking date is the expected booking date, unless the status is booked, in which case it is the actual booking date.All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00
CreationDateTime
"2020-10-23T10:23:58Z"
Date and time at which the resource was created.All dates in the JSON payloads are represented in ISO 8601 date-time format.
All date-time fields in responses must include the timezone. An example is below:
2017-04-05T10:43:07+00:00
Properties
Name
Type
Required
Restrictions
Description
anonymous
string(date-time)
false
none
Date and time at which the resource was created.All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00
DateTime
"2020-10-23T10:23:58Z"
Date and time associated with the date time type.All dates in the JSON payloads are represented in ISO 8601 date-time format.
All date-time fields in responses must include the timezone. An example is below:
2017-04-05T10:43:07+00:00
Properties
Name
Type
Required
Restrictions
Description
anonymous
string(date-time)
false
none
Date and time associated with the date time type.All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00
Description_0
"string"
Specifies the description of the account type.
Properties
Name
Type
Required
Restrictions
Description
anonymous
string
false
none
Specifies the description of the account type.
Description_1
"string"
Description that may be available for the statement fee.
Properties
Name
Type
Required
Restrictions
Description
anonymous
string
false
none
Description that may be available for the statement fee.
Description_2
"string"
Description that may be available for the statement interest.
Properties
Name
Type
Required
Restrictions
Description
anonymous
string
false
none
Description that may be available for the statement interest.
Description_3
"string"
Description to describe the purpose of the code
Properties
Name
Type
Required
Restrictions
Description
anonymous
string
false
none
Description to describe the purpose of the code
EmailAddress
"string"
Address for electronic mail (e-mail).
Properties
Name
Type
Required
Restrictions
Description
anonymous
string
false
none
Address for electronic mail (e-mail).
EndDateTime
"2020-10-23T10:23:58Z"
Date and time at which the statement period ends.All dates in the JSON payloads are represented in ISO 8601 date-time format.
All date-time fields in responses must include the timezone. An example is below:
2017-04-05T10:43:07+00:00
Properties
Name
Type
Required
Restrictions
Description
anonymous
string(date-time)
false
none
Date and time at which the statement period ends.All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00
FinalPaymentDateTime
"2020-10-23T10:23:58Z"
The date on which the final payment for a Standing Order schedule will be made.All dates in the JSON payloads are represented in ISO 8601 date-time format.
All date-time fields in responses must include the timezone. An example is below:
2017-04-05T10:43:07+00:00
Properties
Name
Type
Required
Restrictions
Description
anonymous
string(date-time)
false
none
The date on which the final payment for a Standing Order schedule will be made.All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00
FirstPaymentDateTime
"2020-10-23T10:23:58Z"
The date on which the first payment for a Standing Order schedule will be made.All dates in the JSON payloads are represented in ISO 8601 date-time format.
All date-time fields in responses must include the timezone. An example is below:
2017-04-05T10:43:07+00:00
Properties
Name
Type
Required
Restrictions
Description
anonymous
string(date-time)
false
none
The date on which the first payment for a Standing Order schedule will be made.All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00
Frequency_0
"string"
Individual Definitions:
EvryDay - Every day
EvryWorkgDay - Every working day
IntrvlWkDay - An interval specified in weeks (01 to 09), and the day within the week (01 to 07)
WkInMnthDay - A monthly interval, specifying the week of the month (01 to 05) and day within the week (01 to 07)
IntrvlMnthDay - An interval specified in months (between 01 to 06, 12, 24), specifying the day within the month (-5 to -1, 1 to 31)
QtrDay - Quarterly (either ENGLISH, SCOTTISH, or RECEIVED)
ENGLISH = Paid on the 25th March, 24th June, 29th September and 25th December.
SCOTTISH = Paid on the 2nd February, 15th May, 1st August and 11th November.
RECEIVED = Paid on the 20th March, 19th June, 24th September and 20th December.
Individual Patterns:
EvryDay (ScheduleCode)
EvryWorkgDay (ScheduleCode)
IntrvlWkDay:IntervalInWeeks:DayInWeek (ScheduleCode + IntervalInWeeks + DayInWeek)
WkInMnthDay:WeekInMonth:DayInWeek (ScheduleCode + WeekInMonth + DayInWeek)
IntrvlMnthDay:IntervalInMonths:DayInMonth (ScheduleCode + IntervalInMonths + DayInMonth)
QtrDay: + either (ENGLISH, SCOTTISH or RECEIVED) ScheduleCode + QuarterDay
The regular expression for this element combines five smaller versions for each permitted pattern. To aid legibility - the components are presented individually here:
EvryDay
EvryWorkgDay
IntrvlWkDay:0[1-9]:0[1-7]
WkInMnthDay:0[1-5]:0[1-7]
IntrvlMnthDay:(0[1-6]|12|24)😦-0[1-5]|0[1-9]|[12][0-9]|3[01])
QtrDay:(ENGLISH|SCOTTISH|RECEIVED)
Full Regular Expression:
^(EvryDay)$|^(EvryWorkgDay)$|^(IntrvlWkDay:0[1-9]:0[1-7])$|^(WkInMnthDay:0[1-5]:0[1-7])$|^(IntrvlMnthDay:(0[1-6]|12|24)😦-0[1-5]|0[1-9]|[12][0-9]|3[01]))$|^(QtrDay:(ENGLISH|SCOTTISH|RECEIVED))$
Properties
Name
Type
Required
Restrictions
Description
anonymous
string
false
none
Individual Definitions: EvryDay - Every day EvryWorkgDay - Every working day IntrvlWkDay - An interval specified in weeks (01 to 09), and the day within the week (01 to 07) WkInMnthDay - A monthly interval, specifying the week of the month (01 to 05) and day within the week (01 to 07) IntrvlMnthDay - An interval specified in months (between 01 to 06, 12, 24), specifying the day within the month (-5 to -1, 1 to 31) QtrDay - Quarterly (either ENGLISH, SCOTTISH, or RECEIVED) ENGLISH = Paid on the 25th March, 24th June, 29th September and 25th December. SCOTTISH = Paid on the 2nd February, 15th May, 1st August and 11th November. RECEIVED = Paid on the 20th March, 19th June, 24th September and 20th December. Individual Patterns: EvryDay (ScheduleCode) EvryWorkgDay (ScheduleCode) IntrvlWkDay:IntervalInWeeks:DayInWeek (ScheduleCode + IntervalInWeeks + DayInWeek) WkInMnthDay:WeekInMonth:DayInWeek (ScheduleCode + WeekInMonth + DayInWeek) IntrvlMnthDay:IntervalInMonths:DayInMonth (ScheduleCode + IntervalInMonths + DayInMonth) QtrDay: + either (ENGLISH, SCOTTISH or RECEIVED) ScheduleCode + QuarterDay The regular expression for this element combines five smaller versions for each permitted pattern. To aid legibility - the components are presented individually here: EvryDay EvryWorkgDay IntrvlWkDay:0[1-9]:0[1-7] WkInMnthDay:0[1-5]:0[1-7] IntrvlMnthDay:(0[1-6]
Frequency_1
"string"
Individual Definitions:
EvryDay - Every day
EvryWorkgDay - Every working day
IntrvlWkDay - An interval specified in weeks (01 to 09), and the day within the week (01 to 07)
WkInMnthDay - A monthly interval, specifying the week of the month (01 to 05) and day within the week (01 to 07)
IntrvlMnthDay - An interval specified in months (between 01 to 06, 12, 24), specifying the day within the month (-5 to -1, 1 to 31)
QtrDay - Quarterly (either ENGLISH, SCOTTISH, or RECEIVED)
ENGLISH = Paid on the 25th March, 24th June, 29th September and 25th December.
SCOTTISH = Paid on the 2nd February, 15th May, 1st August and 11th November.
RECEIVED = Paid on the 20th March, 19th June, 24th September and 20th December.
Individual Patterns:
EvryDay (ScheduleCode)
EvryWorkgDay (ScheduleCode)
IntrvlWkDay:IntervalInWeeks:DayInWeek (ScheduleCode + IntervalInWeeks + DayInWeek)
WkInMnthDay:WeekInMonth:DayInWeek (ScheduleCode + WeekInMonth + DayInWeek)
IntrvlMnthDay:IntervalInMonths:DayInMonth (ScheduleCode + IntervalInMonths + DayInMonth)
QtrDay: + either (ENGLISH, SCOTTISH or RECEIVED) ScheduleCode + QuarterDay
The regular expression for this element combines five smaller versions for each permitted pattern. To aid legibility - the components are presented individually here:
EvryDay
EvryWorkgDay
IntrvlWkDay:0[1-9]:0[1-7]
WkInMnthDay:0[1-5]:0[1-7]
IntrvlMnthDay:(0[1-6]|12|24)😦-0[1-5]|0[1-9]|[12][0-9]|3[01])
QtrDay:(ENGLISH|SCOTTISH|RECEIVED)
Full Regular Expression:
^(EvryDay)$|^(EvryWorkgDay)$|^(IntrvlWkDay:0[1-9]:0[1-7])$|^(WkInMnthDay:0[1-5]:0[1-7])$|^(IntrvlMnthDay:(0[1-6]|12|24)😦-0[1-5]|0[1-9]|[12][0-9]|3[01]))$|^(QtrDay:(ENGLISH|SCOTTISH|RECEIVED))$
Properties
Name
Type
Required
Restrictions
Description
anonymous
string
false
none
Individual Definitions: EvryDay - Every day EvryWorkgDay - Every working day IntrvlWkDay - An interval specified in weeks (01 to 09), and the day within the week (01 to 07) WkInMnthDay - A monthly interval, specifying the week of the month (01 to 05) and day within the week (01 to 07) IntrvlMnthDay - An interval specified in months (between 01 to 06, 12, 24), specifying the day within the month (-5 to -1, 1 to 31) QtrDay - Quarterly (either ENGLISH, SCOTTISH, or RECEIVED) ENGLISH = Paid on the 25th March, 24th June, 29th September and 25th December. SCOTTISH = Paid on the 2nd February, 15th May, 1st August and 11th November. RECEIVED = Paid on the 20th March, 19th June, 24th September and 20th December. Individual Patterns: EvryDay (ScheduleCode) EvryWorkgDay (ScheduleCode) IntrvlWkDay:IntervalInWeeks:DayInWeek (ScheduleCode + IntervalInWeeks + DayInWeek) WkInMnthDay:WeekInMonth:DayInWeek (ScheduleCode + WeekInMonth + DayInWeek) IntrvlMnthDay:IntervalInMonths:DayInMonth (ScheduleCode + IntervalInMonths + DayInMonth) QtrDay: + either (ENGLISH, SCOTTISH or RECEIVED) ScheduleCode + QuarterDay The regular expression for this element combines five smaller versions for each permitted pattern. To aid legibility - the components are presented individually here: EvryDay EvryWorkgDay IntrvlWkDay:0[1-9]:0[1-7] WkInMnthDay:0[1-5]:0[1-7] IntrvlMnthDay:(0[1-6]
FullLegalName
"string"
Specifies a character string with a maximum length of 350 characters.
Properties
Name
Type
Required
Restrictions
Description
anonymous
string
false
none
Specifies a character string with a maximum length of 350 characters.
Identification_0
"string"
Identification assigned by an institution to identify an account. This identification is known by the account owner.
Properties
Name
Type
Required
Restrictions
Description
anonymous
string
false
none
Identification assigned by an institution to identify an account. This identification is known by the account owner.
Identification_1
"string"
Unique and unambiguous identification of the servicing institution.
Properties
Name
Type
Required
Restrictions
Description
anonymous
string
false
none
Unique and unambiguous identification of the servicing institution.
Identification_2
"string"
Unique and unambiguous identification of a financial institution or a branch of a financial institution.
Properties
Name
Type
Required
Restrictions
Description
anonymous
string
false
none
Unique and unambiguous identification of a financial institution or a branch of a financial institution.
Name_0
"string"
The account name is the name or names of the account owner(s) represented at an account level, as displayed by the ASPSP's online channels.
Note, the account name is not the product name or the nickname of the account.
Properties
Name
Type
Required
Restrictions
Description
anonymous
string
false
none
The account name is the name or names of the account owner(s) represented at an account level, as displayed by the ASPSP's online channels. Note, the account name is not the product name or the nickname of the account.
Name_1
"string"
Name by which a party is known and which is usually used to identify that party.
Properties
Name
Type
Required
Restrictions
Description
anonymous
string
false
none
Name by which a party is known and which is usually used to identify that party.
Name_2
"string"
Name by which an agent is known and which is usually used to identify that agent.
Properties
Name
Type
Required
Restrictions
Description
anonymous
string
false
none
Name by which an agent is known and which is usually used to identify that agent.
Name_3
"string"
Long name associated with the code
Properties
Name
Type
Required
Restrictions
Description
anonymous
string
false
none
Long name associated with the code
NextPaymentDateTime
"2020-10-23T10:23:58Z"
The date on which the next payment for a Standing Order schedule will be made.All dates in the JSON payloads are represented in ISO 8601 date-time format.
All date-time fields in responses must include the timezone. An example is below:
2017-04-05T10:43:07+00:00
Properties
Name
Type
Required
Restrictions
Description
anonymous
string(date-time)
false
none
The date on which the next payment for a Standing Order schedule will be made.All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00
Nickname
"string"
The nickname of the account, assigned by the account owner in order to provide an additional means of identification of the account.
Properties
Name
Type
Required
Restrictions
Description
anonymous
string
false
none
The nickname of the account, assigned by the account owner in order to provide an additional means of identification of the account.
Number_0
0
Indicates whether the advertised overdraft rate is guaranteed to be offered to a borrower by the bank e.g. if it�s part of a government scheme, or whether the rate may vary dependent on the applicant�s circumstances.
Properties
Name
Type
Required
Restrictions
Description
anonymous
integer
false
none
Indicates whether the advertised overdraft rate is guaranteed to be offered to a borrower by the bank e.g. if it�s part of a government scheme, or whether the rate may vary dependent on the applicant�s circumstances.
Number_1
0
fee/charges are captured dependent on the number of occurrences rather than capped at a particular amount
Properties
Name
Type
Required
Restrictions
Description
anonymous
integer
false
none
fee/charges are captured dependent on the number of occurrences rather than capped at a particular amount
Identification of the currency in which the account is held. Usage: Currency should only be used in case one and the same account number covers several currencies and the initiating party needs to identify which currency needs to be used for settlement on the account.
Identification of the currency in which the account is held. Usage: Currency should only be used in case one and the same account number covers several currencies and the initiating party needs to identify which currency needs to be used for settlement on the account.
The account name is the name or names of the account owner(s) represented at an account level, as displayed by the ASPSP's online channels. Note, the account name is not the product name or the nickname of the account.
This is secondary identification of the account, as assigned by the account servicing institution. This can be used by building societies to additionally identify accounts with a roll number (in addition to a sort code and account number combination).
Party that manages the account on behalf of the account owner, that is manages the registration and booking of entries on the account, calculates balances on the account and provides information about the account.
Date and time at which the resource status was updated.All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00
Identification of the currency in which the account is held. Usage: Currency should only be used in case one and the same account number covers several currencies and the initiating party needs to identify which currency needs to be used for settlement on the account.
Date and time at which the resource status was updated.All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00
Identification of the currency in which the account is held. Usage: Currency should only be used in case one and the same account number covers several currencies and the initiating party needs to identify which currency needs to be used for settlement on the account.
The account name is the name or names of the account owner(s) represented at an account level, as displayed by the ASPSP's online channels. Note, the account name is not the product name or the nickname of the account.
This is secondary identification of the account, as assigned by the account servicing institution. This can be used by building societies to additionally identify accounts with a roll number (in addition to a sort code and account number combination).
Party that manages the account on behalf of the account owner, that is manages the registration and booking of entries on the account, calculates balances on the account and provides information about the account.
OBAccountStatus1Code
"Deleted"
Specifies the status of account resource in code form.
Properties
Name
Type
Required
Restrictions
Description
anonymous
string
false
none
Specifies the status of account resource in code form.
A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 "Codes for the representation of currencies and funds".
A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 "Codes for the representation of currencies and funds".
A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 "Codes for the representation of currencies and funds".
OBActiveOrHistoricCurrencyAndAmount_3
{
"Amount": "string",
"Currency": "string"
}
Amount of money associated with the statement benefit type.
A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 "Codes for the representation of currencies and funds".
OBActiveOrHistoricCurrencyAndAmount_4
{
"Amount": "string",
"Currency": "string"
}
Amount of money associated with the statement fee type.
A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 "Codes for the representation of currencies and funds".
OBActiveOrHistoricCurrencyAndAmount_5
{
"Amount": "string",
"Currency": "string"
}
Amount of money associated with the statement interest amount type.
A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 "Codes for the representation of currencies and funds".
A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 "Codes for the representation of currencies and funds".
A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 "Codes for the representation of currencies and funds".
OBActiveOrHistoricCurrencyAndAmount_8
{
"Amount": "string",
"Currency": "string"
}
Transaction charges to be paid by the charge bearer.
A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 "Codes for the representation of currencies and funds".
OBActiveOrHistoricCurrencyAndAmount_9
{
"Amount": "string",
"Currency": "string"
}
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.
Usage: This amount has to be transported unchanged through the transaction chain.
A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 "Codes for the representation of currencies and funds".
OBBalanceType1Code
"ClosingAvailable"
Balance type, in a coded form.
Properties
Name
Type
Required
Restrictions
Description
anonymous
string
false
none
Balance type, in a coded form.
Enumerated Values
Property
Value
anonymous
ClosingAvailable
anonymous
ClosingBooked
anonymous
ClosingCleared
anonymous
Expected
anonymous
ForwardAvailable
anonymous
Information
anonymous
InterimAvailable
anonymous
InterimBooked
anonymous
InterimCleared
anonymous
OpeningAvailable
anonymous
OpeningBooked
anonymous
OpeningCleared
anonymous
PreviouslyClosedBooked
OBBankTransactionCodeStructure1
{
"Code": "string",
"SubCode": "string"
}
Set of elements used to fully identify the type of underlying transaction resulting in an entry.
Properties
Name
Type
Required
Restrictions
Description
Code
string
true
none
Specifies the family within a domain.
SubCode
string
true
none
Specifies the sub-product family within a specific family.
Unique reference, as assigned by the creditor, to unambiguously refer to the payment transaction. Usage: If available, the initiating party should provide this reference in the structured remittance information, to enable reconciliation by the creditor upon receipt of the amount of money. If the business context requires the use of a creditor reference or a payment remit identification, and only one identifier can be passed through the end-to-end chain, the creditor's reference or payment remittance identification should be quoted in the end-to-end transaction identification.
Unique reference, as assigned by the creditor, to unambiguously refer to the payment transaction. Usage: If available, the initiating party should provide this reference in the structured remittance information, to enable reconciliation by the creditor upon receipt of the amount of money. If the business context requires the use of a creditor reference or a payment remit identification, and only one identifier can be passed through the end-to-end chain, the creditor's reference or payment remittance identification should be quoted in the end-to-end transaction identification.
Party that manages the account on behalf of the account owner, that is manages the registration and booking of entries on the account, calculates balances on the account and provides information about the account. This is the servicer of the beneficiary account.
Party that manages the account on behalf of the account owner, that is manages the registration and booking of entries on the account, calculates balances on the account and provides information about the account.
Party that manages the account on behalf of the account owner, that is manages the registration and booking of entries on the account, calculates balances on the account and provides information about the account.
This is the servicer of the beneficiary account.
Party that manages the account on behalf of the account owner, that is manages the registration and booking of entries on the account, calculates balances on the account and provides information about the account.
This is the servicer of the beneficiary account.
The account name is the name or names of the account owner(s) represented at an account level, as displayed by the ASPSP's online channels. Note, the account name is not the product name or the nickname of the account.
This is secondary identification of the account, as assigned by the account servicing institution. This can be used by building societies to additionally identify accounts with a roll number (in addition to a sort code and account number combination).
The account name is the name or names of the account owner(s) represented at an account level, as displayed by the ASPSP's online channels. Note, the account name is not the product name or the nickname of the account.
This is secondary identification of the account, as assigned by the account servicing institution. This can be used by building societies to additionally identify accounts with a roll number (in addition to a sort code and account number combination).
The account name is the name or names of the account owner(s) represented at an account level, as displayed by the ASPSP's online channels. Note, the account name is not the product name or the nickname of the account.
This is secondary identification of the account, as assigned by the account servicing institution. This can be used by building societies to additionally identify accounts with a roll number (in addition to a sort code and account number combination).
The account name is the name or names of the account owner(s) represented at an account level, as displayed by the ASPSP's online channels. Note, the account name is not the product name or the nickname of the account.
This is secondary identification of the account, as assigned by the account servicing institution. This can be used by building societies to additionally identify accounts with a roll number (in addition to a sort code and account number combination).
OBCreditDebitCode_0
"Credit"
Indicates whether the amount is a credit or a debit.
Usage: A zero amount is considered to be a credit amount.
Properties
Name
Type
Required
Restrictions
Description
anonymous
string
false
none
Indicates whether the amount is a credit or a debit. Usage: A zero amount is considered to be a credit amount.
Enumerated Values
Property
Value
anonymous
Credit
anonymous
Debit
OBCreditDebitCode_1
"Credit"
Indicates whether the transaction is a credit or a debit entry.
Properties
Name
Type
Required
Restrictions
Description
anonymous
string
false
none
Indicates whether the transaction is a credit or a debit entry.
Enumerated Values
Property
Value
anonymous
Credit
anonymous
Debit
OBCreditDebitCode_2
"Credit"
Indicates whether the balance is a credit or a debit balance.
Usage: A zero balance is considered to be a credit balance.
Properties
Name
Type
Required
Restrictions
Description
anonymous
string
false
none
Indicates whether the balance is a credit or a debit balance. Usage: A zero balance is considered to be a credit balance.
Set of elements used to provide details on the currency exchange.
Properties
Name
Type
Required
Restrictions
Description
SourceCurrency
string
true
none
Currency from which an amount is to be converted in a currency conversion.
TargetCurrency
string
false
none
Currency into which an amount is to be converted in a currency conversion.
UnitCurrency
string
false
none
Currency in which the rate of exchange is expressed in a currency exchange. In the example 1GBP = xxxCUR, the unit currency is GBP.
ExchangeRate
number
true
none
Factor used to convert an amount from one currency into another. This reflects the price at which one currency was bought with another currency. Usage: ExchangeRate expresses the ratio between UnitCurrency and QuotedCurrency (ExchangeRate = UnitCurrency/QuotedCurrency).
ContractIdentification
string
false
none
Unique identification to unambiguously identify the foreign exchange contract.
QuotationDate
string(date-time)
false
none
Date and time at which an exchange rate is quoted.All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00
InstructedAmount
object
false
none
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.
A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 "Codes for the representation of currencies and funds".
OBEntryStatus1Code
"Booked"
Status of a transaction entry on the books of the account servicer.
Properties
Name
Type
Required
Restrictions
Description
anonymous
string
false
none
Status of a transaction entry on the books of the account servicer.
Enumerated Values
Property
Value
anonymous
Booked
anonymous
Pending
OBExternalAccountRole1Code
"string"
A party�s role with respect to the related account.
Properties
Name
Type
Required
Restrictions
Description
anonymous
string
false
none
A party�s role with respect to the related account.
OBExternalAccountSubType1Code
"ChargeCard"
Specifies the sub type of account (product family group).
Properties
Name
Type
Required
Restrictions
Description
anonymous
string
false
none
Specifies the sub type of account (product family group).
Enumerated Values
Property
Value
anonymous
ChargeCard
anonymous
CreditCard
anonymous
CurrentAccount
anonymous
EMoney
anonymous
Loan
anonymous
Mortgage
anonymous
PrePaidCard
anonymous
Savings
OBExternalAccountType1Code
"Business"
Specifies the type of account (personal or business).
Properties
Name
Type
Required
Restrictions
Description
anonymous
string
false
none
Specifies the type of account (personal or business).
Enumerated Values
Property
Value
anonymous
Business
anonymous
Personal
OBExternalFinancialInstitutionIdentification4Code
"string"
Name of the identification scheme, in a coded form as published in an external list.
Properties
Name
Type
Required
Restrictions
Description
anonymous
string
false
none
Name of the identification scheme, in a coded form as published in an external list.
OBExternalLegalStructureType1Code
"string"
Legal standing of the party.
Properties
Name
Type
Required
Restrictions
Description
anonymous
string
false
none
Legal standing of the party.
OBExternalPartyType1Code
"Delegate"
Party type, in a coded form.
Properties
Name
Type
Required
Restrictions
Description
anonymous
string
false
none
Party type, in a coded form.
Enumerated Values
Property
Value
anonymous
Delegate
anonymous
Joint
anonymous
Sole
OBExternalScheduleType1Code
"Arrival"
Specifies the scheduled payment date type requested
Properties
Name
Type
Required
Restrictions
Description
anonymous
string
false
none
Specifies the scheduled payment date type requested
Enumerated Values
Property
Value
anonymous
Arrival
anonymous
Execution
OBExternalStandingOrderStatus1Code
"Active"
Specifies the status of the standing order in code form.
Properties
Name
Type
Required
Restrictions
Description
anonymous
string
false
none
Specifies the status of the standing order in code form.
Enumerated Values
Property
Value
anonymous
Active
anonymous
Inactive
OBExternalStatementAmountType1Code
"string"
Amount type, in a coded form.
Properties
Name
Type
Required
Restrictions
Description
anonymous
string
false
none
Amount type, in a coded form.
OBExternalStatementBenefitType1Code
"string"
Benefit type, in a coded form.
Properties
Name
Type
Required
Restrictions
Description
anonymous
string
false
none
Benefit type, in a coded form.
OBExternalStatementDateTimeType1Code
"string"
Date time type, in a coded form.
Properties
Name
Type
Required
Restrictions
Description
anonymous
string
false
none
Date time type, in a coded form.
OBExternalStatementFeeFrequency1Code
"string"
How frequently the fee is applied to the Account.
Properties
Name
Type
Required
Restrictions
Description
anonymous
string
false
none
How frequently the fee is applied to the Account.
OBExternalStatementFeeRateType1Code
"string"
Description that may be available for the statement fee rate type.
Properties
Name
Type
Required
Restrictions
Description
anonymous
string
false
none
Description that may be available for the statement fee rate type.
OBExternalStatementFeeType1Code
"string"
Fee type, in a coded form.
Properties
Name
Type
Required
Restrictions
Description
anonymous
string
false
none
Fee type, in a coded form.
OBExternalStatementInterestFrequency1Code
"string"
Specifies the statement fee type requested
Properties
Name
Type
Required
Restrictions
Description
anonymous
string
false
none
Specifies the statement fee type requested
OBExternalStatementInterestRateType1Code
"string"
Description that may be available for the statement Interest rate type.
Properties
Name
Type
Required
Restrictions
Description
anonymous
string
false
none
Description that may be available for the statement Interest rate type.
Indicates the date (and time) of the balance.All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00
A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 "Codes for the representation of currencies and funds".
»» CreditLine
[object]
false
none
none
»»» Included
boolean
true
none
Indicates whether or not the credit line is included in the balance of the account. Usage: If not present, credit line is not included in the balance amount of the account.
A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 "Codes for the representation of currencies and funds".
Specified date and time the permissions will expire. If this is not populated, the permissions will be open ended.All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00
» TransactionFromDateTime
string(date-time)
false
none
Specified start date and time for the transaction query period. If this is not populated, the start date will be open ended, and data will be returned from the earliest available transaction.All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00
» TransactionToDateTime
string(date-time)
false
none
Specified end date and time for the transaction query period. If this is not populated, the end date will be open ended, and data will be returned to the latest available transaction.All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00
Date and time at which the resource was created.All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00
» Status
string
true
none
Specifies the status of consent resource in code form.
Date and time at which the resource status was updated.All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00
» Permissions
[string]
true
none
none
» ExpirationDateTime
string(date-time)
false
none
Specified date and time the permissions will expire. If this is not populated, the permissions will be open ended.All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00
» TransactionFromDateTime
string(date-time)
false
none
Specified start date and time for the transaction query period. If this is not populated, the start date will be open ended, and data will be returned from the earliest available transaction.All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00
» TransactionToDateTime
string(date-time)
false
none
Specified end date and time for the transaction query period. If this is not populated, the end date will be open ended, and data will be returned to the latest available transaction.All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00
A unique and immutable identifier used to identify the account resource. This identifier has no meaning to the account owner.
»» DirectDebitId
string
false
none
A unique and immutable identifier used to identify the direct debit resource. This identifier has no meaning to the account owner.
»» MandateIdentification
string
true
none
Direct Debit reference. For AUDDIS service users provide Core Reference. For non AUDDIS service users provide Core reference if possible or last used reference.
»» DirectDebitStatusCode
string
false
none
Specifies the status of the direct debit in code form.
»» Name
string
true
none
Name of Service User.
»» PreviousPaymentDateTime
string(date-time)
false
none
Date of most recent direct debit collection.All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00
»» PreviousPaymentAmount
object
false
none
The amount of the most recent direct debit collection.
A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 "Codes for the representation of currencies and funds".
A unique and immutable identifier used to identify the account resource. This identifier has no meaning to the account owner.
»» OfferId
string
false
none
A unique and immutable identifier used to identify the offer resource. This identifier has no meaning to the account owner.
»» OfferType
string
false
none
Offer type, in a coded form.
»» Description
string
false
none
Further details of the offer.
»» StartDateTime
string(date-time)
false
none
Date and time at which the offer starts.All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00
»» EndDateTime
string(date-time)
false
none
Date and time at which the offer ends.All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00
»» Rate
string
false
none
Rate associated with the offer type.
»» Value
integer
false
none
Value associated with the offer type.
»» Term
string
false
none
Further details of the term of the offer.
»» URL
string
false
none
URL (Uniform Resource Locator) where documentation on the offer can be found
A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 "Codes for the representation of currencies and funds".
A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 "Codes for the representation of currencies and funds".
Product details of Other Product which is not avaiable in the standard list
Properties
Name
Type
Required
Restrictions
Description
Data
object
true
none
Aligning with the read write specs structure.
» Product
[object]
false
none
none
»» ProductName
string
false
none
The name of the Product used for marketing purposes from a customer perspective. I.e. what the customer would recognise.
»» ProductId
string
false
none
The unique ID that has been internally assigned by the financial institution to each of the current account banking products they market to their retail and/or small to medium enterprise (SME) customers.
»» AccountId
string
true
none
Account Identification of the customer for Product Details
»» SecondaryProductId
string
false
none
Any secondary Identification which supports Product Identifier to uniquely identify the current account banking products.
»» ProductType
string
true
none
Product type : Personal Current Account, Business Current Account
»» MarketingStateId
string
false
none
Unique and unambiguous identification of a Product Marketing State.
»» OtherProductType
object
false
none
Other product type details associated with the account.
»»» Name
string
true
none
Long name associated with the product
»»» Description
string
true
none
Description of the Product associated with the account
»»» ProductDetails
object
false
none
none
»»»» Segment
[string]
false
none
none
»»»» FeeFreeLength
integer
false
none
The length/duration of the fee free period
»»»» FeeFreeLengthPeriod
string
false
none
The unit of period (days, weeks, months etc.) of the promotional length
»»»» MonthlyMaximumCharge
string
false
none
The maximum relevant charges that could accrue as defined fully in Part 7 of the CMA order
Details about the interest that may be payable to the Account holders
»»»» TierBandSet
[object]
true
none
none
»»»»» TierBandMethod
string
true
none
The methodology of how credit interest is paid/applied. It can be:- 1. Banded Interest rates are banded. i.e. Increasing rate on whole balance as balance increases. 2. Tiered Interest rates are tiered. i.e. increasing rate for each tier as balance increases, but interest paid on tier fixed for that tier and not on whole balance. 3. Whole The same interest rate is applied irrespective of the product holder's account balance
Unique and unambiguous identification of a Tier Band for the Product.
»»»»»» TierValueMinimum
string
true
none
Minimum deposit value for which the credit interest tier applies.
»»»»»» TierValueMaximum
string
false
none
Maximum deposit value for which the credit interest tier applies.
»»»»»» CalculationFrequency
string
false
none
How often is credit interest calculated for the account.
»»»»»» ApplicationFrequency
string
true
none
How often is interest applied to the Product for this tier/band i.e. how often the financial institution pays accumulated interest to the customer's account.
The annual equivalent rate (AER) is interest that is calculated under the assumption that any interest paid is combined with the original balance and the next interest payment will be based on the slightly higher account balance. Overall, this means that interest can be compounded several times in a year depending on the number of times that interest payments are made. Read more: Annual Equivalent Rate (AER) http://www.investopedia.com/terms/a/aer.asp#ixzz4gfR7IO1A
»»»»»» BankInterestRateType
string
false
none
Interest rate types, other than AER, which financial institutions may use to describe the annual interest rate payable to the account holder's account.
»»»»»» BankInterestRate
string
false
none
Bank Interest for the product
»»»»»» Notes
[string]
false
none
none
»»»»»» OtherBankInterestType
object
false
none
Other interest rate types which are not available in the standard code list
Other calculation frequency which is not available in the standard code set.
»»»»» Overdraft
object
false
none
Borrowing details
»»»»»» Notes
[string]
false
none
none
»»»»»» OverdraftTierBandSet
[object]
true
none
none
»»»»»»» TierBandMethod
string
true
none
The methodology of how overdraft is charged. It can be: 'Whole' Where the same charge/rate is applied to the entirety of the overdraft balance (where charges are applicable). 'Tiered' Where different charges/rates are applied dependent on overdraft maximum and minimum balance amount tiers defined by the lending financial organisation 'Banded' Where different charges/rates are applied dependent on overdraft maximum and minimum balance amount bands defined by a government organisation.
»»»»»»» OverdraftType
string
false
none
An overdraft can either be 'committed' which means that the facility cannot be withdrawn without reasonable notification before it's agreed end date, or 'on demand' which means that the financial institution can demand repayment at any point in time.
»»»»»»» Identification
string
false
none
Unique and unambiguous identification of a Tier Band for a overdraft product.
»»»»»»» AuthorisedIndicator
boolean
false
none
Indicates if the Overdraft is authorised (Y) or unauthorised (N)
»»»»»»» BufferAmount
string
false
none
When a customer exceeds their credit limit, a financial institution will not charge the customer unauthorised overdraft charges if they do not exceed by more than the buffer amount. Note: Authorised overdraft charges may still apply.
»»»»»»» Notes
[string]
false
none
none
»»»»»»» OverdraftTierBand
[object]
true
none
none
»»»»»»»» Identification
string
false
none
Unique and unambiguous identification of a Tier Band for a overdraft.
»»»»»»»» TierValueMin
string
true
none
Minimum value of Overdraft Tier/Band
»»»»»»»» TierValueMax
string
false
none
Maximum value of Overdraft Tier/Band
»»»»»»»» EAR
string
false
none
EAR means Effective Annual Rate and/or Equivalent Annual Rate (frequently used interchangeably), being the actual annual interest rate of an Overdraft.
»»»»»»»» AgreementLengthMin
integer
false
none
Specifies the minimum length of a band for a fixed overdraft agreement
»»»»»»»» AgreementLengthMax
integer
false
none
Specifies the maximum length of a band for a fixed overdraft agreement
»»»»»»»» AgreementPeriod
string
false
none
Specifies the period of a fixed length overdraft agreement
»»»»»»»» OverdraftInterestChargingCoverage
string
false
none
Refers to which interest rate is applied when interests are tiered. For example, if an overdraft balance is �2k and the interest tiers are:- 0-�500 0.1%, 500-1000 0.2%, 1000-10000 0.5%, then the applicable interest rate could either be 0.5% of the entire balance (since the account balance sits in the top interest tier) or (0.1%*500)+(0.2%*500)+(0.5%*1000). In the 1st situation, we say the interest is applied to the �Whole� of the account balance, and in the 2nd that it is �Tiered�.
»»»»»»»» BankGuaranteedIndicator
boolean
false
none
Indicates whether the advertised overdraft rate is guaranteed to be offered to a borrower by the bank e.g. if it�s part of a government scheme, or whether the rate may vary dependent on the applicant�s circumstances.
Indicates whether the advertised overdraft rate is guaranteed to be offered to a borrower by the bank e.g. if it�s part of a government scheme, or whether the rate may vary dependent on the applicant�s circumstances.
Indicates whether the advertised overdraft rate is guaranteed to be offered to a borrower by the bank e.g. if it�s part of a government scheme, or whether the rate may vary dependent on the applicant�s circumstances.
Indicates whether the advertised overdraft rate is guaranteed to be offered to a borrower by the bank e.g. if it�s part of a government scheme, or whether the rate may vary dependent on the applicant�s circumstances.
Indicates whether the advertised overdraft rate is guaranteed to be offered to a borrower by the bank e.g. if it�s part of a government scheme, or whether the rate may vary dependent on the applicant�s circumstances.
Other calculation frequency which is not available in the standard code set.
»»»»»»»»»»»»»» LoanInterest
object
false
none
Details about the interest that may be payable to the SME Loan holders
»»»»»»»»»»»»»»» Notes
[string]
false
none
none
»»»»»»»»»»»»»»» LoanInterestTierBandSet
[object]
true
none
none
»»»»»»»»»»»»»»»» TierBandMethod
string
true
none
The methodology of how credit interest is charged. It can be:- 1. Banded Interest rates are banded. i.e. Increasing rate on whole balance as balance increases. 2. Tiered Interest rates are tiered. i.e. increasing rate for each tier as balance increases, but interest paid on tier fixed for that tier and not on whole balance. 3. Whole The same interest rate is applied irrespective of the SME Loan balance
»»»»»»»»»»»»»»»» Identification
string
false
none
Loan interest tierbandset identification. Used by loan providers for internal use purpose.
The annual equivalent rate (AER) is interest that is calculated under the assumption that any interest paid is combined with the original balance and the next interest payment will be based on the slightly higher account balance. Overall, this means that interest can be compounded several times in a year depending on the number of times that interest payments are made. For SME Loan, this APR is the representative APR which includes any account fees.
»»»»»»»»»»»»»»»»» LoanProviderInterestRateType
string
false
none
Interest rate types, other than APR, which financial institutions may use to describe the annual interest rate payable for the SME Loan.
Additional information that can not be captured in the structured fields and/or any other specific block.
»»»»»»»»»»»»»»»»»»»»»»»»»»» BCA
object
false
none
none
»»»»»»»»»»»»»»»»»»»»»»»»»»»» ProductDetails
object
false
none
none
»»»»»»»»»»»»»»»»»»»»»»»»»»»»» Segment
[string]
false
none
Market segmentation is a marketing term referring to the aggregating of prospective buyers into groups, or segments, that have common needs and respond similarly to a marketing action. Market segmentation enables companies to target different categories of consumers who perceive the full value of certain products and services differently from one another. Read more: Market Segmentation http://www.investopedia.com/terms/m/marketsegmentation.asp#ixzz4gfEEalTd With respect to BCA products, they are segmented in relation to different markets that they wish to focus on.
»»»»»»»»»»»»»»»»»»»»»»»»»»»»» FeeFreeLength
number(float)
false
none
The length/duration of the fee free period
»»»»»»»»»»»»»»»»»»»»»»»»»»»»» FeeFreeLengthPeriod
string
false
none
The unit of period (days, weeks, months etc.) of the promotional length
»»»»»»»»»»»»»»»»»»»»»»»»»»»»» Notes
[string]
false
none
Optional additional notes to supplement the Core product details
»»»»»»»»»»»»»»»»»»»»»»»»»»»» CreditInterest
object
false
none
Details about the interest that may be payable to the BCA account holders
»»»»»»»»»»»»»»»»»»»»»»»»»»»»» TierBandSet
[object]
true
none
The group of tiers or bands for which credit interest can be applied.
»»»»»»»»»»»»»»»»»»»»»»»»»»»»»» TierBandMethod
string
true
none
The methodology of how credit interest is paid/applied. It can be:- 1. Banded Interest rates are banded. i.e. Increasing rate on whole balance as balance increases. 2. Tiered Interest rates are tiered. i.e. increasing rate for each tier as balance increases, but interest paid on tier fixed for that tier and not on whole balance. 3. Whole The same interest rate is applied irrespective of the BCA balance
»»»»»»»»»»»»»»»»»»»»»»»»»»»»»» CalculationMethod
string
false
none
Methods of calculating interest
»»»»»»»»»»»»»»»»»»»»»»»»»»»»»» Destination
string
true
none
Describes whether accrued interest is payable only to the BCA or to another bank account
»»»»»»»»»»»»»»»»»»»»»»»»»»»»»» Notes
[string]
false
none
Optional additional notes to supplement the Tier Band Set details
»»»»»»»»»»»»»»»»»»»»»»»»»»»»»» TierBand
[object]
true
none
Tier Band Details
»»»»»»»»»»»»»»»»»»»»»»»»»»»»»»» Identification
string
false
none
Unique and unambiguous identification of a Tier Band for a BCA.
»»»»»»»»»»»»»»»»»»»»»»»»»»»»»»» TierValueMinimum
string
true
none
Minimum deposit value for which the credit interest tier applies.
»»»»»»»»»»»»»»»»»»»»»»»»»»»»»»» TierValueMaximum
string
false
none
Maximum deposit value for which the credit interest tier applies.
The annual equivalent rate (AER) is interest that is calculated under the assumption that any interest paid is combined with the original balance and the next interest payment will be based on the slightly higher account balance. Overall, this means that interest can be compounded several times in a year depending on the number of times that interest payments are made. Read more: Annual Equivalent Rate (AER) http://www.investopedia.com/terms/a/aer.asp#ixzz4gfR7IO1A
The methodology of how overdraft is charged. It can be: 'Whole' Where the same charge/rate is applied to the entirety of the overdraft balance (where charges are applicable). 'Tiered' Where different charges/rates are applied dependent on overdraft maximum and minimum balance amount tiers defined by the lending financial organisation 'Banded' Where different charges/rates are applied dependent on overdraft maximum and minimum balance amount bands defined by a government organisation.
»»»»»»»»»»»»»»»»»»»»»»»»»»»»»»»»» OverdraftType
string
false
none
An overdraft can either be 'committed' which means that the facility cannot be withdrawn without reasonable notification before it's agreed end date, or 'on demand' which means that the financial institution can demand repayment at any point in time.
»»»»»»»»»»»»»»»»»»»»»»»»»»»»»»»»» Identification
string
false
none
Unique and unambiguous identification of a Tier Band for a overdraft product.
Indicates if the Overdraft is authorised (Y) or unauthorised (N)
»»»»»»»»»»»»»»»»»»»»»»»»»»»»»»»»» BufferAmount
string
false
none
When a customer exceeds their credit limit, a financial institution will not charge the customer unauthorised overdraft charges if they do not exceed by more than the buffer amount. Note: Authorised overdraft charges may still apply.
»»»»»»»»»»»»»»»»»»»»»»»»»»»»»»»»» Notes
[string]
false
none
Optional additional notes to supplement the overdraft Tier Band Set details
Provides overdraft details for a specific tier or band
»»»»»»»»»»»»»»»»»»»»»»»»»»»»»»»»»» Identification
string
false
none
Unique and unambiguous identification of a Tier Band for a overdraft.
»»»»»»»»»»»»»»»»»»»»»»»»»»»»»»»»»» TierValueMin
string
true
none
Minimum value of Overdraft Tier/Band
»»»»»»»»»»»»»»»»»»»»»»»»»»»»»»»»»» TierValueMax
string
false
none
Maximum value of Overdraft Tier/Band
»»»»»»»»»»»»»»»»»»»»»»»»»»»»»»»»»» EAR
string
false
none
EAR means Effective Annual Rate and/or Equivalent Annual Rate (frequently used interchangeably), being the actual annual interest rate of an Overdraft.
Refers to which interest rate is applied when interests are tiered. For example, if an overdraft balance is £2k and the interest tiers are:- 0-£500 0.1%, 500-1000 0.2%, 1000-10000 0.5%, then the applicable interest rate could either be 0.5% of the entire balance (since the account balance sits in the top interest tier) or (0.1%*500)+(0.2%*500)+(0.5%*1000). In the 1st situation, we say the interest is applied to the ‘Whole’ of the account balance, and in the 2nd that it is ‘Tiered’.
Indicates whether the advertised overdraft rate is guaranteed to be offered to a borrower by the bank e.g. if it’s part of a government scheme, or whether the rate may vary dependent on the applicant’s circumstances.
»»»»»»»»»»»»»»»»»»»»»»»»»»»»»»»»»» Notes
[string]
false
none
Optional additional notes to supplement the Tier/band details
Details about any caps (maximum charges) that apply to a particular fee/charge. Capping can either be based on an amount (in gbp), an amount (in items) or a rate.
Indicates whether the advertised overdraft rate is guaranteed to be offered to a borrower by the bank e.g. if it’s part of a government scheme, or whether the rate may vary dependent on the applicant’s circumstances.
Details about any caps (maximum charges) that apply to a particular fee/charge. Capping can either be based on an amount (in gbp), an amount (in items) or a rate.
Indicates whether the advertised overdraft rate is guaranteed to be offered to a borrower by the bank e.g. if it’s part of a government scheme, or whether the rate may vary dependent on the applicant’s circumstances.
Details about any caps (maximum charges) that apply to a particular fee/charge. Capping can either be based on an amount (in gbp), an amount (in items) or a rate.
Indicates whether the advertised overdraft rate is guaranteed to be offered to a borrower by the bank e.g. if it’s part of a government scheme, or whether the rate may vary dependent on the applicant’s circumstances.
Details about any caps (maximum charges) that apply to a particular fee/charge. Capping can either be based on an amount (in gbp), an amount (in items) or a rate.
Indicates whether the advertised overdraft rate is guaranteed to be offered to a borrower by the bank e.g. if it’s part of a government scheme, or whether the rate may vary dependent on the applicant’s circumstances.
Market segmentation is a marketing term referring to the aggregating of prospective buyers into groups, or segments, that have common needs and respond similarly to a marketing action. Market segmentation enables companies to target different categories of consumers who perceive the full value of certain products and services differently from one another. Read more: Market Segmentation http://www.investopedia.com/terms/m/marketsegmentation.asp#ixzz4gfEEalTd With respect to PCA products, they are segmented in relation to different markets that they wish to focus on.
The methodology of how credit interest is charged. It can be:- 1. Banded Interest rates are banded. i.e. Increasing rate on whole balance as balance increases. 2. Tiered Interest rates are tiered. i.e. increasing rate for each tier as balance increases, but interest paid on tier fixed for that tier and not on whole balance. 3. Whole The same interest rate is applied irrespective of the PCA balance
The annual equivalent rate (AER) is interest that is calculated under the assumption that any interest paid is combined with the original balance and the next interest payment will be based on the slightly higher account balance. Overall, this means that interest can be compounded several times in a year depending on the number of times that interest payments are made. Read more: Annual Equivalent Rate (AER) http://www.investopedia.com/terms/a/aer.asp#ixzz4gfR7IO1A
The methodology of how overdraft is charged. It can be: 'Whole' Where the same charge/rate is applied to the entirety of the overdraft balance (where charges are applicable). 'Tiered' Where different charges/rates are applied dependent on overdraft maximum and minimum balance amount tiers defined by the lending financial organisation 'Banded' Where different charges/rates are applied dependent on overdraft maximum and minimum balance amount bands defined by a government organisation.
An overdraft can either be 'committed' which means that the facility cannot be withdrawn without reasonable notification before it's agreed end date, or 'on demand' which means that the financial institution can demand repayment at any point in time.
When a customer exceeds their credit limit, a financial institution will not charge the customer unauthorised overdraft charges if they do not exceed by more than the buffer amount. Note: Authorised overdraft charges may still apply.
EAR means Effective Annual Rate and/or Equivalent Annual Rate (frequently used interchangeably), being the actual annual interest rate of an Overdraft.
The date on which the scheduled payment will be made.All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00
Unique reference, as assigned by the creditor, to unambiguously refer to the payment transaction. Usage: If available, the initiating party should provide this reference in the structured remittance information, to enable reconciliation by the creditor upon receipt of the amount of money. If the business context requires the use of a creditor reference or a payment remit identification, and only one identifier can be passed through the end-to-end chain, the creditor's reference or payment remittance identification should be quoted in the end-to-end transaction identification.
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. Usage: This amount has to be transported unchanged through the transaction chain.
The date on which the scheduled payment will be made.All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00
Unique reference, as assigned by the creditor, to unambiguously refer to the payment transaction. Usage: If available, the initiating party should provide this reference in the structured remittance information, to enable reconciliation by the creditor upon receipt of the amount of money. If the business context requires the use of a creditor reference or a payment remit identification, and only one identifier can be passed through the end-to-end chain, the creditor's reference or payment remittance identification should be quoted in the end-to-end transaction identification.
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. Usage: This amount has to be transported unchanged through the transaction chain.
Party that manages the account on behalf of the account owner, that is manages the registration and booking of entries on the account, calculates balances on the account and provides information about the account. This is the servicer of the beneficiary account.
Individual Definitions: EvryDay - Every day EvryWorkgDay - Every working day IntrvlWkDay - An interval specified in weeks (01 to 09), and the day within the week (01 to 07) WkInMnthDay - A monthly interval, specifying the week of the month (01 to 05) and day within the week (01 to 07) IntrvlMnthDay - An interval specified in months (between 01 to 06, 12, 24), specifying the day within the month (-5 to -1, 1 to 31) QtrDay - Quarterly (either ENGLISH, SCOTTISH, or RECEIVED) ENGLISH = Paid on the 25th March, 24th June, 29th September and 25th December. SCOTTISH = Paid on the 2nd February, 15th May, 1st August and 11th November. RECEIVED = Paid on the 20th March, 19th June, 24th September and 20th December. Individual Patterns: EvryDay (ScheduleCode) EvryWorkgDay (ScheduleCode) IntrvlWkDay:IntervalInWeeks:DayInWeek (ScheduleCode + IntervalInWeeks + DayInWeek) WkInMnthDay:WeekInMonth:DayInWeek (ScheduleCode + WeekInMonth + DayInWeek) IntrvlMnthDay:IntervalInMonths:DayInMonth (ScheduleCode + IntervalInMonths + DayInMonth) QtrDay: + either (ENGLISH, SCOTTISH or RECEIVED) ScheduleCode + QuarterDay The regular expression for this element combines five smaller versions for each permitted pattern. To aid legibility - the components are presented individually here: EvryDay EvryWorkgDay IntrvlWkDay:0[1-9]:0[1-7] WkInMnthDay:0[1-5]:0[1-7] IntrvlMnthDay:(0[1-6]
Unique reference, as assigned by the creditor, to unambiguously refer to the payment transaction. Usage: If available, the initiating party should provide this reference in the structured remittance information, to enable reconciliation by the creditor upon receipt of the amount of money. If the business context requires the use of a creditor reference or a payment remit identification, and only one identifier can be passed through the end-to-end chain, the creditor's reference or payment remittance identification should be quoted in the end-to-end transaction identification.
The date on which the first payment for a Standing Order schedule will be made.All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00
The date on which the next payment for a Standing Order schedule will be made.All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00
The date on which the final payment for a Standing Order schedule will be made.All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00
Individual Definitions: EvryDay - Every day EvryWorkgDay - Every working day IntrvlWkDay - An interval specified in weeks (01 to 09), and the day within the week (01 to 07) WkInMnthDay - A monthly interval, specifying the week of the month (01 to 05) and day within the week (01 to 07) IntrvlMnthDay - An interval specified in months (between 01 to 06, 12, 24), specifying the day within the month (-5 to -1, 1 to 31) QtrDay - Quarterly (either ENGLISH, SCOTTISH, or RECEIVED) ENGLISH = Paid on the 25th March, 24th June, 29th September and 25th December. SCOTTISH = Paid on the 2nd February, 15th May, 1st August and 11th November. RECEIVED = Paid on the 20th March, 19th June, 24th September and 20th December. Individual Patterns: EvryDay (ScheduleCode) EvryWorkgDay (ScheduleCode) IntrvlWkDay:IntervalInWeeks:DayInWeek (ScheduleCode + IntervalInWeeks + DayInWeek) WkInMnthDay:WeekInMonth:DayInWeek (ScheduleCode + WeekInMonth + DayInWeek) IntrvlMnthDay:IntervalInMonths:DayInMonth (ScheduleCode + IntervalInMonths + DayInMonth) QtrDay: + either (ENGLISH, SCOTTISH or RECEIVED) ScheduleCode + QuarterDay The regular expression for this element combines five smaller versions for each permitted pattern. To aid legibility - the components are presented individually here: EvryDay EvryWorkgDay IntrvlWkDay:0[1-9]:0[1-7] WkInMnthDay:0[1-5]:0[1-7] IntrvlMnthDay:(0[1-6]
Unique reference, as assigned by the creditor, to unambiguously refer to the payment transaction. Usage: If available, the initiating party should provide this reference in the structured remittance information, to enable reconciliation by the creditor upon receipt of the amount of money. If the business context requires the use of a creditor reference or a payment remit identification, and only one identifier can be passed through the end-to-end chain, the creditor's reference or payment remittance identification should be quoted in the end-to-end transaction identification.
The date on which the first payment for a Standing Order schedule will be made.All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00
The date on which the next payment for a Standing Order schedule will be made.All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00
The date on which the final payment for a Standing Order schedule will be made.All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00
Party that manages the account on behalf of the account owner, that is manages the registration and booking of entries on the account, calculates balances on the account and provides information about the account. This is the servicer of the beneficiary account.
Individual Definitions: EvryDay - Every day EvryWorkgDay - Every working day IntrvlWkDay - An interval specified in weeks (01 to 09), and the day within the week (01 to 07) WkInMnthDay - A monthly interval, specifying the week of the month (01 to 05) and day within the week (01 to 07) IntrvlMnthDay - An interval specified in months (between 01 to 06, 12, 24), specifying the day within the month (-5 to -1, 1 to 31) QtrDay - Quarterly (either ENGLISH, SCOTTISH, or RECEIVED) ENGLISH = Paid on the 25th March, 24th June, 29th September and 25th December. SCOTTISH = Paid on the 2nd February, 15th May, 1st August and 11th November. RECEIVED = Paid on the 20th March, 19th June, 24th September and 20th December. Individual Patterns: EvryDay (ScheduleCode) EvryWorkgDay (ScheduleCode) IntrvlWkDay:IntervalInWeeks:DayInWeek (ScheduleCode + IntervalInWeeks + DayInWeek) WkInMnthDay:WeekInMonth:DayInWeek (ScheduleCode + WeekInMonth + DayInWeek) IntrvlMnthDay:IntervalInMonths:DayInMonth (ScheduleCode + IntervalInMonths + DayInMonth) QtrDay: + either (ENGLISH, SCOTTISH or RECEIVED) ScheduleCode + QuarterDay The regular expression for this element combines five smaller versions for each permitted pattern. To aid legibility - the components are presented individually here: EvryDay EvryWorkgDay IntrvlWkDay:0[1-9]:0[1-7] WkInMnthDay:0[1-5]:0[1-7] IntrvlMnthDay:(0[1-6]
Unique reference, as assigned by the creditor, to unambiguously refer to the payment transaction. Usage: If available, the initiating party should provide this reference in the structured remittance information, to enable reconciliation by the creditor upon receipt of the amount of money. If the business context requires the use of a creditor reference or a payment remit identification, and only one identifier can be passed through the end-to-end chain, the creditor's reference or payment remittance identification should be quoted in the end-to-end transaction identification.
The date on which the first payment for a Standing Order schedule will be made.All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00
The date on which the next payment for a Standing Order schedule will be made.All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00
The date on which the final payment for a Standing Order schedule will be made.All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00
Individual Definitions: EvryDay - Every day EvryWorkgDay - Every working day IntrvlWkDay - An interval specified in weeks (01 to 09), and the day within the week (01 to 07) WkInMnthDay - A monthly interval, specifying the week of the month (01 to 05) and day within the week (01 to 07) IntrvlMnthDay - An interval specified in months (between 01 to 06, 12, 24), specifying the day within the month (-5 to -1, 1 to 31) QtrDay - Quarterly (either ENGLISH, SCOTTISH, or RECEIVED) ENGLISH = Paid on the 25th March, 24th June, 29th September and 25th December. SCOTTISH = Paid on the 2nd February, 15th May, 1st August and 11th November. RECEIVED = Paid on the 20th March, 19th June, 24th September and 20th December. Individual Patterns: EvryDay (ScheduleCode) EvryWorkgDay (ScheduleCode) IntrvlWkDay:IntervalInWeeks:DayInWeek (ScheduleCode + IntervalInWeeks + DayInWeek) WkInMnthDay:WeekInMonth:DayInWeek (ScheduleCode + WeekInMonth + DayInWeek) IntrvlMnthDay:IntervalInMonths:DayInMonth (ScheduleCode + IntervalInMonths + DayInMonth) QtrDay: + either (ENGLISH, SCOTTISH or RECEIVED) ScheduleCode + QuarterDay The regular expression for this element combines five smaller versions for each permitted pattern. To aid legibility - the components are presented individually here: EvryDay EvryWorkgDay IntrvlWkDay:0[1-9]:0[1-7] WkInMnthDay:0[1-5]:0[1-7] IntrvlMnthDay:(0[1-6]
Unique reference, as assigned by the creditor, to unambiguously refer to the payment transaction. Usage: If available, the initiating party should provide this reference in the structured remittance information, to enable reconciliation by the creditor upon receipt of the amount of money. If the business context requires the use of a creditor reference or a payment remit identification, and only one identifier can be passed through the end-to-end chain, the creditor's reference or payment remittance identification should be quoted in the end-to-end transaction identification.
The date on which the first payment for a Standing Order schedule will be made.All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00
The date on which the next payment for a Standing Order schedule will be made.All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00
The date on which the final payment for a Standing Order schedule will be made.All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00
Party that manages the account on behalf of the account owner, that is manages the registration and booking of entries on the account, calculates balances on the account and provides information about the account. This is the servicer of the beneficiary account.
Date and time at which the statement period starts.All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00
Date and time at which the statement period ends.All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00
Date and time at which the resource was created.All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00
Date and time associated with the date time type.All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00
Date and time at which the statement period starts.All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00
Date and time at which the statement period ends.All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00
Date and time at which the resource was created.All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00
Date and time associated with the date time type.All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00
Date and time when a transaction entry is posted to an account on the account servicer's books. Usage: Booking date is the expected booking date, unless the status is booked, in which case it is the actual booking date.All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00
Date and time at which assets become available to the account owner in case of a credit entry, or cease to be available to the account owner in case of a debit transaction entry. Usage: If transaction entry status is pending and value date is present, then the value date refers to an expected/requested value date. For transaction entries subject to availability/float and for which availability information is provided, the value date must not be used. In this case the availability component identifies the number of availability days.All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00
Date and time when a transaction entry is posted to an account on the account servicer's books. Usage: Booking date is the expected booking date, unless the status is booked, in which case it is the actual booking date.All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00
Date and time at which assets become available to the account owner in case of a credit entry, or cease to be available to the account owner in case of a debit transaction entry. Usage: If transaction entry status is pending and value date is present, then the value date refers to an expected/requested value date. For transaction entries subject to availability/float and for which availability information is provided, the value date must not be used. In this case the availability component identifies the number of availability days.All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00
Set of elements used to define the balance as a numerical representation of the net increases and decreases in an account after a transaction entry is applied to the account.
Set of elements to describe the card instrument used in the transaction.
Properties
Name
Type
Required
Restrictions
Description
CardSchemeName
string
true
none
Name of the card scheme.
AuthorisationType
string
false
none
The card authorisation type.
Name
string
false
none
Name of the cardholder using the card instrument.
Identification
string
false
none
Identification assigned by an institution to identify the card instrument used in the transaction. This identification is known by the account owner, and may be masked.
Set of elements used to define the balance as a numerical representation of the net increases and decreases in an account after a transaction entry is applied to the account.
A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 "Codes for the representation of currencies and funds".
OB_Amount1_0
"string"
Cap amount charged for a fee/charge
Properties
Name
Type
Required
Restrictions
Description
anonymous
string
false
none
Cap amount charged for a fee/charge
OB_Amount1_1
"string"
Every additional tranche of an overdraft balance to which an overdraft fee is applied
Properties
Name
Type
Required
Restrictions
Description
anonymous
string
false
none
Every additional tranche of an overdraft balance to which an overdraft fee is applied
OB_Amount1_2
"string"
Amount charged for an overdraft fee/charge (where it is charged in terms of an amount rather than a rate)
Properties
Name
Type
Required
Restrictions
Description
anonymous
string
false
none
Amount charged for an overdraft fee/charge (where it is charged in terms of an amount rather than a rate)
OB_Amount1_3
"string"
Fee Amount charged for a fee/charge (where it is charged in terms of an amount rather than a rate)
Properties
Name
Type
Required
Restrictions
Description
anonymous
string
false
none
Fee Amount charged for a fee/charge (where it is charged in terms of an amount rather than a rate)
OB_Amount1_4
"string"
Cap amount charged for a fee/charge (where it is charged in terms of an amount rather than a rate)
Properties
Name
Type
Required
Restrictions
Description
anonymous
string
false
none
Cap amount charged for a fee/charge (where it is charged in terms of an amount rather than a rate)
OB_CodeMnemonic
"string"
The four letter Mnemonic used within an XML file to identify a code
Properties
Name
Type
Required
Restrictions
Description
anonymous
string
false
none
The four letter Mnemonic used within an XML file to identify a code
OB_FeeCategory1Code
"FCOT"
Categorisation of fees and charges into standard categories.
Properties
Name
Type
Required
Restrictions
Description
anonymous
string
false
none
Categorisation of fees and charges into standard categories.
Enumerated Values
Property
Value
anonymous
FCOT
anonymous
FCRE
anonymous
FCSV
OB_FeeFrequency1Code_0
"FEAC"
Frequency at which the overdraft charge is applied to the account
Properties
Name
Type
Required
Restrictions
Description
anonymous
string
false
none
Frequency at which the overdraft charge is applied to the account
Enumerated Values
Property
Value
anonymous
FEAC
anonymous
FEAO
anonymous
FECP
anonymous
FEDA
anonymous
FEHO
anonymous
FEI
anonymous
FEMO
anonymous
FEOA
anonymous
FEOT
anonymous
FEPC
anonymous
FEPH
anonymous
FEPO
anonymous
FEPS
anonymous
FEPT
anonymous
FEPTA
anonymous
FEPTP
anonymous
FEQU
anonymous
FESM
anonymous
FEST
anonymous
FEWE
anonymous
FEYE
OB_FeeFrequency1Code_1
"FEAC"
How often is the overdraft fee/charge calculated for the account.
Properties
Name
Type
Required
Restrictions
Description
anonymous
string
false
none
How often is the overdraft fee/charge calculated for the account.
Enumerated Values
Property
Value
anonymous
FEAC
anonymous
FEAO
anonymous
FECP
anonymous
FEDA
anonymous
FEHO
anonymous
FEI
anonymous
FEMO
anonymous
FEOA
anonymous
FEOT
anonymous
FEPC
anonymous
FEPH
anonymous
FEPO
anonymous
FEPS
anonymous
FEPT
anonymous
FEPTA
anonymous
FEPTP
anonymous
FEQU
anonymous
FESM
anonymous
FEST
anonymous
FEWE
anonymous
FEYE
OB_FeeFrequency1Code_2
"FEAC"
How frequently the fee/charge is applied to the account
Properties
Name
Type
Required
Restrictions
Description
anonymous
string
false
none
How frequently the fee/charge is applied to the account
Enumerated Values
Property
Value
anonymous
FEAC
anonymous
FEAO
anonymous
FECP
anonymous
FEDA
anonymous
FEHO
anonymous
FEI
anonymous
FEMO
anonymous
FEOA
anonymous
FEOT
anonymous
FEPC
anonymous
FEPH
anonymous
FEPO
anonymous
FEPS
anonymous
FEPT
anonymous
FEPTA
anonymous
FEPTP
anonymous
FEQU
anonymous
FESM
anonymous
FEST
anonymous
FEWE
anonymous
FEYE
OB_FeeFrequency1Code_3
"FEAC"
How frequently the fee/charge is calculated
Properties
Name
Type
Required
Restrictions
Description
anonymous
string
false
none
How frequently the fee/charge is calculated
Enumerated Values
Property
Value
anonymous
FEAC
anonymous
FEAO
anonymous
FECP
anonymous
FEDA
anonymous
FEHO
anonymous
FEI
anonymous
FEMO
anonymous
FEOA
anonymous
FEOT
anonymous
FEPC
anonymous
FEPH
anonymous
FEPO
anonymous
FEPS
anonymous
FEPT
anonymous
FEPTA
anonymous
FEPTP
anonymous
FEQU
anonymous
FESM
anonymous
FEST
anonymous
FEWE
anonymous
FEYE
OB_FeeFrequency1Code_4
"FEAC"
Period e.g. day, week, month etc. for which the fee/charge is capped
Properties
Name
Type
Required
Restrictions
Description
anonymous
string
false
none
Period e.g. day, week, month etc. for which the fee/charge is capped
Enumerated Values
Property
Value
anonymous
FEAC
anonymous
FEAO
anonymous
FECP
anonymous
FEDA
anonymous
FEHO
anonymous
FEI
anonymous
FEMO
anonymous
FEOA
anonymous
FEOT
anonymous
FEPC
anonymous
FEPH
anonymous
FEPO
anonymous
FEPS
anonymous
FEPT
anonymous
FEPTA
anonymous
FEPTP
anonymous
FEQU
anonymous
FESM
anonymous
FEST
anonymous
FEWE
anonymous
FEYE
OB_FeeType1Code
"FEPF"
Fee/Charge Type
Properties
Name
Type
Required
Restrictions
Description
anonymous
string
false
none
Fee/Charge Type
Enumerated Values
Property
Value
anonymous
FEPF
anonymous
FTOT
anonymous
FYAF
anonymous
FYAM
anonymous
FYAQ
anonymous
FYCP
anonymous
FYDB
anonymous
FYMI
anonymous
FYXX
OB_InterestCalculationMethod1Code
"ITCO"
Methods of calculating interest
Properties
Name
Type
Required
Restrictions
Description
anonymous
string
false
none
Methods of calculating interest
Enumerated Values
Property
Value
anonymous
ITCO
anonymous
ITOT
anonymous
ITSI
OB_InterestFixedVariableType1Code
"INFI"
Type of interest rate, Fixed or Variable
Properties
Name
Type
Required
Restrictions
Description
anonymous
string
false
none
Type of interest rate, Fixed or Variable
Enumerated Values
Property
Value
anonymous
INFI
anonymous
INVA
OB_InterestRateType1Code_0
"INBB"
Rate type for overdraft fee/charge (where it is charged in terms of a rate rather than an amount)
Properties
Name
Type
Required
Restrictions
Description
anonymous
string
false
none
Rate type for overdraft fee/charge (where it is charged in terms of a rate rather than an amount)
Enumerated Values
Property
Value
anonymous
INBB
anonymous
INFR
anonymous
INGR
anonymous
INLR
anonymous
INNE
anonymous
INOT
OB_InterestRateType1Code_1
"INBB"
Rate type for Fee/Charge (where it is charged in terms of a rate rather than an amount)
Properties
Name
Type
Required
Restrictions
Description
anonymous
string
false
none
Rate type for Fee/Charge (where it is charged in terms of a rate rather than an amount)
Period e.g. day, week, month etc. for which the fee/charge is capped
Properties
Name
Type
Required
Restrictions
Description
anonymous
string
false
none
Period e.g. day, week, month etc. for which the fee/charge is capped
Enumerated Values
Property
Value
anonymous
PACT
anonymous
PDAY
anonymous
PHYR
anonymous
PMTH
anonymous
PQTR
anonymous
PWEK
anonymous
PYER
OB_Rate1_0
"string"
Rate charged for overdraft fee/charge (where it is charged in terms of a rate rather than an amount)
Properties
Name
Type
Required
Restrictions
Description
anonymous
string
false
none
Rate charged for overdraft fee/charge (where it is charged in terms of a rate rather than an amount)
OB_Rate1_1
"string"
Rate charged for Fee/Charge (where it is charged in terms of a rate rather than an amount)
Properties
Name
Type
Required
Restrictions
Description
anonymous
string
false
none
Rate charged for Fee/Charge (where it is charged in terms of a rate rather than an amount)
PartyId
"string"
A unique and immutable identifier used to identify the customer resource. This identifier has no meaning to the account owner.
Properties
Name
Type
Required
Restrictions
Description
anonymous
string
false
none
A unique and immutable identifier used to identify the customer resource. This identifier has no meaning to the account owner.
PartyNumber
"string"
Number assigned by an agent to identify its customer.
Properties
Name
Type
Required
Restrictions
Description
anonymous
string
false
none
Number assigned by an agent to identify its customer.
PhoneNumber_0
"string"
Collection of information that identifies a phone number, as defined by telecom services.
Properties
Name
Type
Required
Restrictions
Description
anonymous
string
false
none
Collection of information that identifies a phone number, as defined by telecom services.
PhoneNumber_1
"string"
Collection of information that identifies a mobile phone number, as defined by telecom services.
Properties
Name
Type
Required
Restrictions
Description
anonymous
string
false
none
Collection of information that identifies a mobile phone number, as defined by telecom services.
ProprietaryBankTransactionCodeStructure1
{
"Code": "string",
"Issuer": "string"
}
Set of elements to fully identify a proprietary bank transaction code.
Properties
Name
Type
Required
Restrictions
Description
Code
string
true
none
Proprietary bank transaction code to identify the underlying transaction.
Issuer
string
false
none
Identification of the issuer of the proprietary bank transaction code.
Reference
"string"
Unique reference, as assigned by the creditor, to unambiguously refer to the payment transaction.
Usage: If available, the initiating party should provide this reference in the structured remittance information, to enable reconciliation by the creditor upon receipt of the amount of money.
If the business context requires the use of a creditor reference or a payment remit identification, and only one identifier can be passed through the end-to-end chain, the creditor's reference or payment remittance identification should be quoted in the end-to-end transaction identification.
Properties
Name
Type
Required
Restrictions
Description
anonymous
string
false
none
Unique reference, as assigned by the creditor, to unambiguously refer to the payment transaction. Usage: If available, the initiating party should provide this reference in the structured remittance information, to enable reconciliation by the creditor upon receipt of the amount of money. If the business context requires the use of a creditor reference or a payment remit identification, and only one identifier can be passed through the end-to-end chain, the creditor's reference or payment remittance identification should be quoted in the end-to-end transaction identification.
ScheduledPaymentDateTime
"2020-10-23T10:23:58Z"
The date on which the scheduled payment will be made.All dates in the JSON payloads are represented in ISO 8601 date-time format.
All date-time fields in responses must include the timezone. An example is below:
2017-04-05T10:43:07+00:00
Properties
Name
Type
Required
Restrictions
Description
anonymous
string(date-time)
false
none
The date on which the scheduled payment will be made.All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00
ScheduledPaymentId
"string"
A unique and immutable identifier used to identify the scheduled payment resource. This identifier has no meaning to the account owner.
Properties
Name
Type
Required
Restrictions
Description
anonymous
string
false
none
A unique and immutable identifier used to identify the scheduled payment resource. This identifier has no meaning to the account owner.
StandingOrderId
"string"
A unique and immutable identifier used to identify the standing order resource. This identifier has no meaning to the account owner.
Properties
Name
Type
Required
Restrictions
Description
anonymous
string
false
none
A unique and immutable identifier used to identify the standing order resource. This identifier has no meaning to the account owner.
StartDateTime
"2020-10-23T10:23:58Z"
Date and time at which the statement period starts.All dates in the JSON payloads are represented in ISO 8601 date-time format.
All date-time fields in responses must include the timezone. An example is below:
2017-04-05T10:43:07+00:00
Properties
Name
Type
Required
Restrictions
Description
anonymous
string(date-time)
false
none
Date and time at which the statement period starts.All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00
StatementId
"string"
Unique identifier for the statement resource within an servicing institution. This identifier is both unique and immutable.
Properties
Name
Type
Required
Restrictions
Description
anonymous
string
false
none
Unique identifier for the statement resource within an servicing institution. This identifier is both unique and immutable.
StatementReference
"string"
Unique reference for the statement. This reference may be optionally populated if available.
Properties
Name
Type
Required
Restrictions
Description
anonymous
string
false
none
Unique reference for the statement. This reference may be optionally populated if available.
StatusUpdateDateTime
"2020-10-23T10:23:58Z"
Date and time at which the resource status was updated.All dates in the JSON payloads are represented in ISO 8601 date-time format.
All date-time fields in responses must include the timezone. An example is below:
2017-04-05T10:43:07+00:00
Properties
Name
Type
Required
Restrictions
Description
anonymous
string(date-time)
false
none
Date and time at which the resource status was updated.All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00
TransactionId
"string"
Unique identifier for the transaction within an servicing institution. This identifier is both unique and immutable.
Properties
Name
Type
Required
Restrictions
Description
anonymous
string
false
none
Unique identifier for the transaction within an servicing institution. This identifier is both unique and immutable.
TransactionInformation
"string"
Further details of the transaction.
This is the transaction narrative, which is unstructured text.
Properties
Name
Type
Required
Restrictions
Description
anonymous
string
false
none
Further details of the transaction. This is the transaction narrative, which is unstructured text.
TransactionReference
"string"
Unique reference for the transaction. This reference is optionally populated, and may as an example be the FPID in the Faster Payments context.
Properties
Name
Type
Required
Restrictions
Description
anonymous
string
false
none
Unique reference for the transaction. This reference is optionally populated, and may as an example be the FPID in the Faster Payments context.
Type_0
"string"
Statement rate type, in a coded form.
Properties
Name
Type
Required
Restrictions
Description
anonymous
string
false
none
Statement rate type, in a coded form.
Type_1
"string"
Statement value type, in a coded form.
Properties
Name
Type
Required
Restrictions
Description
anonymous
string
false
none
Statement value type, in a coded form.
ValueDateTime
"2020-10-23T10:23:58Z"
Date and time at which assets become available to the account owner in case of a credit entry, or cease to be available to the account owner in case of a debit transaction entry.
Usage: If transaction entry status is pending and value date is present, then the value date refers to an expected/requested value date.
For transaction entries subject to availability/float and for which availability information is provided, the value date must not be used. In this case the availability component identifies the number of availability days.All dates in the JSON payloads are represented in ISO 8601 date-time format.
All date-time fields in responses must include the timezone. An example is below:
2017-04-05T10:43:07+00:00
Properties
Name
Type
Required
Restrictions
Description
anonymous
string(date-time)
false
none
Date and time at which assets become available to the account owner in case of a credit entry, or cease to be available to the account owner in case of a debit transaction entry. Usage: If transaction entry status is pending and value date is present, then the value date refers to an expected/requested value date. For transaction entries subject to availability/float and for which availability information is provided, the value date must not be used. In this case the availability component identifies the number of availability days.All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00
Request data for resending webhook events. At least one of StartDate and EndDate must be provided. If both are provided they must be no more than 14 days apart
Request data for resending webhook events. At least one of StartDate and EndDate must be provided. If both are provided they must be no more than 14 days apart
Properties
Name
Type
Required
Restrictions
Description
StartDate
string(date-time)|null
false
none
Start date to find webhook events. If provided this must be in the past, but by no more than one year
EndDate
string(date-time)|null
false
none
End date to find webhook events, If provided this must be in the past
IncludeSent
boolean|null
false
none
If provided and true, also resend events that were successfully received. Otherwise only uncessfully events will be resent
