---
swagger: "2.0"
info:
x-ibm-name: ob-payment-initiation-v31
title: Payment Initiation V3
description: "This API provides the ability for authorised payment initiation service
providers (PISPs, TPPs � third party providers) to initiate and set up new domestic,
international and file based payments. The TPPs will be able to initiate requests
directly from the customer�s (PSU- payment service user) current - personal or
business - accounts, after being granted consent. Within Domestic Payments, Faster
and CHAPS immediate payments can be initiated. This API is developed according
to the Open Banking Read/Write API Specifications and fulfils PSD2 regulation,
see https://www.openbanking.org.uk\n\n\n
\n**API Information**\n\n| Title |
Payment Initiation V3 |\n|-----|-----|\n| Protocol | TLS-MA |\n| Open Banking
Specification Version | 3.1 |\n| Access | Free to use but subscription is
required |\n\n\n** Key Features:**\n-\tDomestic payments (in GBP)\n-\tDomestic
scheduled payments (in GBP)\n-\tDomestic standing orders (in GBP)\n-\tInternational
payments\n-\tFile payments (Domestic payments in GBP, File Status & Report File)\n\n
\n\n**
Not in this version: **\n\n**_Domestic Payments_**\n\nSantander do not support
the object \"Authorisation\" for the domestic-payment-consents endpoint. If a
PISP consent request is received with this object, it will be rejected as a HTTP
400 BAD request.\n\n**_International Payments_**\n\nSantander do not support \"InstructionPriority\"
for the international-payment-consents endpoint. If a PISP consent request is
received with this, it will be rejected as a HTTP 400 BAD request.
\n\nSantander
only support DebtorAccount/SchemeName equal to UK.OBIE.SortCodeAccountNumber or
SortCodeAccountNumber for the international-payment-consents endpoint, when populated
in the request. If a PISP consent request is received with a different DebtorAccount/SchemeName,
(or with a DebtorAccount structure but the SchemeName value = NULL), it will be
rejected as a HTTP 400 BAD request.
\n\nSantander only support a CreditorAgent/SchemeName
of UK.OBIE.BICFI or BICFI for the international-payment-consents endpoint. If
a PISP consent request is received with a different CreditorAgent/SchemeName,
(or with UK.OBIE.BICFI or BICFI but further validations are not passed), it will
be rejected as a HTTP 400 BAD request. A request for sending USD to US can provide
the NCCCode and NCCIdentification in SupplementaryData instead of the CreditorAgent
SchemeName and Identification (see below).
\n\nSantander only support
an international payment request where the CreditorAccount/SchemeName is UK.OBIE.IBAN
or UK.Santander.OtherAccount (or IBAN or OtherAccount) for the international-payment-consents
endpoint. If a PISP consent request is received with a different CreditorAccount/SchemeName
it will be rejected as a HTTP 400 BAD request.
\n\nPlease note that customers
executing an international payment will not have visibility of personalised charges/final
charges and exchange rates until the requested payment has been executed by Santander
UK.
\n\nExecution of any SEPA payments for Corporate customers is not
available.
\n\n**_File Payments_**\n\nSantander only supports Bulk Faster Payment
File processing (1 debit for multiple credit payments) for SBBI & Corporate Business
Customers. OB File Payments processing is not supported for Retail Santander customers
(including Cahoot).
\nSantander will only support payment files uploaded
in the 'UK.OBIE.PaymentInitiation.3.1' format. Any other type of file format uploaded
will result in the file being rejected.
\nSantander will only accept domestic
payments specified in the PaymentInitiation file that will be processed via faster
payment scheme. The payments will need to have the LocalInstrument value set to
�UK.OBIE.FPS�. Any other payment type will result in the file being rejected.
\nSantander does not currently support scheduled payments for domestic
file payments processing.
\nSantander does not currently support multi-auth
processing for BULK faster payments file processing.
\nSantander will
not currently provide individual payment status details in the report-file for
BULK file payments. \n\n** **"
termsOfService: https://www.openbanking.org.uk/terms
contact:
name: Support Mailbox
email: PaymentsAPIsSupport@santander.co.uk
license:
name: Open Banking
url: https://www.openbanking.org.uk/terms
version: 3.1.99
basePath: /open-banking/v3.1/pisp
schemes:
- https
consumes:
- application/json; charset=utf-8
produces:
- application/json; charset=utf-8
paths:
/domestic-payment-consents:
post:
tags:
- Domestic Payments
summary: Create Domestic Payment Consents
operationId: DPCPost
parameters:
- $ref: '#/parameters/OBWriteDomesticConsent4Param'
- $ref: '#/parameters/x-fapi-auth-date'
- $ref: '#/parameters/x-fapi-customer-ip-address'
- $ref: '#/parameters/x-fapi-interaction-id'
- $ref: '#/parameters/Authorization'
- $ref: '#/parameters/x-idempotency-key'
- $ref: '#/parameters/x-jws-signature'
- $ref: '#/parameters/x-customer-user-agent'
produces:
- application/json; charset=utf-8
responses:
201:
$ref: '#/responses/201DomesticPaymentConsentsCreated'
400:
$ref: '#/responses/400Error'
401:
$ref: '#/responses/401Error'
403:
$ref: '#/responses/403Error'
405:
$ref: '#/responses/405Error'
406:
$ref: '#/responses/406Error'
415:
$ref: '#/responses/415Error'
429:
$ref: '#/responses/429Error'
500:
$ref: '#/responses/500Error'
security:
- TPPOAuth2Security:
- payments
/domestic-payment-consents/{ConsentId}:
get:
tags:
- Domestic Payments
summary: Get Domestic Payment Consents
operationId: DPCGet
parameters:
- $ref: '#/parameters/ConsentId'
- $ref: '#/parameters/x-fapi-auth-date'
- $ref: '#/parameters/x-fapi-customer-ip-address'
- $ref: '#/parameters/x-fapi-interaction-id'
- $ref: '#/parameters/Authorization'
- $ref: '#/parameters/x-customer-user-agent'
produces:
- application/json; charset=utf-8
responses:
200:
$ref: '#/responses/200DomesticPaymentConsentsConsentIdRead'
400:
$ref: '#/responses/400Error'
401:
$ref: '#/responses/401Error'
403:
$ref: '#/responses/403Error'
404:
$ref: '#/responses/404Error'
405:
$ref: '#/responses/405Error'
406:
$ref: '#/responses/406Error'
429:
$ref: '#/responses/429Error'
500:
$ref: '#/responses/500Error'
security:
- TPPOAuth2Security:
- payments
/domestic-payment-consents/{ConsentId}/funds-confirmation:
get:
tags:
- Domestic Payments
summary: Get Domestic Payment Consents Funds Confirmation
operationId: DPCCoFGet
parameters:
- $ref: '#/parameters/ConsentId'
- $ref: '#/parameters/x-fapi-auth-date'
- $ref: '#/parameters/x-fapi-customer-ip-address'
- $ref: '#/parameters/x-fapi-interaction-id'
- $ref: '#/parameters/Authorization'
- $ref: '#/parameters/x-customer-user-agent'
produces:
- application/json; charset=utf-8
responses:
200:
$ref: '#/responses/200DomesticPaymentConsentsConsentIdFundsConfirmationRead'
400:
$ref: '#/responses/400Error'
401:
$ref: '#/responses/401Error'
403:
$ref: '#/responses/403Error'
405:
$ref: '#/responses/405Error'
406:
$ref: '#/responses/406Error'
429:
$ref: '#/responses/429Error'
500:
$ref: '#/responses/500Error'
security:
- PSUOAuth2Security:
- payments
/domestic-payments:
post:
tags:
- Domestic Payments
summary: Create Domestic Payments
operationId: DPPost
parameters:
- $ref: '#/parameters/OBWriteDomestic2Param'
- $ref: '#/parameters/x-fapi-auth-date'
- $ref: '#/parameters/x-fapi-customer-ip-address'
- $ref: '#/parameters/x-fapi-interaction-id'
- $ref: '#/parameters/Authorization'
- $ref: '#/parameters/x-idempotency-key'
- $ref: '#/parameters/x-jws-signature'
- $ref: '#/parameters/x-customer-user-agent'
produces:
- application/json; charset=utf-8
responses:
201:
$ref: '#/responses/201DomesticPaymentsCreated'
400:
$ref: '#/responses/400Error'
401:
$ref: '#/responses/401Error'
403:
$ref: '#/responses/403Error'
405:
$ref: '#/responses/405Error'
406:
$ref: '#/responses/406Error'
415:
$ref: '#/responses/415Error'
429:
$ref: '#/responses/429Error'
500:
$ref: '#/responses/500Error'
security:
- PSUOAuth2Security:
- payments
/domestic-payments/{DomesticPaymentId}:
get:
tags:
- Domestic Payments
summary: Get Domestic Payments
operationId: DPGet
parameters:
- $ref: '#/parameters/DomesticPaymentId'
- $ref: '#/parameters/x-fapi-auth-date'
- $ref: '#/parameters/x-fapi-customer-ip-address'
- $ref: '#/parameters/x-fapi-interaction-id'
- $ref: '#/parameters/Authorization'
- $ref: '#/parameters/x-customer-user-agent'
produces:
- application/json; charset=utf-8
responses:
200:
$ref: '#/responses/200DomesticPaymentsDomesticPaymentIdRead'
400:
$ref: '#/responses/400Error'
401:
$ref: '#/responses/401Error'
403:
$ref: '#/responses/403Error'
404:
$ref: '#/responses/404Error'
405:
$ref: '#/responses/405Error'
406:
$ref: '#/responses/406Error'
429:
$ref: '#/responses/429Error'
500:
$ref: '#/responses/500Error'
security:
- TPPOAuth2Security:
- payments
/domestic-scheduled-payment-consents:
post:
tags:
- Domestic Scheduled Payments
summary: Create Domestic Scheduled Payment Consents
operationId: DSPCPost
parameters:
- $ref: '#/parameters/OBWriteDomesticScheduledConsent4Param'
- $ref: '#/parameters/x-fapi-auth-date'
- $ref: '#/parameters/x-fapi-customer-ip-address'
- $ref: '#/parameters/x-fapi-interaction-id'
- $ref: '#/parameters/Authorization'
- $ref: '#/parameters/x-idempotency-key'
- $ref: '#/parameters/x-jws-signature'
- $ref: '#/parameters/x-customer-user-agent'
produces:
- application/json; charset=utf-8
responses:
201:
$ref: '#/responses/201DomesticScheduledPaymentConsentsCreated'
400:
$ref: '#/responses/400Error'
401:
$ref: '#/responses/401Error'
403:
$ref: '#/responses/403Error'
404:
$ref: '#/responses/404Error'
405:
$ref: '#/responses/405Error'
406:
$ref: '#/responses/406Error'
415:
$ref: '#/responses/415Error'
429:
$ref: '#/responses/429Error'
500:
$ref: '#/responses/500Error'
security:
- TPPOAuth2Security:
- payments
/domestic-scheduled-payment-consents/{ConsentId}:
get:
tags:
- Domestic Scheduled Payments
summary: Get Domestic Scheduled Payment Consents
operationId: DSPCGet
parameters:
- $ref: '#/parameters/ConsentId'
- $ref: '#/parameters/x-fapi-auth-date'
- $ref: '#/parameters/x-fapi-customer-ip-address'
- $ref: '#/parameters/x-fapi-interaction-id'
- $ref: '#/parameters/Authorization'
- $ref: '#/parameters/x-customer-user-agent'
produces:
- application/json; charset=utf-8
responses:
200:
$ref: '#/responses/200DomesticScheduledPaymentConsentsConsentIdRead'
400:
$ref: '#/responses/400Error'
401:
$ref: '#/responses/401Error'
403:
$ref: '#/responses/403Error'
404:
$ref: '#/responses/404Error'
405:
$ref: '#/responses/405Error'
406:
$ref: '#/responses/406Error'
429:
$ref: '#/responses/429Error'
500:
$ref: '#/responses/500Error'
security:
- TPPOAuth2Security:
- payments
/domestic-scheduled-payments:
post:
tags:
- Domestic Scheduled Payments
summary: Create Domestic Scheduled Payments
operationId: DSPPost
parameters:
- $ref: '#/parameters/OBWriteDomesticScheduled2Param'
- $ref: '#/parameters/x-fapi-auth-date'
- $ref: '#/parameters/x-fapi-customer-ip-address'
- $ref: '#/parameters/x-fapi-interaction-id'
- $ref: '#/parameters/Authorization'
- $ref: '#/parameters/x-idempotency-key'
- $ref: '#/parameters/x-jws-signature'
- $ref: '#/parameters/x-customer-user-agent'
produces:
- application/json; charset=utf-8
responses:
201:
$ref: '#/responses/201DomesticScheduledPaymentsCreated'
400:
$ref: '#/responses/400Error'
401:
$ref: '#/responses/401Error'
403:
$ref: '#/responses/403Error'
404:
$ref: '#/responses/404Error'
405:
$ref: '#/responses/405Error'
406:
$ref: '#/responses/406Error'
415:
$ref: '#/responses/415Error'
429:
$ref: '#/responses/429Error'
500:
$ref: '#/responses/500Error'
security:
- PSUOAuth2Security:
- payments
/domestic-scheduled-payments/{DomesticScheduledPaymentId}:
get:
tags:
- Domestic Scheduled Payments
summary: Get Domestic Scheduled Payments
operationId: DSPGet
parameters:
- $ref: '#/parameters/DomesticScheduledPaymentId'
- $ref: '#/parameters/x-fapi-auth-date'
- $ref: '#/parameters/x-fapi-customer-ip-address'
- $ref: '#/parameters/x-fapi-interaction-id'
- $ref: '#/parameters/Authorization'
- $ref: '#/parameters/x-customer-user-agent'
produces:
- application/json; charset=utf-8
responses:
200:
$ref: '#/responses/200DomesticScheduledPaymentsDomesticScheduledPaymentIdRead'
400:
$ref: '#/responses/400Error'
401:
$ref: '#/responses/401Error'
403:
$ref: '#/responses/403Error'
404:
$ref: '#/responses/404Error'
405:
$ref: '#/responses/405Error'
406:
$ref: '#/responses/406Error'
429:
$ref: '#/responses/429Error'
500:
$ref: '#/responses/500Error'
security:
- TPPOAuth2Security:
- payments
/domestic-standing-order-consents:
post:
tags:
- Domestic Standing Orders
summary: Create Domestic Standing Order Consents
operationId: DSOCPost
parameters:
- $ref: '#/parameters/OBWriteDomesticStandingOrderConsent5Param'
- $ref: '#/parameters/x-fapi-auth-date'
- $ref: '#/parameters/x-fapi-customer-ip-address'
- $ref: '#/parameters/x-fapi-interaction-id'
- $ref: '#/parameters/Authorization'
- $ref: '#/parameters/x-idempotency-key'
- $ref: '#/parameters/x-jws-signature'
- $ref: '#/parameters/x-customer-user-agent'
produces:
- application/json; charset=utf-8
responses:
201:
$ref: '#/responses/201DomesticStandingOrderConsentsCreated'
400:
$ref: '#/responses/400Error'
401:
$ref: '#/responses/401Error'
403:
$ref: '#/responses/403Error'
404:
$ref: '#/responses/404Error'
405:
$ref: '#/responses/405Error'
406:
$ref: '#/responses/406Error'
415:
$ref: '#/responses/415Error'
429:
$ref: '#/responses/429Error'
500:
$ref: '#/responses/500Error'
security:
- TPPOAuth2Security:
- payments
/domestic-standing-order-consents/{ConsentId}:
get:
tags:
- Domestic Standing Orders
summary: Get Domestic Standing Order Consents
operationId: DSOCGet
parameters:
- $ref: '#/parameters/ConsentId'
- $ref: '#/parameters/x-fapi-auth-date'
- $ref: '#/parameters/x-fapi-customer-ip-address'
- $ref: '#/parameters/x-fapi-interaction-id'
- $ref: '#/parameters/Authorization'
- $ref: '#/parameters/x-customer-user-agent'
produces:
- application/json; charset=utf-8
responses:
200:
$ref: '#/responses/200DomesticStandingOrderConsentsConsentIdRead'
400:
$ref: '#/responses/400Error'
401:
$ref: '#/responses/401Error'
403:
$ref: '#/responses/403Error'
404:
$ref: '#/responses/404Error'
405:
$ref: '#/responses/405Error'
406:
$ref: '#/responses/406Error'
429:
$ref: '#/responses/429Error'
500:
$ref: '#/responses/500Error'
security:
- TPPOAuth2Security:
- payments
/domestic-standing-orders:
post:
tags:
- Domestic Standing Orders
summary: Create Domestic Standing Orders
operationId: DSOPost
parameters:
- $ref: '#/parameters/OBWriteDomesticStandingOrder3Param'
- $ref: '#/parameters/x-fapi-auth-date'
- $ref: '#/parameters/x-fapi-customer-ip-address'
- $ref: '#/parameters/x-fapi-interaction-id'
- $ref: '#/parameters/Authorization'
- $ref: '#/parameters/x-idempotency-key'
- $ref: '#/parameters/x-jws-signature'
- $ref: '#/parameters/x-customer-user-agent'
produces:
- application/json; charset=utf-8
responses:
201:
$ref: '#/responses/201DomesticStandingOrdersCreated'
400:
$ref: '#/responses/400Error'
401:
$ref: '#/responses/401Error'
403:
$ref: '#/responses/403Error'
404:
$ref: '#/responses/404Error'
405:
$ref: '#/responses/405Error'
406:
$ref: '#/responses/406Error'
415:
$ref: '#/responses/415Error'
429:
$ref: '#/responses/429Error'
500:
$ref: '#/responses/500Error'
security:
- PSUOAuth2Security:
- payments
/domestic-standing-orders/{DomesticStandingOrderId}:
get:
tags:
- Domestic Standing Orders
summary: Get Domestic Standing Orders
operationId: DSOGet
parameters:
- $ref: '#/parameters/DomesticStandingOrderId'
- $ref: '#/parameters/x-fapi-auth-date'
- $ref: '#/parameters/x-fapi-customer-ip-address'
- $ref: '#/parameters/x-fapi-interaction-id'
- $ref: '#/parameters/Authorization'
- $ref: '#/parameters/x-customer-user-agent'
produces:
- application/json; charset=utf-8
responses:
200:
$ref: '#/responses/200DomesticStandingOrdersDomesticStandingOrderIdRead'
400:
$ref: '#/responses/400Error'
401:
$ref: '#/responses/401Error'
403:
$ref: '#/responses/403Error'
404:
$ref: '#/responses/404Error'
405:
$ref: '#/responses/405Error'
406:
$ref: '#/responses/406Error'
429:
$ref: '#/responses/429Error'
500:
$ref: '#/responses/500Error'
security:
- TPPOAuth2Security:
- payments
/file-payment-consents:
post:
tags:
- File Payments
summary: Create File Payment Consents
operationId: FPCPost
parameters:
- $ref: '#/parameters/OBWriteFileConsent3Param'
- $ref: '#/parameters/x-fapi-auth-date'
- $ref: '#/parameters/x-fapi-customer-ip-address'
- $ref: '#/parameters/x-fapi-interaction-id'
- $ref: '#/parameters/Authorization'
- $ref: '#/parameters/x-idempotency-key'
- $ref: '#/parameters/x-jws-signature'
- $ref: '#/parameters/x-customer-user-agent'
produces:
- application/json; charset=utf-8
responses:
201:
$ref: '#/responses/201FilePaymentConsentsCreated'
400:
$ref: '#/responses/400Error'
401:
$ref: '#/responses/401Error'
403:
$ref: '#/responses/403Error'
404:
$ref: '#/responses/404Error'
405:
$ref: '#/responses/405Error'
406:
$ref: '#/responses/406Error'
415:
$ref: '#/responses/415Error'
429:
$ref: '#/responses/429Error'
500:
$ref: '#/responses/500Error'
security:
- TPPOAuth2Security:
- payments
/file-payment-consents/{ConsentId}:
get:
tags:
- File Payments
summary: Get File Payment Consents
operationId: FPCGet
parameters:
- $ref: '#/parameters/ConsentId'
- $ref: '#/parameters/x-fapi-auth-date'
- $ref: '#/parameters/x-fapi-customer-ip-address'
- $ref: '#/parameters/x-fapi-interaction-id'
- $ref: '#/parameters/Authorization'
- $ref: '#/parameters/x-customer-user-agent'
produces:
- application/json; charset=utf-8
responses:
200:
$ref: '#/responses/200FilePaymentConsentsConsentIdRead'
400:
$ref: '#/responses/400Error'
401:
$ref: '#/responses/401Error'
403:
$ref: '#/responses/403Error'
404:
$ref: '#/responses/404Error'
405:
$ref: '#/responses/405Error'
406:
$ref: '#/responses/406Error'
429:
$ref: '#/responses/429Error'
500:
$ref: '#/responses/500Error'
security:
- TPPOAuth2Security:
- payments
/file-payment-consents/{ConsentId}/file:
post:
tags:
- File Payments
summary: Create File Payment Consents
operationId: FPCFilePost
parameters:
- $ref: '#/parameters/FileParam'
- $ref: '#/parameters/ConsentId'
- $ref: '#/parameters/x-fapi-auth-date'
- $ref: '#/parameters/x-fapi-customer-ip-address'
- $ref: '#/parameters/x-fapi-interaction-id'
- $ref: '#/parameters/Authorization'
- $ref: '#/parameters/x-idempotency-key'
- $ref: '#/parameters/x-jws-signature'
- $ref: '#/parameters/x-customer-user-agent'
consumes:
- '*/*'
produces:
- application/json; charset=utf-8
responses:
200:
$ref: '#/responses/200FilePaymentConsentsConsentIdFileCreated'
400:
$ref: '#/responses/400Error'
401:
$ref: '#/responses/401Error'
403:
$ref: '#/responses/403Error'
404:
$ref: '#/responses/404Error'
405:
$ref: '#/responses/405Error'
406:
$ref: '#/responses/406Error'
415:
$ref: '#/responses/415Error'
429:
$ref: '#/responses/429Error'
500:
$ref: '#/responses/500Error'
security:
- TPPOAuth2Security:
- payments
get:
tags:
- File Payments
summary: Get File Payment Consents
operationId: FPCFileGet
parameters:
- $ref: '#/parameters/ConsentId'
- $ref: '#/parameters/x-fapi-auth-date'
- $ref: '#/parameters/x-fapi-customer-ip-address'
- $ref: '#/parameters/x-fapi-interaction-id'
- $ref: '#/parameters/Authorization'
- $ref: '#/parameters/x-customer-user-agent'
produces:
- '*/*'
responses:
200:
$ref: '#/responses/200FilePaymentConsentsConsentIdFileRead'
400:
$ref: '#/responses/400Error'
401:
$ref: '#/responses/401Error'
403:
$ref: '#/responses/403Error'
404:
$ref: '#/responses/404Error'
405:
$ref: '#/responses/405Error'
406:
$ref: '#/responses/406Error'
429:
$ref: '#/responses/429Error'
500:
$ref: '#/responses/500Error'
security:
- TPPOAuth2Security:
- payments
/file-payments:
post:
tags:
- File Payments
summary: Create File Payments
operationId: FPPost
parameters:
- $ref: '#/parameters/OBWriteFile2Param'
- $ref: '#/parameters/x-fapi-auth-date'
- $ref: '#/parameters/x-fapi-customer-ip-address'
- $ref: '#/parameters/x-fapi-interaction-id'
- $ref: '#/parameters/Authorization'
- $ref: '#/parameters/x-idempotency-key'
- $ref: '#/parameters/x-jws-signature'
- $ref: '#/parameters/x-customer-user-agent'
produces:
- application/json; charset=utf-8
responses:
201:
$ref: '#/responses/201FilePaymentsCreated'
400:
$ref: '#/responses/400Error'
401:
$ref: '#/responses/401Error'
403:
$ref: '#/responses/403Error'
404:
$ref: '#/responses/404Error'
405:
$ref: '#/responses/405Error'
406:
$ref: '#/responses/406Error'
415:
$ref: '#/responses/415Error'
429:
$ref: '#/responses/429Error'
500:
$ref: '#/responses/500Error'
security:
- PSUOAuth2Security:
- payments
/file-payments/{FilePaymentId}:
get:
tags:
- File Payments
summary: Get File Payments
operationId: FPGet
parameters:
- $ref: '#/parameters/FilePaymentId'
- $ref: '#/parameters/x-fapi-auth-date'
- $ref: '#/parameters/x-fapi-customer-ip-address'
- $ref: '#/parameters/x-fapi-interaction-id'
- $ref: '#/parameters/Authorization'
- $ref: '#/parameters/x-customer-user-agent'
produces:
- application/json; charset=utf-8
responses:
200:
$ref: '#/responses/200FilePaymentsFilePaymentIdRead'
400:
$ref: '#/responses/400Error'
401:
$ref: '#/responses/401Error'
403:
$ref: '#/responses/403Error'
404:
$ref: '#/responses/404Error'
405:
$ref: '#/responses/405Error'
406:
$ref: '#/responses/406Error'
429:
$ref: '#/responses/429Error'
500:
$ref: '#/responses/500Error'
security:
- TPPOAuth2Security:
- payments
/file-payments/{FilePaymentId}/report-file:
get:
tags:
- File Payments
summary: Get File Payments
operationId: FPReportGet
parameters:
- $ref: '#/parameters/FilePaymentId'
- $ref: '#/parameters/x-fapi-auth-date'
- $ref: '#/parameters/x-fapi-customer-ip-address'
- $ref: '#/parameters/x-fapi-interaction-id'
- $ref: '#/parameters/Authorization'
- $ref: '#/parameters/x-customer-user-agent'
produces:
- '*/*'
responses:
200:
$ref: '#/responses/200FilePaymentsFilePaymentIdReportFileRead'
400:
$ref: '#/responses/400Error'
401:
$ref: '#/responses/401Error'
403:
$ref: '#/responses/403Error'
404:
$ref: '#/responses/404Error'
405:
$ref: '#/responses/405Error'
406:
$ref: '#/responses/406Error'
429:
$ref: '#/responses/429Error'
500:
$ref: '#/responses/500Error'
security:
- TPPOAuth2Security:
- payments
/international-payment-consents:
post:
tags:
- International Payments
summary: Create International Payment Consents
operationId: IPCPost
parameters:
- $ref: '#/parameters/OBWriteInternationalConsent5Param'
- $ref: '#/parameters/x-fapi-auth-date'
- $ref: '#/parameters/x-fapi-customer-ip-address'
- $ref: '#/parameters/x-fapi-interaction-id'
- $ref: '#/parameters/Authorization'
- $ref: '#/parameters/x-idempotency-key'
- $ref: '#/parameters/x-jws-signature'
- $ref: '#/parameters/x-customer-user-agent'
produces:
- application/json; charset=utf-8
responses:
201:
$ref: '#/responses/201InternationalPaymentConsentsCreated'
400:
$ref: '#/responses/400Error'
401:
$ref: '#/responses/401Error'
403:
$ref: '#/responses/403Error'
404:
$ref: '#/responses/404Error'
405:
$ref: '#/responses/405Error'
406:
$ref: '#/responses/406Error'
415:
$ref: '#/responses/415Error'
429:
$ref: '#/responses/429Error'
500:
$ref: '#/responses/500Error'
security:
- TPPOAuth2Security:
- payments
/international-payment-consents/{ConsentId}:
get:
tags:
- International Payments
summary: Get International Payment Consents
operationId: IPCGet
parameters:
- $ref: '#/parameters/ConsentId'
- $ref: '#/parameters/x-fapi-auth-date'
- $ref: '#/parameters/x-fapi-customer-ip-address'
- $ref: '#/parameters/x-fapi-interaction-id'
- $ref: '#/parameters/Authorization'
- $ref: '#/parameters/x-customer-user-agent'
produces:
- application/json; charset=utf-8
responses:
200:
$ref: '#/responses/200InternationalPaymentConsentsConsentIdRead'
400:
$ref: '#/responses/400Error'
401:
$ref: '#/responses/401Error'
403:
$ref: '#/responses/403Error'
404:
$ref: '#/responses/404Error'
405:
$ref: '#/responses/405Error'
406:
$ref: '#/responses/406Error'
429:
$ref: '#/responses/429Error'
500:
$ref: '#/responses/500Error'
security:
- TPPOAuth2Security:
- payments
/international-payment-consents/{ConsentId}/funds-confirmation:
get:
tags:
- International Payments
summary: Get International Payment Consents Funds Confirmation
operationId: IPCCoFGet
parameters:
- $ref: '#/parameters/ConsentId'
- $ref: '#/parameters/x-fapi-auth-date'
- $ref: '#/parameters/x-fapi-customer-ip-address'
- $ref: '#/parameters/x-fapi-interaction-id'
- $ref: '#/parameters/Authorization'
- $ref: '#/parameters/x-customer-user-agent'
produces:
- application/json; charset=utf-8
responses:
200:
$ref: '#/responses/200InternationalPaymentConsentsConsentIdFundsConfirmationRead'
400:
$ref: '#/responses/400Error'
401:
$ref: '#/responses/401Error'
403:
$ref: '#/responses/403Error'
404:
$ref: '#/responses/404Error'
405:
$ref: '#/responses/405Error'
406:
$ref: '#/responses/406Error'
429:
$ref: '#/responses/429Error'
500:
$ref: '#/responses/500Error'
security:
- PSUOAuth2Security:
- payments
/international-payments:
post:
tags:
- International Payments
summary: Create International Payments
operationId: IPPost
parameters:
- $ref: '#/parameters/OBWriteInternational3Param'
- $ref: '#/parameters/x-fapi-auth-date'
- $ref: '#/parameters/x-fapi-customer-ip-address'
- $ref: '#/parameters/x-fapi-interaction-id'
- $ref: '#/parameters/Authorization'
- $ref: '#/parameters/x-idempotency-key'
- $ref: '#/parameters/x-jws-signature'
- $ref: '#/parameters/x-customer-user-agent'
produces:
- application/json; charset=utf-8
responses:
201:
$ref: '#/responses/201InternationalPaymentsCreated'
400:
$ref: '#/responses/400Error'
401:
$ref: '#/responses/401Error'
403:
$ref: '#/responses/403Error'
404:
$ref: '#/responses/404Error'
405:
$ref: '#/responses/405Error'
406:
$ref: '#/responses/406Error'
415:
$ref: '#/responses/415Error'
429:
$ref: '#/responses/429Error'
500:
$ref: '#/responses/500Error'
security:
- PSUOAuth2Security:
- payments
/international-payments/{InternationalPaymentId}:
get:
tags:
- International Payments
summary: Get International Payments
operationId: IPGet
parameters:
- $ref: '#/parameters/InternationalPaymentId'
- $ref: '#/parameters/x-fapi-auth-date'
- $ref: '#/parameters/x-fapi-customer-ip-address'
- $ref: '#/parameters/x-fapi-interaction-id'
- $ref: '#/parameters/Authorization'
- $ref: '#/parameters/x-customer-user-agent'
produces:
- application/json; charset=utf-8
responses:
200:
$ref: '#/responses/200InternationalPaymentsInternationalPaymentIdRead'
400:
$ref: '#/responses/400Error'
401:
$ref: '#/responses/401Error'
403:
$ref: '#/responses/403Error'
404:
$ref: '#/responses/404Error'
405:
$ref: '#/responses/405Error'
406:
$ref: '#/responses/406Error'
429:
$ref: '#/responses/429Error'
500:
$ref: '#/responses/500Error'
security:
- TPPOAuth2Security:
- payments
/international-scheduled-payment-consents:
post:
tags:
- International Scheduled Payments
summary: Create International Scheduled Payment Consents
operationId: ISPCPost
parameters:
- $ref: '#/parameters/OBWriteInternationalScheduledConsent5Param'
- $ref: '#/parameters/x-fapi-auth-date'
- $ref: '#/parameters/x-fapi-customer-ip-address'
- $ref: '#/parameters/x-fapi-interaction-id'
- $ref: '#/parameters/Authorization'
- $ref: '#/parameters/x-idempotency-key'
- $ref: '#/parameters/x-jws-signature'
produces:
- application/json; charset=utf-8
responses:
201:
$ref: '#/responses/201InternationalScheduledPaymentConsentsCreated'
400:
$ref: '#/responses/400Error'
401:
$ref: '#/responses/401Error'
403:
$ref: '#/responses/403Error'
404:
$ref: '#/responses/404Error'
405:
$ref: '#/responses/405Error'
406:
$ref: '#/responses/406Error'
415:
$ref: '#/responses/415Error'
429:
$ref: '#/responses/429Error'
500:
$ref: '#/responses/500Error'
security:
- TPPOAuth2Security:
- payments
/international-scheduled-payment-consents/{ConsentId}:
get:
tags:
- International Scheduled Payments
summary: Get International Scheduled Payment Consents
operationId: ISPCGet
parameters:
- $ref: '#/parameters/ConsentId'
- $ref: '#/parameters/x-fapi-auth-date'
- $ref: '#/parameters/x-fapi-customer-ip-address'
- $ref: '#/parameters/x-fapi-interaction-id'
- $ref: '#/parameters/Authorization'
produces:
- application/json; charset=utf-8
responses:
200:
$ref: '#/responses/200InternationalScheduledPaymentConsentsConsentIdRead'
400:
$ref: '#/responses/400Error'
401:
$ref: '#/responses/401Error'
403:
$ref: '#/responses/403Error'
404:
$ref: '#/responses/404Error'
405:
$ref: '#/responses/405Error'
406:
$ref: '#/responses/406Error'
429:
$ref: '#/responses/429Error'
500:
$ref: '#/responses/500Error'
security:
- TPPOAuth2Security:
- payments
/international-scheduled-payment-consents/{ConsentId}/funds-confirmation:
get:
tags:
- International Scheduled Payments
summary: Get International Scheduled Payment Consents Funds Confirmation
operationId: ISPCofGet
parameters:
- $ref: '#/parameters/ConsentId'
- $ref: '#/parameters/x-fapi-auth-date'
- $ref: '#/parameters/x-fapi-customer-ip-address'
- $ref: '#/parameters/x-fapi-interaction-id'
- $ref: '#/parameters/Authorization'
produces:
- application/json; charset=utf-8
responses:
200:
$ref: '#/responses/200InternationalScheduledPaymentConsentsConsentIdFundsConfirmationRead'
400:
$ref: '#/responses/400Error'
401:
$ref: '#/responses/401Error'
403:
$ref: '#/responses/403Error'
404:
$ref: '#/responses/404Error'
405:
$ref: '#/responses/405Error'
406:
$ref: '#/responses/406Error'
429:
$ref: '#/responses/429Error'
500:
$ref: '#/responses/500Error'
security:
- PSUOAuth2Security:
- payments
/international-scheduled-payments:
post:
tags:
- International Scheduled Payments
summary: Create International Scheduled Payments
operationId: ISPPost
parameters:
- $ref: '#/parameters/OBWriteInternationalScheduled3Param'
- $ref: '#/parameters/x-fapi-auth-date'
- $ref: '#/parameters/x-fapi-customer-ip-address'
- $ref: '#/parameters/x-fapi-interaction-id'
- $ref: '#/parameters/Authorization'
- $ref: '#/parameters/x-idempotency-key'
- $ref: '#/parameters/x-jws-signature'
produces:
- application/json; charset=utf-8
responses:
201:
$ref: '#/responses/201InternationalScheduledPaymentsCreated'
400:
$ref: '#/responses/400Error'
401:
$ref: '#/responses/401Error'
403:
$ref: '#/responses/403Error'
404:
$ref: '#/responses/404Error'
405:
$ref: '#/responses/405Error'
406:
$ref: '#/responses/406Error'
415:
$ref: '#/responses/415Error'
429:
$ref: '#/responses/429Error'
500:
$ref: '#/responses/500Error'
security:
- PSUOAuth2Security:
- payments
/international-scheduled-payments/{InternationalScheduledPaymentId}:
get:
tags:
- International Scheduled Payments
summary: Get International Scheduled Payments
operationId: ISPGet
parameters:
- $ref: '#/parameters/InternationalScheduledPaymentId'
- $ref: '#/parameters/x-fapi-auth-date'
- $ref: '#/parameters/x-fapi-customer-ip-address'
- $ref: '#/parameters/x-fapi-interaction-id'
- $ref: '#/parameters/Authorization'
produces:
- application/json; charset=utf-8
responses:
200:
$ref: '#/responses/200InternationalScheduledPaymentsInternationalScheduledPaymentIdRead'
400:
$ref: '#/responses/400Error'
401:
$ref: '#/responses/401Error'
403:
$ref: '#/responses/403Error'
404:
$ref: '#/responses/404Error'
405:
$ref: '#/responses/405Error'
406:
$ref: '#/responses/406Error'
429:
$ref: '#/responses/429Error'
500:
$ref: '#/responses/500Error'
security:
- TPPOAuth2Security:
- payments
parameters:
OBWriteDomesticConsent4Param:
name: OBWriteDomesticConsent4Param
in: body
description: Default
required: true
schema:
$ref: '#/definitions/OBWriteDomesticConsent4'
ConsentId:
name: ConsentId
in: path
description: ConsentId
required: true
type: string
OBWriteDomestic2Param:
name: OBWriteDomestic2Param
in: body
description: Default
required: true
schema:
$ref: '#/definitions/OBWriteDomestic2'
DomesticPaymentId:
name: DomesticPaymentId
in: path
description: DomesticPaymentId
required: true
type: string
OBWriteDomesticScheduledConsent4Param:
name: OBWriteDomesticScheduledConsent4Param
in: body
description: Default
required: true
schema:
$ref: '#/definitions/OBWriteDomesticScheduledConsent4'
OBWriteDomesticScheduled2Param:
name: OBWriteDomesticScheduled2Param
in: body
description: Default
required: true
schema:
$ref: '#/definitions/OBWriteDomesticScheduled2'
DomesticScheduledPaymentId:
name: DomesticScheduledPaymentId
in: path
description: DomesticScheduledPaymentId
required: true
type: string
OBWriteDomesticStandingOrderConsent5Param:
name: OBWriteDomesticStandingOrderConsent5Param
in: body
description: Default
required: true
schema:
$ref: '#/definitions/OBWriteDomesticStandingOrderConsent5'
OBWriteDomesticStandingOrder3Param:
name: OBWriteDomesticStandingOrder3Param
in: body
description: Default
required: true
schema:
$ref: '#/definitions/OBWriteDomesticStandingOrder3'
DomesticStandingOrderId:
name: DomesticStandingOrderId
in: path
description: DomesticStandingOrderId
required: true
type: string
OBWriteFileConsent3Param:
name: OBWriteFileConsent3Param
in: body
description: Default
required: true
schema:
$ref: '#/definitions/OBWriteFileConsent3'
FileParam:
name: FileParam
in: body
description: Default
required: true
schema:
$ref: '#/definitions/File'
OBWriteFile2Param:
name: OBWriteFile2Param
in: body
description: Default
required: true
schema:
$ref: '#/definitions/OBWriteFile2'
FilePaymentId:
name: FilePaymentId
in: path
description: FilePaymentId
required: true
type: string
OBWriteInternationalConsent5Param:
name: OBWriteInternationalConsent5Param
in: body
description: Default
required: true
schema:
$ref: '#/definitions/OBWriteInternationalConsent5'
OBWriteInternational3Param:
name: OBWriteInternational3Param
in: body
description: Default
required: true
schema:
$ref: '#/definitions/OBWriteInternational3'
InternationalPaymentId:
name: InternationalPaymentId
in: path
description: InternationalPaymentId
required: true
type: string
OBWriteInternationalScheduledConsent5Param:
name: OBWriteInternationalScheduledConsent5Param
in: body
description: Default
required: true
schema:
$ref: '#/definitions/OBWriteInternationalScheduledConsent5'
OBWriteInternationalScheduled3Param:
name: OBWriteInternationalScheduled3Param
in: body
description: Default
required: true
schema:
$ref: '#/definitions/OBWriteInternationalScheduled3'
InternationalScheduledPaymentId:
name: InternationalScheduledPaymentId
in: path
description: InternationalScheduledPaymentId
required: true
type: string
OBWriteInternationalStandingOrderConsent6Param:
name: OBWriteInternationalStandingOrderConsent6Param
in: body
description: Default
required: true
schema:
$ref: '#/definitions/OBWriteInternationalStandingOrderConsent6'
OBWriteInternationalStandingOrder4Param:
name: OBWriteInternationalStandingOrder4Param
in: body
description: Default
required: true
schema:
$ref: '#/definitions/OBWriteInternationalStandingOrder4'
InternationalStandingOrderPaymentId:
name: InternationalStandingOrderPaymentId
in: path
description: InternationalStandingOrderPaymentId
required: true
type: string
Authorization:
in: header
name: Authorization
type: string
required: true
description: An Authorisation Token as per https://tools.ietf.org/html/rfc6750
x-customer-user-agent:
in: header
name: x-customer-user-agent
type: string
description: Indicates the user-agent that the PSU is using.
required: false
x-fapi-customer-ip-address:
in: header
name: x-fapi-customer-ip-address
type: string
required: false
description: The PSU's IP address if the PSU is currently logged in with the TPP.
x-fapi-auth-date:
in: header
name: x-fapi-auth-date
type: string
required: false
description: "The time when the PSU last logged in with the TPP. \nAll dates in
the HTTP headers are represented as RFC 7231 Full Dates. An example is below:
\nSun, 10 Sep 2017 19:43:31 UTC"
pattern: ^(Mon|Tue|Wed|Thu|Fri|Sat|Sun), \d{2} (Jan|Feb|Mar|Apr|May|Jun|Jul|Aug|Sep|Oct|Nov|Dec)
\d{4} \d{2}:\d{2}:\d{2} (GMT|UTC)$
x-fapi-interaction-id:
in: header
name: x-fapi-interaction-id
type: string
required: false
description: An RFC4122 UID used as a correlation id.
x-idempotency-key:
name: x-idempotency-key
in: header
description: |
Every request will be processed only once per x-idempotency-key. The
Idempotency Key will be valid for 24 hours.
required: true
type: string
pattern: ^(?!\s)(.*)(\S)$
maxLength: 40
x-jws-signature:
in: header
name: x-jws-signature
type: string
required: true
description: A detached JWS signature of the body of the payload.
responses:
201DomesticPaymentConsentsCreated:
description: Domestic Payment Consents Created
headers:
x-fapi-interaction-id:
type: string
description: An RFC4122 UID used as a correlation id.
x-jws-signature:
type: string
description: |
Header containing a detached JWS signature of the body of the payload.
schema:
$ref: '#/definitions/OBWriteDomesticConsentResponse5'
200DomesticPaymentConsentsConsentIdRead:
description: Domestic Payment Consents Read
headers:
x-fapi-interaction-id:
type: string
description: An RFC4122 UID used as a correlation id.
x-jws-signature:
type: string
description: |
Header containing a detached JWS signature of the body of the payload.
schema:
$ref: '#/definitions/OBWriteDomesticConsentResponse5'
200DomesticPaymentConsentsConsentIdFundsConfirmationRead:
description: Domestic Payment Consents Read
headers:
x-fapi-interaction-id:
type: string
description: An RFC4122 UID used as a correlation id.
x-jws-signature:
type: string
description: |
Header containing a detached JWS signature of the body of the payload.
schema:
$ref: '#/definitions/OBWriteFundsConfirmationResponse1'
201DomesticPaymentsCreated:
description: Domestic Payments Created
headers:
x-fapi-interaction-id:
type: string
description: An RFC4122 UID used as a correlation id.
x-jws-signature:
type: string
description: |
Header containing a detached JWS signature of the body of the payload.
schema:
$ref: '#/definitions/OBWriteDomesticResponse5'
200DomesticPaymentsDomesticPaymentIdRead:
description: Domestic Payments Read
headers:
x-fapi-interaction-id:
type: string
description: An RFC4122 UID used as a correlation id.
x-jws-signature:
type: string
description: |
Header containing a detached JWS signature of the body of the payload.
schema:
$ref: '#/definitions/OBWriteDomesticResponse5'
200DomesticPaymentsDomesticPaymentIdPaymentDetailsRead:
description: Payment Details Read
headers:
x-fapi-interaction-id:
type: string
description: An RFC4122 UID used as a correlation id.
x-jws-signature:
type: string
description: |
Header containing a detached JWS signature of the body of the payload.
schema:
$ref: '#/definitions/OBWritePaymentDetailsResponse1'
201DomesticScheduledPaymentConsentsCreated:
description: Domestic Scheduled Payment Consents Created
headers:
x-fapi-interaction-id:
type: string
description: An RFC4122 UID used as a correlation id.
x-jws-signature:
type: string
description: |
Header containing a detached JWS signature of the body of the payload.
schema:
$ref: '#/definitions/OBWriteDomesticScheduledConsentResponse5'
200DomesticScheduledPaymentConsentsConsentIdRead:
description: Domestic Scheduled Payment Consents Read
headers:
x-fapi-interaction-id:
type: string
description: An RFC4122 UID used as a correlation id.
x-jws-signature:
type: string
description: |
Header containing a detached JWS signature of the body of the payload.
schema:
$ref: '#/definitions/OBWriteDomesticScheduledConsentResponse5'
201DomesticScheduledPaymentsCreated:
description: Domestic Scheduled Payments Created
headers:
x-fapi-interaction-id:
type: string
description: An RFC4122 UID used as a correlation id.
x-jws-signature:
type: string
description: |
Header containing a detached JWS signature of the body of the payload.
schema:
$ref: '#/definitions/OBWriteDomesticScheduledResponse5'
200DomesticScheduledPaymentsDomesticScheduledPaymentIdRead:
description: Domestic Scheduled Payments Read
headers:
x-fapi-interaction-id:
type: string
description: An RFC4122 UID used as a correlation id.
x-jws-signature:
type: string
description: |
Header containing a detached JWS signature of the body of the payload.
schema:
$ref: '#/definitions/OBWriteDomesticScheduledResponse5'
200DomesticScheduledPaymentsDomesticScheduledPaymentIdPaymentDetailsRead:
description: Payment Details Read
headers:
x-fapi-interaction-id:
type: string
description: An RFC4122 UID used as a correlation id.
x-jws-signature:
type: string
description: |
Header containing a detached JWS signature of the body of the payload.
schema:
$ref: '#/definitions/OBWritePaymentDetailsResponse1'
201DomesticStandingOrderConsentsCreated:
description: Domestic Standing Order Consents Created
headers:
x-fapi-interaction-id:
type: string
description: An RFC4122 UID used as a correlation id.
x-jws-signature:
type: string
description: |
Header containing a detached JWS signature of the body of the payload.
schema:
$ref: '#/definitions/OBWriteDomesticStandingOrderConsentResponse6'
200DomesticStandingOrderConsentsConsentIdRead:
description: Domestic Standing Order Consents Read
headers:
x-fapi-interaction-id:
type: string
description: An RFC4122 UID used as a correlation id.
x-jws-signature:
type: string
description: |
Header containing a detached JWS signature of the body of the payload.
schema:
$ref: '#/definitions/OBWriteDomesticStandingOrderConsentResponse6'
201DomesticStandingOrdersCreated:
description: Domestic Standing Orders Created
headers:
x-fapi-interaction-id:
type: string
description: An RFC4122 UID used as a correlation id.
x-jws-signature:
type: string
description: |
Header containing a detached JWS signature of the body of the payload.
schema:
$ref: '#/definitions/OBWriteDomesticStandingOrderResponse6'
200DomesticStandingOrdersDomesticStandingOrderIdRead:
description: Domestic Standing Orders Read
headers:
x-fapi-interaction-id:
type: string
description: An RFC4122 UID used as a correlation id.
x-jws-signature:
type: string
description: |
Header containing a detached JWS signature of the body of the payload.
schema:
$ref: '#/definitions/OBWriteDomesticStandingOrderResponse6'
200DomesticStandingOrdersDomesticStandingOrderIdPaymentDetailsRead:
description: Payment Details Read
headers:
x-fapi-interaction-id:
type: string
description: An RFC4122 UID used as a correlation id.
x-jws-signature:
type: string
description: |
Header containing a detached JWS signature of the body of the payload.
schema:
$ref: '#/definitions/OBWritePaymentDetailsResponse1'
201FilePaymentConsentsCreated:
description: File Payment Consents Created
headers:
x-fapi-interaction-id:
type: string
description: An RFC4122 UID used as a correlation id.
x-jws-signature:
type: string
description: |
Header containing a detached JWS signature of the body of the payload.
schema:
$ref: '#/definitions/OBWriteFileConsentResponse4'
200FilePaymentConsentsConsentIdFileCreated:
description: File Payment Consents Created
headers:
x-fapi-interaction-id:
type: string
description: An RFC4122 UID used as a correlation id.
200FilePaymentConsentsConsentIdRead:
description: File Payment Consents Read
headers:
x-fapi-interaction-id:
type: string
description: An RFC4122 UID used as a correlation id.
x-jws-signature:
type: string
description: |
Header containing a detached JWS signature of the body of the payload.
schema:
$ref: '#/definitions/OBWriteFileConsentResponse4'
200FilePaymentConsentsConsentIdFileRead:
description: File Payment Consents Read
headers:
x-fapi-interaction-id:
type: string
description: An RFC4122 UID used as a correlation id.
x-jws-signature:
type: string
description: |
Header containing a detached JWS signature of the body of the payload.
schema:
$ref: '#/definitions/File'
201FilePaymentsCreated:
description: File Payments Created
headers:
x-fapi-interaction-id:
type: string
description: An RFC4122 UID used as a correlation id.
x-jws-signature:
type: string
description: |
Header containing a detached JWS signature of the body of the payload.
schema:
$ref: '#/definitions/OBWriteFileResponse3'
200FilePaymentsFilePaymentIdRead:
description: File Payments Read
headers:
x-fapi-interaction-id:
type: string
description: An RFC4122 UID used as a correlation id.
x-jws-signature:
type: string
description: |
Header containing a detached JWS signature of the body of the payload.
schema:
$ref: '#/definitions/OBWriteFileResponse3'
200FilePaymentsFilePaymentIdReportFileRead:
description: File Payments Read
headers:
x-fapi-interaction-id:
type: string
description: An RFC4122 UID used as a correlation id.
x-jws-signature:
type: string
description: |
Header containing a detached JWS signature of the body of the payload.
schema:
$ref: '#/definitions/File'
200FilePaymentsFilePaymentIdPaymentDetailsRead:
description: Payment Details Read
headers:
x-fapi-interaction-id:
type: string
description: An RFC4122 UID used as a correlation id.
x-jws-signature:
type: string
description: |
Header containing a detached JWS signature of the body of the payload.
schema:
$ref: '#/definitions/OBWritePaymentDetailsResponse1'
201InternationalPaymentConsentsCreated:
description: International Payment Consents Created
headers:
x-fapi-interaction-id:
type: string
description: An RFC4122 UID used as a correlation id.
x-jws-signature:
type: string
description: |
Header containing a detached JWS signature of the body of the payload.
schema:
$ref: '#/definitions/OBWriteInternationalConsentResponse6'
200InternationalPaymentConsentsConsentIdRead:
description: International Payment Consents Read
headers:
x-fapi-interaction-id:
type: string
description: An RFC4122 UID used as a correlation id.
x-jws-signature:
type: string
description: |
Header containing a detached JWS signature of the body of the payload.
schema:
$ref: '#/definitions/OBWriteInternationalConsentResponse6'
200InternationalPaymentConsentsConsentIdFundsConfirmationRead:
description: International Payment Consents Read
headers:
x-fapi-interaction-id:
type: string
description: An RFC4122 UID used as a correlation id.
x-jws-signature:
type: string
description: |
Header containing a detached JWS signature of the body of the payload.
schema:
$ref: '#/definitions/OBWriteFundsConfirmationResponse1'
201InternationalPaymentsCreated:
description: International Payments Created
headers:
x-fapi-interaction-id:
type: string
description: An RFC4122 UID used as a correlation id.
x-jws-signature:
type: string
description: |
Header containing a detached JWS signature of the body of the payload.
schema:
$ref: '#/definitions/OBWriteInternationalResponse5'
200InternationalPaymentsInternationalPaymentIdRead:
description: International Payments Read
headers:
x-fapi-interaction-id:
type: string
description: An RFC4122 UID used as a correlation id.
x-jws-signature:
type: string
description: |
Header containing a detached JWS signature of the body of the payload.
schema:
$ref: '#/definitions/OBWriteInternationalResponse5'
200InternationalPaymentsInternationalPaymentIdPaymentDetailsRead:
description: Payment Details Read
headers:
x-fapi-interaction-id:
type: string
description: An RFC4122 UID used as a correlation id.
x-jws-signature:
type: string
description: |
Header containing a detached JWS signature of the body of the payload.
schema:
$ref: '#/definitions/OBWritePaymentDetailsResponse1'
201InternationalScheduledPaymentConsentsCreated:
description: International Scheduled Payment Consents Created
headers:
x-fapi-interaction-id:
type: string
description: An RFC4122 UID used as a correlation id.
x-jws-signature:
type: string
description: |
Header containing a detached JWS signature of the body of the payload.
schema:
$ref: '#/definitions/OBWriteInternationalScheduledConsentResponse6'
200InternationalScheduledPaymentConsentsConsentIdRead:
description: International Scheduled Payment Consents Read
headers:
x-fapi-interaction-id:
type: string
description: An RFC4122 UID used as a correlation id.
x-jws-signature:
type: string
description: |
Header containing a detached JWS signature of the body of the payload.
schema:
$ref: '#/definitions/OBWriteInternationalScheduledConsentResponse6'
200InternationalScheduledPaymentConsentsConsentIdFundsConfirmationRead:
description: International Scheduled Payment Consents Read
headers:
x-fapi-interaction-id:
type: string
description: An RFC4122 UID used as a correlation id.
x-jws-signature:
type: string
description: |
Header containing a detached JWS signature of the body of the payload.
schema:
$ref: '#/definitions/OBWriteFundsConfirmationResponse1'
201InternationalScheduledPaymentsCreated:
description: International Scheduled Payments Created
headers:
x-fapi-interaction-id:
type: string
description: An RFC4122 UID used as a correlation id.
x-jws-signature:
type: string
description: |
Header containing a detached JWS signature of the body of the payload.
schema:
$ref: '#/definitions/OBWriteInternationalScheduledResponse6'
200InternationalScheduledPaymentsInternationalScheduledPaymentIdRead:
description: International Scheduled Payments Read
headers:
x-fapi-interaction-id:
type: string
description: An RFC4122 UID used as a correlation id.
x-jws-signature:
type: string
description: |
Header containing a detached JWS signature of the body of the payload.
schema:
$ref: '#/definitions/OBWriteInternationalScheduledResponse6'
200InternationalScheduledPaymentsInternationalScheduledPaymentIdPaymentDetailsRead:
description: Payment Details Read
headers:
x-fapi-interaction-id:
type: string
description: An RFC4122 UID used as a correlation id.
x-jws-signature:
type: string
description: |
Header containing a detached JWS signature of the body of the payload.
schema:
$ref: '#/definitions/OBWritePaymentDetailsResponse1'
201InternationalStandingOrderConsentsCreated:
description: International Standing Order Consents Created
headers:
x-fapi-interaction-id:
type: string
description: An RFC4122 UID used as a correlation id.
x-jws-signature:
type: string
description: |
Header containing a detached JWS signature of the body of the payload.
schema:
$ref: '#/definitions/OBWriteInternationalStandingOrderConsentResponse7'
200InternationalStandingOrderConsentsConsentIdRead:
description: International Standing Order Consents Read
headers:
x-fapi-interaction-id:
type: string
description: An RFC4122 UID used as a correlation id.
x-jws-signature:
type: string
description: |
Header containing a detached JWS signature of the body of the payload.
schema:
$ref: '#/definitions/OBWriteInternationalStandingOrderConsentResponse7'
201InternationalStandingOrdersCreated:
description: International Standing Orders Created
headers:
x-fapi-interaction-id:
type: string
description: An RFC4122 UID used as a correlation id.
x-jws-signature:
type: string
description: |
Header containing a detached JWS signature of the body of the payload.
schema:
$ref: '#/definitions/OBWriteInternationalStandingOrderResponse7'
200InternationalStandingOrdersInternationalStandingOrderPaymentIdRead:
description: International Standing Orders Read
headers:
x-fapi-interaction-id:
type: string
description: An RFC4122 UID used as a correlation id.
x-jws-signature:
type: string
description: |
Header containing a detached JWS signature of the body of the payload.
schema:
$ref: '#/definitions/OBWriteInternationalStandingOrderResponse7'
200InternationalStandingOrdersInternationalStandingOrderPaymentIdPaymentDetailsRead:
description: Payment Details Read
headers:
x-fapi-interaction-id:
type: string
description: An RFC4122 UID used as a correlation id.
x-jws-signature:
type: string
description: |
Header containing a detached JWS signature of the body of the payload.
schema:
$ref: '#/definitions/OBWritePaymentDetailsResponse1'
400Error:
description: Bad request
headers:
x-fapi-interaction-id:
type: string
description: An RFC4122 UID used as a correlation id.
x-jws-signature:
type: string
description: |
Header containing a detached JWS signature of the body of the payload.
schema:
$ref: '#/definitions/OBErrorResponse1'
401Error:
description: Unauthorized
headers:
x-fapi-interaction-id:
type: string
description: An RFC4122 UID used as a correlation id.
403Error:
description: Forbidden
headers:
x-fapi-interaction-id:
type: string
description: An RFC4122 UID used as a correlation id.
x-jws-signature:
type: string
description: |
Header containing a detached JWS signature of the body of the payload.
schema:
$ref: '#/definitions/OBErrorResponse1'
404Error:
description: Not found
headers:
x-fapi-interaction-id:
type: string
description: An RFC4122 UID used as a correlation id.
405Error:
description: Method Not Allowed
headers:
x-fapi-interaction-id:
type: string
description: An RFC4122 UID used as a correlation id.
406Error:
description: Not Acceptable
headers:
x-fapi-interaction-id:
type: string
description: An RFC4122 UID used as a correlation id.
415Error:
description: Unsupported Media Type
headers:
x-fapi-interaction-id:
type: string
description: An RFC4122 UID used as a correlation id.
429Error:
description: Too Many Requests
headers:
Retry-After:
description: Number in seconds to wait
type: integer
x-fapi-interaction-id:
type: string
description: An RFC4122 UID used as a correlation id.
500Error:
description: Internal Server Error
headers:
x-fapi-interaction-id:
type: string
description: An RFC4122 UID used as a correlation id.
x-jws-signature:
type: string
description: |
Header containing a detached JWS signature of the body of the payload.
schema:
$ref: '#/definitions/OBErrorResponse1'
securityDefinitions:
TPPOAuth2Security:
type: oauth2
flow: application
tokenUrl: https://authserver.example/token
scopes:
payments: Generic payment scope
description: TPP client credential authorisation flow with the ASPSP
PSUOAuth2Security:
type: oauth2
flow: accessCode
tokenUrl: https://authserver.example/token
authorizationUrl: https://authserver.example/authorization
scopes:
payments: Generic payment scope
description: 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
definitions:
ActiveOrHistoricCurrencyCode:
description: 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".
type: string
pattern: ^[A-Z]{3,3}$
BuildingNumber:
description: Number that identifies the position of a building on a street.
type: string
minLength: 1
maxLength: 16
CountryCode:
description: Nation with its own government.
type: string
pattern: ^[A-Z]{2,2}$
CountrySubDivision:
description: Identifies a subdivision of a country such as state, region, county.
type: string
minLength: 1
maxLength: 35
Department:
description: Identification of a division of a large organisation or building.
type: string
minLength: 1
maxLength: 70
File:
type: object
additionalProperties: false
properties: []
ISODateTime:
description: "All dates in the JSON payloads are represented in ISO 8601 date-time
format. \nAll date-time fields in responses must include the timezone. An example
is below:\n2017-04-05T10:43:07+00:00"
type: string
format: date-time
Identification_0:
description: Identification assigned by an institution to identify an account.
This identification is known by the account owner.
type: string
minLength: 1
maxLength: 256
Identification_1:
description: Unique and unambiguous identification of a financial institution
or a branch of a financial institution.
type: string
minLength: 1
maxLength: 35
Links:
type: object
additionalProperties: false
description: Links relevant to the payload
properties:
Self:
type: string
format: uri
First:
type: string
format: uri
Prev:
type: string
format: uri
Next:
type: string
format: uri
Last:
type: string
format: uri
required:
- Self
Meta:
title: MetaData
type: object
additionalProperties: false
description: Meta Data relevant to the payload
properties:
TotalPages:
type: integer
format: int32
FirstAvailableDateTime:
$ref: '#/definitions/ISODateTime'
LastAvailableDateTime:
$ref: '#/definitions/ISODateTime'
Name:
description: Name by which an agent is known and which is usually used to identify
that agent.
type: string
minLength: 1
maxLength: 140
OBActiveCurrencyAndAmount_SimpleType:
description: A number of monetary units specified in an active currency where
the unit of currency is explicit and compliant with ISO 4217.
type: string
pattern: ^\d{1,13}$|^\d{1,13}\.\d{1,5}$
OBActiveOrHistoricCurrencyAndAmount:
type: object
additionalProperties: false
required:
- Amount
- Currency
description: Amount of money associated with the charge type.
properties:
Amount:
$ref: '#/definitions/OBActiveCurrencyAndAmount_SimpleType'
Currency:
$ref: '#/definitions/ActiveOrHistoricCurrencyCode'
OBAddressTypeCode:
description: Identifies the nature of the postal address.
type: string
enum:
- Business
- Correspondence
- DeliveryTo
- MailTo
- POBox
- Postal
- Residential
- Statement
OBChargeBearerType1Code:
description: Specifies which party/parties will bear the charges associated with
the processing of the payment transaction.
type: string
enum:
- BorneByCreditor
- BorneByDebtor
- FollowingServiceLevel
- Shared
OBError1:
type: object
additionalProperties: false
properties:
ErrorCode:
description: Low level textual error code, e.g., UK.OBIE.Field.Missing
type: string
x-namespaced-enum:
- UK.OBIE.Field.Expected
- UK.OBIE.Field.Invalid
- UK.OBIE.Field.InvalidDate
- UK.OBIE.Field.Missing
- UK.OBIE.Field.Unexpected
- UK.OBIE.Header.Invalid
- UK.OBIE.Header.Missing
- UK.OBIE.Reauthenticate
- UK.OBIE.Resource.ConsentMismatch
- UK.OBIE.Resource.InvalidConsentStatus
- UK.OBIE.Resource.InvalidFormat
- UK.OBIE.Resource.NotFound
- UK.OBIE.Rules.AfterCutOffDateTime
- UK.OBIE.Rules.DuplicateReference
- UK.OBIE.Signature.Invalid
- UK.OBIE.Signature.InvalidClaim
- UK.OBIE.Signature.Malformed
- UK.OBIE.Signature.Missing
- UK.OBIE.Signature.MissingClaim
- UK.OBIE.Signature.Unexpected
- UK.OBIE.UnexpectedError
- UK.OBIE.Unsupported.AccountIdentifier
- UK.OBIE.Unsupported.AccountSecondaryIdentifier
- UK.OBIE.Unsupported.Currency
- UK.OBIE.Unsupported.Frequency
- UK.OBIE.Unsupported.LocalInstrument
- UK.OBIE.Unsupported.Scheme
Message:
description: |-
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
type: string
minLength: 1
maxLength: 500
Path:
description: Recommended but optional reference to the JSON Path of the field
with error, e.g., Data.Initiation.InstructedAmount.Currency
type: string
minLength: 1
maxLength: 500
Url:
description: URL to help remediate the problem, or provide more information,
or to API Reference, or help etc
type: string
required:
- ErrorCode
- Message
minProperties: 1
OBErrorResponse1:
description: An array of detail error codes, and messages, and URLs to documentation
to help remediation.
type: object
additionalProperties: false
properties:
Code:
description: High level textual error code, to help categorize the errors.
type: string
minLength: 1
maxLength: 40
Id:
description: A unique reference for the error instance, for audit purposes,
in case of unknown/unclassified errors.
type: string
minLength: 1
maxLength: 40
Message:
description: Brief Error message, e.g., 'There is something wrong with the
request parameters provided'
type: string
minLength: 1
maxLength: 500
Errors:
items:
$ref: '#/definitions/OBError1'
type: array
minItems: 1
required:
- Code
- Message
- Errors
OBExternalAccountIdentification4Code:
description: Name of the identification scheme, in a coded form as published in
an external list.
type: string
x-namespaced-enum:
- UK.OBIE.BBAN
- UK.OBIE.IBAN
- UK.OBIE.PAN
- UK.OBIE.Paym
- UK.OBIE.SortCodeAccountNumber
OBExternalFinancialInstitutionIdentification4Code:
description: Name of the identification scheme, in a coded form as published in
an external list.
type: string
x-namespaced-enum:
- UK.OBIE.BICFI
OBExternalLocalInstrument1Code:
description: |-
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.
type: string
x-namespaced-enum:
- UK.OBIE.BACS
- UK.OBIE.BalanceTransfer
- UK.OBIE.CHAPS
- UK.OBIE.Euro1
- UK.OBIE.FPS
- UK.OBIE.Link
- UK.OBIE.MoneyTransfer
- UK.OBIE.Paym
- UK.OBIE.SEPACreditTransfer
- UK.OBIE.SEPAInstantCreditTransfer
- UK.OBIE.SWIFT
- UK.OBIE.Target2
OBExternalPaymentChargeType1Code:
description: Charge type, in a coded form.
type: string
x-namespaced-enum:
- UK.OBIE.CHAPSOut
OBPostalAddress6:
type: object
additionalProperties: false
description: Information that locates and identifies a specific address, as defined
by postal services.
properties:
AddressType:
$ref: '#/definitions/OBAddressTypeCode'
Department:
$ref: '#/definitions/Department'
SubDepartment:
$ref: '#/definitions/SubDepartment'
StreetName:
$ref: '#/definitions/StreetName'
BuildingNumber:
$ref: '#/definitions/BuildingNumber'
PostCode:
$ref: '#/definitions/PostCode'
TownName:
$ref: '#/definitions/TownName'
CountrySubDivision:
$ref: '#/definitions/CountrySubDivision'
Country:
$ref: '#/definitions/CountryCode'
AddressLine:
type: array
items:
description: Information that locates and identifies a specific address,
as defined by postal services, presented in free format text.
type: string
minLength: 1
maxLength: 70
minItems: 0
maxItems: 7
OBDebtorIdentification1:
type: object
additionalProperties: false
description: Set of elements used to identify a person or an organisation.
properties:
Name:
type: string
description: 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.
minLength: 0
maxLength: 350
OBRisk1:
type: object
additionalProperties: false
description: The Risk section is sent by the initiating party to the ASPSP. It
is used to specify additional details for risk scoring for Payments.
properties:
PaymentContextCode:
description: Specifies the payment context
type: string
enum:
- BillPayment
- EcommerceGoods
- EcommerceServices
- Other
- PartyToParty
MerchantCategoryCode:
description: Category code conform to ISO 18245, related to the type of services
or goods the merchant provides for the transaction.
type: string
minLength: 3
maxLength: 4
MerchantCustomerIdentification:
description: The unique customer identifier of the PSU with the merchant.
type: string
minLength: 1
maxLength: 70
DeliveryAddress:
type: object
additionalProperties: false
required:
- TownName
- Country
description: Information that locates and identifies a specific address, as
defined by postal services or in free format text.
properties:
AddressLine:
type: array
items:
description: Information that locates and identifies a specific address,
as defined by postal services, that is presented in free format text.
type: string
minLength: 1
maxLength: 70
minItems: 0
maxItems: 2
StreetName:
$ref: '#/definitions/StreetName'
BuildingNumber:
$ref: '#/definitions/BuildingNumber'
PostCode:
$ref: '#/definitions/PostCode'
TownName:
$ref: '#/definitions/TownName'
CountrySubDivision:
$ref: '#/definitions/CountrySubDivision'
Country:
description: Nation with its own government, occupying a particular territory.
type: string
pattern: ^[A-Z]{2,2}$
OBSupplementaryData1:
type: object
properties: []
additionalProperties: true
description: Additional information that can not be captured in the structured
fields and/or any other specific block.
OBWriteDomestic2:
type: object
additionalProperties: false
required:
- Data
- Risk
properties:
Data:
type: object
additionalProperties: false
required:
- ConsentId
- Initiation
properties:
ConsentId:
description: 'OB: Unique identification as assigned by the ASPSP to uniquely
identify the consent resource.'
type: string
minLength: 1
maxLength: 128
Initiation:
type: object
additionalProperties: false
required:
- InstructionIdentification
- EndToEndIdentification
- InstructedAmount
- CreditorAccount
description: 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.
properties:
InstructionIdentification:
description: |-
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.
type: string
minLength: 1
maxLength: 35
EndToEndIdentification:
description: |-
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.
type: string
minLength: 1
maxLength: 35
LocalInstrument:
$ref: '#/definitions/OBExternalLocalInstrument1Code'
InstructedAmount:
type: object
additionalProperties: false
required:
- Amount
- Currency
description: |-
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.
properties:
Amount:
$ref: '#/definitions/OBActiveCurrencyAndAmount_SimpleType'
Currency:
$ref: '#/definitions/ActiveOrHistoricCurrencyCode'
DebtorAccount:
type: object
additionalProperties: false
required:
- SchemeName
- Identification
description: Unambiguous identification of the account of the debtor
to which a debit entry will be made as a result of the transaction.
properties:
SchemeName:
$ref: '#/definitions/OBExternalAccountIdentification4Code'
Identification:
$ref: '#/definitions/Identification_0'
Name:
description: |-
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.
type: string
minLength: 1
maxLength: 350
SecondaryIdentification:
$ref: '#/definitions/SecondaryIdentification'
CreditorAccount:
type: object
additionalProperties: false
required:
- SchemeName
- Identification
- Name
description: Unambiguous identification of the account of the creditor
to which a credit entry will be posted as a result of the payment
transaction.
properties:
SchemeName:
$ref: '#/definitions/OBExternalAccountIdentification4Code'
Identification:
$ref: '#/definitions/Identification_0'
Name:
description: |-
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.
type: string
minLength: 1
maxLength: 350
SecondaryIdentification:
$ref: '#/definitions/SecondaryIdentification'
CreditorPostalAddress:
$ref: '#/definitions/OBPostalAddress6'
RemittanceInformation:
type: object
additionalProperties: false
description: 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.
properties:
Unstructured:
description: 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.
type: string
minLength: 1
maxLength: 140
Reference:
description: |-
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.
type: string
minLength: 1
maxLength: 35
SupplementaryData:
$ref: '#/definitions/OBSupplementaryData1'
Risk:
$ref: '#/definitions/OBRisk1'
OBWriteDomesticConsent4:
type: object
additionalProperties: false
required:
- Data
- Risk
properties:
Data:
type: object
additionalProperties: false
required:
- Initiation
properties:
ReadRefundAccount:
description: Specifies to share the refund account details with PISP
type: string
enum:
- "No"
- "Yes"
Initiation:
type: object
additionalProperties: false
required:
- InstructionIdentification
- EndToEndIdentification
- InstructedAmount
- CreditorAccount
description: 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.
properties:
InstructionIdentification:
description: |-
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.
type: string
minLength: 1
maxLength: 35
EndToEndIdentification:
description: |-
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.
type: string
minLength: 1
maxLength: 35
LocalInstrument:
$ref: '#/definitions/OBExternalLocalInstrument1Code'
InstructedAmount:
type: object
additionalProperties: false
required:
- Amount
- Currency
description: |-
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.
properties:
Amount:
$ref: '#/definitions/OBActiveCurrencyAndAmount_SimpleType'
Currency:
$ref: '#/definitions/ActiveOrHistoricCurrencyCode'
DebtorAccount:
type: object
additionalProperties: false
required:
- SchemeName
- Identification
description: Unambiguous identification of the account of the debtor
to which a debit entry will be made as a result of the transaction.
properties:
SchemeName:
$ref: '#/definitions/OBExternalAccountIdentification4Code'
Identification:
$ref: '#/definitions/Identification_0'
Name:
description: |-
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.
type: string
minLength: 1
maxLength: 350
SecondaryIdentification:
$ref: '#/definitions/SecondaryIdentification'
CreditorAccount:
type: object
additionalProperties: false
required:
- SchemeName
- Identification
- Name
description: Unambiguous identification of the account of the creditor
to which a credit entry will be posted as a result of the payment
transaction.
properties:
SchemeName:
$ref: '#/definitions/OBExternalAccountIdentification4Code'
Identification:
$ref: '#/definitions/Identification_0'
Name:
description: |-
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.
type: string
minLength: 1
maxLength: 350
SecondaryIdentification:
$ref: '#/definitions/SecondaryIdentification'
CreditorPostalAddress:
$ref: '#/definitions/OBPostalAddress6'
RemittanceInformation:
type: object
additionalProperties: false
description: 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.
properties:
Unstructured:
description: 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.
type: string
minLength: 1
maxLength: 140
Reference:
description: |-
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.
type: string
minLength: 1
maxLength: 35
SupplementaryData:
$ref: '#/definitions/OBSupplementaryData1'
Authorisation:
type: object
additionalProperties: false
required:
- AuthorisationType
description: The authorisation type request from the TPP.
properties:
AuthorisationType:
description: Type of authorisation flow requested.
type: string
enum:
- Any
- Single
CompletionDateTime:
description: "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. \nAll date-time fields in responses
must include the timezone. An example is below:\n2017-04-05T10:43:07+00:00"
type: string
format: date-time
SCASupportData:
type: object
additionalProperties: false
description: Supporting Data provided by TPP, when requesting SCA Exemption.
properties:
RequestedSCAExemptionType:
description: This field allows a PISP to request specific SCA Exemption
for a Payment Initiation
type: string
enum:
- BillPayment
- ContactlessTravel
- EcommerceGoods
- EcommerceServices
- Kiosk
- Parking
- PartyToParty
AppliedAuthenticationApproach:
description: |-
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
type: string
enum:
- CA
- SCA
ReferencePaymentOrderId:
description: |-
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.
type: string
minLength: 1
maxLength: 128
Risk:
$ref: '#/definitions/OBRisk1'
OBWriteDomesticConsentResponse5:
type: object
additionalProperties: false
required:
- Data
- Risk
properties:
Data:
type: object
additionalProperties: false
required:
- ConsentId
- CreationDateTime
- Status
- StatusUpdateDateTime
- Initiation
properties:
ConsentId:
description: 'OB: Unique identification as assigned by the ASPSP to uniquely
identify the consent resource.'
type: string
minLength: 1
maxLength: 128
CreationDateTime:
description: "Date and time at which the resource was created.All dates
in the JSON payloads are represented in ISO 8601 date-time format. \nAll
date-time fields in responses must include the timezone. An example
is below:\n2017-04-05T10:43:07+00:00"
type: string
format: date-time
Status:
description: Specifies the status of consent resource in code form.
type: string
enum:
- Authorised
- AwaitingAuthorisation
- Consumed
- Rejected
StatusUpdateDateTime:
description: "Date and time at which the resource status was updated.All
dates in the JSON payloads are represented in ISO 8601 date-time format.
\nAll date-time fields in responses must include the timezone. An example
is below:\n2017-04-05T10:43:07+00:00"
type: string
format: date-time
ReadRefundAccount:
description: Specifies to share the refund account details with PISP
type: string
enum:
- "No"
- "Yes"
CutOffDateTime:
description: "Specified cut-off date and time for the payment consent.All
dates in the JSON payloads are represented in ISO 8601 date-time format.
\nAll date-time fields in responses must include the timezone. An example
is below:\n2017-04-05T10:43:07+00:00"
type: string
format: date-time
ExpectedExecutionDateTime:
description: "Expected execution date and time for the payment resource.All
dates in the JSON payloads are represented in ISO 8601 date-time format.
\nAll date-time fields in responses must include the timezone. An example
is below:\n2017-04-05T10:43:07+00:00"
type: string
format: date-time
ExpectedSettlementDateTime:
description: "Expected settlement date and time for the payment resource.All
dates in the JSON payloads are represented in ISO 8601 date-time format.
\nAll date-time fields in responses must include the timezone. An example
is below:\n2017-04-05T10:43:07+00:00"
type: string
format: date-time
Charges:
type: array
items:
type: object
additionalProperties: false
description: Set of elements used to provide details of a charge for
the payment initiation.
required:
- ChargeBearer
- Type
- Amount
properties:
ChargeBearer:
$ref: '#/definitions/OBChargeBearerType1Code'
Type:
$ref: '#/definitions/OBExternalPaymentChargeType1Code'
Amount:
$ref: '#/definitions/OBActiveOrHistoricCurrencyAndAmount'
Initiation:
type: object
additionalProperties: false
required:
- InstructionIdentification
- EndToEndIdentification
- InstructedAmount
- CreditorAccount
description: 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.
properties:
InstructionIdentification:
description: |-
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.
type: string
minLength: 1
maxLength: 35
EndToEndIdentification:
description: |-
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.
type: string
minLength: 1
maxLength: 35
LocalInstrument:
$ref: '#/definitions/OBExternalLocalInstrument1Code'
InstructedAmount:
type: object
additionalProperties: false
required:
- Amount
- Currency
description: |-
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.
properties:
Amount:
$ref: '#/definitions/OBActiveCurrencyAndAmount_SimpleType'
Currency:
$ref: '#/definitions/ActiveOrHistoricCurrencyCode'
DebtorAccount:
type: object
additionalProperties: false
required:
- SchemeName
- Identification
description: Unambiguous identification of the account of the debtor
to which a debit entry will be made as a result of the transaction.
properties:
SchemeName:
$ref: '#/definitions/OBExternalAccountIdentification4Code'
Identification:
$ref: '#/definitions/Identification_0'
Name:
description: |-
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.
type: string
minLength: 1
maxLength: 350
SecondaryIdentification:
$ref: '#/definitions/SecondaryIdentification'
CreditorAccount:
type: object
additionalProperties: false
required:
- SchemeName
- Identification
- Name
description: Unambiguous identification of the account of the creditor
to which a credit entry will be posted as a result of the payment
transaction.
properties:
SchemeName:
$ref: '#/definitions/OBExternalAccountIdentification4Code'
Identification:
$ref: '#/definitions/Identification_0'
Name:
description: |-
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.
type: string
minLength: 1
maxLength: 350
SecondaryIdentification:
$ref: '#/definitions/SecondaryIdentification'
CreditorPostalAddress:
$ref: '#/definitions/OBPostalAddress6'
RemittanceInformation:
type: object
additionalProperties: false
description: 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.
properties:
Unstructured:
description: 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.
type: string
minLength: 1
maxLength: 140
Reference:
description: |-
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.
type: string
minLength: 1
maxLength: 35
SupplementaryData:
$ref: '#/definitions/OBSupplementaryData1'
Authorisation:
type: object
additionalProperties: false
required:
- AuthorisationType
description: The authorisation type request from the TPP.
properties:
AuthorisationType:
description: Type of authorisation flow requested.
type: string
enum:
- Any
- Single
CompletionDateTime:
description: "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. \nAll date-time fields in responses
must include the timezone. An example is below:\n2017-04-05T10:43:07+00:00"
type: string
format: date-time
SCASupportData:
type: object
additionalProperties: false
description: Supporting Data provided by TPP, when requesting SCA Exemption.
properties:
RequestedSCAExemptionType:
description: This field allows a PISP to request specific SCA Exemption
for a Payment Initiation
type: string
enum:
- BillPayment
- ContactlessTravel
- EcommerceGoods
- EcommerceServices
- Kiosk
- Parking
- PartyToParty
AppliedAuthenticationApproach:
description: |-
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
type: string
enum:
- CA
- SCA
ReferencePaymentOrderId:
description: |-
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.
type: string
minLength: 1
maxLength: 128
Debtor:
$ref: '#/definitions/OBDebtorIdentification1'
Risk:
$ref: '#/definitions/OBRisk1'
Links:
$ref: '#/definitions/Links'
Meta:
$ref: '#/definitions/Meta'
OBWriteDomesticResponse5:
type: object
additionalProperties: false
required:
- Data
properties:
Data:
type: object
additionalProperties: false
required:
- DomesticPaymentId
- ConsentId
- CreationDateTime
- Status
- StatusUpdateDateTime
- Initiation
properties:
DomesticPaymentId:
description: 'OB: Unique identification as assigned by the ASPSP to uniquely
identify the domestic payment resource.'
type: string
minLength: 1
maxLength: 40
ConsentId:
description: 'OB: Unique identification as assigned by the ASPSP to uniquely
identify the consent resource.'
type: string
minLength: 1
maxLength: 128
CreationDateTime:
description: "Date and time at which the message was created.All dates
in the JSON payloads are represented in ISO 8601 date-time format. \nAll
date-time fields in responses must include the timezone. An example
is below:\n2017-04-05T10:43:07+00:00"
type: string
format: date-time
Status:
description: Specifies the status of the payment information group.
type: string
enum:
- AcceptedCreditSettlementCompleted
- AcceptedSettlementCompleted
- AcceptedSettlementInProcess
- AcceptedWithoutPosting
- Pending
- Rejected
StatusUpdateDateTime:
description: "Date and time at which the resource status was updated.All
dates in the JSON payloads are represented in ISO 8601 date-time format.
\nAll date-time fields in responses must include the timezone. An example
is below:\n2017-04-05T10:43:07+00:00"
type: string
format: date-time
ExpectedExecutionDateTime:
description: "Expected execution date and time for the payment resource.All
dates in the JSON payloads are represented in ISO 8601 date-time format.
\nAll date-time fields in responses must include the timezone. An example
is below:\n2017-04-05T10:43:07+00:00"
type: string
format: date-time
ExpectedSettlementDateTime:
description: "Expected settlement date and time for the payment resource.All
dates in the JSON payloads are represented in ISO 8601 date-time format.
\nAll date-time fields in responses must include the timezone. An example
is below:\n2017-04-05T10:43:07+00:00"
type: string
format: date-time
Refund:
type: object
additionalProperties: false
required:
- Account
description: Unambiguous identification of the refund account to which
a refund will be made as a result of the transaction.
properties:
Account:
type: object
additionalProperties: false
required:
- SchemeName
- Identification
- Name
description: Provides the details to identify an account.
properties:
SchemeName:
$ref: '#/definitions/OBExternalAccountIdentification4Code'
Identification:
$ref: '#/definitions/Identification_0'
Name:
description: |-
Name of the account, as assigned by the account servicing institution.
Usage: The account name is the name or names of the account owner(s) represented at an account level. 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.
type: string
minLength: 1
maxLength: 350
SecondaryIdentification:
$ref: '#/definitions/SecondaryIdentification'
Charges:
type: array
items:
type: object
additionalProperties: false
description: Set of elements used to provide details of a charge for
the payment initiation.
required:
- ChargeBearer
- Type
- Amount
properties:
ChargeBearer:
$ref: '#/definitions/OBChargeBearerType1Code'
Type:
$ref: '#/definitions/OBExternalPaymentChargeType1Code'
Amount:
$ref: '#/definitions/OBActiveOrHistoricCurrencyAndAmount'
Initiation:
type: object
additionalProperties: false
required:
- InstructionIdentification
- EndToEndIdentification
- InstructedAmount
- CreditorAccount
description: 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.
properties:
InstructionIdentification:
description: |-
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.
type: string
minLength: 1
maxLength: 35
EndToEndIdentification:
description: |-
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.
type: string
minLength: 1
maxLength: 35
LocalInstrument:
$ref: '#/definitions/OBExternalLocalInstrument1Code'
InstructedAmount:
type: object
additionalProperties: false
required:
- Amount
- Currency
description: |-
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.
properties:
Amount:
$ref: '#/definitions/OBActiveCurrencyAndAmount_SimpleType'
Currency:
$ref: '#/definitions/ActiveOrHistoricCurrencyCode'
DebtorAccount:
type: object
additionalProperties: false
required:
- SchemeName
- Identification
description: Unambiguous identification of the account of the debtor
to which a debit entry will be made as a result of the transaction.
properties:
SchemeName:
$ref: '#/definitions/OBExternalAccountIdentification4Code'
Identification:
$ref: '#/definitions/Identification_0'
Name:
description: |-
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.
type: string
minLength: 1
maxLength: 350
SecondaryIdentification:
$ref: '#/definitions/SecondaryIdentification'
CreditorAccount:
type: object
additionalProperties: false
required:
- SchemeName
- Identification
- Name
description: Unambiguous identification of the account of the creditor
to which a credit entry will be posted as a result of the payment
transaction.
properties:
SchemeName:
$ref: '#/definitions/OBExternalAccountIdentification4Code'
Identification:
$ref: '#/definitions/Identification_0'
Name:
description: |-
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.
type: string
minLength: 1
maxLength: 350
SecondaryIdentification:
$ref: '#/definitions/SecondaryIdentification'
CreditorPostalAddress:
$ref: '#/definitions/OBPostalAddress6'
RemittanceInformation:
type: object
additionalProperties: false
description: 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.
properties:
Unstructured:
description: 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.
type: string
minLength: 1
maxLength: 140
Reference:
description: |-
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.
type: string
minLength: 1
maxLength: 35
SupplementaryData:
$ref: '#/definitions/OBSupplementaryData1'
MultiAuthorisation:
type: object
additionalProperties: false
required:
- Status
description: The multiple authorisation flow response from the ASPSP.
properties:
Status:
description: Specifies the status of the authorisation flow in code
form.
type: string
enum:
- Authorised
- AwaitingFurtherAuthorisation
- Rejected
NumberRequired:
description: Number of authorisations required for payment order (total
required at the start of the multi authorisation journey).
type: integer
NumberReceived:
description: Number of authorisations received.
type: integer
LastUpdateDateTime:
description: "Last date and time at the authorisation flow was updated.All
dates in the JSON payloads are represented in ISO 8601 date-time
format. \nAll date-time fields in responses must include the timezone.
An example is below:\n2017-04-05T10:43:07+00:00"
type: string
format: date-time
ExpirationDateTime:
description: "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. \nAll date-time fields in responses
must include the timezone. An example is below:\n2017-04-05T10:43:07+00:00"
type: string
format: date-time
Debtor:
$ref: '#/definitions/OBDebtorIdentification1'
Links:
$ref: '#/definitions/Links'
Meta:
$ref: '#/definitions/Meta'
OBWriteDomesticScheduled2:
type: object
additionalProperties: false
required:
- Data
- Risk
properties:
Data:
type: object
additionalProperties: false
required:
- ConsentId
- Initiation
properties:
ConsentId:
description: 'OB: Unique identification as assigned by the ASPSP to uniquely
identify the consent resource.'
type: string
minLength: 1
maxLength: 128
Initiation:
type: object
additionalProperties: false
required:
- InstructionIdentification
- RequestedExecutionDateTime
- InstructedAmount
- CreditorAccount
description: 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.
properties:
InstructionIdentification:
description: |-
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.
type: string
minLength: 1
maxLength: 35
EndToEndIdentification:
description: |-
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.
type: string
minLength: 1
maxLength: 35
LocalInstrument:
$ref: '#/definitions/OBExternalLocalInstrument1Code'
RequestedExecutionDateTime:
description: "Date at which the initiating party requests the clearing
agent to process the payment. \nUsage: 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. \nAll date-time fields
in responses must include the timezone. An example is below:\n2017-04-05T10:43:07+00:00"
type: string
format: date-time
InstructedAmount:
type: object
additionalProperties: false
required:
- Amount
- Currency
description: |-
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.
properties:
Amount:
$ref: '#/definitions/OBActiveCurrencyAndAmount_SimpleType'
Currency:
$ref: '#/definitions/ActiveOrHistoricCurrencyCode'
DebtorAccount:
type: object
additionalProperties: false
required:
- SchemeName
- Identification
description: Unambiguous identification of the account of the debtor
to which a debit entry will be made as a result of the transaction.
properties:
SchemeName:
$ref: '#/definitions/OBExternalAccountIdentification4Code'
Identification:
$ref: '#/definitions/Identification_0'
Name:
description: |-
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.
type: string
minLength: 1
maxLength: 350
SecondaryIdentification:
$ref: '#/definitions/SecondaryIdentification'
CreditorAccount:
type: object
additionalProperties: false
required:
- SchemeName
- Identification
- Name
description: Unambiguous identification of the account of the creditor
to which a credit entry will be posted as a result of the payment
transaction.
properties:
SchemeName:
$ref: '#/definitions/OBExternalAccountIdentification4Code'
Identification:
$ref: '#/definitions/Identification_0'
Name:
description: |-
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.
type: string
minLength: 1
maxLength: 350
SecondaryIdentification:
$ref: '#/definitions/SecondaryIdentification'
CreditorPostalAddress:
$ref: '#/definitions/OBPostalAddress6'
RemittanceInformation:
type: object
additionalProperties: false
description: 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.
properties:
Unstructured:
description: 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.
type: string
minLength: 1
maxLength: 140
Reference:
description: |-
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.
type: string
minLength: 1
maxLength: 35
SupplementaryData:
$ref: '#/definitions/OBSupplementaryData1'
Risk:
$ref: '#/definitions/OBRisk1'
OBWriteDomesticScheduledConsent4:
type: object
additionalProperties: false
required:
- Data
- Risk
properties:
Data:
type: object
additionalProperties: false
required:
- Permission
- Initiation
properties:
Permission:
description: Specifies the Open Banking service request types.
type: string
enum:
- Create
ReadRefundAccount:
description: Specifies to share the refund account details with PISP
type: string
enum:
- "No"
- "Yes"
Initiation:
type: object
additionalProperties: false
required:
- InstructionIdentification
- RequestedExecutionDateTime
- InstructedAmount
- CreditorAccount
description: 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.
properties:
InstructionIdentification:
description: |-
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.
type: string
minLength: 1
maxLength: 35
EndToEndIdentification:
description: |-
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.
type: string
minLength: 1
maxLength: 35
LocalInstrument:
$ref: '#/definitions/OBExternalLocalInstrument1Code'
RequestedExecutionDateTime:
description: "Date at which the initiating party requests the clearing
agent to process the payment. \nUsage: 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. \nAll date-time fields
in responses must include the timezone. An example is below:\n2017-04-05T10:43:07+00:00"
type: string
format: date-time
InstructedAmount:
type: object
additionalProperties: false
required:
- Amount
- Currency
description: |-
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.
properties:
Amount:
$ref: '#/definitions/OBActiveCurrencyAndAmount_SimpleType'
Currency:
$ref: '#/definitions/ActiveOrHistoricCurrencyCode'
DebtorAccount:
type: object
additionalProperties: false
required:
- SchemeName
- Identification
description: Unambiguous identification of the account of the debtor
to which a debit entry will be made as a result of the transaction.
properties:
SchemeName:
$ref: '#/definitions/OBExternalAccountIdentification4Code'
Identification:
$ref: '#/definitions/Identification_0'
Name:
description: |-
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.
type: string
minLength: 1
maxLength: 350
SecondaryIdentification:
$ref: '#/definitions/SecondaryIdentification'
CreditorAccount:
type: object
additionalProperties: false
required:
- SchemeName
- Identification
- Name
description: Unambiguous identification of the account of the creditor
to which a credit entry will be posted as a result of the payment
transaction.
properties:
SchemeName:
$ref: '#/definitions/OBExternalAccountIdentification4Code'
Identification:
$ref: '#/definitions/Identification_0'
Name:
description: |-
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.
type: string
minLength: 1
maxLength: 350
SecondaryIdentification:
$ref: '#/definitions/SecondaryIdentification'
CreditorPostalAddress:
$ref: '#/definitions/OBPostalAddress6'
RemittanceInformation:
type: object
additionalProperties: false
description: 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.
properties:
Unstructured:
description: 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.
type: string
minLength: 1
maxLength: 140
Reference:
description: |-
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.
type: string
minLength: 1
maxLength: 35
SupplementaryData:
$ref: '#/definitions/OBSupplementaryData1'
Authorisation:
type: object
additionalProperties: false
required:
- AuthorisationType
description: The authorisation type request from the TPP.
properties:
AuthorisationType:
description: Type of authorisation flow requested.
type: string
enum:
- Any
- Single
CompletionDateTime:
description: "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. \nAll date-time fields in responses
must include the timezone. An example is below:\n2017-04-05T10:43:07+00:00"
type: string
format: date-time
SCASupportData:
type: object
additionalProperties: false
description: Supporting Data provided by TPP, when requesting SCA Exemption.
properties:
RequestedSCAExemptionType:
description: This field allows a PISP to request specific SCA Exemption
for a Payment Initiation
type: string
enum:
- BillPayment
- ContactlessTravel
- EcommerceGoods
- EcommerceServices
- Kiosk
- Parking
- PartyToParty
AppliedAuthenticationApproach:
description: |-
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
type: string
enum:
- CA
- SCA
ReferencePaymentOrderId:
description: |-
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.
type: string
minLength: 1
maxLength: 128
Risk:
$ref: '#/definitions/OBRisk1'
OBWriteDomesticScheduledConsentResponse5:
type: object
additionalProperties: false
required:
- Data
- Risk
properties:
Data:
type: object
additionalProperties: false
required:
- ConsentId
- CreationDateTime
- Status
- StatusUpdateDateTime
- Permission
- Initiation
properties:
ConsentId:
description: 'OB: Unique identification as assigned by the ASPSP to uniquely
identify the consent resource.'
type: string
minLength: 1
maxLength: 128
CreationDateTime:
description: "Date and time at which the resource was created.All dates
in the JSON payloads are represented in ISO 8601 date-time format. \nAll
date-time fields in responses must include the timezone. An example
is below:\n2017-04-05T10:43:07+00:00"
type: string
format: date-time
Status:
description: Specifies the status of consent resource in code form.
type: string
enum:
- Authorised
- AwaitingAuthorisation
- Consumed
- Rejected
StatusUpdateDateTime:
description: "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.
\nAll date-time fields in responses must include the timezone. An example
is below:\n2017-04-05T10:43:07+00:00"
type: string
format: date-time
Permission:
description: Specifies the Open Banking service request types.
type: string
enum:
- Create
ReadRefundAccount:
description: Specifies to share the refund account details with PISP
type: string
enum:
- "No"
- "Yes"
CutOffDateTime:
description: "Specified cut-off date and time for the payment consent.All
dates in the JSON payloads are represented in ISO 8601 date-time format.
\nAll date-time fields in responses must include the timezone. An example
is below:\n2017-04-05T10:43:07+00:00"
type: string
format: date-time
ExpectedExecutionDateTime:
description: "Expected execution date and time for the payment resource.All
dates in the JSON payloads are represented in ISO 8601 date-time format.
\nAll date-time fields in responses must include the timezone. An example
is below:\n2017-04-05T10:43:07+00:00"
type: string
format: date-time
ExpectedSettlementDateTime:
description: "Expected settlement date and time for the payment resource.All
dates in the JSON payloads are represented in ISO 8601 date-time format.
\nAll date-time fields in responses must include the timezone. An example
is below:\n2017-04-05T10:43:07+00:00"
type: string
format: date-time
Charges:
type: array
items:
type: object
additionalProperties: false
description: Set of elements used to provide details of a charge for
the payment initiation.
required:
- ChargeBearer
- Type
- Amount
properties:
ChargeBearer:
$ref: '#/definitions/OBChargeBearerType1Code'
Type:
$ref: '#/definitions/OBExternalPaymentChargeType1Code'
Amount:
$ref: '#/definitions/OBActiveOrHistoricCurrencyAndAmount'
Initiation:
type: object
additionalProperties: false
required:
- InstructionIdentification
- RequestedExecutionDateTime
- InstructedAmount
- CreditorAccount
description: 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.
properties:
InstructionIdentification:
description: |-
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.
type: string
minLength: 1
maxLength: 35
EndToEndIdentification:
description: |-
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.
type: string
minLength: 1
maxLength: 35
LocalInstrument:
$ref: '#/definitions/OBExternalLocalInstrument1Code'
RequestedExecutionDateTime:
description: "Date at which the initiating party requests the clearing
agent to process the payment. \nUsage: 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. \nAll date-time fields
in responses must include the timezone. An example is below:\n2017-04-05T10:43:07+00:00"
type: string
format: date-time
InstructedAmount:
type: object
additionalProperties: false
required:
- Amount
- Currency
description: |-
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.
properties:
Amount:
$ref: '#/definitions/OBActiveCurrencyAndAmount_SimpleType'
Currency:
$ref: '#/definitions/ActiveOrHistoricCurrencyCode'
DebtorAccount:
type: object
additionalProperties: false
required:
- SchemeName
- Identification
description: Unambiguous identification of the account of the debtor
to which a debit entry will be made as a result of the transaction.
properties:
SchemeName:
$ref: '#/definitions/OBExternalAccountIdentification4Code'
Identification:
$ref: '#/definitions/Identification_0'
Name:
description: |-
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.
type: string
minLength: 1
maxLength: 350
SecondaryIdentification:
$ref: '#/definitions/SecondaryIdentification'
CreditorAccount:
type: object
additionalProperties: false
required:
- SchemeName
- Identification
- Name
description: Unambiguous identification of the account of the creditor
to which a credit entry will be posted as a result of the payment
transaction.
properties:
SchemeName:
$ref: '#/definitions/OBExternalAccountIdentification4Code'
Identification:
$ref: '#/definitions/Identification_0'
Name:
description: |-
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.
type: string
minLength: 1
maxLength: 350
SecondaryIdentification:
$ref: '#/definitions/SecondaryIdentification'
CreditorPostalAddress:
$ref: '#/definitions/OBPostalAddress6'
RemittanceInformation:
type: object
additionalProperties: false
description: 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.
properties:
Unstructured:
description: 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.
type: string
minLength: 1
maxLength: 140
Reference:
description: |-
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.
type: string
minLength: 1
maxLength: 35
SupplementaryData:
$ref: '#/definitions/OBSupplementaryData1'
Authorisation:
type: object
additionalProperties: false
required:
- AuthorisationType
description: The authorisation type request from the TPP.
properties:
AuthorisationType:
description: Type of authorisation flow requested.
type: string
enum:
- Any
- Single
CompletionDateTime:
description: "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. \nAll date-time fields in responses
must include the timezone. An example is below:\n2017-04-05T10:43:07+00:00"
type: string
format: date-time
SCASupportData:
type: object
additionalProperties: false
description: Supporting Data provided by TPP, when requesting SCA Exemption.
properties:
RequestedSCAExemptionType:
description: This field allows a PISP to request specific SCA Exemption
for a Payment Initiation
type: string
enum:
- BillPayment
- ContactlessTravel
- EcommerceGoods
- EcommerceServices
- Kiosk
- Parking
- PartyToParty
AppliedAuthenticationApproach:
description: |-
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
type: string
enum:
- CA
- SCA
ReferencePaymentOrderId:
description: |-
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.
type: string
minLength: 1
maxLength: 128
Debtor:
$ref: '#/definitions/OBDebtorIdentification1'
Risk:
$ref: '#/definitions/OBRisk1'
Links:
$ref: '#/definitions/Links'
Meta:
$ref: '#/definitions/Meta'
OBWriteDomesticScheduledResponse5:
type: object
additionalProperties: false
required:
- Data
properties:
Data:
type: object
additionalProperties: false
required:
- DomesticScheduledPaymentId
- ConsentId
- CreationDateTime
- Status
- StatusUpdateDateTime
- Initiation
properties:
DomesticScheduledPaymentId:
description: 'OB: Unique identification as assigned by the ASPSP to uniquely
identify the domestic schedule payment resource.'
type: string
minLength: 1
maxLength: 40
ConsentId:
description: 'OB: Unique identification as assigned by the ASPSP to uniquely
identify the consent resource.'
type: string
minLength: 1
maxLength: 128
CreationDateTime:
description: "Date and time at which the message was created.All dates
in the JSON payloads are represented in ISO 8601 date-time format. \nAll
date-time fields in responses must include the timezone. An example
is below:\n2017-04-05T10:43:07+00:00"
type: string
format: date-time
Status:
description: Specifies the status of the payment order resource.
type: string
enum:
- Cancelled
- InitiationCompleted
- InitiationFailed
- InitiationPending
StatusUpdateDateTime:
description: "Date and time at which the resource status was updated.All
dates in the JSON payloads are represented in ISO 8601 date-time format.
\nAll date-time fields in responses must include the timezone. An example
is below:\n2017-04-05T10:43:07+00:00"
type: string
format: date-time
ExpectedExecutionDateTime:
description: "Expected execution date and time for the payment resource.All
dates in the JSON payloads are represented in ISO 8601 date-time format.
\nAll date-time fields in responses must include the timezone. An example
is below:\n2017-04-05T10:43:07+00:00"
type: string
format: date-time
ExpectedSettlementDateTime:
description: "Expected settlement date and time for the payment resource.All
dates in the JSON payloads are represented in ISO 8601 date-time format.
\nAll date-time fields in responses must include the timezone. An example
is below:\n2017-04-05T10:43:07+00:00"
type: string
format: date-time
Refund:
type: object
additionalProperties: false
required:
- Account
description: Unambiguous identification of the refund account to which
a refund will be made as a result of the transaction.
properties:
Account:
type: object
additionalProperties: false
required:
- SchemeName
- Identification
- Name
description: Provides the details to identify an account.
properties:
SchemeName:
$ref: '#/definitions/OBExternalAccountIdentification4Code'
Identification:
$ref: '#/definitions/Identification_0'
Name:
description: |-
Name of the account, as assigned by the account servicing institution.
Usage: The account name is the name or names of the account owner(s) represented at an account level. 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.
type: string
minLength: 1
maxLength: 350
SecondaryIdentification:
$ref: '#/definitions/SecondaryIdentification'
Charges:
type: array
items:
type: object
additionalProperties: false
description: Set of elements used to provide details of a charge for
the payment initiation.
required:
- ChargeBearer
- Type
- Amount
properties:
ChargeBearer:
$ref: '#/definitions/OBChargeBearerType1Code'
Type:
$ref: '#/definitions/OBExternalPaymentChargeType1Code'
Amount:
$ref: '#/definitions/OBActiveOrHistoricCurrencyAndAmount'
Initiation:
type: object
additionalProperties: false
required:
- InstructionIdentification
- RequestedExecutionDateTime
- InstructedAmount
- CreditorAccount
description: 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.
properties:
InstructionIdentification:
description: |-
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.
type: string
minLength: 1
maxLength: 35
EndToEndIdentification:
description: |-
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.
type: string
minLength: 1
maxLength: 35
LocalInstrument:
$ref: '#/definitions/OBExternalLocalInstrument1Code'
RequestedExecutionDateTime:
description: "Date at which the initiating party requests the clearing
agent to process the payment. \nUsage: 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. \nAll date-time fields
in responses must include the timezone. An example is below:\n2017-04-05T10:43:07+00:00"
type: string
format: date-time
InstructedAmount:
type: object
additionalProperties: false
required:
- Amount
- Currency
description: |-
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.
properties:
Amount:
$ref: '#/definitions/OBActiveCurrencyAndAmount_SimpleType'
Currency:
$ref: '#/definitions/ActiveOrHistoricCurrencyCode'
DebtorAccount:
type: object
additionalProperties: false
required:
- SchemeName
- Identification
description: Unambiguous identification of the account of the debtor
to which a debit entry will be made as a result of the transaction.
properties:
SchemeName:
$ref: '#/definitions/OBExternalAccountIdentification4Code'
Identification:
$ref: '#/definitions/Identification_0'
Name:
description: |-
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.
type: string
minLength: 1
maxLength: 350
SecondaryIdentification:
$ref: '#/definitions/SecondaryIdentification'
CreditorAccount:
type: object
additionalProperties: false
required:
- SchemeName
- Identification
- Name
description: Unambiguous identification of the account of the creditor
to which a credit entry will be posted as a result of the payment
transaction.
properties:
SchemeName:
$ref: '#/definitions/OBExternalAccountIdentification4Code'
Identification:
$ref: '#/definitions/Identification_0'
Name:
description: |-
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.
type: string
minLength: 1
maxLength: 350
SecondaryIdentification:
$ref: '#/definitions/SecondaryIdentification'
CreditorPostalAddress:
$ref: '#/definitions/OBPostalAddress6'
RemittanceInformation:
type: object
additionalProperties: false
description: 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.
properties:
Unstructured:
description: 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.
type: string
minLength: 1
maxLength: 140
Reference:
description: |-
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.
type: string
minLength: 1
maxLength: 35
SupplementaryData:
$ref: '#/definitions/OBSupplementaryData1'
MultiAuthorisation:
type: object
additionalProperties: false
required:
- Status
description: The multiple authorisation flow response from the ASPSP.
properties:
Status:
description: Specifies the status of the authorisation flow in code
form.
type: string
enum:
- Authorised
- AwaitingFurtherAuthorisation
- Rejected
NumberRequired:
description: Number of authorisations required for payment order (total
required at the start of the multi authorisation journey).
type: integer
NumberReceived:
description: Number of authorisations received.
type: integer
LastUpdateDateTime:
description: "Last date and time at the authorisation flow was updated.All
dates in the JSON payloads are represented in ISO 8601 date-time
format. \nAll date-time fields in responses must include the timezone.
An example is below:\n2017-04-05T10:43:07+00:00"
type: string
format: date-time
ExpirationDateTime:
description: "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. \nAll date-time fields in responses
must include the timezone. An example is below:\n2017-04-05T10:43:07+00:00"
type: string
format: date-time
Debtor:
$ref: '#/definitions/OBDebtorIdentification1'
Links:
$ref: '#/definitions/Links'
Meta:
$ref: '#/definitions/Meta'
OBWriteDomesticStandingOrder3:
type: object
additionalProperties: false
required:
- Data
- Risk
properties:
Data:
type: object
additionalProperties: false
required:
- ConsentId
- Initiation
properties:
ConsentId:
description: 'OB: Unique identification as assigned by the ASPSP to uniquely
identify the consent resource.'
type: string
minLength: 1
maxLength: 128
Initiation:
type: object
additionalProperties: false
required:
- Frequency
- FirstPaymentDateTime
- FirstPaymentAmount
- CreditorAccount
description: 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.
properties:
Frequency:
description: "Individual Definitions:\nEvryDay - Every day\nEvryWorkgDay
- Every working day\nIntrvlWkDay - An interval specified in weeks
(01 to 09), and the day within the week (01 to 07)\nWkInMnthDay
- A monthly interval, specifying the week of the month (01 to 05)
and day within the week (01 to 07)\nIntrvlMnthDay - An interval
specified in months (between 01 to 06, 12, 24), specifying the day
within the month (-5 to -1, 1 to 31)\nQtrDay - Quarterly (either
ENGLISH, SCOTTISH, or RECEIVED). \nENGLISH = Paid on the 25th March,
24th June, 29th September and 25th December. \nSCOTTISH = Paid on
the 2nd February, 15th May, 1st August and 11th November.\nRECEIVED
= Paid on the 20th March, 19th June, 24th September and 20th December.
\nIndividual Patterns:\nEvryDay (ScheduleCode)\nEvryWorkgDay (ScheduleCode)\nIntrvlWkDay:IntervalInWeeks:DayInWeek
(ScheduleCode + IntervalInWeeks + DayInWeek)\nWkInMnthDay:WeekInMonth:DayInWeek
(ScheduleCode + WeekInMonth + DayInWeek)\nIntrvlMnthDay:IntervalInMonths:DayInMonth
(ScheduleCode + IntervalInMonths + DayInMonth)\nQtrDay: + either
(ENGLISH, SCOTTISH or RECEIVED) ScheduleCode + QuarterDay\nThe regular
expression for this element combines five smaller versions for each
permitted pattern. To aid legibility - the components are presented
individually here:\nEvryDay\nEvryWorkgDay\nIntrvlWkDay:0[1-9]:0[1-7]\nWkInMnthDay:0[1-5]:0[1-7]\nIntrvlMnthDay:(0[1-6]|12|24):(-0[1-5]|0[1-9]|[12][0-9]|3[01])\nQtrDay:(ENGLISH|SCOTTISH|RECEIVED)\nFull
Regular Expression:\n^(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))$"
type: string
pattern: ^(EvryDay)$|^(EvryWorkgDay)$|^(IntrvlDay:((0[2-9])|([1-2][0-9])|3[0-1]))$|^(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))$
Reference:
description: |-
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.
type: string
minLength: 1
maxLength: 35
NumberOfPayments:
description: Number of the payments that will be made in completing
this frequency sequence including any executed since the sequence
start date.
type: string
minLength: 1
maxLength: 35
FirstPaymentDateTime:
description: "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. \nAll date-time fields in responses
must include the timezone. An example is below:\n2017-04-05T10:43:07+00:00"
type: string
format: date-time
RecurringPaymentDateTime:
description: "The date on which the first recurring payment for a
Standing Order schedule will be made. \nUsage: 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. \nAll date-time fields in responses must include
the timezone. An example is below:\n2017-04-05T10:43:07+00:00"
type: string
format: date-time
FinalPaymentDateTime:
description: "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. \nAll date-time fields in responses
must include the timezone. An example is below:\n2017-04-05T10:43:07+00:00"
type: string
format: date-time
FirstPaymentAmount:
type: object
additionalProperties: false
required:
- Amount
- Currency
description: The amount of the first Standing Order
properties:
Amount:
$ref: '#/definitions/OBActiveCurrencyAndAmount_SimpleType'
Currency:
$ref: '#/definitions/ActiveOrHistoricCurrencyCode'
RecurringPaymentAmount:
type: object
additionalProperties: false
required:
- Amount
- Currency
description: The amount of the recurring Standing Order
properties:
Amount:
$ref: '#/definitions/OBActiveCurrencyAndAmount_SimpleType'
Currency:
$ref: '#/definitions/ActiveOrHistoricCurrencyCode'
FinalPaymentAmount:
type: object
additionalProperties: false
required:
- Amount
- Currency
description: The amount of the final Standing Order
properties:
Amount:
$ref: '#/definitions/OBActiveCurrencyAndAmount_SimpleType'
Currency:
$ref: '#/definitions/ActiveOrHistoricCurrencyCode'
DebtorAccount:
type: object
additionalProperties: false
required:
- SchemeName
- Identification
description: Provides the details to identify the debtor account.
properties:
SchemeName:
$ref: '#/definitions/OBExternalAccountIdentification4Code'
Identification:
$ref: '#/definitions/Identification_0'
Name:
description: |-
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.
type: string
minLength: 1
maxLength: 350
SecondaryIdentification:
$ref: '#/definitions/SecondaryIdentification'
CreditorAccount:
type: object
additionalProperties: false
required:
- SchemeName
- Identification
- Name
description: Identification assigned by an institution to identify
an account. This identification is known by the account owner.
properties:
SchemeName:
$ref: '#/definitions/OBExternalAccountIdentification4Code'
Identification:
$ref: '#/definitions/Identification_0'
Name:
description: |-
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.
type: string
minLength: 1
maxLength: 350
SecondaryIdentification:
$ref: '#/definitions/SecondaryIdentification'
SupplementaryData:
$ref: '#/definitions/OBSupplementaryData1'
Risk:
$ref: '#/definitions/OBRisk1'
OBWriteDomesticStandingOrderConsent5:
type: object
additionalProperties: false
required:
- Data
- Risk
properties:
Data:
type: object
additionalProperties: false
required:
- Permission
- Initiation
properties:
Permission:
description: Specifies the Open Banking service request types.
type: string
enum:
- Create
ReadRefundAccount:
description: Specifies to share the refund account details with PISP
type: string
enum:
- "No"
- "Yes"
Initiation:
type: object
additionalProperties: false
required:
- Frequency
- FirstPaymentDateTime
- FirstPaymentAmount
- CreditorAccount
description: 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.
properties:
Frequency:
description: "Individual Definitions:\nEvryDay - Every day\nEvryWorkgDay
- Every working day\nIntrvlWkDay - An interval specified in weeks
(01 to 09), and the day within the week (01 to 07)\nWkInMnthDay
- A monthly interval, specifying the week of the month (01 to 05)
and day within the week (01 to 07)\nIntrvlMnthDay - An interval
specified in months (between 01 to 06, 12, 24), specifying the day
within the month (-5 to -1, 1 to 31)\nQtrDay - Quarterly (either
ENGLISH, SCOTTISH, or RECEIVED). \nENGLISH = Paid on the 25th March,
24th June, 29th September and 25th December. \nSCOTTISH = Paid on
the 2nd February, 15th May, 1st August and 11th November.\nRECEIVED
= Paid on the 20th March, 19th June, 24th September and 20th December.
\nIndividual Patterns:\nEvryDay (ScheduleCode)\nEvryWorkgDay (ScheduleCode)\nIntrvlWkDay:IntervalInWeeks:DayInWeek
(ScheduleCode + IntervalInWeeks + DayInWeek)\nWkInMnthDay:WeekInMonth:DayInWeek
(ScheduleCode + WeekInMonth + DayInWeek)\nIntrvlMnthDay:IntervalInMonths:DayInMonth
(ScheduleCode + IntervalInMonths + DayInMonth)\nQtrDay: + either
(ENGLISH, SCOTTISH or RECEIVED) ScheduleCode + QuarterDay\nThe regular
expression for this element combines five smaller versions for each
permitted pattern. To aid legibility - the components are presented
individually here:\nEvryDay\nEvryWorkgDay\nIntrvlWkDay:0[1-9]:0[1-7]\nWkInMnthDay:0[1-5]:0[1-7]\nIntrvlMnthDay:(0[1-6]|12|24):(-0[1-5]|0[1-9]|[12][0-9]|3[01])\nQtrDay:(ENGLISH|SCOTTISH|RECEIVED)\nFull
Regular Expression:\n^(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))$"
type: string
pattern: ^(EvryDay)$|^(EvryWorkgDay)$|^(IntrvlDay:((0[2-9])|([1-2][0-9])|3[0-1]))$|^(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))$
Reference:
description: |-
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.
type: string
minLength: 1
maxLength: 35
NumberOfPayments:
description: Number of the payments that will be made in completing
this frequency sequence including any executed since the sequence
start date.
type: string
minLength: 1
maxLength: 35
FirstPaymentDateTime:
description: "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. \nAll date-time fields in responses
must include the timezone. An example is below:\n2017-04-05T10:43:07+00:00"
type: string
format: date-time
RecurringPaymentDateTime:
description: "The date on which the first recurring payment for a
Standing Order schedule will be made. \nUsage: 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. \nAll date-time fields in responses must include
the timezone. An example is below:\n2017-04-05T10:43:07+00:00"
type: string
format: date-time
FinalPaymentDateTime:
description: "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. \nAll date-time fields in responses
must include the timezone. An example is below:\n2017-04-05T10:43:07+00:00"
type: string
format: date-time
FirstPaymentAmount:
type: object
additionalProperties: false
required:
- Amount
- Currency
description: The amount of the first Standing Order
properties:
Amount:
$ref: '#/definitions/OBActiveCurrencyAndAmount_SimpleType'
Currency:
$ref: '#/definitions/ActiveOrHistoricCurrencyCode'
RecurringPaymentAmount:
type: object
additionalProperties: false
required:
- Amount
- Currency
description: The amount of the recurring Standing Order
properties:
Amount:
$ref: '#/definitions/OBActiveCurrencyAndAmount_SimpleType'
Currency:
$ref: '#/definitions/ActiveOrHistoricCurrencyCode'
FinalPaymentAmount:
type: object
additionalProperties: false
required:
- Amount
- Currency
description: The amount of the final Standing Order
properties:
Amount:
$ref: '#/definitions/OBActiveCurrencyAndAmount_SimpleType'
Currency:
$ref: '#/definitions/ActiveOrHistoricCurrencyCode'
DebtorAccount:
type: object
additionalProperties: false
required:
- SchemeName
- Identification
description: Provides the details to identify the debtor account.
properties:
SchemeName:
$ref: '#/definitions/OBExternalAccountIdentification4Code'
Identification:
$ref: '#/definitions/Identification_0'
Name:
description: |-
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.
type: string
minLength: 1
maxLength: 350
SecondaryIdentification:
$ref: '#/definitions/SecondaryIdentification'
CreditorAccount:
type: object
additionalProperties: false
required:
- SchemeName
- Identification
- Name
description: Identification assigned by an institution to identify
an account. This identification is known by the account owner.
properties:
SchemeName:
$ref: '#/definitions/OBExternalAccountIdentification4Code'
Identification:
$ref: '#/definitions/Identification_0'
Name:
description: |-
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.
type: string
minLength: 1
maxLength: 350
SecondaryIdentification:
$ref: '#/definitions/SecondaryIdentification'
SupplementaryData:
$ref: '#/definitions/OBSupplementaryData1'
Authorisation:
type: object
additionalProperties: false
required:
- AuthorisationType
description: The authorisation type request from the TPP.
properties:
AuthorisationType:
description: Type of authorisation flow requested.
type: string
enum:
- Any
- Single
CompletionDateTime:
description: "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. \nAll date-time fields in responses
must include the timezone. An example is below:\n2017-04-05T10:43:07+00:00"
type: string
format: date-time
SCASupportData:
type: object
additionalProperties: false
description: Supporting Data provided by TPP, when requesting SCA Exemption.
properties:
RequestedSCAExemptionType:
description: This field allows a PISP to request specific SCA Exemption
for a Payment Initiation
type: string
enum:
- BillPayment
- ContactlessTravel
- EcommerceGoods
- EcommerceServices
- Kiosk
- Parking
- PartyToParty
AppliedAuthenticationApproach:
description: |-
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
type: string
enum:
- CA
- SCA
ReferencePaymentOrderId:
description: |-
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.
type: string
minLength: 1
maxLength: 128
Risk:
$ref: '#/definitions/OBRisk1'
OBWriteDomesticStandingOrderConsentResponse6:
type: object
additionalProperties: false
required:
- Data
- Risk
properties:
Data:
type: object
additionalProperties: false
required:
- ConsentId
- CreationDateTime
- Status
- StatusUpdateDateTime
- Permission
- Initiation
properties:
ConsentId:
description: 'OB: Unique identification as assigned by the ASPSP to uniquely
identify the consent resource.'
type: string
minLength: 1
maxLength: 128
CreationDateTime:
description: "Date and time at which the resource was created.All dates
in the JSON payloads are represented in ISO 8601 date-time format. \nAll
date-time fields in responses must include the timezone. An example
is below:\n2017-04-05T10:43:07+00:00"
type: string
format: date-time
Status:
description: Specifies the status of consent resource in code form.
type: string
enum:
- Authorised
- AwaitingAuthorisation
- Consumed
- Rejected
StatusUpdateDateTime:
description: "Date and time at which the resource status was updated.All
dates in the JSON payloads are represented in ISO 8601 date-time format.
\nAll date-time fields in responses must include the timezone. An example
is below:\n2017-04-05T10:43:07+00:00"
type: string
format: date-time
Permission:
description: Specifies the Open Banking service request types.
type: string
enum:
- Create
ReadRefundAccount:
description: Specifies to share the refund account details with PISP
type: string
enum:
- "No"
- "Yes"
CutOffDateTime:
description: "Specified cut-off date and time for the payment consent.All
dates in the JSON payloads are represented in ISO 8601 date-time format.
\nAll date-time fields in responses must include the timezone. An example
is below:\n2017-04-05T10:43:07+00:00"
type: string
format: date-time
Charges:
type: array
items:
type: object
additionalProperties: false
description: Set of elements used to provide details of a charge for
the payment initiation.
required:
- ChargeBearer
- Type
- Amount
properties:
ChargeBearer:
$ref: '#/definitions/OBChargeBearerType1Code'
Type:
$ref: '#/definitions/OBExternalPaymentChargeType1Code'
Amount:
$ref: '#/definitions/OBActiveOrHistoricCurrencyAndAmount'
Initiation:
type: object
additionalProperties: false
required:
- Frequency
- FirstPaymentDateTime
- FirstPaymentAmount
- CreditorAccount
description: 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.
properties:
Frequency:
description: "Individual Definitions:\nEvryDay - Every day\nEvryWorkgDay
- Every working day\nIntrvlWkDay - An interval specified in weeks
(01 to 09), and the day within the week (01 to 07)\nWkInMnthDay
- A monthly interval, specifying the week of the month (01 to 05)
and day within the week (01 to 07)\nIntrvlMnthDay - An interval
specified in months (between 01 to 06, 12, 24), specifying the day
within the month (-5 to -1, 1 to 31)\nQtrDay - Quarterly (either
ENGLISH, SCOTTISH, or RECEIVED). \nENGLISH = Paid on the 25th March,
24th June, 29th September and 25th December. \nSCOTTISH = Paid on
the 2nd February, 15th May, 1st August and 11th November.\nRECEIVED
= Paid on the 20th March, 19th June, 24th September and 20th December.
\nIndividual Patterns:\nEvryDay (ScheduleCode)\nEvryWorkgDay (ScheduleCode)\nIntrvlWkDay:IntervalInWeeks:DayInWeek
(ScheduleCode + IntervalInWeeks + DayInWeek)\nWkInMnthDay:WeekInMonth:DayInWeek
(ScheduleCode + WeekInMonth + DayInWeek)\nIntrvlMnthDay:IntervalInMonths:DayInMonth
(ScheduleCode + IntervalInMonths + DayInMonth)\nQtrDay: + either
(ENGLISH, SCOTTISH or RECEIVED) ScheduleCode + QuarterDay\nThe regular
expression for this element combines five smaller versions for each
permitted pattern. To aid legibility - the components are presented
individually here:\nEvryDay\nEvryWorkgDay\nIntrvlWkDay:0[1-9]:0[1-7]\nWkInMnthDay:0[1-5]:0[1-7]\nIntrvlMnthDay:(0[1-6]|12|24):(-0[1-5]|0[1-9]|[12][0-9]|3[01])\nQtrDay:(ENGLISH|SCOTTISH|RECEIVED)\nFull
Regular Expression:\n^(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))$"
type: string
pattern: ^(EvryDay)$|^(EvryWorkgDay)$|^(IntrvlDay:((0[2-9])|([1-2][0-9])|3[0-1]))$|^(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))$
Reference:
description: |-
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.
type: string
minLength: 1
maxLength: 35
NumberOfPayments:
description: Number of the payments that will be made in completing
this frequency sequence including any executed since the sequence
start date.
type: string
minLength: 1
maxLength: 35
FirstPaymentDateTime:
description: "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. \nAll date-time fields in responses
must include the timezone. An example is below:\n2017-04-05T10:43:07+00:00"
type: string
format: date-time
RecurringPaymentDateTime:
description: "The date on which the first recurring payment for a
Standing Order schedule will be made. \nUsage: 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. \nAll date-time fields in responses must include
the timezone. An example is below:\n2017-04-05T10:43:07+00:00"
type: string
format: date-time
FinalPaymentDateTime:
description: "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. \nAll date-time fields in responses
must include the timezone. An example is below:\n2017-04-05T10:43:07+00:00"
type: string
format: date-time
FirstPaymentAmount:
type: object
additionalProperties: false
required:
- Amount
- Currency
description: The amount of the first Standing Order
properties:
Amount:
$ref: '#/definitions/OBActiveCurrencyAndAmount_SimpleType'
Currency:
$ref: '#/definitions/ActiveOrHistoricCurrencyCode'
RecurringPaymentAmount:
type: object
additionalProperties: false
required:
- Amount
- Currency
description: The amount of the recurring Standing Order
properties:
Amount:
$ref: '#/definitions/OBActiveCurrencyAndAmount_SimpleType'
Currency:
$ref: '#/definitions/ActiveOrHistoricCurrencyCode'
FinalPaymentAmount:
type: object
additionalProperties: false
required:
- Amount
- Currency
description: The amount of the final Standing Order
properties:
Amount:
$ref: '#/definitions/OBActiveCurrencyAndAmount_SimpleType'
Currency:
$ref: '#/definitions/ActiveOrHistoricCurrencyCode'
DebtorAccount:
type: object
additionalProperties: false
required:
- SchemeName
- Identification
description: Provides the details to identify the debtor account.
properties:
SchemeName:
$ref: '#/definitions/OBExternalAccountIdentification4Code'
Identification:
$ref: '#/definitions/Identification_0'
Name:
description: |-
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.
type: string
minLength: 1
maxLength: 350
SecondaryIdentification:
$ref: '#/definitions/SecondaryIdentification'
CreditorAccount:
type: object
additionalProperties: false
required:
- SchemeName
- Identification
- Name
description: Identification assigned by an institution to identify
an account. This identification is known by the account owner.
properties:
SchemeName:
$ref: '#/definitions/OBExternalAccountIdentification4Code'
Identification:
$ref: '#/definitions/Identification_0'
Name:
description: |-
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.
type: string
minLength: 1
maxLength: 350
SecondaryIdentification:
$ref: '#/definitions/SecondaryIdentification'
SupplementaryData:
$ref: '#/definitions/OBSupplementaryData1'
Authorisation:
type: object
additionalProperties: false
required:
- AuthorisationType
description: The authorisation type request from the TPP.
properties:
AuthorisationType:
description: Type of authorisation flow requested.
type: string
enum:
- Any
- Single
CompletionDateTime:
description: "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. \nAll date-time fields in responses
must include the timezone. An example is below:\n2017-04-05T10:43:07+00:00"
type: string
format: date-time
SCASupportData:
type: object
additionalProperties: false
description: Supporting Data provided by TPP, when requesting SCA Exemption.
properties:
RequestedSCAExemptionType:
description: This field allows a PISP to request specific SCA Exemption
for a Payment Initiation
type: string
enum:
- BillPayment
- ContactlessTravel
- EcommerceGoods
- EcommerceServices
- Kiosk
- Parking
- PartyToParty
AppliedAuthenticationApproach:
description: |-
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
type: string
enum:
- CA
- SCA
ReferencePaymentOrderId:
description: |-
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.
type: string
minLength: 1
maxLength: 128
Debtor:
$ref: '#/definitions/OBDebtorIdentification1'
Risk:
$ref: '#/definitions/OBRisk1'
Links:
$ref: '#/definitions/Links'
Meta:
$ref: '#/definitions/Meta'
OBWriteDomesticStandingOrderResponse6:
type: object
additionalProperties: false
required:
- Data
properties:
Data:
type: object
additionalProperties: false
required:
- DomesticStandingOrderId
- ConsentId
- CreationDateTime
- Status
- StatusUpdateDateTime
- Initiation
properties:
DomesticStandingOrderId:
description: 'OB: Unique identification as assigned by the ASPSP to uniquely
identify the domestic standing order resource.'
type: string
minLength: 1
maxLength: 40
ConsentId:
description: 'OB: Unique identification as assigned by the ASPSP to uniquely
identify the consent resource.'
type: string
minLength: 1
maxLength: 128
CreationDateTime:
description: "Date and time at which the resource was created.All dates
in the JSON payloads are represented in ISO 8601 date-time format. \nAll
date-time fields in responses must include the timezone. An example
is below:\n2017-04-05T10:43:07+00:00"
type: string
format: date-time
Status:
description: Specifies the status of the payment order resource.
type: string
enum:
- Cancelled
- InitiationCompleted
- InitiationFailed
- InitiationPending
StatusUpdateDateTime:
description: "Date and time at which the resource status was updated.All
dates in the JSON payloads are represented in ISO 8601 date-time format.
\nAll date-time fields in responses must include the timezone. An example
is below:\n2017-04-05T10:43:07+00:00"
type: string
format: date-time
Refund:
type: object
additionalProperties: false
required:
- Account
description: Unambiguous identification of the refund account to which
a refund will be made as a result of the transaction.
properties:
Account:
type: object
additionalProperties: false
required:
- SchemeName
- Identification
- Name
description: Provides the details to identify an account.
properties:
SchemeName:
$ref: '#/definitions/OBExternalAccountIdentification4Code'
Identification:
$ref: '#/definitions/Identification_0'
Name:
description: |-
Name of the account, as assigned by the account servicing institution.
Usage: The account name is the name or names of the account owner(s) represented at an account level. 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.
type: string
minLength: 1
maxLength: 350
SecondaryIdentification:
$ref: '#/definitions/SecondaryIdentification'
Charges:
type: array
items:
type: object
additionalProperties: false
description: Set of elements used to provide details of a charge for
the payment initiation.
required:
- ChargeBearer
- Type
- Amount
properties:
ChargeBearer:
$ref: '#/definitions/OBChargeBearerType1Code'
Type:
$ref: '#/definitions/OBExternalPaymentChargeType1Code'
Amount:
$ref: '#/definitions/OBActiveOrHistoricCurrencyAndAmount'
Initiation:
type: object
additionalProperties: false
required:
- Frequency
- FirstPaymentDateTime
- FirstPaymentAmount
- CreditorAccount
description: 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.
properties:
Frequency:
description: "Individual Definitions:\nEvryDay - Every day\nEvryWorkgDay
- Every working day\nIntrvlWkDay - An interval specified in weeks
(01 to 09), and the day within the week (01 to 07)\nWkInMnthDay
- A monthly interval, specifying the week of the month (01 to 05)
and day within the week (01 to 07)\nIntrvlMnthDay - An interval
specified in months (between 01 to 06, 12, 24), specifying the day
within the month (-5 to -1, 1 to 31)\nQtrDay - Quarterly (either
ENGLISH, SCOTTISH, or RECEIVED). \nENGLISH = Paid on the 25th March,
24th June, 29th September and 25th December. \nSCOTTISH = Paid on
the 2nd February, 15th May, 1st August and 11th November.\nRECEIVED
= Paid on the 20th March, 19th June, 24th September and 20th December.
\nIndividual Patterns:\nEvryDay (ScheduleCode)\nEvryWorkgDay (ScheduleCode)\nIntrvlWkDay:IntervalInWeeks:DayInWeek
(ScheduleCode + IntervalInWeeks + DayInWeek)\nWkInMnthDay:WeekInMonth:DayInWeek
(ScheduleCode + WeekInMonth + DayInWeek)\nIntrvlMnthDay:IntervalInMonths:DayInMonth
(ScheduleCode + IntervalInMonths + DayInMonth)\nQtrDay: + either
(ENGLISH, SCOTTISH or RECEIVED) ScheduleCode + QuarterDay\nThe regular
expression for this element combines five smaller versions for each
permitted pattern. To aid legibility - the components are presented
individually here:\nEvryDay\nEvryWorkgDay\nIntrvlWkDay:0[1-9]:0[1-7]\nWkInMnthDay:0[1-5]:0[1-7]\nIntrvlMnthDay:(0[1-6]|12|24):(-0[1-5]|0[1-9]|[12][0-9]|3[01])\nQtrDay:(ENGLISH|SCOTTISH|RECEIVED)\nFull
Regular Expression:\n^(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))$"
type: string
pattern: ^(EvryDay)$|^(EvryWorkgDay)$|^(IntrvlDay:((0[2-9])|([1-2][0-9])|3[0-1]))$|^(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))$
Reference:
description: |-
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.
type: string
minLength: 1
maxLength: 35
NumberOfPayments:
description: Number of the payments that will be made in completing
this frequency sequence including any executed since the sequence
start date.
type: string
minLength: 1
maxLength: 35
FirstPaymentDateTime:
description: "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. \nAll date-time fields in responses
must include the timezone. An example is below:\n2017-04-05T10:43:07+00:00"
type: string
format: date-time
RecurringPaymentDateTime:
description: "The date on which the first recurring payment for a
Standing Order schedule will be made. \nUsage: 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. \nAll date-time fields in responses must include
the timezone. An example is below:\n2017-04-05T10:43:07+00:00"
type: string
format: date-time
FinalPaymentDateTime:
description: "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. \nAll date-time fields in responses
must include the timezone. An example is below:\n2017-04-05T10:43:07+00:00"
type: string
format: date-time
FirstPaymentAmount:
type: object
additionalProperties: false
required:
- Amount
- Currency
description: The amount of the first Standing Order
properties:
Amount:
$ref: '#/definitions/OBActiveCurrencyAndAmount_SimpleType'
Currency:
$ref: '#/definitions/ActiveOrHistoricCurrencyCode'
RecurringPaymentAmount:
type: object
additionalProperties: false
required:
- Amount
- Currency
description: The amount of the recurring Standing Order
properties:
Amount:
$ref: '#/definitions/OBActiveCurrencyAndAmount_SimpleType'
Currency:
$ref: '#/definitions/ActiveOrHistoricCurrencyCode'
FinalPaymentAmount:
type: object
additionalProperties: false
required:
- Amount
- Currency
description: The amount of the final Standing Order
properties:
Amount:
$ref: '#/definitions/OBActiveCurrencyAndAmount_SimpleType'
Currency:
$ref: '#/definitions/ActiveOrHistoricCurrencyCode'
DebtorAccount:
type: object
additionalProperties: false
required:
- SchemeName
- Identification
description: Provides the details to identify the debtor account.
properties:
SchemeName:
$ref: '#/definitions/OBExternalAccountIdentification4Code'
Identification:
$ref: '#/definitions/Identification_0'
Name:
description: |-
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.
type: string
minLength: 1
maxLength: 350
SecondaryIdentification:
$ref: '#/definitions/SecondaryIdentification'
CreditorAccount:
type: object
additionalProperties: false
required:
- SchemeName
- Identification
- Name
description: Identification assigned by an institution to identify
an account. This identification is known by the account owner.
properties:
SchemeName:
$ref: '#/definitions/OBExternalAccountIdentification4Code'
Identification:
$ref: '#/definitions/Identification_0'
Name:
description: |-
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.
type: string
minLength: 1
maxLength: 350
SecondaryIdentification:
$ref: '#/definitions/SecondaryIdentification'
SupplementaryData:
$ref: '#/definitions/OBSupplementaryData1'
MultiAuthorisation:
type: object
additionalProperties: false
required:
- Status
description: The multiple authorisation flow response from the ASPSP.
properties:
Status:
description: Specifies the status of the authorisation flow in code
form.
type: string
enum:
- Authorised
- AwaitingFurtherAuthorisation
- Rejected
NumberRequired:
description: Number of authorisations required for payment order (total
required at the start of the multi authorisation journey).
type: integer
NumberReceived:
description: Number of authorisations received.
type: integer
LastUpdateDateTime:
description: "Last date and time at the authorisation flow was updated.All
dates in the JSON payloads are represented in ISO 8601 date-time
format. \nAll date-time fields in responses must include the timezone.
An example is below:\n2017-04-05T10:43:07+00:00"
type: string
format: date-time
ExpirationDateTime:
description: "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. \nAll date-time fields in responses
must include the timezone. An example is below:\n2017-04-05T10:43:07+00:00"
type: string
format: date-time
Debtor:
$ref: '#/definitions/OBDebtorIdentification1'
Links:
$ref: '#/definitions/Links'
Meta:
$ref: '#/definitions/Meta'
OBWriteFile2:
type: object
additionalProperties: false
required:
- Data
properties:
Data:
type: object
additionalProperties: false
required:
- ConsentId
- Initiation
properties:
ConsentId:
description: 'OB: Unique identification as assigned by the ASPSP to uniquely
identify the consent resource.'
type: string
minLength: 1
maxLength: 128
Initiation:
type: object
additionalProperties: false
required:
- FileType
- FileHash
description: The Initiation payload is sent by the initiating party to
the ASPSP. It is used to request movement of funds using a payment file.
properties:
FileType:
description: Specifies the payment file type.
type: string
x-namespaced-enum:
- UK.OBIE.PaymentInitiation.3.1
- UK.OBIE.pain.001.001.08
FileHash:
description: A base64 encoding of a SHA256 hash of the file to be
uploaded.
type: string
minLength: 1
maxLength: 44
FileReference:
description: Reference for the file.
type: string
minLength: 1
maxLength: 40
NumberOfTransactions:
description: Number of individual transactions contained in the payment
information group.
type: string
pattern: '[0-9]{1,15}'
ControlSum:
description: Total of all individual amounts included in the group,
irrespective of currencies.
type: number
RequestedExecutionDateTime:
description: "Date at which the initiating party requests the clearing
agent to process the payment. \nUsage: 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. \nAll date-time fields
in responses must include the timezone. An example is below:\n2017-04-05T10:43:07+00:00"
type: string
format: date-time
LocalInstrument:
$ref: '#/definitions/OBExternalLocalInstrument1Code'
DebtorAccount:
type: object
additionalProperties: false
required:
- SchemeName
- Identification
description: Unambiguous identification of the account of the debtor
to which a debit entry will be made as a result of the transaction.
properties:
SchemeName:
$ref: '#/definitions/OBExternalAccountIdentification4Code'
Identification:
$ref: '#/definitions/Identification_0'
Name:
description: |-
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.
type: string
minLength: 1
maxLength: 350
SecondaryIdentification:
$ref: '#/definitions/SecondaryIdentification'
RemittanceInformation:
type: object
additionalProperties: false
description: 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.
properties:
Unstructured:
description: 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.
type: string
minLength: 1
maxLength: 140
Reference:
description: |-
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.
type: string
minLength: 1
maxLength: 35
SupplementaryData:
$ref: '#/definitions/OBSupplementaryData1'
OBWriteFileConsent3:
type: object
additionalProperties: false
required:
- Data
properties:
Data:
type: object
additionalProperties: false
required:
- Initiation
properties:
Initiation:
type: object
additionalProperties: false
required:
- FileType
- FileHash
description: The Initiation payload is sent by the initiating party to
the ASPSP. It is used to request movement of funds using a payment file.
properties:
FileType:
description: Specifies the payment file type.
type: string
x-namespaced-enum:
- UK.OBIE.PaymentInitiation.3.1
- UK.OBIE.pain.001.001.08
FileHash:
description: A base64 encoding of a SHA256 hash of the file to be
uploaded.
type: string
minLength: 1
maxLength: 44
FileReference:
description: Reference for the file.
type: string
minLength: 1
maxLength: 40
NumberOfTransactions:
description: Number of individual transactions contained in the payment
information group.
type: string
pattern: '[0-9]{1,15}'
ControlSum:
description: Total of all individual amounts included in the group,
irrespective of currencies.
type: number
RequestedExecutionDateTime:
description: "Date at which the initiating party requests the clearing
agent to process the payment. \nUsage: 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. \nAll date-time fields
in responses must include the timezone. An example is below:\n2017-04-05T10:43:07+00:00"
type: string
format: date-time
LocalInstrument:
$ref: '#/definitions/OBExternalLocalInstrument1Code'
DebtorAccount:
type: object
additionalProperties: false
required:
- SchemeName
- Identification
description: Unambiguous identification of the account of the debtor
to which a debit entry will be made as a result of the transaction.
properties:
SchemeName:
$ref: '#/definitions/OBExternalAccountIdentification4Code'
Identification:
$ref: '#/definitions/Identification_0'
Name:
description: |-
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.
type: string
minLength: 1
maxLength: 350
SecondaryIdentification:
$ref: '#/definitions/SecondaryIdentification'
RemittanceInformation:
type: object
additionalProperties: false
description: 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.
properties:
Unstructured:
description: 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.
type: string
minLength: 1
maxLength: 140
Reference:
description: |-
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.
type: string
minLength: 1
maxLength: 35
SupplementaryData:
$ref: '#/definitions/OBSupplementaryData1'
Authorisation:
type: object
additionalProperties: false
required:
- AuthorisationType
description: The authorisation type request from the TPP.
properties:
AuthorisationType:
description: Type of authorisation flow requested.
type: string
enum:
- Any
- Single
CompletionDateTime:
description: "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. \nAll date-time fields in responses
must include the timezone. An example is below:\n2017-04-05T10:43:07+00:00"
type: string
format: date-time
SCASupportData:
type: object
additionalProperties: false
description: Supporting Data provided by TPP, when requesting SCA Exemption.
properties:
RequestedSCAExemptionType:
description: This field allows a PISP to request specific SCA Exemption
for a Payment Initiation
type: string
enum:
- BillPayment
- ContactlessTravel
- EcommerceGoods
- EcommerceServices
- Kiosk
- Parking
- PartyToParty
AppliedAuthenticationApproach:
description: |-
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
type: string
enum:
- CA
- SCA
ReferencePaymentOrderId:
description: |-
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.
type: string
minLength: 1
maxLength: 128
OBWriteFileConsentResponse4:
type: object
additionalProperties: false
required:
- Data
properties:
Data:
type: object
additionalProperties: false
required:
- ConsentId
- CreationDateTime
- Status
- StatusUpdateDateTime
- Initiation
properties:
ConsentId:
description: 'OB: Unique identification as assigned by the ASPSP to uniquely
identify the consent resource.'
type: string
minLength: 1
maxLength: 128
CreationDateTime:
description: "Date and time at which the resource was created.All dates
in the JSON payloads are represented in ISO 8601 date-time format. \nAll
date-time fields in responses must include the timezone. An example
is below:\n2017-04-05T10:43:07+00:00"
type: string
format: date-time
Status:
description: Specifies the status of consent resource in code form.
type: string
enum:
- Authorised
- AwaitingAuthorisation
- AwaitingUpload
- Consumed
- Rejected
StatusUpdateDateTime:
description: "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.
\nAll date-time fields in responses must include the timezone. An example
is below:\n2017-04-05T10:43:07+00:00"
type: string
format: date-time
CutOffDateTime:
description: "Specified cut-off date and time for the payment consent.All
dates in the JSON payloads are represented in ISO 8601 date-time format.
\nAll date-time fields in responses must include the timezone. An example
is below:\n2017-04-05T10:43:07+00:00"
type: string
format: date-time
Charges:
type: array
items:
type: object
additionalProperties: false
description: Set of elements used to provide details of a charge for
the payment initiation.
required:
- ChargeBearer
- Type
- Amount
properties:
ChargeBearer:
$ref: '#/definitions/OBChargeBearerType1Code'
Type:
$ref: '#/definitions/OBExternalPaymentChargeType1Code'
Amount:
$ref: '#/definitions/OBActiveOrHistoricCurrencyAndAmount'
Initiation:
type: object
additionalProperties: false
required:
- FileType
- FileHash
description: The Initiation payload is sent by the initiating party to
the ASPSP. It is used to request movement of funds using a payment file.
properties:
FileType:
description: Specifies the payment file type.
type: string
x-namespaced-enum:
- UK.OBIE.PaymentInitiation.3.1
- UK.OBIE.pain.001.001.08
FileHash:
description: A base64 encoding of a SHA256 hash of the file to be
uploaded.
type: string
minLength: 1
maxLength: 44
FileReference:
description: Reference for the file.
type: string
minLength: 1
maxLength: 40
NumberOfTransactions:
description: Number of individual transactions contained in the payment
information group.
type: string
pattern: '[0-9]{1,15}'
ControlSum:
description: Total of all individual amounts included in the group,
irrespective of currencies.
type: number
RequestedExecutionDateTime:
description: "Date at which the initiating party requests the clearing
agent to process the payment. \nUsage: 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. \nAll date-time fields
in responses must include the timezone. An example is below:\n2017-04-05T10:43:07+00:00"
type: string
format: date-time
LocalInstrument:
$ref: '#/definitions/OBExternalLocalInstrument1Code'
DebtorAccount:
type: object
additionalProperties: false
required:
- SchemeName
- Identification
description: Unambiguous identification of the account of the debtor
to which a debit entry will be made as a result of the transaction.
properties:
SchemeName:
$ref: '#/definitions/OBExternalAccountIdentification4Code'
Identification:
$ref: '#/definitions/Identification_0'
Name:
description: |-
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.
type: string
minLength: 1
maxLength: 350
SecondaryIdentification:
$ref: '#/definitions/SecondaryIdentification'
RemittanceInformation:
type: object
additionalProperties: false
description: 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.
properties:
Unstructured:
description: 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.
type: string
minLength: 1
maxLength: 140
Reference:
description: |-
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.
type: string
minLength: 1
maxLength: 35
SupplementaryData:
$ref: '#/definitions/OBSupplementaryData1'
Authorisation:
type: object
additionalProperties: false
required:
- AuthorisationType
description: The authorisation type request from the TPP.
properties:
AuthorisationType:
description: Type of authorisation flow requested.
type: string
enum:
- Any
- Single
CompletionDateTime:
description: "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. \nAll date-time fields in responses
must include the timezone. An example is below:\n2017-04-05T10:43:07+00:00"
type: string
format: date-time
SCASupportData:
type: object
additionalProperties: false
description: Supporting Data provided by TPP, when requesting SCA Exemption.
properties:
RequestedSCAExemptionType:
description: This field allows a PISP to request specific SCA Exemption
for a Payment Initiation
type: string
enum:
- BillPayment
- ContactlessTravel
- EcommerceGoods
- EcommerceServices
- Kiosk
- Parking
- PartyToParty
AppliedAuthenticationApproach:
description: |-
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
type: string
enum:
- CA
- SCA
ReferencePaymentOrderId:
description: |-
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.
type: string
minLength: 1
maxLength: 128
Debtor:
$ref: '#/definitions/OBDebtorIdentification1'
Links:
$ref: '#/definitions/Links'
Meta:
$ref: '#/definitions/Meta'
OBWriteFileResponse3:
type: object
additionalProperties: false
required:
- Data
properties:
Data:
type: object
additionalProperties: false
required:
- FilePaymentId
- ConsentId
- CreationDateTime
- Status
- StatusUpdateDateTime
- Initiation
properties:
FilePaymentId:
description: 'OB: Unique identification as assigned by the ASPSP to uniquely
identify the file payment resource.'
type: string
minLength: 1
maxLength: 40
ConsentId:
description: 'OB: Unique identification as assigned by the ASPSP to uniquely
identify the consent resource.'
type: string
minLength: 1
maxLength: 128
CreationDateTime:
description: "Date and time at which the message was created.All dates
in the JSON payloads are represented in ISO 8601 date-time format. \nAll
date-time fields in responses must include the timezone. An example
is below:\n2017-04-05T10:43:07+00:00"
type: string
format: date-time
Status:
description: Specifies the status of the payment order resource.
type: string
enum:
- InitiationCompleted
- InitiationFailed
- InitiationPending
StatusUpdateDateTime:
description: "Date and time at which the resource status was updated.All
dates in the JSON payloads are represented in ISO 8601 date-time format.
\nAll date-time fields in responses must include the timezone. An example
is below:\n2017-04-05T10:43:07+00:00"
type: string
format: date-time
Charges:
type: array
items:
type: object
additionalProperties: false
description: Set of elements used to provide details of a charge for
the payment initiation.
required:
- ChargeBearer
- Type
- Amount
properties:
ChargeBearer:
$ref: '#/definitions/OBChargeBearerType1Code'
Type:
$ref: '#/definitions/OBExternalPaymentChargeType1Code'
Amount:
$ref: '#/definitions/OBActiveOrHistoricCurrencyAndAmount'
Initiation:
type: object
additionalProperties: false
required:
- FileType
- FileHash
description: The Initiation payload is sent by the initiating party to
the ASPSP. It is used to request movement of funds using a payment file.
properties:
FileType:
description: Specifies the payment file type.
type: string
x-namespaced-enum:
- UK.OBIE.PaymentInitiation.3.1
- UK.OBIE.pain.001.001.08
FileHash:
description: A base64 encoding of a SHA256 hash of the file to be
uploaded.
type: string
minLength: 1
maxLength: 44
FileReference:
description: Reference for the file.
type: string
minLength: 1
maxLength: 40
NumberOfTransactions:
description: Number of individual transactions contained in the payment
information group.
type: string
pattern: '[0-9]{1,15}'
ControlSum:
description: Total of all individual amounts included in the group,
irrespective of currencies.
type: number
RequestedExecutionDateTime:
description: "Date at which the initiating party requests the clearing
agent to process the payment. \nUsage: 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. \nAll date-time fields
in responses must include the timezone. An example is below:\n2017-04-05T10:43:07+00:00"
type: string
format: date-time
LocalInstrument:
$ref: '#/definitions/OBExternalLocalInstrument1Code'
DebtorAccount:
type: object
additionalProperties: false
required:
- SchemeName
- Identification
description: Unambiguous identification of the account of the debtor
to which a debit entry will be made as a result of the transaction.
properties:
SchemeName:
$ref: '#/definitions/OBExternalAccountIdentification4Code'
Identification:
$ref: '#/definitions/Identification_0'
Name:
description: |-
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.
type: string
minLength: 1
maxLength: 350
SecondaryIdentification:
$ref: '#/definitions/SecondaryIdentification'
RemittanceInformation:
type: object
additionalProperties: false
description: 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.
properties:
Unstructured:
description: 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.
type: string
minLength: 1
maxLength: 140
Reference:
description: |-
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.
type: string
minLength: 1
maxLength: 35
SupplementaryData:
$ref: '#/definitions/OBSupplementaryData1'
MultiAuthorisation:
type: object
additionalProperties: false
required:
- Status
description: The multiple authorisation flow response from the ASPSP.
properties:
Status:
description: Specifies the status of the authorisation flow in code
form.
type: string
enum:
- Authorised
- AwaitingFurtherAuthorisation
- Rejected
NumberRequired:
description: Number of authorisations required for payment order (total
required at the start of the multi authorisation journey).
type: integer
NumberReceived:
description: Number of authorisations received.
type: integer
LastUpdateDateTime:
description: "Last date and time at the authorisation flow was updated.All
dates in the JSON payloads are represented in ISO 8601 date-time
format. \nAll date-time fields in responses must include the timezone.
An example is below:\n2017-04-05T10:43:07+00:00"
type: string
format: date-time
ExpirationDateTime:
description: "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. \nAll date-time fields in responses
must include the timezone. An example is below:\n2017-04-05T10:43:07+00:00"
type: string
format: date-time
Debtor:
$ref: '#/definitions/OBDebtorIdentification1'
Links:
$ref: '#/definitions/Links'
Meta:
$ref: '#/definitions/Meta'
OBWriteFundsConfirmationResponse1:
type: object
additionalProperties: false
required:
- Data
properties:
Data:
type: object
additionalProperties: false
properties:
FundsAvailableResult:
type: object
additionalProperties: false
required:
- FundsAvailableDateTime
- FundsAvailable
description: Result of a funds availability check.
properties:
FundsAvailableDateTime:
description: "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. \nAll date-time fields in responses must
include the timezone. An example is below:\n2017-04-05T10:43:07+00:00"
type: string
format: date-time
FundsAvailable:
description: Flag to indicate the availability of funds given the
Amount in the consent request.
type: boolean
SupplementaryData:
$ref: '#/definitions/OBSupplementaryData1'
Links:
$ref: '#/definitions/Links'
Meta:
$ref: '#/definitions/Meta'
OBWriteInternational3:
type: object
additionalProperties: false
required:
- Data
- Risk
properties:
Data:
type: object
additionalProperties: false
required:
- ConsentId
- Initiation
properties:
ConsentId:
description: 'OB: Unique identification as assigned by the ASPSP to uniquely
identify the consent resource.'
type: string
minLength: 1
maxLength: 128
Initiation:
type: object
additionalProperties: false
required:
- InstructionIdentification
- EndToEndIdentification
- CurrencyOfTransfer
- InstructedAmount
- CreditorAccount
description: 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.
properties:
InstructionIdentification:
description: |-
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.
type: string
minLength: 1
maxLength: 35
EndToEndIdentification:
description: |-
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.
type: string
minLength: 1
maxLength: 35
LocalInstrument:
$ref: '#/definitions/OBExternalLocalInstrument1Code'
InstructionPriority:
description: 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.
type: string
enum:
- Normal
- Urgent
Purpose:
description: |-
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.
type: string
minLength: 1
maxLength: 4
ExtendedPurpose:
description: Specifies the purpose of an international payment, when
there is no corresponding 4 character code available in the ISO20022
list of Purpose Codes.
type: string
minLength: 1
maxLength: 140
ChargeBearer:
$ref: '#/definitions/OBChargeBearerType1Code'
CurrencyOfTransfer:
description: Specifies the currency of the to be transferred amount,
which is different from the currency of the debtor's account.
type: string
pattern: ^[A-Z]{3,3}$
DestinationCountryCode:
description: Country in which Credit Account is domiciled. Code to
identify a country, a dependency, or another area of particular
geopolitical interest, on the basis of country names obtained from
the United Nations (ISO 3166, Alpha-2 code).
type: string
pattern: '[A-Z]{2,2}'
InstructedAmount:
type: object
additionalProperties: false
required:
- Amount
- Currency
description: |-
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.
properties:
Amount:
$ref: '#/definitions/OBActiveCurrencyAndAmount_SimpleType'
Currency:
$ref: '#/definitions/ActiveOrHistoricCurrencyCode'
ExchangeRateInformation:
type: object
additionalProperties: false
required:
- UnitCurrency
- RateType
description: Provides details on the currency exchange rate and contract.
properties:
UnitCurrency:
description: Currency in which the rate of exchange is expressed
in a currency exchange. In the example 1GBP = xxxCUR, the unit
currency is GBP.
type: string
pattern: ^[A-Z]{3,3}$
ExchangeRate:
description: 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.
type: number
RateType:
description: Specifies the type used to complete the currency
exchange.
type: string
enum:
- Actual
- Agreed
- Indicative
ContractIdentification:
description: Unique and unambiguous reference to the foreign exchange
contract agreed between the initiating party/creditor and the
debtor agent.
type: string
minLength: 1
maxLength: 256
DebtorAccount:
type: object
additionalProperties: false
required:
- SchemeName
- Identification
description: Unambiguous identification of the account of the debtor
to which a debit entry will be made as a result of the transaction.
properties:
SchemeName:
$ref: '#/definitions/OBExternalAccountIdentification4Code'
Identification:
$ref: '#/definitions/Identification_0'
Name:
description: |-
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.
type: string
minLength: 1
maxLength: 350
SecondaryIdentification:
$ref: '#/definitions/SecondaryIdentification'
Creditor:
type: object
additionalProperties: false
description: Party to which an amount of money is due.
properties:
Name:
description: Name by which a party is known and which is usually
used to identify that party.
type: string
minLength: 1
maxLength: 140
PostalAddress:
$ref: '#/definitions/OBPostalAddress6'
CreditorAgent:
type: object
additionalProperties: false
description: Financial institution servicing an account for the creditor.
properties:
SchemeName:
$ref: '#/definitions/OBExternalFinancialInstitutionIdentification4Code'
Identification:
$ref: '#/definitions/Identification_1'
Name:
$ref: '#/definitions/Name'
PostalAddress:
$ref: '#/definitions/OBPostalAddress6'
CreditorAccount:
type: object
additionalProperties: false
required:
- SchemeName
- Identification
- Name
description: Unambiguous identification of the account of the creditor
to which a credit entry will be posted as a result of the payment
transaction.
properties:
SchemeName:
$ref: '#/definitions/OBExternalAccountIdentification4Code'
Identification:
$ref: '#/definitions/Identification_0'
Name:
description: |-
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.
type: string
minLength: 1
maxLength: 350
SecondaryIdentification:
$ref: '#/definitions/SecondaryIdentification'
RemittanceInformation:
type: object
additionalProperties: false
description: 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.
properties:
Unstructured:
description: 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.
type: string
minLength: 1
maxLength: 140
Reference:
description: |-
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.
type: string
minLength: 1
maxLength: 35
SupplementaryData:
$ref: '#/definitions/OBSupplementaryData1'
Risk:
$ref: '#/definitions/OBRisk1'
OBWriteInternationalConsent5:
type: object
additionalProperties: false
required:
- Data
- Risk
properties:
Data:
type: object
additionalProperties: false
required:
- Initiation
properties:
ReadRefundAccount:
description: Specifies to share the refund account details with PISP
type: string
enum:
- "No"
- "Yes"
Initiation:
type: object
additionalProperties: false
required:
- InstructionIdentification
- EndToEndIdentification
- CurrencyOfTransfer
- InstructedAmount
- CreditorAccount
description: 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.
properties:
InstructionIdentification:
description: |-
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.
type: string
minLength: 1
maxLength: 35
EndToEndIdentification:
description: |-
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.
type: string
minLength: 1
maxLength: 35
LocalInstrument:
$ref: '#/definitions/OBExternalLocalInstrument1Code'
InstructionPriority:
description: 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.
type: string
enum:
- Normal
- Urgent
Purpose:
description: |-
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.
type: string
minLength: 1
maxLength: 4
ExtendedPurpose:
description: Specifies the purpose of an international payment, when
there is no corresponding 4 character code available in the ISO20022
list of Purpose Codes.
type: string
minLength: 1
maxLength: 140
ChargeBearer:
$ref: '#/definitions/OBChargeBearerType1Code'
CurrencyOfTransfer:
description: Specifies the currency of the to be transferred amount,
which is different from the currency of the debtor's account.
type: string
pattern: ^[A-Z]{3,3}$
DestinationCountryCode:
description: Country in which Credit Account is domiciled. Code to
identify a country, a dependency, or another area of particular
geopolitical interest, on the basis of country names obtained from
the United Nations (ISO 3166, Alpha-2 code).
type: string
pattern: '[A-Z]{2,2}'
InstructedAmount:
type: object
additionalProperties: false
required:
- Amount
- Currency
description: |-
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.
properties:
Amount:
$ref: '#/definitions/OBActiveCurrencyAndAmount_SimpleType'
Currency:
$ref: '#/definitions/ActiveOrHistoricCurrencyCode'
ExchangeRateInformation:
type: object
additionalProperties: false
required:
- UnitCurrency
- RateType
description: Provides details on the currency exchange rate and contract.
properties:
UnitCurrency:
description: Currency in which the rate of exchange is expressed
in a currency exchange. In the example 1GBP = xxxCUR, the unit
currency is GBP.
type: string
pattern: ^[A-Z]{3,3}$
ExchangeRate:
description: 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.
type: number
RateType:
description: Specifies the type used to complete the currency
exchange.
type: string
enum:
- Actual
- Agreed
- Indicative
ContractIdentification:
description: Unique and unambiguous reference to the foreign exchange
contract agreed between the initiating party/creditor and the
debtor agent.
type: string
minLength: 1
maxLength: 256
DebtorAccount:
type: object
additionalProperties: false
required:
- SchemeName
- Identification
description: Unambiguous identification of the account of the debtor
to which a debit entry will be made as a result of the transaction.
properties:
SchemeName:
$ref: '#/definitions/OBExternalAccountIdentification4Code'
Identification:
$ref: '#/definitions/Identification_0'
Name:
description: |-
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.
type: string
minLength: 1
maxLength: 350
SecondaryIdentification:
$ref: '#/definitions/SecondaryIdentification'
Creditor:
type: object
additionalProperties: false
description: Party to which an amount of money is due.
properties:
Name:
description: Name by which a party is known and which is usually
used to identify that party.
type: string
minLength: 1
maxLength: 140
PostalAddress:
$ref: '#/definitions/OBPostalAddress6'
CreditorAgent:
type: object
additionalProperties: false
description: Financial institution servicing an account for the creditor.
properties:
SchemeName:
$ref: '#/definitions/OBExternalFinancialInstitutionIdentification4Code'
Identification:
$ref: '#/definitions/Identification_1'
Name:
$ref: '#/definitions/Name'
PostalAddress:
$ref: '#/definitions/OBPostalAddress6'
CreditorAccount:
type: object
additionalProperties: false
required:
- SchemeName
- Identification
- Name
description: Unambiguous identification of the account of the creditor
to which a credit entry will be posted as a result of the payment
transaction.
properties:
SchemeName:
$ref: '#/definitions/OBExternalAccountIdentification4Code'
Identification:
$ref: '#/definitions/Identification_0'
Name:
description: |-
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.
type: string
minLength: 1
maxLength: 350
SecondaryIdentification:
$ref: '#/definitions/SecondaryIdentification'
RemittanceInformation:
type: object
additionalProperties: false
description: 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.
properties:
Unstructured:
description: 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.
type: string
minLength: 1
maxLength: 140
Reference:
description: |-
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.
type: string
minLength: 1
maxLength: 35
SupplementaryData:
$ref: '#/definitions/OBSupplementaryData1'
Authorisation:
type: object
additionalProperties: false
required:
- AuthorisationType
description: The authorisation type request from the TPP.
properties:
AuthorisationType:
description: Type of authorisation flow requested.
type: string
enum:
- Any
- Single
CompletionDateTime:
description: "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. \nAll date-time fields in responses
must include the timezone. An example is below:\n2017-04-05T10:43:07+00:00"
type: string
format: date-time
SCASupportData:
type: object
additionalProperties: false
description: Supporting Data provided by TPP, when requesting SCA Exemption.
properties:
RequestedSCAExemptionType:
description: This field allows a PISP to request specific SCA Exemption
for a Payment Initiation
type: string
enum:
- BillPayment
- ContactlessTravel
- EcommerceGoods
- EcommerceServices
- Kiosk
- Parking
- PartyToParty
AppliedAuthenticationApproach:
description: |-
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
type: string
enum:
- CA
- SCA
ReferencePaymentOrderId:
description: |-
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.
type: string
minLength: 1
maxLength: 128
Risk:
$ref: '#/definitions/OBRisk1'
OBWriteInternationalConsentResponse6:
type: object
additionalProperties: false
required:
- Data
- Risk
properties:
Data:
type: object
additionalProperties: false
required:
- ConsentId
- CreationDateTime
- Status
- StatusUpdateDateTime
- Initiation
properties:
ConsentId:
description: 'OB: Unique identification as assigned by the ASPSP to uniquely
identify the consent resource.'
type: string
minLength: 1
maxLength: 128
CreationDateTime:
description: "Date and time at which the resource was created.All dates
in the JSON payloads are represented in ISO 8601 date-time format. \nAll
date-time fields in responses must include the timezone. An example
is below:\n2017-04-05T10:43:07+00:00"
type: string
format: date-time
Status:
description: Specifies the status of consent resource in code form.
type: string
enum:
- Authorised
- AwaitingAuthorisation
- Consumed
- Rejected
StatusUpdateDateTime:
description: "Date and time at which the resource status was updated.All
dates in the JSON payloads are represented in ISO 8601 date-time format.
\nAll date-time fields in responses must include the timezone. An example
is below:\n2017-04-05T10:43:07+00:00"
type: string
format: date-time
ReadRefundAccount:
description: Specifies to share the refund account details with PISP
type: string
enum:
- "No"
- "Yes"
CutOffDateTime:
description: "Specified cut-off date and time for the payment consent.All
dates in the JSON payloads are represented in ISO 8601 date-time format.
\nAll date-time fields in responses must include the timezone. An example
is below:\n2017-04-05T10:43:07+00:00"
type: string
format: date-time
ExpectedExecutionDateTime:
description: "Expected execution date and time for the payment resource.All
dates in the JSON payloads are represented in ISO 8601 date-time format.
\nAll date-time fields in responses must include the timezone. An example
is below:\n2017-04-05T10:43:07+00:00"
type: string
format: date-time
ExpectedSettlementDateTime:
description: "Expected settlement date and time for the payment resource.All
dates in the JSON payloads are represented in ISO 8601 date-time format.
\nAll date-time fields in responses must include the timezone. An example
is below:\n2017-04-05T10:43:07+00:00"
type: string
format: date-time
Charges:
type: array
items:
type: object
additionalProperties: false
description: Set of elements used to provide details of a charge for
the payment initiation.
required:
- ChargeBearer
- Type
- Amount
properties:
ChargeBearer:
$ref: '#/definitions/OBChargeBearerType1Code'
Type:
$ref: '#/definitions/OBExternalPaymentChargeType1Code'
Amount:
$ref: '#/definitions/OBActiveOrHistoricCurrencyAndAmount'
ExchangeRateInformation:
type: object
additionalProperties: false
required:
- UnitCurrency
- ExchangeRate
- RateType
description: Further detailed information on the exchange rate that has
been used in the payment transaction.
properties:
UnitCurrency:
description: Currency in which the rate of exchange is expressed in
a currency exchange. In the example 1GBP = xxxCUR, the unit currency
is GBP.
type: string
pattern: ^[A-Z]{3,3}$
ExchangeRate:
description: 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.
type: number
RateType:
description: Specifies the type used to complete the currency exchange.
type: string
enum:
- Actual
- Agreed
- Indicative
ContractIdentification:
description: Unique and unambiguous reference to the foreign exchange
contract agreed between the initiating party/creditor and the debtor
agent.
type: string
minLength: 1
maxLength: 256
ExpirationDateTime:
description: "Specified date and time the exchange rate agreement
will expire.All dates in the JSON payloads are represented in ISO
8601 date-time format. \nAll date-time fields in responses must
include the timezone. An example is below:\n2017-04-05T10:43:07+00:00"
type: string
format: date-time
Initiation:
type: object
additionalProperties: false
required:
- InstructionIdentification
- EndToEndIdentification
- CurrencyOfTransfer
- InstructedAmount
- CreditorAccount
description: 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.
properties:
InstructionIdentification:
description: |-
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.
type: string
minLength: 1
maxLength: 35
EndToEndIdentification:
description: |-
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.
type: string
minLength: 1
maxLength: 35
LocalInstrument:
$ref: '#/definitions/OBExternalLocalInstrument1Code'
InstructionPriority:
description: 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.
type: string
enum:
- Normal
- Urgent
Purpose:
description: |-
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.
type: string
minLength: 1
maxLength: 4
ExtendedPurpose:
description: Specifies the purpose of an international payment, when
there is no corresponding 4 character code available in the ISO20022
list of Purpose Codes.
type: string
minLength: 1
maxLength: 140
ChargeBearer:
$ref: '#/definitions/OBChargeBearerType1Code'
CurrencyOfTransfer:
description: Specifies the currency of the to be transferred amount,
which is different from the currency of the debtor's account.
type: string
pattern: ^[A-Z]{3,3}$
DestinationCountryCode:
description: Country in which Credit Account is domiciled. Code to
identify a country, a dependency, or another area of particular
geopolitical interest, on the basis of country names obtained from
the United Nations (ISO 3166, Alpha-2 code).
type: string
pattern: '[A-Z]{2,2}'
InstructedAmount:
type: object
additionalProperties: false
required:
- Amount
- Currency
description: |-
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.
properties:
Amount:
$ref: '#/definitions/OBActiveCurrencyAndAmount_SimpleType'
Currency:
$ref: '#/definitions/ActiveOrHistoricCurrencyCode'
ExchangeRateInformation:
type: object
additionalProperties: false
required:
- UnitCurrency
- RateType
description: Provides details on the currency exchange rate and contract.
properties:
UnitCurrency:
description: Currency in which the rate of exchange is expressed
in a currency exchange. In the example 1GBP = xxxCUR, the unit
currency is GBP.
type: string
pattern: ^[A-Z]{3,3}$
ExchangeRate:
description: 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.
type: number
RateType:
description: Specifies the type used to complete the currency
exchange.
type: string
enum:
- Actual
- Agreed
- Indicative
ContractIdentification:
description: Unique and unambiguous reference to the foreign exchange
contract agreed between the initiating party/creditor and the
debtor agent.
type: string
minLength: 1
maxLength: 256
DebtorAccount:
type: object
additionalProperties: false
required:
- SchemeName
- Identification
description: Unambiguous identification of the account of the debtor
to which a debit entry will be made as a result of the transaction.
properties:
SchemeName:
$ref: '#/definitions/OBExternalAccountIdentification4Code'
Identification:
$ref: '#/definitions/Identification_0'
Name:
description: |-
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.
type: string
minLength: 1
maxLength: 350
SecondaryIdentification:
$ref: '#/definitions/SecondaryIdentification'
Creditor:
type: object
additionalProperties: false
description: Party to which an amount of money is due.
properties:
Name:
description: Name by which a party is known and which is usually
used to identify that party.
type: string
minLength: 1
maxLength: 140
PostalAddress:
$ref: '#/definitions/OBPostalAddress6'
CreditorAgent:
type: object
additionalProperties: false
description: Financial institution servicing an account for the creditor.
properties:
SchemeName:
$ref: '#/definitions/OBExternalFinancialInstitutionIdentification4Code'
Identification:
$ref: '#/definitions/Identification_1'
Name:
$ref: '#/definitions/Name'
PostalAddress:
$ref: '#/definitions/OBPostalAddress6'
CreditorAccount:
type: object
additionalProperties: false
required:
- SchemeName
- Identification
- Name
description: Unambiguous identification of the account of the creditor
to which a credit entry will be posted as a result of the payment
transaction.
properties:
SchemeName:
$ref: '#/definitions/OBExternalAccountIdentification4Code'
Identification:
$ref: '#/definitions/Identification_0'
Name:
description: |-
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.
type: string
minLength: 1
maxLength: 350
SecondaryIdentification:
$ref: '#/definitions/SecondaryIdentification'
RemittanceInformation:
type: object
additionalProperties: false
description: 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.
properties:
Unstructured:
description: 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.
type: string
minLength: 1
maxLength: 140
Reference:
description: |-
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.
type: string
minLength: 1
maxLength: 35
SupplementaryData:
$ref: '#/definitions/OBSupplementaryData1'
Authorisation:
type: object
additionalProperties: false
required:
- AuthorisationType
description: The authorisation type request from the TPP.
properties:
AuthorisationType:
description: Type of authorisation flow requested.
type: string
enum:
- Any
- Single
CompletionDateTime:
description: "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. \nAll date-time fields in responses
must include the timezone. An example is below:\n2017-04-05T10:43:07+00:00"
type: string
format: date-time
SCASupportData:
type: object
additionalProperties: false
description: Supporting Data provided by TPP, when requesting SCA Exemption.
properties:
RequestedSCAExemptionType:
description: This field allows a PISP to request specific SCA Exemption
for a Payment Initiation
type: string
enum:
- BillPayment
- ContactlessTravel
- EcommerceGoods
- EcommerceServices
- Kiosk
- Parking
- PartyToParty
AppliedAuthenticationApproach:
description: |-
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
type: string
enum:
- CA
- SCA
ReferencePaymentOrderId:
description: |-
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.
type: string
minLength: 1
maxLength: 128
Debtor:
$ref: '#/definitions/OBDebtorIdentification1'
Risk:
$ref: '#/definitions/OBRisk1'
Links:
$ref: '#/definitions/Links'
Meta:
$ref: '#/definitions/Meta'
OBWriteInternationalResponse5:
type: object
additionalProperties: false
required:
- Data
properties:
Data:
type: object
additionalProperties: false
required:
- InternationalPaymentId
- ConsentId
- CreationDateTime
- Status
- StatusUpdateDateTime
- Initiation
properties:
InternationalPaymentId:
description: 'OB: Unique identification as assigned by the ASPSP to uniquely
identify the international payment resource.'
type: string
minLength: 1
maxLength: 40
ConsentId:
description: 'OB: Unique identification as assigned by the ASPSP to uniquely
identify the consent resource.'
type: string
minLength: 1
maxLength: 128
CreationDateTime:
description: "Date and time at which the message was created.All dates
in the JSON payloads are represented in ISO 8601 date-time format. \nAll
date-time fields in responses must include the timezone. An example
is below:\n2017-04-05T10:43:07+00:00"
type: string
format: date-time
Status:
description: Specifies the status of the payment information group.
type: string
enum:
- AcceptedCreditSettlementCompleted
- AcceptedSettlementCompleted
- AcceptedSettlementInProcess
- AcceptedWithoutPosting
- Pending
- Rejected
StatusUpdateDateTime:
description: "Date and time at which the resource status was updated.All
dates in the JSON payloads are represented in ISO 8601 date-time format.
\nAll date-time fields in responses must include the timezone. An example
is below:\n2017-04-05T10:43:07+00:00"
type: string
format: date-time
ExpectedExecutionDateTime:
description: "Expected execution date and time for the payment resource.All
dates in the JSON payloads are represented in ISO 8601 date-time format.
\nAll date-time fields in responses must include the timezone. An example
is below:\n2017-04-05T10:43:07+00:00"
type: string
format: date-time
ExpectedSettlementDateTime:
description: "Expected settlement date and time for the payment resource.All
dates in the JSON payloads are represented in ISO 8601 date-time format.
\nAll date-time fields in responses must include the timezone. An example
is below:\n2017-04-05T10:43:07+00:00"
type: string
format: date-time
Refund:
type: object
additionalProperties: false
required:
- Account
properties:
Creditor:
type: object
additionalProperties: false
description: Set of elements used to identify a person or an organisation.
properties:
Name:
description: Name by which a party is known and which is usually
used to identify that party.
type: string
minLength: 1
maxLength: 140
PostalAddress:
$ref: '#/definitions/OBPostalAddress6'
Agent:
type: object
additionalProperties: false
description: Set of elements used to uniquely and unambiguously identify
a financial institution or a branch of a financial institution.
properties:
SchemeName:
$ref: '#/definitions/OBExternalFinancialInstitutionIdentification4Code'
Identification:
$ref: '#/definitions/Identification_1'
Name:
$ref: '#/definitions/Name'
PostalAddress:
$ref: '#/definitions/OBPostalAddress6'
Account:
type: object
additionalProperties: false
required:
- SchemeName
- Identification
- Name
description: Provides the details to identify an account.
properties:
SchemeName:
$ref: '#/definitions/OBExternalAccountIdentification4Code'
Identification:
$ref: '#/definitions/Identification_0'
Name:
description: |-
Name of the account, as assigned by the account servicing institution.
Usage: The account name is the name or names of the account owner(s) represented at an account level. 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.
type: string
minLength: 1
maxLength: 350
SecondaryIdentification:
$ref: '#/definitions/SecondaryIdentification'
Charges:
type: array
items:
type: object
additionalProperties: false
description: Set of elements used to provide details of a charge for
the payment initiation.
required:
- ChargeBearer
- Type
- Amount
properties:
ChargeBearer:
$ref: '#/definitions/OBChargeBearerType1Code'
Type:
$ref: '#/definitions/OBExternalPaymentChargeType1Code'
Amount:
$ref: '#/definitions/OBActiveOrHistoricCurrencyAndAmount'
ExchangeRateInformation:
type: object
additionalProperties: false
required:
- UnitCurrency
- ExchangeRate
- RateType
description: Further detailed information on the exchange rate that has
been used in the payment transaction.
properties:
UnitCurrency:
description: Currency in which the rate of exchange is expressed in
a currency exchange. In the example 1GBP = xxxCUR, the unit currency
is GBP.
type: string
pattern: ^[A-Z]{3,3}$
ExchangeRate:
description: 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.
type: number
RateType:
description: Specifies the type used to complete the currency exchange.
type: string
enum:
- Actual
- Agreed
- Indicative
ContractIdentification:
description: Unique and unambiguous reference to the foreign exchange
contract agreed between the initiating party/creditor and the debtor
agent.
type: string
minLength: 1
maxLength: 256
ExpirationDateTime:
description: "Specified date and time the exchange rate agreement
will expire.All dates in the JSON payloads are represented in ISO
8601 date-time format. \nAll date-time fields in responses must
include the timezone. An example is below:\n2017-04-05T10:43:07+00:00"
type: string
format: date-time
Initiation:
type: object
additionalProperties: false
required:
- InstructionIdentification
- EndToEndIdentification
- CurrencyOfTransfer
- InstructedAmount
- CreditorAccount
description: 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.
properties:
InstructionIdentification:
description: |-
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.
type: string
minLength: 1
maxLength: 35
EndToEndIdentification:
description: |-
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.
type: string
minLength: 1
maxLength: 35
LocalInstrument:
$ref: '#/definitions/OBExternalLocalInstrument1Code'
InstructionPriority:
description: 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.
type: string
enum:
- Normal
- Urgent
Purpose:
description: |-
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.
type: string
minLength: 1
maxLength: 4
ExtendedPurpose:
description: Specifies the purpose of an international payment, when
there is no corresponding 4 character code available in the ISO20022
list of Purpose Codes.
type: string
minLength: 1
maxLength: 140
ChargeBearer:
$ref: '#/definitions/OBChargeBearerType1Code'
CurrencyOfTransfer:
description: Specifies the currency of the to be transferred amount,
which is different from the currency of the debtor's account.
type: string
pattern: ^[A-Z]{3,3}$
DestinationCountryCode:
description: Country in which Credit Account is domiciled. Code to
identify a country, a dependency, or another area of particular
geopolitical interest, on the basis of country names obtained from
the United Nations (ISO 3166, Alpha-2 code).
type: string
pattern: '[A-Z]{2,2}'
InstructedAmount:
type: object
additionalProperties: false
required:
- Amount
- Currency
description: |-
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.
properties:
Amount:
$ref: '#/definitions/OBActiveCurrencyAndAmount_SimpleType'
Currency:
$ref: '#/definitions/ActiveOrHistoricCurrencyCode'
ExchangeRateInformation:
type: object
additionalProperties: false
required:
- UnitCurrency
- RateType
description: Provides details on the currency exchange rate and contract.
properties:
UnitCurrency:
description: Currency in which the rate of exchange is expressed
in a currency exchange. In the example 1GBP = xxxCUR, the unit
currency is GBP.
type: string
pattern: ^[A-Z]{3,3}$
ExchangeRate:
description: 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.
type: number
RateType:
description: Specifies the type used to complete the currency
exchange.
type: string
enum:
- Actual
- Agreed
- Indicative
ContractIdentification:
description: Unique and unambiguous reference to the foreign exchange
contract agreed between the initiating party/creditor and the
debtor agent.
type: string
minLength: 1
maxLength: 256
DebtorAccount:
type: object
additionalProperties: false
required:
- SchemeName
- Identification
description: Unambiguous identification of the account of the debtor
to which a debit entry will be made as a result of the transaction.
properties:
SchemeName:
$ref: '#/definitions/OBExternalAccountIdentification4Code'
Identification:
$ref: '#/definitions/Identification_0'
Name:
description: |-
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.
type: string
minLength: 1
maxLength: 350
SecondaryIdentification:
$ref: '#/definitions/SecondaryIdentification'
Creditor:
type: object
additionalProperties: false
description: Party to which an amount of money is due.
properties:
Name:
description: Name by which a party is known and which is usually
used to identify that party.
type: string
minLength: 1
maxLength: 140
PostalAddress:
$ref: '#/definitions/OBPostalAddress6'
CreditorAgent:
type: object
additionalProperties: false
description: Financial institution servicing an account for the creditor.
properties:
SchemeName:
$ref: '#/definitions/OBExternalFinancialInstitutionIdentification4Code'
Identification:
$ref: '#/definitions/Identification_1'
Name:
$ref: '#/definitions/Name'
PostalAddress:
$ref: '#/definitions/OBPostalAddress6'
CreditorAccount:
type: object
additionalProperties: false
required:
- SchemeName
- Identification
- Name
description: Unambiguous identification of the account of the creditor
to which a credit entry will be posted as a result of the payment
transaction.
properties:
SchemeName:
$ref: '#/definitions/OBExternalAccountIdentification4Code'
Identification:
$ref: '#/definitions/Identification_0'
Name:
description: |-
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.
type: string
minLength: 1
maxLength: 350
SecondaryIdentification:
$ref: '#/definitions/SecondaryIdentification'
RemittanceInformation:
type: object
additionalProperties: false
description: 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.
properties:
Unstructured:
description: 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.
type: string
minLength: 1
maxLength: 140
Reference:
description: |-
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.
type: string
minLength: 1
maxLength: 35
SupplementaryData:
$ref: '#/definitions/OBSupplementaryData1'
MultiAuthorisation:
type: object
additionalProperties: false
required:
- Status
description: The multiple authorisation flow response from the ASPSP.
properties:
Status:
description: Specifies the status of the authorisation flow in code
form.
type: string
enum:
- Authorised
- AwaitingFurtherAuthorisation
- Rejected
NumberRequired:
description: Number of authorisations required for payment order (total
required at the start of the multi authorisation journey).
type: integer
NumberReceived:
description: Number of authorisations received.
type: integer
LastUpdateDateTime:
description: "Last date and time at the authorisation flow was updated.All
dates in the JSON payloads are represented in ISO 8601 date-time
format. \nAll date-time fields in responses must include the timezone.
An example is below:\n2017-04-05T10:43:07+00:00"
type: string
format: date-time
ExpirationDateTime:
description: "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. \nAll date-time fields in responses
must include the timezone. An example is below:\n2017-04-05T10:43:07+00:00"
type: string
format: date-time
Debtor:
$ref: '#/definitions/OBDebtorIdentification1'
Links:
$ref: '#/definitions/Links'
Meta:
$ref: '#/definitions/Meta'
OBWriteInternationalScheduled3:
type: object
additionalProperties: false
required:
- Data
- Risk
properties:
Data:
type: object
additionalProperties: false
required:
- ConsentId
- Initiation
properties:
ConsentId:
description: 'OB: Unique identification as assigned by the ASPSP to uniquely
identify the consent resource.'
type: string
minLength: 1
maxLength: 128
Initiation:
type: object
additionalProperties: false
required:
- InstructionIdentification
- RequestedExecutionDateTime
- CurrencyOfTransfer
- InstructedAmount
- CreditorAccount
description: 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.
properties:
InstructionIdentification:
description: |-
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.
type: string
minLength: 1
maxLength: 35
EndToEndIdentification:
description: |-
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.
type: string
minLength: 1
maxLength: 35
LocalInstrument:
$ref: '#/definitions/OBExternalLocalInstrument1Code'
InstructionPriority:
description: 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.
type: string
enum:
- Normal
- Urgent
Purpose:
description: |-
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.
type: string
minLength: 1
maxLength: 4
ExtendedPurpose:
description: Specifies the purpose of an international payment, when
there is no corresponding 4 character code available in the ISO20022
list of Purpose Codes.
type: string
minLength: 1
maxLength: 140
ChargeBearer:
$ref: '#/definitions/OBChargeBearerType1Code'
RequestedExecutionDateTime:
description: "Date at which the initiating party requests the clearing
agent to process the payment. \nUsage: 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. \nAll date-time fields
in responses must include the timezone. An example is below:\n2017-04-05T10:43:07+00:00"
type: string
format: date-time
CurrencyOfTransfer:
description: Specifies the currency of the to be transferred amount,
which is different from the currency of the debtor's account.
type: string
pattern: ^[A-Z]{3,3}$
DestinationCountryCode:
description: Country in which Credit Account is domiciled. Code to
identify a country, a dependency, or another area of particular
geopolitical interest, on the basis of country names obtained from
the United Nations (ISO 3166, Alpha-2 code).
type: string
pattern: '[A-Z]{2,2}'
InstructedAmount:
type: object
additionalProperties: false
required:
- Amount
- Currency
description: |-
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.
properties:
Amount:
$ref: '#/definitions/OBActiveCurrencyAndAmount_SimpleType'
Currency:
$ref: '#/definitions/ActiveOrHistoricCurrencyCode'
ExchangeRateInformation:
type: object
additionalProperties: false
required:
- UnitCurrency
- RateType
description: Provides details on the currency exchange rate and contract.
properties:
UnitCurrency:
description: Currency in which the rate of exchange is expressed
in a currency exchange. In the example 1GBP = xxxCUR, the unit
currency is GBP.
type: string
pattern: ^[A-Z]{3,3}$
ExchangeRate:
description: 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.
type: number
RateType:
description: Specifies the type used to complete the currency
exchange.
type: string
enum:
- Actual
- Agreed
- Indicative
ContractIdentification:
description: Unique and unambiguous reference to the foreign exchange
contract agreed between the initiating party/creditor and the
debtor agent.
type: string
minLength: 1
maxLength: 256
DebtorAccount:
type: object
additionalProperties: false
required:
- SchemeName
- Identification
description: Unambiguous identification of the account of the debtor
to which a debit entry will be made as a result of the transaction.
properties:
SchemeName:
$ref: '#/definitions/OBExternalAccountIdentification4Code'
Identification:
$ref: '#/definitions/Identification_0'
Name:
description: |-
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.
type: string
minLength: 1
maxLength: 350
SecondaryIdentification:
$ref: '#/definitions/SecondaryIdentification'
Creditor:
type: object
additionalProperties: false
description: Party to which an amount of money is due.
properties:
Name:
description: Name by which a party is known and which is usually
used to identify that party.
type: string
minLength: 1
maxLength: 140
PostalAddress:
$ref: '#/definitions/OBPostalAddress6'
CreditorAgent:
type: object
additionalProperties: false
description: Financial institution servicing an account for the creditor.
properties:
SchemeName:
$ref: '#/definitions/OBExternalFinancialInstitutionIdentification4Code'
Identification:
$ref: '#/definitions/Identification_1'
Name:
$ref: '#/definitions/Name'
PostalAddress:
$ref: '#/definitions/OBPostalAddress6'
CreditorAccount:
type: object
additionalProperties: false
required:
- SchemeName
- Identification
- Name
description: Unambiguous identification of the account of the creditor
to which a credit entry will be posted as a result of the payment
transaction.
properties:
SchemeName:
$ref: '#/definitions/OBExternalAccountIdentification4Code'
Identification:
$ref: '#/definitions/Identification_0'
Name:
description: |-
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.
type: string
minLength: 1
maxLength: 350
SecondaryIdentification:
$ref: '#/definitions/SecondaryIdentification'
RemittanceInformation:
type: object
additionalProperties: false
description: 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.
properties:
Unstructured:
description: 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.
type: string
minLength: 1
maxLength: 140
Reference:
description: |-
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.
type: string
minLength: 1
maxLength: 35
SupplementaryData:
$ref: '#/definitions/OBSupplementaryData1'
Risk:
$ref: '#/definitions/OBRisk1'
OBWriteInternationalScheduledConsent5:
type: object
additionalProperties: false
required:
- Data
- Risk
properties:
Data:
type: object
additionalProperties: false
required:
- Permission
- Initiation
properties:
Permission:
description: Specifies the Open Banking service request types.
type: string
enum:
- Create
ReadRefundAccount:
description: Specifies to share the refund account details with PISP
type: string
enum:
- "No"
- "Yes"
Initiation:
type: object
additionalProperties: false
required:
- InstructionIdentification
- RequestedExecutionDateTime
- CurrencyOfTransfer
- InstructedAmount
- CreditorAccount
description: 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.
properties:
InstructionIdentification:
description: |-
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.
type: string
minLength: 1
maxLength: 35
EndToEndIdentification:
description: |-
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.
type: string
minLength: 1
maxLength: 35
LocalInstrument:
$ref: '#/definitions/OBExternalLocalInstrument1Code'
InstructionPriority:
description: 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.
type: string
enum:
- Normal
- Urgent
Purpose:
description: |-
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.
type: string
minLength: 1
maxLength: 4
ExtendedPurpose:
description: Specifies the purpose of an international payment, when
there is no corresponding 4 character code available in the ISO20022
list of Purpose Codes.
type: string
minLength: 1
maxLength: 140
ChargeBearer:
$ref: '#/definitions/OBChargeBearerType1Code'
RequestedExecutionDateTime:
description: "Date at which the initiating party requests the clearing
agent to process the payment. \nUsage: 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. \nAll date-time fields
in responses must include the timezone. An example is below:\n2017-04-05T10:43:07+00:00"
type: string
format: date-time
CurrencyOfTransfer:
description: Specifies the currency of the to be transferred amount,
which is different from the currency of the debtor's account.
type: string
pattern: ^[A-Z]{3,3}$
DestinationCountryCode:
description: Country in which Credit Account is domiciled. Code to
identify a country, a dependency, or another area of particular
geopolitical interest, on the basis of country names obtained from
the United Nations (ISO 3166, Alpha-2 code).
type: string
pattern: '[A-Z]{2,2}'
InstructedAmount:
type: object
additionalProperties: false
required:
- Amount
- Currency
description: |-
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.
properties:
Amount:
$ref: '#/definitions/OBActiveCurrencyAndAmount_SimpleType'
Currency:
$ref: '#/definitions/ActiveOrHistoricCurrencyCode'
ExchangeRateInformation:
type: object
additionalProperties: false
required:
- UnitCurrency
- RateType
description: Provides details on the currency exchange rate and contract.
properties:
UnitCurrency:
description: Currency in which the rate of exchange is expressed
in a currency exchange. In the example 1GBP = xxxCUR, the unit
currency is GBP.
type: string
pattern: ^[A-Z]{3,3}$
ExchangeRate:
description: 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.
type: number
RateType:
description: Specifies the type used to complete the currency
exchange.
type: string
enum:
- Actual
- Agreed
- Indicative
ContractIdentification:
description: Unique and unambiguous reference to the foreign exchange
contract agreed between the initiating party/creditor and the
debtor agent.
type: string
minLength: 1
maxLength: 256
DebtorAccount:
type: object
additionalProperties: false
required:
- SchemeName
- Identification
description: Unambiguous identification of the account of the debtor
to which a debit entry will be made as a result of the transaction.
properties:
SchemeName:
$ref: '#/definitions/OBExternalAccountIdentification4Code'
Identification:
$ref: '#/definitions/Identification_0'
Name:
description: |-
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.
type: string
minLength: 1
maxLength: 350
SecondaryIdentification:
$ref: '#/definitions/SecondaryIdentification'
Creditor:
type: object
additionalProperties: false
description: Party to which an amount of money is due.
properties:
Name:
description: Name by which a party is known and which is usually
used to identify that party.
type: string
minLength: 1
maxLength: 140
PostalAddress:
$ref: '#/definitions/OBPostalAddress6'
CreditorAgent:
type: object
additionalProperties: false
description: Financial institution servicing an account for the creditor.
properties:
SchemeName:
$ref: '#/definitions/OBExternalFinancialInstitutionIdentification4Code'
Identification:
$ref: '#/definitions/Identification_1'
Name:
$ref: '#/definitions/Name'
PostalAddress:
$ref: '#/definitions/OBPostalAddress6'
CreditorAccount:
type: object
additionalProperties: false
required:
- SchemeName
- Identification
- Name
description: Unambiguous identification of the account of the creditor
to which a credit entry will be posted as a result of the payment
transaction.
properties:
SchemeName:
$ref: '#/definitions/OBExternalAccountIdentification4Code'
Identification:
$ref: '#/definitions/Identification_0'
Name:
description: |-
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.
type: string
minLength: 1
maxLength: 350
SecondaryIdentification:
$ref: '#/definitions/SecondaryIdentification'
RemittanceInformation:
type: object
additionalProperties: false
description: 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.
properties:
Unstructured:
description: 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.
type: string
minLength: 1
maxLength: 140
Reference:
description: |-
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.
type: string
minLength: 1
maxLength: 35
SupplementaryData:
$ref: '#/definitions/OBSupplementaryData1'
Authorisation:
type: object
additionalProperties: false
required:
- AuthorisationType
description: The authorisation type request from the TPP.
properties:
AuthorisationType:
description: Type of authorisation flow requested.
type: string
enum:
- Any
- Single
CompletionDateTime:
description: "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. \nAll date-time fields in responses
must include the timezone. An example is below:\n2017-04-05T10:43:07+00:00"
type: string
format: date-time
SCASupportData:
type: object
additionalProperties: false
description: Supporting Data provided by TPP, when requesting SCA Exemption.
properties:
RequestedSCAExemptionType:
description: This field allows a PISP to request specific SCA Exemption
for a Payment Initiation
type: string
enum:
- BillPayment
- ContactlessTravel
- EcommerceGoods
- EcommerceServices
- Kiosk
- Parking
- PartyToParty
AppliedAuthenticationApproach:
description: |-
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
type: string
enum:
- CA
- SCA
ReferencePaymentOrderId:
description: |-
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.
type: string
minLength: 1
maxLength: 128
Risk:
$ref: '#/definitions/OBRisk1'
OBWriteInternationalScheduledConsentResponse6:
type: object
additionalProperties: false
required:
- Data
- Risk
properties:
Data:
type: object
additionalProperties: false
required:
- ConsentId
- CreationDateTime
- Status
- StatusUpdateDateTime
- Permission
- Initiation
properties:
ConsentId:
description: 'OB: Unique identification as assigned by the ASPSP to uniquely
identify the consent resource.'
type: string
minLength: 1
maxLength: 128
CreationDateTime:
description: "Date and time at which the resource was created.All dates
in the JSON payloads are represented in ISO 8601 date-time format. \nAll
date-time fields in responses must include the timezone. An example
is below:\n2017-04-05T10:43:07+00:00"
type: string
format: date-time
Status:
description: Specifies the status of consent resource in code form.
type: string
enum:
- Authorised
- AwaitingAuthorisation
- Consumed
- Rejected
StatusUpdateDateTime:
description: "Date and time at which the resource status was updated.All
dates in the JSON payloads are represented in ISO 8601 date-time format.
\nAll date-time fields in responses must include the timezone. An example
is below:\n2017-04-05T10:43:07+00:00"
type: string
format: date-time
Permission:
description: Specifies the Open Banking service request types.
type: string
enum:
- Create
ReadRefundAccount:
description: Specifies to share the refund account details with PISP
type: string
enum:
- "No"
- "Yes"
CutOffDateTime:
description: "Specified cut-off date and time for the payment consent.All
dates in the JSON payloads are represented in ISO 8601 date-time format.
\nAll date-time fields in responses must include the timezone. An example
is below:\n2017-04-05T10:43:07+00:00"
type: string
format: date-time
ExpectedExecutionDateTime:
description: "Expected execution date and time for the payment resource.All
dates in the JSON payloads are represented in ISO 8601 date-time format.
\nAll date-time fields in responses must include the timezone. An example
is below:\n2017-04-05T10:43:07+00:00"
type: string
format: date-time
ExpectedSettlementDateTime:
description: "Expected settlement date and time for the payment resource.All
dates in the JSON payloads are represented in ISO 8601 date-time format.
\nAll date-time fields in responses must include the timezone. An example
is below:\n2017-04-05T10:43:07+00:00"
type: string
format: date-time
Charges:
type: array
items:
type: object
additionalProperties: false
description: Set of elements used to provide details of a charge for
the payment initiation.
required:
- ChargeBearer
- Type
- Amount
properties:
ChargeBearer:
$ref: '#/definitions/OBChargeBearerType1Code'
Type:
$ref: '#/definitions/OBExternalPaymentChargeType1Code'
Amount:
$ref: '#/definitions/OBActiveOrHistoricCurrencyAndAmount'
ExchangeRateInformation:
type: object
additionalProperties: false
required:
- UnitCurrency
- ExchangeRate
- RateType
description: Further detailed information on the exchange rate that has
been used in the payment transaction.
properties:
UnitCurrency:
description: Currency in which the rate of exchange is expressed in
a currency exchange. In the example 1GBP = xxxCUR, the unit currency
is GBP.
type: string
pattern: ^[A-Z]{3,3}$
ExchangeRate:
description: 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.
type: number
RateType:
description: Specifies the type used to complete the currency exchange.
type: string
enum:
- Actual
- Agreed
- Indicative
ContractIdentification:
description: Unique and unambiguous reference to the foreign exchange
contract agreed between the initiating party/creditor and the debtor
agent.
type: string
minLength: 1
maxLength: 256
ExpirationDateTime:
description: "Specified date and time the exchange rate agreement
will expire.All dates in the JSON payloads are represented in ISO
8601 date-time format. \nAll date-time fields in responses must
include the timezone. An example is below:\n2017-04-05T10:43:07+00:00"
type: string
format: date-time
Initiation:
type: object
additionalProperties: false
required:
- InstructionIdentification
- RequestedExecutionDateTime
- CurrencyOfTransfer
- InstructedAmount
- CreditorAccount
description: 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.
properties:
InstructionIdentification:
description: |-
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.
type: string
minLength: 1
maxLength: 35
EndToEndIdentification:
description: |-
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.
type: string
minLength: 1
maxLength: 35
LocalInstrument:
$ref: '#/definitions/OBExternalLocalInstrument1Code'
InstructionPriority:
description: 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.
type: string
enum:
- Normal
- Urgent
Purpose:
description: |-
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.
type: string
minLength: 1
maxLength: 4
ExtendedPurpose:
description: Specifies the purpose of an international payment, when
there is no corresponding 4 character code available in the ISO20022
list of Purpose Codes.
type: string
minLength: 1
maxLength: 140
ChargeBearer:
$ref: '#/definitions/OBChargeBearerType1Code'
RequestedExecutionDateTime:
description: "Date at which the initiating party requests the clearing
agent to process the payment. \nUsage: 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. \nAll date-time fields
in responses must include the timezone. An example is below:\n2017-04-05T10:43:07+00:00"
type: string
format: date-time
CurrencyOfTransfer:
description: Specifies the currency of the to be transferred amount,
which is different from the currency of the debtor's account.
type: string
pattern: ^[A-Z]{3,3}$
DestinationCountryCode:
description: Country in which Credit Account is domiciled. Code to
identify a country, a dependency, or another area of particular
geopolitical interest, on the basis of country names obtained from
the United Nations (ISO 3166, Alpha-2 code).
type: string
pattern: '[A-Z]{2,2}'
InstructedAmount:
type: object
additionalProperties: false
required:
- Amount
- Currency
description: |-
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.
properties:
Amount:
$ref: '#/definitions/OBActiveCurrencyAndAmount_SimpleType'
Currency:
$ref: '#/definitions/ActiveOrHistoricCurrencyCode'
ExchangeRateInformation:
type: object
additionalProperties: false
required:
- UnitCurrency
- RateType
description: Provides details on the currency exchange rate and contract.
properties:
UnitCurrency:
description: Currency in which the rate of exchange is expressed
in a currency exchange. In the example 1GBP = xxxCUR, the unit
currency is GBP.
type: string
pattern: ^[A-Z]{3,3}$
ExchangeRate:
description: 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.
type: number
RateType:
description: Specifies the type used to complete the currency
exchange.
type: string
enum:
- Actual
- Agreed
- Indicative
ContractIdentification:
description: Unique and unambiguous reference to the foreign exchange
contract agreed between the initiating party/creditor and the
debtor agent.
type: string
minLength: 1
maxLength: 256
DebtorAccount:
type: object
additionalProperties: false
required:
- SchemeName
- Identification
description: Unambiguous identification of the account of the debtor
to which a debit entry will be made as a result of the transaction.
properties:
SchemeName:
$ref: '#/definitions/OBExternalAccountIdentification4Code'
Identification:
$ref: '#/definitions/Identification_0'
Name:
description: |-
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.
type: string
minLength: 1
maxLength: 350
SecondaryIdentification:
$ref: '#/definitions/SecondaryIdentification'
Creditor:
type: object
additionalProperties: false
description: Party to which an amount of money is due.
properties:
Name:
description: Name by which a party is known and which is usually
used to identify that party.
type: string
minLength: 1
maxLength: 350
PostalAddress:
$ref: '#/definitions/OBPostalAddress6'
CreditorAgent:
type: object
additionalProperties: false
description: Financial institution servicing an account for the creditor.
properties:
SchemeName:
$ref: '#/definitions/OBExternalFinancialInstitutionIdentification4Code'
Identification:
$ref: '#/definitions/Identification_1'
Name:
$ref: '#/definitions/Name'
PostalAddress:
$ref: '#/definitions/OBPostalAddress6'
CreditorAccount:
type: object
additionalProperties: false
required:
- SchemeName
- Identification
- Name
description: Unambiguous identification of the account of the creditor
to which a credit entry will be posted as a result of the payment
transaction.
properties:
SchemeName:
$ref: '#/definitions/OBExternalAccountIdentification4Code'
Identification:
$ref: '#/definitions/Identification_0'
Name:
description: |-
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.
type: string
minLength: 1
maxLength: 350
SecondaryIdentification:
$ref: '#/definitions/SecondaryIdentification'
RemittanceInformation:
type: object
additionalProperties: false
description: 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.
properties:
Unstructured:
description: 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.
type: string
minLength: 1
maxLength: 140
Reference:
description: |-
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.
type: string
minLength: 1
maxLength: 35
SupplementaryData:
$ref: '#/definitions/OBSupplementaryData1'
Authorisation:
type: object
additionalProperties: false
required:
- AuthorisationType
description: The authorisation type request from the TPP.
properties:
AuthorisationType:
description: Type of authorisation flow requested.
type: string
enum:
- Any
- Single
CompletionDateTime:
description: "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. \nAll date-time fields in responses
must include the timezone. An example is below:\n2017-04-05T10:43:07+00:00"
type: string
format: date-time
SCASupportData:
type: object
additionalProperties: false
description: Supporting Data provided by TPP, when requesting SCA Exemption.
properties:
RequestedSCAExemptionType:
description: This field allows a PISP to request specific SCA Exemption
for a Payment Initiation
type: string
enum:
- BillPayment
- ContactlessTravel
- EcommerceGoods
- EcommerceServices
- Kiosk
- Parking
- PartyToParty
AppliedAuthenticationApproach:
description: |-
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
type: string
enum:
- CA
- SCA
ReferencePaymentOrderId:
description: |-
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.
type: string
minLength: 1
maxLength: 128
Debtor:
$ref: '#/definitions/OBDebtorIdentification1'
Risk:
$ref: '#/definitions/OBRisk1'
Links:
$ref: '#/definitions/Links'
Meta:
$ref: '#/definitions/Meta'
OBWriteInternationalScheduledResponse6:
type: object
additionalProperties: false
required:
- Data
properties:
Data:
type: object
additionalProperties: false
required:
- InternationalScheduledPaymentId
- ConsentId
- CreationDateTime
- Status
- StatusUpdateDateTime
- Initiation
properties:
InternationalScheduledPaymentId:
description: 'OB: Unique identification as assigned by the ASPSP to uniquely
identify the international scheduled payment resource.'
type: string
minLength: 1
maxLength: 40
ConsentId:
description: 'OB: Unique identification as assigned by the ASPSP to uniquely
identify the consent resource.'
type: string
minLength: 1
maxLength: 128
CreationDateTime:
description: "Date and time at which the message was created.All dates
in the JSON payloads are represented in ISO 8601 date-time format. \nAll
date-time fields in responses must include the timezone. An example
is below:\n2017-04-05T10:43:07+00:00"
type: string
format: date-time
Status:
description: Specifies the status of the payment order resource.
type: string
enum:
- Cancelled
- InitiationCompleted
- InitiationFailed
- InitiationPending
StatusUpdateDateTime:
description: "Date and time at which the resource status was updated.All
dates in the JSON payloads are represented in ISO 8601 date-time format.
\nAll date-time fields in responses must include the timezone. An example
is below:\n2017-04-05T10:43:07+00:00"
type: string
format: date-time
ExpectedExecutionDateTime:
description: "Expected execution date and time for the payment resource.All
dates in the JSON payloads are represented in ISO 8601 date-time format.
\nAll date-time fields in responses must include the timezone. An example
is below:\n2017-04-05T10:43:07+00:00"
type: string
format: date-time
ExpectedSettlementDateTime:
description: "Expected settlement date and time for the payment resource.All
dates in the JSON payloads are represented in ISO 8601 date-time format.
\nAll date-time fields in responses must include the timezone. An example
is below:\n2017-04-05T10:43:07+00:00"
type: string
format: date-time
Refund:
type: object
additionalProperties: false
required:
- Account
properties:
Creditor:
type: object
additionalProperties: false
description: Set of elements used to identify a person or an organisation.
properties:
Name:
description: Name by which a party is known and which is usually
used to identify that party.
type: string
minLength: 1
maxLength: 140
PostalAddress:
$ref: '#/definitions/OBPostalAddress6'
Agent:
type: object
additionalProperties: false
description: Set of elements used to uniquely and unambiguously identify
a financial institution or a branch of a financial institution.
properties:
SchemeName:
$ref: '#/definitions/OBExternalFinancialInstitutionIdentification4Code'
Identification:
$ref: '#/definitions/Identification_1'
Name:
$ref: '#/definitions/Name'
PostalAddress:
$ref: '#/definitions/OBPostalAddress6'
Account:
type: object
additionalProperties: false
required:
- SchemeName
- Identification
- Name
description: Provides the details to identify an account.
properties:
SchemeName:
$ref: '#/definitions/OBExternalAccountIdentification4Code'
Identification:
$ref: '#/definitions/Identification_0'
Name:
description: |-
Name of the account, as assigned by the account servicing institution.
Usage: The account name is the name or names of the account owner(s) represented at an account level. 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.
type: string
minLength: 1
maxLength: 350
SecondaryIdentification:
$ref: '#/definitions/SecondaryIdentification'
Charges:
type: array
items:
type: object
additionalProperties: false
description: Set of elements used to provide details of a charge for
the payment initiation.
required:
- ChargeBearer
- Type
- Amount
properties:
ChargeBearer:
$ref: '#/definitions/OBChargeBearerType1Code'
Type:
$ref: '#/definitions/OBExternalPaymentChargeType1Code'
Amount:
$ref: '#/definitions/OBActiveOrHistoricCurrencyAndAmount'
ExchangeRateInformation:
type: object
additionalProperties: false
required:
- UnitCurrency
- ExchangeRate
- RateType
description: Further detailed information on the exchange rate that has
been used in the payment transaction.
properties:
UnitCurrency:
description: Currency in which the rate of exchange is expressed in
a currency exchange. In the example 1GBP = xxxCUR, the unit currency
is GBP.
type: string
pattern: ^[A-Z]{3,3}$
ExchangeRate:
description: 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.
type: number
RateType:
description: Specifies the type used to complete the currency exchange.
type: string
enum:
- Actual
- Agreed
- Indicative
ContractIdentification:
description: Unique and unambiguous reference to the foreign exchange
contract agreed between the initiating party/creditor and the debtor
agent.
type: string
minLength: 1
maxLength: 256
ExpirationDateTime:
description: "Specified date and time the exchange rate agreement
will expire.All dates in the JSON payloads are represented in ISO
8601 date-time format. \nAll date-time fields in responses must
include the timezone. An example is below:\n2017-04-05T10:43:07+00:00"
type: string
format: date-time
Initiation:
type: object
additionalProperties: false
required:
- InstructionIdentification
- RequestedExecutionDateTime
- CurrencyOfTransfer
- InstructedAmount
- CreditorAccount
description: 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.
properties:
InstructionIdentification:
description: |-
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.
type: string
minLength: 1
maxLength: 35
EndToEndIdentification:
description: |-
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.
type: string
minLength: 1
maxLength: 35
LocalInstrument:
$ref: '#/definitions/OBExternalLocalInstrument1Code'
InstructionPriority:
description: 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.
type: string
enum:
- Normal
- Urgent
Purpose:
description: |-
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.
type: string
minLength: 1
maxLength: 4
ExtendedPurpose:
description: Specifies the purpose of an international payment, when
there is no corresponding 4 character code available in the ISO20022
list of Purpose Codes.
type: string
minLength: 1
maxLength: 140
ChargeBearer:
$ref: '#/definitions/OBChargeBearerType1Code'
RequestedExecutionDateTime:
description: "Date at which the initiating party requests the clearing
agent to process the payment. \nUsage: 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. \nAll date-time fields
in responses must include the timezone. An example is below:\n2017-04-05T10:43:07+00:00"
type: string
format: date-time
CurrencyOfTransfer:
description: Specifies the currency of the to be transferred amount,
which is different from the currency of the debtor's account.
type: string
pattern: ^[A-Z]{3,3}$
DestinationCountryCode:
description: Country in which Credit Account is domiciled. Code to
identify a country, a dependency, or another area of particular
geopolitical interest, on the basis of country names obtained from
the United Nations (ISO 3166, Alpha-2 code).
type: string
pattern: '[A-Z]{2,2}'
InstructedAmount:
type: object
additionalProperties: false
required:
- Amount
- Currency
description: |-
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.
properties:
Amount:
$ref: '#/definitions/OBActiveCurrencyAndAmount_SimpleType'
Currency:
$ref: '#/definitions/ActiveOrHistoricCurrencyCode'
ExchangeRateInformation:
type: object
additionalProperties: false
required:
- UnitCurrency
- RateType
description: Provides details on the currency exchange rate and contract.
properties:
UnitCurrency:
description: Currency in which the rate of exchange is expressed
in a currency exchange. In the example 1GBP = xxxCUR, the unit
currency is GBP.
type: string
pattern: ^[A-Z]{3,3}$
ExchangeRate:
description: 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.
type: number
RateType:
description: Specifies the type used to complete the currency
exchange.
type: string
enum:
- Actual
- Agreed
- Indicative
ContractIdentification:
description: Unique and unambiguous reference to the foreign exchange
contract agreed between the initiating party/creditor and the
debtor agent.
type: string
minLength: 1
maxLength: 256
DebtorAccount:
type: object
additionalProperties: false
required:
- SchemeName
- Identification
description: Unambiguous identification of the account of the debtor
to which a debit entry will be made as a result of the transaction.
properties:
SchemeName:
$ref: '#/definitions/OBExternalAccountIdentification4Code'
Identification:
$ref: '#/definitions/Identification_0'
Name:
description: |-
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.
type: string
minLength: 1
maxLength: 350
SecondaryIdentification:
$ref: '#/definitions/SecondaryIdentification'
Creditor:
type: object
additionalProperties: false
description: Party to which an amount of money is due.
properties:
Name:
description: Name by which a party is known and which is usually
used to identify that party.
type: string
minLength: 1
maxLength: 140
PostalAddress:
$ref: '#/definitions/OBPostalAddress6'
CreditorAgent:
type: object
additionalProperties: false
description: Financial institution servicing an account for the creditor.
properties:
SchemeName:
$ref: '#/definitions/OBExternalFinancialInstitutionIdentification4Code'
Identification:
$ref: '#/definitions/Identification_1'
Name:
$ref: '#/definitions/Name'
PostalAddress:
$ref: '#/definitions/OBPostalAddress6'
CreditorAccount:
type: object
additionalProperties: false
required:
- SchemeName
- Identification
- Name
description: Unambiguous identification of the account of the creditor
to which a credit entry will be posted as a result of the payment
transaction.
properties:
SchemeName:
$ref: '#/definitions/OBExternalAccountIdentification4Code'
Identification:
$ref: '#/definitions/Identification_0'
Name:
description: |-
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.
type: string
minLength: 1
maxLength: 350
SecondaryIdentification:
$ref: '#/definitions/SecondaryIdentification'
RemittanceInformation:
type: object
additionalProperties: false
description: 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.
properties:
Unstructured:
description: 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.
type: string
minLength: 1
maxLength: 140
Reference:
description: |-
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.
type: string
minLength: 1
maxLength: 35
SupplementaryData:
$ref: '#/definitions/OBSupplementaryData1'
MultiAuthorisation:
type: object
additionalProperties: false
required:
- Status
description: The multiple authorisation flow response from the ASPSP.
properties:
Status:
description: Specifies the status of the authorisation flow in code
form.
type: string
enum:
- Authorised
- AwaitingFurtherAuthorisation
- Rejected
NumberRequired:
description: Number of authorisations required for payment order (total
required at the start of the multi authorisation journey).
type: integer
NumberReceived:
description: Number of authorisations received.
type: integer
LastUpdateDateTime:
description: "Last date and time at the authorisation flow was updated.All
dates in the JSON payloads are represented in ISO 8601 date-time
format. \nAll date-time fields in responses must include the timezone.
An example is below:\n2017-04-05T10:43:07+00:00"
type: string
format: date-time
ExpirationDateTime:
description: "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. \nAll date-time fields in responses
must include the timezone. An example is below:\n2017-04-05T10:43:07+00:00"
type: string
format: date-time
Debtor:
$ref: '#/definitions/OBDebtorIdentification1'
Links:
$ref: '#/definitions/Links'
Meta:
$ref: '#/definitions/Meta'
OBWriteInternationalStandingOrder4:
type: object
additionalProperties: false
required:
- Data
- Risk
properties:
Data:
type: object
additionalProperties: false
required:
- ConsentId
- Initiation
properties:
ConsentId:
description: 'OB: Unique identification as assigned by the ASPSP to uniquely
identify the consent resource.'
type: string
minLength: 1
maxLength: 128
Initiation:
type: object
additionalProperties: false
required:
- Frequency
- FirstPaymentDateTime
- CurrencyOfTransfer
- InstructedAmount
- CreditorAccount
description: 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.
properties:
Frequency:
description: "Individual Definitions:\nEvryDay - Every day\nEvryWorkgDay
- Every working day\nIntrvlWkDay - An interval specified in weeks
(01 to 09), and the day within the week (01 to 07)\nWkInMnthDay
- A monthly interval, specifying the week of the month (01 to 05)
and day within the week (01 to 07)\nIntrvlMnthDay - An interval
specified in months (between 01 to 06, 12, 24), specifying the day
within the month (-5 to -1, 1 to 31)\nQtrDay - Quarterly (either
ENGLISH, SCOTTISH, or RECEIVED). \nENGLISH = Paid on the 25th March,
24th June, 29th September and 25th December. \nSCOTTISH = Paid on
the 2nd February, 15th May, 1st August and 11th November.\nRECEIVED
= Paid on the 20th March, 19th June, 24th September and 20th December.
\nIndividual Patterns:\nEvryDay (ScheduleCode)\nEvryWorkgDay (ScheduleCode)\nIntrvlWkDay:IntervalInWeeks:DayInWeek
(ScheduleCode + IntervalInWeeks + DayInWeek)\nWkInMnthDay:WeekInMonth:DayInWeek
(ScheduleCode + WeekInMonth + DayInWeek)\nIntrvlMnthDay:IntervalInMonths:DayInMonth
(ScheduleCode + IntervalInMonths + DayInMonth)\nQtrDay: + either
(ENGLISH, SCOTTISH or RECEIVED) ScheduleCode + QuarterDay\nThe regular
expression for this element combines five smaller versions for each
permitted pattern. To aid legibility - the components are presented
individually here:\nEvryDay\nEvryWorkgDay\nIntrvlWkDay:0[1-9]:0[1-7]\nWkInMnthDay:0[1-5]:0[1-7]\nIntrvlMnthDay:(0[1-6]|12|24):(-0[1-5]|0[1-9]|[12][0-9]|3[01])\nQtrDay:(ENGLISH|SCOTTISH|RECEIVED)\nFull
Regular Expression:\n^(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))$"
type: string
pattern: ^(EvryDay)$|^(EvryWorkgDay)$|^(IntrvlDay:((0[2-9])|([1-2][0-9])|3[0-1]))$|^(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))$
Reference:
description: |-
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.
type: string
minLength: 1
maxLength: 35
NumberOfPayments:
description: Number of the payments that will be made in completing
this frequency sequence including any executed since the sequence
start date.
type: string
minLength: 1
maxLength: 35
FirstPaymentDateTime:
description: "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. \nAll date-time fields in responses
must include the timezone. An example is below:\n2017-04-05T10:43:07+00:00"
type: string
format: date-time
FinalPaymentDateTime:
description: "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. \nAll date-time fields in responses
must include the timezone. An example is below:\n2017-04-05T10:43:07+00:00"
type: string
format: date-time
Purpose:
description: |-
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.
type: string
minLength: 1
maxLength: 4
ExtendedPurpose:
description: Specifies the purpose of an international payment, when
there is no corresponding 4 character code available in the ISO20022
list of Purpose Codes.
type: string
minLength: 1
maxLength: 140
ChargeBearer:
$ref: '#/definitions/OBChargeBearerType1Code'
CurrencyOfTransfer:
description: Specifies the currency of the to be transferred amount,
which is different from the currency of the debtor's account.
type: string
pattern: ^[A-Z]{3,3}$
DestinationCountryCode:
description: Country in which Credit Account is domiciled. Code to
identify a country, a dependency, or another area of particular
geopolitical interest, on the basis of country names obtained from
the United Nations (ISO 3166, Alpha-2 code).
type: string
pattern: '[A-Z]{2,2}'
InstructedAmount:
type: object
additionalProperties: false
required:
- Amount
- Currency
description: |-
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.
properties:
Amount:
$ref: '#/definitions/OBActiveCurrencyAndAmount_SimpleType'
Currency:
$ref: '#/definitions/ActiveOrHistoricCurrencyCode'
DebtorAccount:
type: object
additionalProperties: false
required:
- SchemeName
- Identification
description: Provides the details to identify the debtor account.
properties:
SchemeName:
$ref: '#/definitions/OBExternalAccountIdentification4Code'
Identification:
$ref: '#/definitions/Identification_0'
Name:
description: |-
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.
type: string
minLength: 1
maxLength: 350
SecondaryIdentification:
$ref: '#/definitions/SecondaryIdentification'
Creditor:
type: object
additionalProperties: false
description: Party to which an amount of money is due.
properties:
Name:
description: Name by which a party is known and which is usually
used to identify that party.
type: string
minLength: 1
maxLength: 350
PostalAddress:
$ref: '#/definitions/OBPostalAddress6'
CreditorAgent:
type: object
additionalProperties: false
description: |-
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.
properties:
SchemeName:
$ref: '#/definitions/OBExternalFinancialInstitutionIdentification4Code'
Identification:
description: Unique and unambiguous identification of the servicing
institution.
type: string
minLength: 1
maxLength: 35
Name:
$ref: '#/definitions/Name'
PostalAddress:
$ref: '#/definitions/OBPostalAddress6'
CreditorAccount:
type: object
additionalProperties: false
required:
- SchemeName
- Identification
- Name
description: Provides the details to identify the beneficiary account.
properties:
SchemeName:
$ref: '#/definitions/OBExternalAccountIdentification4Code'
Identification:
$ref: '#/definitions/Identification_0'
Name:
description: |-
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.
type: string
minLength: 1
maxLength: 350
SecondaryIdentification:
$ref: '#/definitions/SecondaryIdentification'
SupplementaryData:
$ref: '#/definitions/OBSupplementaryData1'
Risk:
$ref: '#/definitions/OBRisk1'
OBWriteInternationalStandingOrderConsent6:
type: object
additionalProperties: false
required:
- Data
- Risk
properties:
Data:
type: object
additionalProperties: false
required:
- Permission
- Initiation
properties:
Permission:
description: Specifies the Open Banking service request types.
type: string
enum:
- Create
ReadRefundAccount:
description: Specifies to share the refund account details with PISP
type: string
enum:
- "No"
- "Yes"
Initiation:
type: object
additionalProperties: false
required:
- Frequency
- FirstPaymentDateTime
- CurrencyOfTransfer
- InstructedAmount
- CreditorAccount
description: 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.
properties:
Frequency:
description: "Individual Definitions:\nEvryDay - Every day\nEvryWorkgDay
- Every working day\nIntrvlWkDay - An interval specified in weeks
(01 to 09), and the day within the week (01 to 07)\nWkInMnthDay
- A monthly interval, specifying the week of the month (01 to 05)
and day within the week (01 to 07)\nIntrvlMnthDay - An interval
specified in months (between 01 to 06, 12, 24), specifying the day
within the month (-5 to -1, 1 to 31)\nQtrDay - Quarterly (either
ENGLISH, SCOTTISH, or RECEIVED). \nENGLISH = Paid on the 25th March,
24th June, 29th September and 25th December. \nSCOTTISH = Paid on
the 2nd February, 15th May, 1st August and 11th November.\nRECEIVED
= Paid on the 20th March, 19th June, 24th September and 20th December.
\nIndividual Patterns:\nEvryDay (ScheduleCode)\nEvryWorkgDay (ScheduleCode)\nIntrvlWkDay:IntervalInWeeks:DayInWeek
(ScheduleCode + IntervalInWeeks + DayInWeek)\nWkInMnthDay:WeekInMonth:DayInWeek
(ScheduleCode + WeekInMonth + DayInWeek)\nIntrvlMnthDay:IntervalInMonths:DayInMonth
(ScheduleCode + IntervalInMonths + DayInMonth)\nQtrDay: + either
(ENGLISH, SCOTTISH or RECEIVED) ScheduleCode + QuarterDay\nThe regular
expression for this element combines five smaller versions for each
permitted pattern. To aid legibility - the components are presented
individually here:\nEvryDay\nEvryWorkgDay\nIntrvlWkDay:0[1-9]:0[1-7]\nWkInMnthDay:0[1-5]:0[1-7]\nIntrvlMnthDay:(0[1-6]|12|24):(-0[1-5]|0[1-9]|[12][0-9]|3[01])\nQtrDay:(ENGLISH|SCOTTISH|RECEIVED)\nFull
Regular Expression:\n^(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))$"
type: string
pattern: ^(EvryDay)$|^(EvryWorkgDay)$|^(IntrvlDay:((0[2-9])|([1-2][0-9])|3[0-1]))$|^(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))$
Reference:
description: |-
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.
type: string
minLength: 1
maxLength: 35
NumberOfPayments:
description: Number of the payments that will be made in completing
this frequency sequence including any executed since the sequence
start date.
type: string
minLength: 1
maxLength: 35
FirstPaymentDateTime:
description: "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. \nAll date-time fields in responses
must include the timezone. An example is below:\n2017-04-05T10:43:07+00:00"
type: string
format: date-time
FinalPaymentDateTime:
description: "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. \nAll date-time fields in responses
must include the timezone. An example is below:\n2017-04-05T10:43:07+00:00"
type: string
format: date-time
Purpose:
description: |-
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.
type: string
minLength: 1
maxLength: 4
ExtendedPurpose:
description: Specifies the purpose of an international payment, when
there is no corresponding 4 character code available in the ISO20022
list of Purpose Codes.
type: string
minLength: 1
maxLength: 140
ChargeBearer:
$ref: '#/definitions/OBChargeBearerType1Code'
CurrencyOfTransfer:
description: Specifies the currency of the to be transferred amount,
which is different from the currency of the debtor's account.
type: string
pattern: ^[A-Z]{3,3}$
DestinationCountryCode:
description: Country in which Credit Account is domiciled. Code to
identify a country, a dependency, or another area of particular
geopolitical interest, on the basis of country names obtained from
the United Nations (ISO 3166, Alpha-2 code).
type: string
pattern: '[A-Z]{2,2}'
InstructedAmount:
type: object
additionalProperties: false
required:
- Amount
- Currency
description: |-
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.
properties:
Amount:
$ref: '#/definitions/OBActiveCurrencyAndAmount_SimpleType'
Currency:
$ref: '#/definitions/ActiveOrHistoricCurrencyCode'
DebtorAccount:
type: object
additionalProperties: false
required:
- SchemeName
- Identification
description: Provides the details to identify the debtor account.
properties:
SchemeName:
$ref: '#/definitions/OBExternalAccountIdentification4Code'
Identification:
$ref: '#/definitions/Identification_0'
Name:
description: |-
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.
type: string
minLength: 1
maxLength: 350
SecondaryIdentification:
$ref: '#/definitions/SecondaryIdentification'
Creditor:
type: object
additionalProperties: false
description: Party to which an amount of money is due.
properties:
Name:
description: Name by which a party is known and which is usually
used to identify that party.
type: string
minLength: 1
maxLength: 350
PostalAddress:
$ref: '#/definitions/OBPostalAddress6'
CreditorAgent:
type: object
additionalProperties: false
description: |-
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.
properties:
SchemeName:
$ref: '#/definitions/OBExternalFinancialInstitutionIdentification4Code'
Identification:
description: Unique and unambiguous identification of the servicing
institution.
type: string
minLength: 1
maxLength: 35
Name:
$ref: '#/definitions/Name'
PostalAddress:
$ref: '#/definitions/OBPostalAddress6'
CreditorAccount:
type: object
additionalProperties: false
required:
- SchemeName
- Identification
- Name
description: Provides the details to identify the beneficiary account.
properties:
SchemeName:
$ref: '#/definitions/OBExternalAccountIdentification4Code'
Identification:
$ref: '#/definitions/Identification_0'
Name:
description: |-
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.
type: string
minLength: 1
maxLength: 350
SecondaryIdentification:
$ref: '#/definitions/SecondaryIdentification'
SupplementaryData:
$ref: '#/definitions/OBSupplementaryData1'
Authorisation:
type: object
additionalProperties: false
required:
- AuthorisationType
description: The authorisation type request from the TPP.
properties:
AuthorisationType:
description: Type of authorisation flow requested.
type: string
enum:
- Any
- Single
CompletionDateTime:
description: "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. \nAll date-time fields in responses
must include the timezone. An example is below:\n2017-04-05T10:43:07+00:00"
type: string
format: date-time
SCASupportData:
type: object
additionalProperties: false
description: Supporting Data provided by TPP, when requesting SCA Exemption.
properties:
RequestedSCAExemptionType:
description: This field allows a PISP to request specific SCA Exemption
for a Payment Initiation
type: string
enum:
- BillPayment
- ContactlessTravel
- EcommerceGoods
- EcommerceServices
- Kiosk
- Parking
- PartyToParty
AppliedAuthenticationApproach:
description: |-
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
type: string
enum:
- CA
- SCA
ReferencePaymentOrderId:
description: |-
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.
type: string
minLength: 1
maxLength: 128
Risk:
$ref: '#/definitions/OBRisk1'
OBWriteInternationalStandingOrderConsentResponse7:
type: object
additionalProperties: false
required:
- Data
- Risk
properties:
Data:
type: object
additionalProperties: false
required:
- ConsentId
- CreationDateTime
- Status
- StatusUpdateDateTime
- Permission
- Initiation
properties:
ConsentId:
description: 'OB: Unique identification as assigned by the ASPSP to uniquely
identify the consent resource.'
type: string
minLength: 1
maxLength: 128
CreationDateTime:
description: "Date and time at which the resource was created.All dates
in the JSON payloads are represented in ISO 8601 date-time format. \nAll
date-time fields in responses must include the timezone. An example
is below:\n2017-04-05T10:43:07+00:00"
type: string
format: date-time
Status:
description: Specifies the status of resource in code form.
type: string
enum:
- Authorised
- AwaitingAuthorisation
- Consumed
- Rejected
StatusUpdateDateTime:
description: "Date and time at which the resource status was updated.All
dates in the JSON payloads are represented in ISO 8601 date-time format.
\nAll date-time fields in responses must include the timezone. An example
is below:\n2017-04-05T10:43:07+00:00"
type: string
format: date-time
Permission:
description: Specifies the Open Banking service request types.
type: string
enum:
- Create
ReadRefundAccount:
description: Specifies to share the refund account details with PISP
type: string
enum:
- "No"
- "Yes"
CutOffDateTime:
description: "Specified cut-off date and time for the payment consent.All
dates in the JSON payloads are represented in ISO 8601 date-time format.
\nAll date-time fields in responses must include the timezone. An example
is below:\n2017-04-05T10:43:07+00:00"
type: string
format: date-time
Charges:
type: array
items:
type: object
additionalProperties: false
description: Set of elements used to provide details of a charge for
the payment initiation.
required:
- ChargeBearer
- Type
- Amount
properties:
ChargeBearer:
$ref: '#/definitions/OBChargeBearerType1Code'
Type:
$ref: '#/definitions/OBExternalPaymentChargeType1Code'
Amount:
$ref: '#/definitions/OBActiveOrHistoricCurrencyAndAmount'
Initiation:
type: object
additionalProperties: false
required:
- Frequency
- FirstPaymentDateTime
- CurrencyOfTransfer
- InstructedAmount
- CreditorAccount
description: 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.
properties:
Frequency:
description: "Individual Definitions:\nEvryDay - Every day\nEvryWorkgDay
- Every working day\nIntrvlWkDay - An interval specified in weeks
(01 to 09), and the day within the week (01 to 07)\nWkInMnthDay
- A monthly interval, specifying the week of the month (01 to 05)
and day within the week (01 to 07)\nIntrvlMnthDay - An interval
specified in months (between 01 to 06, 12, 24), specifying the day
within the month (-5 to -1, 1 to 31)\nQtrDay - Quarterly (either
ENGLISH, SCOTTISH, or RECEIVED). \nENGLISH = Paid on the 25th March,
24th June, 29th September and 25th December. \nSCOTTISH = Paid on
the 2nd February, 15th May, 1st August and 11th November.\nRECEIVED
= Paid on the 20th March, 19th June, 24th September and 20th December.
\nIndividual Patterns:\nEvryDay (ScheduleCode)\nEvryWorkgDay (ScheduleCode)\nIntrvlWkDay:IntervalInWeeks:DayInWeek
(ScheduleCode + IntervalInWeeks + DayInWeek)\nWkInMnthDay:WeekInMonth:DayInWeek
(ScheduleCode + WeekInMonth + DayInWeek)\nIntrvlMnthDay:IntervalInMonths:DayInMonth
(ScheduleCode + IntervalInMonths + DayInMonth)\nQtrDay: + either
(ENGLISH, SCOTTISH or RECEIVED) ScheduleCode + QuarterDay\nThe regular
expression for this element combines five smaller versions for each
permitted pattern. To aid legibility - the components are presented
individually here:\nEvryDay\nEvryWorkgDay\nIntrvlWkDay:0[1-9]:0[1-7]\nWkInMnthDay:0[1-5]:0[1-7]\nIntrvlMnthDay:(0[1-6]|12|24):(-0[1-5]|0[1-9]|[12][0-9]|3[01])\nQtrDay:(ENGLISH|SCOTTISH|RECEIVED)\nFull
Regular Expression:\n^(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))$"
type: string
pattern: ^(EvryDay)$|^(EvryWorkgDay)$|^(IntrvlDay:((0[2-9])|([1-2][0-9])|3[0-1]))$|^(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))$
Reference:
description: |-
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.
type: string
minLength: 1
maxLength: 35
NumberOfPayments:
description: Number of the payments that will be made in completing
this frequency sequence including any executed since the sequence
start date.
type: string
minLength: 1
maxLength: 35
FirstPaymentDateTime:
description: "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. \nAll date-time fields in responses
must include the timezone. An example is below:\n2017-04-05T10:43:07+00:00"
type: string
format: date-time
FinalPaymentDateTime:
description: "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. \nAll date-time fields in responses
must include the timezone. An example is below:\n2017-04-05T10:43:07+00:00"
type: string
format: date-time
Purpose:
description: |-
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.
type: string
minLength: 1
maxLength: 4
ExtendedPurpose:
description: Specifies the purpose of an international payment, when
there is no corresponding 4 character code available in the ISO20022
list of Purpose Codes.
type: string
minLength: 1
maxLength: 140
ChargeBearer:
$ref: '#/definitions/OBChargeBearerType1Code'
CurrencyOfTransfer:
description: Specifies the currency of the to be transferred amount,
which is different from the currency of the debtor's account.
type: string
pattern: ^[A-Z]{3,3}$
DestinationCountryCode:
description: Country in which Credit Account is domiciled. Code to
identify a country, a dependency, or another area of particular
geopolitical interest, on the basis of country names obtained from
the United Nations (ISO 3166, Alpha-2 code).
type: string
pattern: '[A-Z]{2,2}'
InstructedAmount:
type: object
additionalProperties: false
required:
- Amount
- Currency
description: |-
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.
properties:
Amount:
$ref: '#/definitions/OBActiveCurrencyAndAmount_SimpleType'
Currency:
$ref: '#/definitions/ActiveOrHistoricCurrencyCode'
DebtorAccount:
type: object
additionalProperties: false
required:
- SchemeName
- Identification
description: Provides the details to identify the debtor account.
properties:
SchemeName:
$ref: '#/definitions/OBExternalAccountIdentification4Code'
Identification:
$ref: '#/definitions/Identification_0'
Name:
description: |-
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.
type: string
minLength: 1
maxLength: 350
SecondaryIdentification:
$ref: '#/definitions/SecondaryIdentification'
Creditor:
type: object
additionalProperties: false
description: Party to which an amount of money is due.
properties:
Name:
description: Name by which a party is known and which is usually
used to identify that party.
type: string
minLength: 1
maxLength: 350
PostalAddress:
$ref: '#/definitions/OBPostalAddress6'
CreditorAgent:
type: object
additionalProperties: false
description: |-
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.
properties:
SchemeName:
$ref: '#/definitions/OBExternalFinancialInstitutionIdentification4Code'
Identification:
description: Unique and unambiguous identification of the servicing
institution.
type: string
minLength: 1
maxLength: 35
Name:
$ref: '#/definitions/Name'
PostalAddress:
$ref: '#/definitions/OBPostalAddress6'
CreditorAccount:
type: object
additionalProperties: false
required:
- SchemeName
- Identification
- Name
description: Provides the details to identify the beneficiary account.
properties:
SchemeName:
$ref: '#/definitions/OBExternalAccountIdentification4Code'
Identification:
$ref: '#/definitions/Identification_0'
Name:
description: |-
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.
type: string
minLength: 1
maxLength: 350
SecondaryIdentification:
$ref: '#/definitions/SecondaryIdentification'
SupplementaryData:
$ref: '#/definitions/OBSupplementaryData1'
Authorisation:
type: object
additionalProperties: false
required:
- AuthorisationType
description: The authorisation type request from the TPP.
properties:
AuthorisationType:
description: Type of authorisation flow requested.
type: string
enum:
- Any
- Single
CompletionDateTime:
description: "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. \nAll date-time fields in responses
must include the timezone. An example is below:\n2017-04-05T10:43:07+00:00"
type: string
format: date-time
SCASupportData:
type: object
additionalProperties: false
description: Supporting Data provided by TPP, when requesting SCA Exemption.
properties:
RequestedSCAExemptionType:
description: This field allows a PISP to request specific SCA Exemption
for a Payment Initiation
type: string
enum:
- BillPayment
- ContactlessTravel
- EcommerceGoods
- EcommerceServices
- Kiosk
- Parking
- PartyToParty
AppliedAuthenticationApproach:
description: |-
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
type: string
enum:
- CA
- SCA
ReferencePaymentOrderId:
description: |-
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.
type: string
minLength: 1
maxLength: 128
Debtor:
$ref: '#/definitions/OBDebtorIdentification1'
Risk:
$ref: '#/definitions/OBRisk1'
Links:
$ref: '#/definitions/Links'
Meta:
$ref: '#/definitions/Meta'
OBWriteInternationalStandingOrderResponse7:
type: object
additionalProperties: false
required:
- Data
properties:
Data:
type: object
additionalProperties: false
required:
- InternationalStandingOrderId
- ConsentId
- CreationDateTime
- Status
- StatusUpdateDateTime
- Initiation
properties:
InternationalStandingOrderId:
description: 'OB: Unique identification as assigned by the ASPSP to uniquely
identify the international standing order resource.'
type: string
minLength: 1
maxLength: 40
ConsentId:
description: 'OB: Unique identification as assigned by the ASPSP to uniquely
identify the consent resource.'
type: string
minLength: 1
maxLength: 128
CreationDateTime:
description: "Date and time at which the resource was created.All dates
in the JSON payloads are represented in ISO 8601 date-time format. \nAll
date-time fields in responses must include the timezone. An example
is below:\n2017-04-05T10:43:07+00:00"
type: string
format: date-time
Status:
description: Specifies the status of resource in code form.
type: string
enum:
- Cancelled
- InitiationCompleted
- InitiationFailed
- InitiationPending
StatusUpdateDateTime:
description: "Date and time at which the resource status was updated.All
dates in the JSON payloads are represented in ISO 8601 date-time format.
\nAll date-time fields in responses must include the timezone. An example
is below:\n2017-04-05T10:43:07+00:00"
type: string
format: date-time
Refund:
type: object
additionalProperties: false
required:
- Account
properties:
Creditor:
type: object
additionalProperties: false
description: Set of elements used to identify a person or an organisation.
properties:
Name:
description: Name by which a party is known and which is usually
used to identify that party.
type: string
minLength: 1
maxLength: 350
PostalAddress:
$ref: '#/definitions/OBPostalAddress6'
Agent:
type: object
additionalProperties: false
description: Set of elements used to uniquely and unambiguously identify
a financial institution or a branch of a financial institution.
properties:
SchemeName:
$ref: '#/definitions/OBExternalFinancialInstitutionIdentification4Code'
Identification:
$ref: '#/definitions/Identification_1'
Name:
$ref: '#/definitions/Name'
PostalAddress:
$ref: '#/definitions/OBPostalAddress6'
Account:
type: object
additionalProperties: false
required:
- SchemeName
- Identification
- Name
description: Provides the details to identify an account.
properties:
SchemeName:
$ref: '#/definitions/OBExternalAccountIdentification4Code'
Identification:
$ref: '#/definitions/Identification_0'
Name:
description: |-
Name of the account, as assigned by the account servicing institution.
Usage: The account name is the name or names of the account owner(s) represented at an account level. 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.
type: string
minLength: 1
maxLength: 350
SecondaryIdentification:
$ref: '#/definitions/SecondaryIdentification'
Charges:
type: array
items:
type: object
additionalProperties: false
description: Set of elements used to provide details of a charge for
the payment initiation.
required:
- ChargeBearer
- Type
- Amount
properties:
ChargeBearer:
$ref: '#/definitions/OBChargeBearerType1Code'
Type:
$ref: '#/definitions/OBExternalPaymentChargeType1Code'
Amount:
$ref: '#/definitions/OBActiveOrHistoricCurrencyAndAmount'
Initiation:
type: object
additionalProperties: false
required:
- Frequency
- FirstPaymentDateTime
- CurrencyOfTransfer
- InstructedAmount
- CreditorAccount
description: 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.
properties:
Frequency:
description: "Individual Definitions:\nEvryDay - Every day\nEvryWorkgDay
- Every working day\nIntrvlWkDay - An interval specified in weeks
(01 to 09), and the day within the week (01 to 07)\nWkInMnthDay
- A monthly interval, specifying the week of the month (01 to 05)
and day within the week (01 to 07)\nIntrvlMnthDay - An interval
specified in months (between 01 to 06, 12, 24), specifying the day
within the month (-5 to -1, 1 to 31)\nQtrDay - Quarterly (either
ENGLISH, SCOTTISH, or RECEIVED). \nENGLISH = Paid on the 25th March,
24th June, 29th September and 25th December. \nSCOTTISH = Paid on
the 2nd February, 15th May, 1st August and 11th November.\nRECEIVED
= Paid on the 20th March, 19th June, 24th September and 20th December.
\nIndividual Patterns:\nEvryDay (ScheduleCode)\nEvryWorkgDay (ScheduleCode)\nIntrvlWkDay:IntervalInWeeks:DayInWeek
(ScheduleCode + IntervalInWeeks + DayInWeek)\nWkInMnthDay:WeekInMonth:DayInWeek
(ScheduleCode + WeekInMonth + DayInWeek)\nIntrvlMnthDay:IntervalInMonths:DayInMonth
(ScheduleCode + IntervalInMonths + DayInMonth)\nQtrDay: + either
(ENGLISH, SCOTTISH or RECEIVED) ScheduleCode + QuarterDay\nThe regular
expression for this element combines five smaller versions for each
permitted pattern. To aid legibility - the components are presented
individually here:\nEvryDay\nEvryWorkgDay\nIntrvlWkDay:0[1-9]:0[1-7]\nWkInMnthDay:0[1-5]:0[1-7]\nIntrvlMnthDay:(0[1-6]|12|24):(-0[1-5]|0[1-9]|[12][0-9]|3[01])\nQtrDay:(ENGLISH|SCOTTISH|RECEIVED)\nFull
Regular Expression:\n^(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))$"
type: string
pattern: ^(EvryDay)$|^(EvryWorkgDay)$|^(IntrvlDay:((0[2-9])|([1-2][0-9])|3[0-1]))$|^(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))$
Reference:
description: |-
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.
type: string
minLength: 1
maxLength: 35
NumberOfPayments:
description: Number of the payments that will be made in completing
this frequency sequence including any executed since the sequence
start date.
type: string
minLength: 1
maxLength: 35
FirstPaymentDateTime:
description: "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. \nAll date-time fields in responses
must include the timezone. An example is below:\n2017-04-05T10:43:07+00:00"
type: string
format: date-time
FinalPaymentDateTime:
description: "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. \nAll date-time fields in responses
must include the timezone. An example is below:\n2017-04-05T10:43:07+00:00"
type: string
format: date-time
Purpose:
description: |-
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.
type: string
minLength: 1
maxLength: 4
ExtendedPurpose:
description: Specifies the purpose of an international payment, when
there is no corresponding 4 character code available in the ISO20022
list of Purpose Codes.
type: string
minLength: 1
maxLength: 140
ChargeBearer:
$ref: '#/definitions/OBChargeBearerType1Code'
CurrencyOfTransfer:
description: Specifies the currency of the to be transferred amount,
which is different from the currency of the debtor's account.
type: string
pattern: ^[A-Z]{3,3}$
DestinationCountryCode:
description: Country in which Credit Account is domiciled. Code to
identify a country, a dependency, or another area of particular
geopolitical interest, on the basis of country names obtained from
the United Nations (ISO 3166, Alpha-2 code).
type: string
pattern: '[A-Z]{2,2}'
InstructedAmount:
type: object
additionalProperties: false
required:
- Amount
- Currency
description: |-
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.
properties:
Amount:
$ref: '#/definitions/OBActiveCurrencyAndAmount_SimpleType'
Currency:
$ref: '#/definitions/ActiveOrHistoricCurrencyCode'
DebtorAccount:
type: object
additionalProperties: false
required:
- SchemeName
- Identification
description: Provides the details to identify the debtor account.
properties:
SchemeName:
$ref: '#/definitions/OBExternalAccountIdentification4Code'
Identification:
$ref: '#/definitions/Identification_0'
Name:
description: |-
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.
type: string
minLength: 1
maxLength: 350
SecondaryIdentification:
$ref: '#/definitions/SecondaryIdentification'
Creditor:
type: object
additionalProperties: false
description: Party to which an amount of money is due.
properties:
Name:
description: Name by which a party is known and which is usually
used to identify that party.
type: string
minLength: 1
maxLength: 350
PostalAddress:
$ref: '#/definitions/OBPostalAddress6'
CreditorAgent:
type: object
additionalProperties: false
description: |-
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.
properties:
SchemeName:
$ref: '#/definitions/OBExternalFinancialInstitutionIdentification4Code'
Identification:
description: Unique and unambiguous identification of the servicing
institution.
type: string
minLength: 1
maxLength: 35
Name:
$ref: '#/definitions/Name'
PostalAddress:
$ref: '#/definitions/OBPostalAddress6'
CreditorAccount:
type: object
additionalProperties: false
required:
- SchemeName
- Identification
- Name
description: Provides the details to identify the beneficiary account.
properties:
SchemeName:
$ref: '#/definitions/OBExternalAccountIdentification4Code'
Identification:
$ref: '#/definitions/Identification_0'
Name:
description: |-
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.
type: string
minLength: 1
maxLength: 350
SecondaryIdentification:
$ref: '#/definitions/SecondaryIdentification'
SupplementaryData:
$ref: '#/definitions/OBSupplementaryData1'
MultiAuthorisation:
type: object
additionalProperties: false
required:
- Status
description: The multiple authorisation flow response from the ASPSP.
properties:
Status:
description: Specifies the status of the authorisation flow in code
form.
type: string
enum:
- Authorised
- AwaitingFurtherAuthorisation
- Rejected
NumberRequired:
description: Number of authorisations required for payment order (total
required at the start of the multi authorisation journey).
type: integer
NumberReceived:
description: Number of authorisations received.
type: integer
LastUpdateDateTime:
description: "Last date and time at the authorisation flow was updated.All
dates in the JSON payloads are represented in ISO 8601 date-time
format. \nAll date-time fields in responses must include the timezone.
An example is below:\n2017-04-05T10:43:07+00:00"
type: string
format: date-time
ExpirationDateTime:
description: "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. \nAll date-time fields in responses
must include the timezone. An example is below:\n2017-04-05T10:43:07+00:00"
type: string
format: date-time
Debtor:
$ref: '#/definitions/OBDebtorIdentification1'
Links:
$ref: '#/definitions/Links'
Meta:
$ref: '#/definitions/Meta'
OBWritePaymentDetailsResponse1:
type: object
additionalProperties: false
required:
- Data
properties:
Data:
type: object
additionalProperties: false
properties:
PaymentStatus:
type: array
items:
type: object
additionalProperties: false
description: Payment status details.
required:
- PaymentTransactionId
- Status
- StatusUpdateDateTime
properties:
PaymentTransactionId:
description: Unique identifier for the transaction within an servicing
institution. This identifier is both unique and immutable.
type: string
minLength: 1
maxLength: 210
Status:
description: Status of a transfe, as assigned by the transaction
administrator.
type: string
enum:
- Accepted
- AcceptedCancellationRequest
- AcceptedCreditSettlementCompleted
- AcceptedCustomerProfile
- AcceptedFundsChecked
- AcceptedSettlementCompleted
- AcceptedSettlementInProcess
- AcceptedTechnicalValidation
- AcceptedWithChange
- AcceptedWithoutPosting
- Cancelled
- NoCancellationProcess
- PartiallyAcceptedCancellationRequest
- PartiallyAcceptedTechnicalCorrect
- PaymentCancelled
- Pending
- PendingCancellationRequest
- Received
- Rejected
- RejectedCancellationRequest
StatusUpdateDateTime:
description: "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. \nAll date-time fields in responses
must include the timezone. An example is below:\n2017-04-05T10:43:07+00:00"
type: string
format: date-time
StatusDetail:
type: object
additionalProperties: false
required:
- Status
description: Payment status details as per underlying Payment Rail.
properties:
LocalInstrument:
$ref: '#/definitions/OBExternalLocalInstrument1Code'
Status:
description: Status of a transfer, as assigned by the transaction
administrator.
type: string
minLength: 1
maxLength: 128
StatusReason:
description: Reason Code provided for the status of a transfer.
type: string
enum:
- Cancelled
- PendingFailingSettlement
- PendingSettlement
- Proprietary
- ProprietaryRejection
- Suspended
- Unmatched
StatusReasonDescription:
description: Reason provided for the status of a transfer.
type: string
minLength: 1
maxLength: 256
Links:
$ref: '#/definitions/Links'
Meta:
$ref: '#/definitions/Meta'
PostCode:
description: Identifier consisting of a group of letters and/or numbers that is
added to a postal address to assist the sorting of mail.
type: string
minLength: 1
maxLength: 16
SecondaryIdentification:
description: "This is secondary identification of the account, as assigned by
the account servicing institution. \nThis can be used by building societies
to additionally identify accounts with a roll number (in addition to a sort
code and account number combination)."
type: string
minLength: 1
maxLength: 34
StreetName:
description: Name of a street or thoroughfare.
type: string
minLength: 1
maxLength: 70
SubDepartment:
description: Identification of a sub-division of a large organisation or building.
type: string
minLength: 1
maxLength: 70
TownName:
description: Name of a built-up area, with defined boundaries, and a local government.
type: string
minLength: 1
maxLength: 35
x-ibm-configuration:
enforced: true
testable: true
phase: specified
categories:
- Type / Experience
- SanUK Business Domain / Common Services & Guidance / Payments
- BIAN Business Area / NA
- BIAN Business Domain / NA
- BIAN Service Domain / NA
security:
- PSUOAuth2Security:
- payments
TPPOAuth2Security:
- payments
x-ibm-endpoints:
- endpointUrl: https://openbanking-ma.santander.co.uk/sanuk/external
description: Endpoint for Open Banking TLS MA only
type:
- production
...