Domestic Payments
Payment Details
Domestic Scheduled Payments
Domestic Standing Orders
File Payments
International Payments
International Scheduled Payments
International Standing Orders
Swagger for Payment Initiation API Specification
Service Desk
production
https://api.nedbank.co.za/apimarket/sandbox
Paths
/domestic-payment-consents
/domestic-payment-consents/{ConsentId}
/domestic-payment-consents/{ConsentId}/funds-confirmation
/domestic-payments
post /domestic-payments
Domestic Payments
CreateDomesticPayments
Create Domestic Payments
PSUOAuth2Security
PSUOAuth2Security
(oauth2 accessCode)
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
Authorization URL
https://api.nedbank.co.za/apimarket/sandbox/oauth/oauth20/authorize
Token URL
https://api.nedbank.co.za/apimarket/sandbox/nboauth/oauth20/token
Scopes
payments
Ability to do the payment submission
x-fapi-auth-date
Optional in header
string
The time when the PSU last logged in with the TPP. All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: Sun, 10 Sep 2017 19:43:31 UTC
{
"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-customer-ip-address
Optional in header
string
The PSU's IP address if the PSU is currently logged in with the TPP.
x-fapi-interaction-id
Optional in header
string
An RFC4122 UID used as a correlation id.
Authorization
Required in header
string
An Authorisation Token as per https://tools.ietf.org/html/rfc6750
x-idempotency-key
Required in header
string
Every request will be processed only once per x-idempotency-key. The Idempotency Key will be valid for 24 hours.
{
"maxLength": 40,
"pattern": "^(?!\\s)(.*)(\\S)$"
}x-jws-signature
Required in header
string
A detached JWS signature of the body of the payload.
x-customer-user-agent
Optional in header
string
Indicates the user-agent that the PSU is using.
Content-Type
Optional in header
string
{
"enum": [
"application\/json; charset=utf-8"
]
}body
Required in body
object
Default
Accept
Optional in header
string
application/json; charset=utf-8
application/json
application/jose+jwe
application/json
application/jose+jwe
201
Domestic Payments Created
400
Bad request
401
Unauthorized
403
Forbidden
405
Method Not Allowed
406
Not Acceptable
415
Unsupported Media Type
429
Too Many Requests
500
Internal Server Error
Example Request
Example Response
POST https://api.nedbank.co.za/apimarket/sandbox/open-banking/v3.1/pisp/domestic-payments
Try this operation
/domestic-payments/{DomesticPaymentId}
get /domestic-payments/{DomesticPaymentId}
Domestic Payments
GetDomesticPaymentsDomesticPaymentId
Get Domestic Payments
TPPOAuth2Security
TPPOAuth2Security
(oauth2 application)
TPP client credential authorisation flow with the ASPSP
Token URL
https://api.nedbank.co.za/apimarket/sandbox/nboauth/oauth20/token
Scopes
payments
Generic payment scope
DomesticPaymentId
Required in path
string
DomesticPaymentId
x-fapi-auth-date
Optional in header
string
The time when the PSU last logged in with the TPP. All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: Sun, 10 Sep 2017 19:43:31 UTC
{
"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-customer-ip-address
Optional in header
string
The PSU's IP address if the PSU is currently logged in with the TPP.
x-fapi-interaction-id
Optional in header
string
An RFC4122 UID used as a correlation id.
Authorization
Required in header
string
An Authorisation Token as per https://tools.ietf.org/html/rfc6750
x-customer-user-agent
Optional in header
string
Indicates the user-agent that the PSU is using.
Accept
Optional in header
string
application/json; charset=utf-8
application/json
application/jose+jwe
application/json
application/jose+jwe
200
Domestic Payments Read
400
Bad request
401
Unauthorized
403
Forbidden
405
Method Not Allowed
406
Not Acceptable
429
Too Many Requests
500
Internal Server Error
Example Request
Example Response
GET https://api.nedbank.co.za/apimarket/sandbox/open-banking/v3.1/pisp/domestic-payments/{DomesticPaymentId}
Try this operation
/domestic-payments/{DomesticPaymentId}/payment-details
get /domestic-payments/{DomesticPaymentId}/payment-details
Payment Details
GetDomesticPaymentsDomesticPaymentIdPaymentDetails
Get Payment Details
TPPOAuth2Security
TPPOAuth2Security
(oauth2 application)
TPP client credential authorisation flow with the ASPSP
Token URL
https://api.nedbank.co.za/apimarket/sandbox/nboauth/oauth20/token
Scopes
payments
Generic payment scope
DomesticPaymentId
Required in path
string
DomesticPaymentId
x-fapi-auth-date
Optional in header
string
The time when the PSU last logged in with the TPP. All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: Sun, 10 Sep 2017 19:43:31 UTC
{
"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-customer-ip-address
Optional in header
string
The PSU's IP address if the PSU is currently logged in with the TPP.
x-fapi-interaction-id
Optional in header
string
An RFC4122 UID used as a correlation id.
Authorization
Required in header
string
An Authorisation Token as per https://tools.ietf.org/html/rfc6750
x-customer-user-agent
Optional in header
string
Indicates the user-agent that the PSU is using.
Accept
Optional in header
string
application/json; charset=utf-8
application/json
application/jose+jwe
application/json
application/jose+jwe
200
Payment Details Read
400
Bad request
401
Unauthorized
403
Forbidden
404
Not found
405
Method Not Allowed
406
Not Acceptable
429
Too Many Requests
500
Internal Server Error
Example Request
Example Response
GET https://api.nedbank.co.za/apimarket/sandbox/open-banking/v3.1/pisp/domestic-payments/{DomesticPaymentId}/payment-details
Try this operation
/domestic-scheduled-payments/{DomesticScheduledPaymentId}/payment-details
get /domestic-scheduled-payments/{DomesticScheduledPaymentId}/payment-details
Payment Details
GetDomesticScheduledPaymentsDomesticScheduledPaymentIdPaymentDetails
Get Payment Details
TPPOAuth2Security
TPPOAuth2Security
(oauth2 application)
TPP client credential authorisation flow with the ASPSP
Token URL
https://api.nedbank.co.za/apimarket/sandbox/nboauth/oauth20/token
Scopes
payments
Generic payment scope
DomesticScheduledPaymentId
Required in path
string
DomesticScheduledPaymentId
x-fapi-auth-date
Optional in header
string
The time when the PSU last logged in with the TPP. All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: Sun, 10 Sep 2017 19:43:31 UTC
{
"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-customer-ip-address
Optional in header
string
The PSU's IP address if the PSU is currently logged in with the TPP.
x-fapi-interaction-id
Optional in header
string
An RFC4122 UID used as a correlation id.
Authorization
Required in header
string
An Authorisation Token as per https://tools.ietf.org/html/rfc6750
x-customer-user-agent
Optional in header
string
Indicates the user-agent that the PSU is using.
Accept
Optional in header
string
application/json; charset=utf-8
application/json
application/jose+jwe
application/json
application/jose+jwe
200
Payment Details Read
400
Bad request
401
Unauthorized
403
Forbidden
404
Not found
405
Method Not Allowed
406
Not Acceptable
429
Too Many Requests
500
Internal Server Error
Example Request
Example Response
GET https://api.nedbank.co.za/apimarket/sandbox/open-banking/v3.1/pisp/domestic-scheduled-payments/{DomesticScheduledPaymentId}/payment-details
Try this operation
/domestic-standing-orders/{DomesticStandingOrderId}/payment-details
get /domestic-standing-orders/{DomesticStandingOrderId}/payment-details
Payment Details
GetDomesticStandingOrdersDomesticStandingOrderIdPaymentDetails
Get Payment Details
TPPOAuth2Security
TPPOAuth2Security
(oauth2 application)
TPP client credential authorisation flow with the ASPSP
Token URL
https://api.nedbank.co.za/apimarket/sandbox/nboauth/oauth20/token
Scopes
payments
Generic payment scope
DomesticStandingOrderId
Required in path
string
DomesticStandingOrderId
x-fapi-auth-date
Optional in header
string
The time when the PSU last logged in with the TPP. All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: Sun, 10 Sep 2017 19:43:31 UTC
{
"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-customer-ip-address
Optional in header
string
The PSU's IP address if the PSU is currently logged in with the TPP.
x-fapi-interaction-id
Optional in header
string
An RFC4122 UID used as a correlation id.
Authorization
Required in header
string
An Authorisation Token as per https://tools.ietf.org/html/rfc6750
x-customer-user-agent
Optional in header
string
Indicates the user-agent that the PSU is using.
Accept
Optional in header
string
application/json; charset=utf-8
application/json
application/jose+jwe
application/json
application/jose+jwe
200
Payment Details Read
400
Bad request
401
Unauthorized
403
Forbidden
404
Not found
405
Method Not Allowed
406
Not Acceptable
429
Too Many Requests
500
Internal Server Error
Example Request
Example Response
GET https://api.nedbank.co.za/apimarket/sandbox/open-banking/v3.1/pisp/domestic-standing-orders/{DomesticStandingOrderId}/payment-details
Try this operation
/file-payments/{FilePaymentId}/payment-details
get /file-payments/{FilePaymentId}/payment-details
Payment Details
GetFilePaymentsFilePaymentIdPaymentDetails
Get Payment Details
TPPOAuth2Security
TPPOAuth2Security
(oauth2 application)
TPP client credential authorisation flow with the ASPSP
Token URL
https://api.nedbank.co.za/apimarket/sandbox/nboauth/oauth20/token
Scopes
payments
Generic payment scope
FilePaymentId
Required in path
string
FilePaymentId
x-fapi-auth-date
Optional in header
string
The time when the PSU last logged in with the TPP. All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: Sun, 10 Sep 2017 19:43:31 UTC
{
"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-customer-ip-address
Optional in header
string
The PSU's IP address if the PSU is currently logged in with the TPP.
x-fapi-interaction-id
Optional in header
string
An RFC4122 UID used as a correlation id.
Authorization
Required in header
string
An Authorisation Token as per https://tools.ietf.org/html/rfc6750
x-customer-user-agent
Optional in header
string
Indicates the user-agent that the PSU is using.
Accept
Optional in header
string
application/json; charset=utf-8
application/json
application/jose+jwe
application/json
application/jose+jwe
200
Payment Details Read
400
Bad request
401
Unauthorized
403
Forbidden
404
Not found
405
Method Not Allowed
406
Not Acceptable
429
Too Many Requests
500
Internal Server Error
Example Request
Example Response
GET https://api.nedbank.co.za/apimarket/sandbox/open-banking/v3.1/pisp/file-payments/{FilePaymentId}/payment-details
Try this operation
/international-payments/{InternationalPaymentId}/payment-details
get /international-payments/{InternationalPaymentId}/payment-details
Payment Details
GetInternationalPaymentsInternationalPaymentIdPaymentDetails
Get Payment Details
TPPOAuth2Security
TPPOAuth2Security
(oauth2 application)
TPP client credential authorisation flow with the ASPSP
Token URL
https://api.nedbank.co.za/apimarket/sandbox/nboauth/oauth20/token
Scopes
payments
Generic payment scope
InternationalPaymentId
Required in path
string
InternationalPaymentId
x-fapi-auth-date
Optional in header
string
The time when the PSU last logged in with the TPP. All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: Sun, 10 Sep 2017 19:43:31 UTC
{
"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-customer-ip-address
Optional in header
string
The PSU's IP address if the PSU is currently logged in with the TPP.
x-fapi-interaction-id
Optional in header
string
An RFC4122 UID used as a correlation id.
Authorization
Required in header
string
An Authorisation Token as per https://tools.ietf.org/html/rfc6750
x-customer-user-agent
Optional in header
string
Indicates the user-agent that the PSU is using.
Accept
Optional in header
string
application/json; charset=utf-8
application/json
application/jose+jwe
application/json
application/jose+jwe
200
Payment Details Read
400
Bad request
401
Unauthorized
403
Forbidden
404
Not found
405
Method Not Allowed
406
Not Acceptable
429
Too Many Requests
500
Internal Server Error
Example Request
Example Response
GET https://api.nedbank.co.za/apimarket/sandbox/open-banking/v3.1/pisp/international-payments/{InternationalPaymentId}/payment-details
Try this operation
/international-scheduled-payments/{InternationalScheduledPaymentId}/payment-details
get /international-scheduled-payments/{InternationalScheduledPaymentId}/payment-details
Payment Details
GetInternationalScheduledPaymentsInternationalScheduledPaymentIdPaymentDetails
Get Payment Details
TPPOAuth2Security
TPPOAuth2Security
(oauth2 application)
TPP client credential authorisation flow with the ASPSP
Token URL
https://api.nedbank.co.za/apimarket/sandbox/nboauth/oauth20/token
Scopes
payments
Generic payment scope
InternationalScheduledPaymentId
Required in path
string
InternationalScheduledPaymentId
x-fapi-auth-date
Optional in header
string
The time when the PSU last logged in with the TPP. All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: Sun, 10 Sep 2017 19:43:31 UTC
{
"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-customer-ip-address
Optional in header
string
The PSU's IP address if the PSU is currently logged in with the TPP.
x-fapi-interaction-id
Optional in header
string
An RFC4122 UID used as a correlation id.
Authorization
Required in header
string
An Authorisation Token as per https://tools.ietf.org/html/rfc6750
x-customer-user-agent
Optional in header
string
Indicates the user-agent that the PSU is using.
Accept
Optional in header
string
application/json; charset=utf-8
application/json
application/jose+jwe
application/json
application/jose+jwe
200
Payment Details Read
400
Bad request
401
Unauthorized
403
Forbidden
404
Not found
405
Method Not Allowed
406
Not Acceptable
429
Too Many Requests
500
Internal Server Error
Example Request
Example Response
GET https://api.nedbank.co.za/apimarket/sandbox/open-banking/v3.1/pisp/international-scheduled-payments/{InternationalScheduledPaymentId}/payment-details
Try this operation
/international-standing-orders/{InternationalStandingOrderPaymentId}/payment-details
get /international-standing-orders/{InternationalStandingOrderPaymentId}/payment-details
Payment Details
GetInternationalStandingOrdersInternationalStandingOrderPaymentIdPaymentDetails
Get Payment Details
TPPOAuth2Security
TPPOAuth2Security
(oauth2 application)
TPP client credential authorisation flow with the ASPSP
Token URL
https://api.nedbank.co.za/apimarket/sandbox/nboauth/oauth20/token
Scopes
payments
Generic payment scope
InternationalStandingOrderPaymentId
Required in path
string
InternationalStandingOrderPaymentId
x-fapi-auth-date
Optional in header
string
The time when the PSU last logged in with the TPP. All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: Sun, 10 Sep 2017 19:43:31 UTC
{
"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-customer-ip-address
Optional in header
string
The PSU's IP address if the PSU is currently logged in with the TPP.
x-fapi-interaction-id
Optional in header
string
An RFC4122 UID used as a correlation id.
Authorization
Required in header
string
An Authorisation Token as per https://tools.ietf.org/html/rfc6750
x-customer-user-agent
Optional in header
string
Indicates the user-agent that the PSU is using.
Accept
Optional in header
string
application/json; charset=utf-8
application/json
application/jose+jwe
application/json
application/jose+jwe
200
Payment Details Read
400
Bad request
401
Unauthorized
403
Forbidden
404
Not found
405
Method Not Allowed
406
Not Acceptable
429
Too Many Requests
500
Internal Server Error
Example Request
Example Response
GET https://api.nedbank.co.za/apimarket/sandbox/open-banking/v3.1/pisp/international-standing-orders/{InternationalStandingOrderPaymentId}/payment-details
Try this operation
/domestic-scheduled-payment-consents
/domestic-scheduled-payment-consents/{ConsentId}
/domestic-scheduled-payments
post /domestic-scheduled-payments
Domestic Scheduled Payments
CreateDomesticScheduledPayments
Create Domestic Scheduled Payments
PSUOAuth2Security
PSUOAuth2Security
(oauth2 accessCode)
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
Authorization URL
https://api.nedbank.co.za/apimarket/sandbox/oauth/oauth20/authorize
Token URL
https://api.nedbank.co.za/apimarket/sandbox/nboauth/oauth20/token
Scopes
payments
Ability to do the payment submission
x-fapi-auth-date
Optional in header
string
The time when the PSU last logged in with the TPP. All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: Sun, 10 Sep 2017 19:43:31 UTC
{
"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-customer-ip-address
Optional in header
string
The PSU's IP address if the PSU is currently logged in with the TPP.
x-fapi-interaction-id
Optional in header
string
An RFC4122 UID used as a correlation id.
Authorization
Required in header
string
An Authorisation Token as per https://tools.ietf.org/html/rfc6750
x-idempotency-key
Required in header
string
Every request will be processed only once per x-idempotency-key. The Idempotency Key will be valid for 24 hours.
{
"maxLength": 40,
"pattern": "^(?!\\s)(.*)(\\S)$"
}x-jws-signature
Required in header
string
A detached JWS signature of the body of the payload.
x-customer-user-agent
Optional in header
string
Indicates the user-agent that the PSU is using.
Content-Type
Optional in header
string
{
"enum": [
"application\/json; charset=utf-8"
]
}body
Required in body
object
Default
Accept
Optional in header
string
application/json; charset=utf-8
application/json
application/jose+jwe
application/json
application/jose+jwe
201
Domestic Scheduled Payments Created
400
Bad request
401
Unauthorized
403
Forbidden
404
Not found
405
Method Not Allowed
406
Not Acceptable
415
Unsupported Media Type
429
Too Many Requests
500
Internal Server Error
Example Request
Example Response
POST https://api.nedbank.co.za/apimarket/sandbox/open-banking/v3.1/pisp/domestic-scheduled-payments
Try this operation
/domestic-scheduled-payments/{DomesticScheduledPaymentId}
get /domestic-scheduled-payments/{DomesticScheduledPaymentId}
Domestic Scheduled Payments
GetDomesticScheduledPaymentsDomesticScheduledPaymentId
Get Domestic Scheduled Payments
TPPOAuth2Security
TPPOAuth2Security
(oauth2 application)
TPP client credential authorisation flow with the ASPSP
Token URL
https://api.nedbank.co.za/apimarket/sandbox/nboauth/oauth20/token
Scopes
payments
Generic payment scope
DomesticScheduledPaymentId
Required in path
string
DomesticScheduledPaymentId
x-fapi-auth-date
Optional in header
string
The time when the PSU last logged in with the TPP. All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: Sun, 10 Sep 2017 19:43:31 UTC
{
"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-customer-ip-address
Optional in header
string
The PSU's IP address if the PSU is currently logged in with the TPP.
x-fapi-interaction-id
Optional in header
string
An RFC4122 UID used as a correlation id.
Authorization
Required in header
string
An Authorisation Token as per https://tools.ietf.org/html/rfc6750
x-customer-user-agent
Optional in header
string
Indicates the user-agent that the PSU is using.
Accept
Optional in header
string
application/json; charset=utf-8
application/json
application/jose+jwe
application/json
application/jose+jwe
200
Domestic Scheduled Payments Read
400
Bad request
401
Unauthorized
403
Forbidden
404
Not found
405
Method Not Allowed
406
Not Acceptable
429
Too Many Requests
500
Internal Server Error
Example Request
Example Response
GET https://api.nedbank.co.za/apimarket/sandbox/open-banking/v3.1/pisp/domestic-scheduled-payments/{DomesticScheduledPaymentId}
Try this operation
/domestic-standing-order-consents
/domestic-standing-order-consents/{ConsentId}
/domestic-standing-orders
post /domestic-standing-orders
Domestic Standing Orders
CreateDomesticStandingOrders
Create Domestic Standing Orders
PSUOAuth2Security
PSUOAuth2Security
(oauth2 accessCode)
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
Authorization URL
https://api.nedbank.co.za/apimarket/sandbox/oauth/oauth20/authorize
Token URL
https://api.nedbank.co.za/apimarket/sandbox/nboauth/oauth20/token
Scopes
payments
Ability to do the payment submission
x-fapi-auth-date
Optional in header
string
The time when the PSU last logged in with the TPP. All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: Sun, 10 Sep 2017 19:43:31 UTC
{
"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-customer-ip-address
Optional in header
string
The PSU's IP address if the PSU is currently logged in with the TPP.
x-fapi-interaction-id
Optional in header
string
An RFC4122 UID used as a correlation id.
Authorization
Required in header
string
An Authorisation Token as per https://tools.ietf.org/html/rfc6750
x-idempotency-key
Required in header
string
Every request will be processed only once per x-idempotency-key. The Idempotency Key will be valid for 24 hours.
{
"maxLength": 40,
"pattern": "^(?!\\s)(.*)(\\S)$"
}x-jws-signature
Required in header
string
A detached JWS signature of the body of the payload.
x-customer-user-agent
Optional in header
string
Indicates the user-agent that the PSU is using.
Content-Type
Optional in header
string
{
"enum": [
"application\/json; charset=utf-8"
]
}body
Required in body
object
Default
Accept
Optional in header
string
application/json; charset=utf-8
application/json
application/jose+jwe
application/json
application/jose+jwe
201
Domestic Standing Orders Created
400
Bad request
401
Unauthorized
403
Forbidden
404
Not found
405
Method Not Allowed
406
Not Acceptable
415
Unsupported Media Type
429
Too Many Requests
500
Internal Server Error
Example Request
Example Response
POST https://api.nedbank.co.za/apimarket/sandbox/open-banking/v3.1/pisp/domestic-standing-orders
Try this operation
/domestic-standing-orders/{DomesticStandingOrderId}
get /domestic-standing-orders/{DomesticStandingOrderId}
Domestic Standing Orders
GetDomesticStandingOrdersDomesticStandingOrderId
Get Domestic Standing Orders
TPPOAuth2Security
TPPOAuth2Security
(oauth2 application)
TPP client credential authorisation flow with the ASPSP
Token URL
https://api.nedbank.co.za/apimarket/sandbox/nboauth/oauth20/token
Scopes
payments
Generic payment scope
DomesticStandingOrderId
Required in path
string
DomesticStandingOrderId
x-fapi-auth-date
Optional in header
string
The time when the PSU last logged in with the TPP. All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: Sun, 10 Sep 2017 19:43:31 UTC
{
"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-customer-ip-address
Optional in header
string
The PSU's IP address if the PSU is currently logged in with the TPP.
x-fapi-interaction-id
Optional in header
string
An RFC4122 UID used as a correlation id.
Authorization
Required in header
string
An Authorisation Token as per https://tools.ietf.org/html/rfc6750
x-customer-user-agent
Optional in header
string
Indicates the user-agent that the PSU is using.
Accept
Optional in header
string
application/json; charset=utf-8
application/json
application/jose+jwe
application/json
application/jose+jwe
200
Domestic Standing Orders Read
400
Bad request
401
Unauthorized
403
Forbidden
404
Not found
405
Method Not Allowed
406
Not Acceptable
429
Too Many Requests
500
Internal Server Error
Example Request
Example Response
GET https://api.nedbank.co.za/apimarket/sandbox/open-banking/v3.1/pisp/domestic-standing-orders/{DomesticStandingOrderId}
Try this operation
/file-payment-consents
/file-payment-consents/{ConsentId}
/file-payment-consents/{ConsentId}/file
/file-payments
post /file-payments
File Payments
CreateFilePayments
Create File Payments
PSUOAuth2Security
PSUOAuth2Security
(oauth2 accessCode)
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
Authorization URL
https://api.nedbank.co.za/apimarket/sandbox/oauth/oauth20/authorize
Token URL
https://api.nedbank.co.za/apimarket/sandbox/nboauth/oauth20/token
Scopes
payments
Ability to do the payment submission
x-fapi-auth-date
Optional in header
string
The time when the PSU last logged in with the TPP. All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: Sun, 10 Sep 2017 19:43:31 UTC
{
"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-customer-ip-address
Optional in header
string
The PSU's IP address if the PSU is currently logged in with the TPP.
x-fapi-interaction-id
Optional in header
string
An RFC4122 UID used as a correlation id.
Authorization
Required in header
string
An Authorisation Token as per https://tools.ietf.org/html/rfc6750
x-idempotency-key
Required in header
string
Every request will be processed only once per x-idempotency-key. The Idempotency Key will be valid for 24 hours.
{
"maxLength": 40,
"pattern": "^(?!\\s)(.*)(\\S)$"
}x-jws-signature
Required in header
string
A detached JWS signature of the body of the payload.
x-customer-user-agent
Optional in header
string
Indicates the user-agent that the PSU is using.
Content-Type
Optional in header
string
{
"enum": [
"application\/json; charset=utf-8"
]
}body
Required in body
object
Default
Accept
Optional in header
string
application/json; charset=utf-8
application/json
application/jose+jwe
application/json
application/jose+jwe
201
File Payments Created
400
Bad request
401
Unauthorized
403
Forbidden
404
Not found
405
Method Not Allowed
406
Not Acceptable
415
Unsupported Media Type
429
Too Many Requests
500
Internal Server Error
Example Request
Example Response
POST https://api.nedbank.co.za/apimarket/sandbox/open-banking/v3.1/pisp/file-payments
Try this operation
/file-payments/{FilePaymentId}
get /file-payments/{FilePaymentId}
File Payments
GetFilePaymentsFilePaymentId
Get File Payments
TPPOAuth2Security
TPPOAuth2Security
(oauth2 application)
TPP client credential authorisation flow with the ASPSP
Token URL
https://api.nedbank.co.za/apimarket/sandbox/nboauth/oauth20/token
Scopes
payments
Generic payment scope
FilePaymentId
Required in path
string
FilePaymentId
x-fapi-auth-date
Optional in header
string
The time when the PSU last logged in with the TPP. All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: Sun, 10 Sep 2017 19:43:31 UTC
{
"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-customer-ip-address
Optional in header
string
The PSU's IP address if the PSU is currently logged in with the TPP.
x-fapi-interaction-id
Optional in header
string
An RFC4122 UID used as a correlation id.
Authorization
Required in header
string
An Authorisation Token as per https://tools.ietf.org/html/rfc6750
x-customer-user-agent
Optional in header
string
Indicates the user-agent that the PSU is using.
Accept
Optional in header
string
application/json; charset=utf-8
application/json
application/jose+jwe
application/json
application/jose+jwe
200
File Payments Read
400
Bad request
401
Unauthorized
403
Forbidden
404
Not found
405
Method Not Allowed
406
Not Acceptable
429
Too Many Requests
500
Internal Server Error
Example Request
Example Response
GET https://api.nedbank.co.za/apimarket/sandbox/open-banking/v3.1/pisp/file-payments/{FilePaymentId}
Try this operation
/file-payments/{FilePaymentId}/report-file
get /file-payments/{FilePaymentId}/report-file
File Payments
GetFilePaymentsFilePaymentIdReportFile
Get File Payments
TPPOAuth2Security
TPPOAuth2Security
(oauth2 application)
TPP client credential authorisation flow with the ASPSP
Token URL
https://api.nedbank.co.za/apimarket/sandbox/nboauth/oauth20/token
Scopes
payments
Generic payment scope
FilePaymentId
Required in path
string
FilePaymentId
x-fapi-auth-date
Optional in header
string
The time when the PSU last logged in with the TPP. All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: Sun, 10 Sep 2017 19:43:31 UTC
{
"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-customer-ip-address
Optional in header
string
The PSU's IP address if the PSU is currently logged in with the TPP.
x-fapi-interaction-id
Optional in header
string
An RFC4122 UID used as a correlation id.
Authorization
Required in header
string
An Authorisation Token as per https://tools.ietf.org/html/rfc6750
x-customer-user-agent
Optional in header
string
Indicates the user-agent that the PSU is using.
Accept
Optional in header
string
application/json; charset=utf-8
application/json
application/jose+jwe
application/json
application/jose+jwe
200
File Payments Read
400
Bad request
401
Unauthorized
403
Forbidden
404
Not found
405
Method Not Allowed
406
Not Acceptable
429
Too Many Requests
500
Internal Server Error
Example Request
Example Response
GET https://api.nedbank.co.za/apimarket/sandbox/open-banking/v3.1/pisp/file-payments/{FilePaymentId}/report-file
Try this operation
/international-payment-consents
/international-payment-consents/{ConsentId}
/international-payment-consents/{ConsentId}/funds-confirmation
/international-payments
post /international-payments
International Payments
CreateInternationalPayments
Create International Payments
PSUOAuth2Security
PSUOAuth2Security
(oauth2 accessCode)
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
Authorization URL
https://api.nedbank.co.za/apimarket/sandbox/oauth/oauth20/authorize
Token URL
https://api.nedbank.co.za/apimarket/sandbox/nboauth/oauth20/token
Scopes
payments
Ability to do the payment submission
x-fapi-auth-date
Optional in header
string
The time when the PSU last logged in with the TPP. All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: Sun, 10 Sep 2017 19:43:31 UTC
{
"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-customer-ip-address
Optional in header
string
The PSU's IP address if the PSU is currently logged in with the TPP.
x-fapi-interaction-id
Optional in header
string
An RFC4122 UID used as a correlation id.
Authorization
Required in header
string
An Authorisation Token as per https://tools.ietf.org/html/rfc6750
x-idempotency-key
Required in header
string
Every request will be processed only once per x-idempotency-key. The Idempotency Key will be valid for 24 hours.
{
"maxLength": 40,
"pattern": "^(?!\\s)(.*)(\\S)$"
}x-jws-signature
Required in header
string
A detached JWS signature of the body of the payload.
x-customer-user-agent
Optional in header
string
Indicates the user-agent that the PSU is using.
Content-Type
Optional in header
string
{
"enum": [
"application\/json; charset=utf-8"
]
}body
Required in body
object
Default
Accept
Optional in header
string
application/json; charset=utf-8
application/json
application/jose+jwe
application/json
application/jose+jwe
201
International Payments Created
400
Bad request
401
Unauthorized
403
Forbidden
404
Not found
405
Method Not Allowed
406
Not Acceptable
415
Unsupported Media Type
429
Too Many Requests
500
Internal Server Error
Example Request
Example Response
POST https://api.nedbank.co.za/apimarket/sandbox/open-banking/v3.1/pisp/international-payments
Try this operation
/international-payments/{InternationalPaymentId}
get /international-payments/{InternationalPaymentId}
International Payments
GetInternationalPaymentsInternationalPaymentId
Get International Payments
TPPOAuth2Security
TPPOAuth2Security
(oauth2 application)
TPP client credential authorisation flow with the ASPSP
Token URL
https://api.nedbank.co.za/apimarket/sandbox/nboauth/oauth20/token
Scopes
payments
Generic payment scope
InternationalPaymentId
Required in path
string
InternationalPaymentId
x-fapi-auth-date
Optional in header
string
The time when the PSU last logged in with the TPP. All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: Sun, 10 Sep 2017 19:43:31 UTC
{
"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-customer-ip-address
Optional in header
string
The PSU's IP address if the PSU is currently logged in with the TPP.
x-fapi-interaction-id
Optional in header
string
An RFC4122 UID used as a correlation id.
Authorization
Required in header
string
An Authorisation Token as per https://tools.ietf.org/html/rfc6750
x-customer-user-agent
Optional in header
string
Indicates the user-agent that the PSU is using.
Accept
Optional in header
string
application/json; charset=utf-8
application/json
application/jose+jwe
application/json
application/jose+jwe
200
International Payments Read
400
Bad request
401
Unauthorized
403
Forbidden
404
Not found
405
Method Not Allowed
406
Not Acceptable
429
Too Many Requests
500
Internal Server Error
Example Request
Example Response
GET https://api.nedbank.co.za/apimarket/sandbox/open-banking/v3.1/pisp/international-payments/{InternationalPaymentId}
Try this operation
/international-scheduled-payment-consents
/international-scheduled-payment-consents/{ConsentId}
/international-scheduled-payment-consents/{ConsentId}/funds-confirmation
/international-scheduled-payments
post /international-scheduled-payments
International Scheduled Payments
CreateInternationalScheduledPayments
Create International Scheduled Payments
PSUOAuth2Security
PSUOAuth2Security
(oauth2 accessCode)
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
Authorization URL
https://api.nedbank.co.za/apimarket/sandbox/oauth/oauth20/authorize
Token URL
https://api.nedbank.co.za/apimarket/sandbox/nboauth/oauth20/token
Scopes
payments
Ability to do the payment submission
x-fapi-auth-date
Optional in header
string
The time when the PSU last logged in with the TPP. All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: Sun, 10 Sep 2017 19:43:31 UTC
{
"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-customer-ip-address
Optional in header
string
The PSU's IP address if the PSU is currently logged in with the TPP.
x-fapi-interaction-id
Optional in header
string
An RFC4122 UID used as a correlation id.
Authorization
Required in header
string
An Authorisation Token as per https://tools.ietf.org/html/rfc6750
x-idempotency-key
Required in header
string
Every request will be processed only once per x-idempotency-key. The Idempotency Key will be valid for 24 hours.
{
"maxLength": 40,
"pattern": "^(?!\\s)(.*)(\\S)$"
}x-jws-signature
Required in header
string
A detached JWS signature of the body of the payload.
x-customer-user-agent
Optional in header
string
Indicates the user-agent that the PSU is using.
Content-Type
Optional in header
string
{
"enum": [
"application\/json; charset=utf-8"
]
}body
Required in body
object
Default
Accept
Optional in header
string
application/json; charset=utf-8
application/json
application/jose+jwe
application/json
application/jose+jwe
201
International Scheduled Payments Created
400
Bad request
401
Unauthorized
403
Forbidden
404
Not found
405
Method Not Allowed
406
Not Acceptable
415
Unsupported Media Type
429
Too Many Requests
500
Internal Server Error
Example Request
Example Response
POST https://api.nedbank.co.za/apimarket/sandbox/open-banking/v3.1/pisp/international-scheduled-payments
Try this operation
/international-scheduled-payments/{InternationalScheduledPaymentId}
get /international-scheduled-payments/{InternationalScheduledPaymentId}
International Scheduled Payments
GetInternationalScheduledPaymentsInternationalScheduledPaymentId
Get International Scheduled Payments
TPPOAuth2Security
TPPOAuth2Security
(oauth2 application)
TPP client credential authorisation flow with the ASPSP
Token URL
https://api.nedbank.co.za/apimarket/sandbox/nboauth/oauth20/token
Scopes
payments
Generic payment scope
InternationalScheduledPaymentId
Required in path
string
InternationalScheduledPaymentId
x-fapi-auth-date
Optional in header
string
The time when the PSU last logged in with the TPP. All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: Sun, 10 Sep 2017 19:43:31 UTC
{
"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-customer-ip-address
Optional in header
string
The PSU's IP address if the PSU is currently logged in with the TPP.
x-fapi-interaction-id
Optional in header
string
An RFC4122 UID used as a correlation id.
Authorization
Required in header
string
An Authorisation Token as per https://tools.ietf.org/html/rfc6750
x-customer-user-agent
Optional in header
string
Indicates the user-agent that the PSU is using.
Accept
Optional in header
string
application/json; charset=utf-8
application/json
application/jose+jwe
application/json
application/jose+jwe
200
International Scheduled Payments Read
400
Bad request
401
Unauthorized
403
Forbidden
404
Not found
405
Method Not Allowed
406
Not Acceptable
429
Too Many Requests
500
Internal Server Error
Example Request
Example Response
GET https://api.nedbank.co.za/apimarket/sandbox/open-banking/v3.1/pisp/international-scheduled-payments/{InternationalScheduledPaymentId}
Try this operation
/international-standing-order-consents
/international-standing-order-consents/{ConsentId}
/international-standing-orders
post /international-standing-orders
International Standing Orders
CreateInternationalStandingOrders
Create International Standing Orders
PSUOAuth2Security
PSUOAuth2Security
(oauth2 accessCode)
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
Authorization URL
https://api.nedbank.co.za/apimarket/sandbox/oauth/oauth20/authorize
Token URL
https://api.nedbank.co.za/apimarket/sandbox/nboauth/oauth20/token
Scopes
payments
Ability to do the payment submission
x-fapi-auth-date
Optional in header
string
The time when the PSU last logged in with the TPP. All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: Sun, 10 Sep 2017 19:43:31 UTC
{
"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-customer-ip-address
Optional in header
string
The PSU's IP address if the PSU is currently logged in with the TPP.
x-fapi-interaction-id
Optional in header
string
An RFC4122 UID used as a correlation id.
Authorization
Required in header
string
An Authorisation Token as per https://tools.ietf.org/html/rfc6750
x-idempotency-key
Required in header
string
Every request will be processed only once per x-idempotency-key. The Idempotency Key will be valid for 24 hours.
{
"maxLength": 40,
"pattern": "^(?!\\s)(.*)(\\S)$"
}x-jws-signature
Required in header
string
A detached JWS signature of the body of the payload.
x-customer-user-agent
Optional in header
string
Indicates the user-agent that the PSU is using.
Content-Type
Optional in header
string
{
"enum": [
"application\/json; charset=utf-8"
]
}body
Required in body
object
Accept
Optional in header
string
application/json; charset=utf-8
application/json
application/jose+jwe
application/json
application/jose+jwe
201
International Standing Orders Created
400
Bad request
401
Unauthorized
403
Forbidden
404
Not found
405
Method Not Allowed
406
Not Acceptable
415
Unsupported Media Type
429
Too Many Requests
500
Internal Server Error
Example Request
Example Response
POST https://api.nedbank.co.za/apimarket/sandbox/open-banking/v3.1/pisp/international-standing-orders
Try this operation
/international-standing-orders/{InternationalStandingOrderPaymentId}
get /international-standing-orders/{InternationalStandingOrderPaymentId}
International Standing Orders
GetInternationalStandingOrdersInternationalStandingOrderPaymentId
Get International Standing Orders
TPPOAuth2Security
TPPOAuth2Security
(oauth2 application)
TPP client credential authorisation flow with the ASPSP
Token URL
https://api.nedbank.co.za/apimarket/sandbox/nboauth/oauth20/token
Scopes
payments
Generic payment scope
InternationalStandingOrderPaymentId
Required in path
string
InternationalStandingOrderPaymentId
x-fapi-auth-date
Optional in header
string
The time when the PSU last logged in with the TPP. All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: Sun, 10 Sep 2017 19:43:31 UTC
{
"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-customer-ip-address
Optional in header
string
The PSU's IP address if the PSU is currently logged in with the TPP.
x-fapi-interaction-id
Optional in header
string
An RFC4122 UID used as a correlation id.
Authorization
Required in header
string
An Authorisation Token as per https://tools.ietf.org/html/rfc6750
x-customer-user-agent
Optional in header
string
Indicates the user-agent that the PSU is using.
Accept
Optional in header
string
application/json; charset=utf-8
application/json
application/jose+jwe
application/json
application/jose+jwe
200
International Standing Orders Read
400
Bad request
401
Unauthorized
403
Forbidden
404
Not found
405
Method Not Allowed
406
Not Acceptable
429
Too Many Requests
500
Internal Server Error
Example Request
Example Response
GET https://api.nedbank.co.za/apimarket/sandbox/open-banking/v3.1/pisp/international-standing-orders/{InternationalStandingOrderPaymentId}
Try this operation
/isup
get /isup
Default
getResult
X-IBM-Client-Secret
X-IBM-Client-Secret
(apiKey located in header)
X-IBM-Client-Id
X-IBM-Client-Id
(apiKey located in header)
CC323803
Accept
Optional in header
string
200
Ok Success Response.
{
"schema": {
"type": "string"
},
"headers": []
}default
default response
{
"schema": {
"type": "object"
}
}Example Request
Example Response
GET https://api.nedbank.co.za/apimarket/sandbox/open-banking/v3.1/pisp/isup
Try this operation
Definitions
Links relevant to the payload
{
"title": "Links",
"type": "object",
"properties": {
"Self": {
"type": "string"
},
"First": {
"type": "string"
},
"Prev": {
"type": "string"
},
"Next": {
"type": "string"
},
"Last": {
"type": "string"
}
},
"required": [
"Self"
]
}
Meta Data relevant to the payload
{
"title": "MetaData",
"type": "object",
"properties": {
"TotalPages": {
"type": "integer",
"format": "int32"
},
"FirstAvailableDateTime": {
"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"
},
"LastAvailableDateTime": {
"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"
}
}
}
Amount of money associated with the charge type.
{
"title": "OBActiveOrHistoricCurrencyAndAmount",
"type": "object",
"properties": {
"Amount": {
"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}$"
},
"Currency": {
"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}$"
}
},
"required": [
"Amount",
"Currency"
]
}
Identifies the nature of the postal address.
{
"title": "OBAddressTypeCode",
"example": "Business",
"type": "string",
"enum": [
"Business",
"Correspondence",
"DeliveryTo",
"MailTo",
"POBox",
"Postal",
"Residential",
"Statement"
]
}
Specifies which party/parties will bear the charges associated with the processing of the payment transaction.
{
"title": "OBChargeBearerType1Code",
"example": "BorneByCreditor",
"type": "string",
"enum": [
"BorneByCreditor",
"BorneByDebtor",
"FollowingServiceLevel",
"Shared"
]
}
^ Only incuded in the response if Data. ReadRefundAccount is set to Yes in the consent.
{
"title": "OBCashAccountDebtor4",
"type": "object",
"properties": {
"SchemeName": {
"description": "^ Name of the identification scheme, in a coded form as published in an external list. | Namespaced Enumeration OBExternalAccountIdentification4Code",
"type": "string"
},
"Identification": {
"description": "^ Identification assigned by an institution to identify an account. This identification is known by the account owner. | Max256Text",
"type": "string"
},
"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.",
"type": "string"
},
"SecondaryIdentification": {
"description": "^ This is secondary identification of the account, as assigned by the account servicing institution. This can be used by building societies to additionally identify accounts with a roll number (in addition to a sort code and account number combination) | Max34Text",
"type": "string"
}
}
}
{
"title": "OBError1",
"type": "object",
"properties": {
"ErrorCode": {
"description": "Low level textual error code, e.g., UK.OBIE.Field.Missing",
"type": "string"
},
"Message": {
"description": "A description of the error that occurred. e.g., 'A mandatory field isn't supplied' or 'RequestedExecutionDateTime must be in future'\nOBIE 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
}
An array of detail error codes, and messages, and URLs to documentation to help remediation.
{
"title": "OBErrorResponse1",
"type": "object",
"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": {
"type": "array",
"items": {
"$ref": "#/definitions/OBError1"
},
"minItems": 1,
"minProperties": 1
}
},
"required": [
"Code",
"Message",
"Errors"
]
}
Specifies the extended type of account.
{
"title": "OBExternalExtendedAccountType1Code",
"example": "Business",
"type": "string",
"enum": [
"Business",
"BusinessSavingsAccount",
"Charity",
"Collection",
"Corporate",
"Ewallet",
"Government",
"Investment",
"ISA",
"JointPersonal",
"Pension",
"Personal",
"PersonalSavingsAccount",
"Premier",
"Wealth"
]
}
Information that locates and identifies a specific address, as defined by postal services.
{
"title": "OBPostalAddress6",
"type": "object",
"properties": {
"AddressType": {
"$ref": "#/definitions/OBAddressTypeCode"
},
"Department": {
"description": "Identification of a division of a large organisation or building.",
"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
},
"StreetName": {
"description": "Name of a street or thoroughfare.",
"type": "string",
"minLength": 1,
"maxLength": 70
},
"BuildingNumber": {
"description": "Number that identifies the position of a building on a street.",
"type": "string",
"minLength": 1,
"maxLength": 16
},
"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
},
"TownName": {
"description": "Name of a built-up area, with defined boundaries, and a local government.",
"type": "string",
"minLength": 1,
"maxLength": 35
},
"CountrySubDivision": {
"description": "Identifies a subdivision of a country such as state, region, county.",
"type": "string",
"minLength": 1,
"maxLength": 35
},
"Country": {
"description": "Nation with its own government.",
"type": "string",
"pattern": "^[A-Z]{2,2}$"
},
"AddressLine": {
"type": "array",
"items": {
"type": "string",
"minLength": 1,
"maxLength": 70
},
"minLength": 1,
"maxLength": 70,
"minItems": 0,
"maxItems": 7
}
}
}
The Risk section is sent by the initiating party to the ASPSP. It is used to specify additional details for risk scoring for Payments.
{
"title": "OBRisk1",
"type": "object",
"properties": {
"PaymentContextCode": {
"$ref": "#/definitions/PaymentContextCode"
},
"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
},
"ContractPresentInidicator": {
"description": "Indicates if Payee has a contractual relationship with the PISP.",
"type": "boolean"
},
"BeneficiaryPrepopulatedIndicator": {
"description": "Indicates if PISP has immutably prepopulated payment details in for the PSU.",
"type": "boolean"
},
"PaymentPurposeCode": {
"description": "Category code, related to the type of services or goods that corresponds to the underlying purpose of the payment that conforms to Recommended UK Purpose Code in ISO 20022 Payment Messaging List",
"type": "string",
"minLength": 3,
"maxLength": 4
},
"BeneficiaryAccountType": {
"$ref": "#/definitions/OBExternalExtendedAccountType1Code"
},
"DeliveryAddress": {
"$ref": "#/definitions/DeliveryAddress"
}
}
}
Supporting Data provided by TPP, when requesting SCA Exemption.
{
"title": "OBSCASupportData1",
"type": "object",
"properties": {
"RequestedSCAExemptionType": {
"$ref": "#/definitions/RequestedSCAExemptionType"
},
"AppliedAuthenticationApproach": {
"$ref": "#/definitions/AppliedAuthenticationApproach"
},
"ReferencePaymentOrderId": {
"description": "If the payment is recurring, then this field is populated with 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. The value here refers to the payment id e.g. DomesticPaymentId",
"type": "string",
"minLength": 1,
"maxLength": 40
}
}
}
{
"title": "OBWriteDomestic2",
"type": "object",
"properties": {
"Data": {
"$ref": "#/definitions/Data"
},
"Risk": {
"$ref": "#/definitions/OBRisk1"
}
},
"required": [
"Data",
"Risk"
]
}
{
"title": "OBWriteDomesticConsent4",
"type": "object",
"properties": {
"Data": {
"$ref": "#/definitions/Data1"
},
"Risk": {
"$ref": "#/definitions/OBRisk1"
}
},
"required": [
"Data",
"Risk"
]
}
{
"title": "OBWriteDomesticConsentResponse5",
"type": "object",
"properties": {
"Data": {
"$ref": "#/definitions/Data2"
},
"Risk": {
"$ref": "#/definitions/OBRisk1"
},
"Links": {
"$ref": "#/definitions/Links"
},
"Meta": {
"$ref": "#/definitions/MetaData"
}
},
"required": [
"Data",
"Risk"
]
}
{
"title": "OBWriteDomesticResponse5",
"type": "object",
"properties": {
"Data": {
"$ref": "#/definitions/Data3"
},
"Links": {
"$ref": "#/definitions/Links"
},
"Meta": {
"$ref": "#/definitions/MetaData"
}
},
"required": [
"Data"
]
}
{
"title": "OBWriteDomesticScheduled2",
"type": "object",
"properties": {
"Data": {
"$ref": "#/definitions/Data4"
},
"Risk": {
"$ref": "#/definitions/OBRisk1"
}
},
"required": [
"Data",
"Risk"
]
}
{
"title": "OBWriteDomesticScheduledConsent4",
"type": "object",
"properties": {
"Data": {
"$ref": "#/definitions/Data5"
},
"Risk": {
"$ref": "#/definitions/OBRisk1"
}
},
"required": [
"Data",
"Risk"
]
}
{
"title": "OBWriteDomesticScheduledConsentResponse5",
"type": "object",
"properties": {
"Data": {
"$ref": "#/definitions/Data6"
},
"Risk": {
"$ref": "#/definitions/OBRisk1"
},
"Links": {
"$ref": "#/definitions/Links"
},
"Meta": {
"$ref": "#/definitions/MetaData"
}
},
"required": [
"Data",
"Risk"
]
}
{
"title": "OBWriteDomesticScheduledResponse5",
"type": "object",
"properties": {
"Data": {
"$ref": "#/definitions/Data7"
},
"Links": {
"$ref": "#/definitions/Links"
},
"Meta": {
"$ref": "#/definitions/MetaData"
}
},
"required": [
"Data"
]
}
{
"title": "OBWriteDomesticStandingOrder3",
"type": "object",
"properties": {
"Data": {
"$ref": "#/definitions/Data8"
},
"Risk": {
"$ref": "#/definitions/OBRisk1"
}
},
"required": [
"Data",
"Risk"
]
}
{
"title": "OBWriteDomesticStandingOrderConsent5",
"type": "object",
"properties": {
"Data": {
"$ref": "#/definitions/Data9"
},
"Risk": {
"$ref": "#/definitions/OBRisk1"
}
},
"required": [
"Data",
"Risk"
]
}
{
"title": "OBWriteDomesticStandingOrderConsentResponse6",
"type": "object",
"properties": {
"Data": {
"$ref": "#/definitions/Data10"
},
"Risk": {
"$ref": "#/definitions/OBRisk1"
},
"Links": {
"$ref": "#/definitions/Links"
},
"Meta": {
"$ref": "#/definitions/MetaData"
}
},
"required": [
"Data",
"Risk"
]
}
{
"title": "OBWriteDomesticStandingOrderResponse6",
"type": "object",
"properties": {
"Data": {
"$ref": "#/definitions/Data11"
},
"Links": {
"$ref": "#/definitions/Links"
},
"Meta": {
"$ref": "#/definitions/MetaData"
}
},
"required": [
"Data"
]
}
{
"title": "OBWriteFile2",
"type": "object",
"properties": {
"Data": {
"$ref": "#/definitions/Data12"
}
},
"required": [
"Data"
]
}
{
"title": "OBWriteFileConsent3",
"type": "object",
"properties": {
"Data": {
"$ref": "#/definitions/Data13"
}
},
"required": [
"Data"
]
}
{
"title": "OBWriteFileConsentResponse4",
"type": "object",
"properties": {
"Data": {
"$ref": "#/definitions/Data14"
},
"Links": {
"$ref": "#/definitions/Links"
},
"Meta": {
"$ref": "#/definitions/MetaData"
}
},
"required": [
"Data"
]
}
{
"title": "OBWriteFileResponse3",
"type": "object",
"properties": {
"Data": {
"$ref": "#/definitions/Data15"
},
"Links": {
"$ref": "#/definitions/Links"
},
"Meta": {
"$ref": "#/definitions/MetaData"
}
},
"required": [
"Data"
]
}
{
"title": "OBWriteFundsConfirmationResponse1",
"type": "object",
"properties": {
"Data": {
"$ref": "#/definitions/Data16"
},
"Links": {
"$ref": "#/definitions/Links"
},
"Meta": {
"$ref": "#/definitions/MetaData"
}
},
"required": [
"Data"
]
}
{
"title": "OBWriteInternational3",
"type": "object",
"properties": {
"Data": {
"$ref": "#/definitions/Data17"
},
"Risk": {
"$ref": "#/definitions/OBRisk1"
}
},
"required": [
"Data",
"Risk"
]
}
{
"title": "OBWriteInternationalConsent5",
"type": "object",
"properties": {
"Data": {
"$ref": "#/definitions/Data18"
},
"Risk": {
"$ref": "#/definitions/OBRisk1"
}
},
"required": [
"Data",
"Risk"
]
}
{
"title": "OBWriteInternationalConsentResponse6",
"type": "object",
"properties": {
"Data": {
"$ref": "#/definitions/Data19"
},
"Risk": {
"$ref": "#/definitions/OBRisk1"
},
"Links": {
"$ref": "#/definitions/Links"
},
"Meta": {
"$ref": "#/definitions/MetaData"
}
},
"required": [
"Data",
"Risk"
]
}
{
"title": "OBWriteInternationalResponse5",
"type": "object",
"properties": {
"Data": {
"$ref": "#/definitions/Data20"
},
"Links": {
"$ref": "#/definitions/Links"
},
"Meta": {
"$ref": "#/definitions/MetaData"
}
},
"required": [
"Data"
]
}
{
"title": "OBWriteInternationalScheduled3",
"type": "object",
"properties": {
"Data": {
"$ref": "#/definitions/Data21"
},
"Risk": {
"$ref": "#/definitions/OBRisk1"
}
},
"required": [
"Data",
"Risk"
]
}
{
"title": "OBWriteInternationalScheduledConsent5",
"type": "object",
"properties": {
"Data": {
"$ref": "#/definitions/Data22"
},
"Risk": {
"$ref": "#/definitions/OBRisk1"
}
},
"required": [
"Data",
"Risk"
]
}
{
"title": "OBWriteInternationalScheduledConsentResponse6",
"type": "object",
"properties": {
"Data": {
"$ref": "#/definitions/Data23"
},
"Risk": {
"$ref": "#/definitions/OBRisk1"
},
"Links": {
"$ref": "#/definitions/Links"
},
"Meta": {
"$ref": "#/definitions/MetaData"
}
},
"required": [
"Data",
"Risk"
]
}
{
"title": "OBWriteInternationalScheduledResponse6",
"type": "object",
"properties": {
"Data": {
"$ref": "#/definitions/Data24"
},
"Links": {
"$ref": "#/definitions/Links"
},
"Meta": {
"$ref": "#/definitions/MetaData"
}
},
"required": [
"Data"
]
}
{
"title": "OBWriteInternationalStandingOrder4",
"type": "object",
"properties": {
"Data": {
"$ref": "#/definitions/Data25"
},
"Risk": {
"$ref": "#/definitions/OBRisk1"
}
},
"required": [
"Data",
"Risk"
]
}
{
"title": "OBWriteInternationalStandingOrderConsent6",
"type": "object",
"properties": {
"Data": {
"$ref": "#/definitions/Data26"
},
"Risk": {
"$ref": "#/definitions/OBRisk1"
}
},
"required": [
"Data",
"Risk"
]
}
{
"title": "OBWriteInternationalStandingOrderConsentResponse7",
"type": "object",
"properties": {
"Data": {
"$ref": "#/definitions/Data27"
},
"Risk": {
"$ref": "#/definitions/OBRisk1"
},
"Links": {
"$ref": "#/definitions/Links"
},
"Meta": {
"$ref": "#/definitions/MetaData"
}
},
"required": [
"Data",
"Risk"
]
}
{
"title": "OBWriteInternationalStandingOrderResponse7",
"type": "object",
"properties": {
"Data": {
"$ref": "#/definitions/Data28"
},
"Links": {
"$ref": "#/definitions/Links"
},
"Meta": {
"$ref": "#/definitions/MetaData"
}
},
"required": [
"Data"
]
}
{
"title": "OBWritePaymentDetailsResponse1",
"type": "object",
"properties": {
"Data": {
"$ref": "#/definitions/Data29"
},
"Links": {
"$ref": "#/definitions/Links"
},
"Meta": {
"$ref": "#/definitions/MetaData"
}
},
"required": [
"Data"
]
}
Provides the details to identify an account.
{
"title": "Account",
"type": "object",
"properties": {
"SchemeName": {
"description": "Name of the identification scheme, in a coded form as published in an external list.",
"type": "string"
},
"Identification": {
"description": "Identification assigned by an institution to identify an account. This identification is known by the account owner.",
"type": "string",
"minLength": 1,
"maxLength": 256
},
"Name": {
"description": "Name of the account, as assigned by the account servicing institution.\nUsage: 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.\nOB: ASPSPs may carry out name validation for Confirmation of Payee, but it is not mandatory.",
"type": "string",
"minLength": 1,
"maxLength": 350
},
"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
}
},
"required": [
"SchemeName",
"Identification",
"Name"
]
}
Set of elements used to uniquely and unambiguously identify a financial institution or a branch of a financial institution.
{
"title": "Agent",
"type": "object",
"properties": {
"SchemeName": {
"description": "Name of the identification scheme, in a coded form as published in an external list.",
"type": "string"
},
"Identification": {
"description": "Unique and unambiguous identification of a financial institution or a branch of a financial institution.",
"type": "string",
"minLength": 1,
"maxLength": 35
},
"Name": {
"description": "Name by which an agent is known and which is usually used to identify that agent.",
"type": "string",
"minLength": 1,
"maxLength": 140
},
"PostalAddress": {
"$ref": "#/definitions/OBPostalAddress6"
}
}
}
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
{
"title": "AppliedAuthenticationApproach",
"example": "CA",
"type": "string",
"enum": [
"CA",
"SCA"
]
}
The authorisation type request from the TPP.
{
"title": "Authorisation",
"type": "object",
"properties": {
"AuthorisationType": {
"$ref": "#/definitions/AuthorisationType"
},
"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"
}
},
"required": [
"AuthorisationType"
]
}
Type of authorisation flow requested.
{
"title": "AuthorisationType",
"example": "Any",
"type": "string",
"enum": [
"Any",
"Single"
]
}
Set of elements used to provide details of a charge for the payment initiation.
{
"title": "Charge",
"type": "object",
"properties": {
"ChargeBearer": {
"$ref": "#/definitions/OBChargeBearerType1Code"
},
"Type": {
"description": "Charge type, in a coded form.",
"type": "string"
},
"Amount": {
"$ref": "#/definitions/OBActiveOrHistoricCurrencyAndAmount"
}
},
"required": [
"ChargeBearer",
"Type",
"Amount"
]
}
Party to which an amount of money is due.
{
"title": "Creditor",
"type": "object",
"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"
}
}
}
Set of elements used to identify a person or an organisation.
{
"title": "Creditor3",
"type": "object",
"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"
}
}
}
Party to which an amount of money is due.
{
"title": "Creditor7",
"type": "object",
"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"
}
}
}
Set of elements used to identify a person or an organisation.
{
"title": "Creditor13",
"type": "object",
"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"
}
}
}
Unambiguous identification of the account of the creditor to which a credit entry will be posted as a result of the payment transaction.
{
"title": "CreditorAccount",
"type": "object",
"properties": {
"SchemeName": {
"description": "Name of the identification scheme, in a coded form as published in an external list.",
"type": "string"
},
"Identification": {
"description": "Identification assigned by an institution to identify an account. This identification is known by the account owner.",
"type": "string",
"minLength": 1,
"maxLength": 256
},
"Name": {
"description": "The account name is the name or names of the account owner(s) represented at an account level.\nNote, the account name is not the product name or the nickname of the account.\nOB: ASPSPs may carry out name validation for Confirmation of Payee, but it is not mandatory.",
"type": "string",
"minLength": 1,
"maxLength": 350
},
"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
}
},
"required": [
"SchemeName",
"Identification",
"Name"
]
}
Identification assigned by an institution to identify an account. This identification is known by the account owner.
{
"title": "CreditorAccount8",
"type": "object",
"properties": {
"SchemeName": {
"description": "Name of the identification scheme, in a coded form as published in an external list.",
"type": "string"
},
"Identification": {
"description": "Identification assigned by an institution to identify an account. This identification is known by the account owner.",
"type": "string",
"minLength": 1,
"maxLength": 256
},
"Name": {
"description": "The account name is the name or names of the account owner(s) represented at an account level.\nNote, the account name is not the product name or the nickname of the account.\nOB: ASPSPs may carry out name validation for Confirmation of Payee, but it is not mandatory.",
"type": "string",
"minLength": 1,
"maxLength": 350
},
"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
}
},
"required": [
"SchemeName",
"Identification",
"Name"
]
}
Provides the details to identify the beneficiary account.
{
"title": "CreditorAccount20",
"type": "object",
"properties": {
"SchemeName": {
"description": "Name of the identification scheme, in a coded form as published in an external list.",
"type": "string"
},
"Identification": {
"description": "Identification assigned by an institution to identify an account. This identification is known by the account owner.",
"type": "string",
"minLength": 1,
"maxLength": 256
},
"Name": {
"description": "The account name is the name or names of the account owner(s) represented at an account level.\nNote, the account name is not the product name or the nickname of the account.\nOB: ASPSPs may carry out name validation for Confirmation of Payee, but it is not mandatory.",
"type": "string",
"minLength": 1,
"maxLength": 350
},
"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
}
},
"required": [
"SchemeName",
"Identification",
"Name"
]
}
Financial institution servicing an account for the creditor.
{
"title": "CreditorAgent",
"type": "object",
"properties": {
"SchemeName": {
"description": "Name of the identification scheme, in a coded form as published in an external list.",
"type": "string"
},
"Identification": {
"description": "Unique and unambiguous identification of a financial institution or a branch of a financial institution.",
"type": "string",
"minLength": 1,
"maxLength": 35
},
"Name": {
"description": "Name by which an agent is known and which is usually used to identify that agent.",
"type": "string",
"minLength": 1,
"maxLength": 140
},
"PostalAddress": {
"$ref": "#/definitions/OBPostalAddress6"
}
}
}
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.
{
"title": "CreditorAgent8",
"type": "object",
"properties": {
"SchemeName": {
"description": "Name of the identification scheme, in a coded form as published in an external list.",
"type": "string"
},
"Identification": {
"description": "Unique and unambiguous identification of the servicing institution.",
"type": "string",
"minLength": 1,
"maxLength": 35
},
"Name": {
"description": "Name by which an agent is known and which is usually used to identify that agent.",
"type": "string",
"minLength": 1,
"maxLength": 140
},
"PostalAddress": {
"$ref": "#/definitions/OBPostalAddress6"
}
}
}
{
"title": "Data",
"type": "object",
"properties": {
"ConsentId": {
"description": "OB: Unique identification as assigned by the ASPSP to uniquely identify the consent resource.",
"type": "string",
"minLength": 1,
"maxLength": 128
},
"Initiation": {
"$ref": "#/definitions/Initiation"
}
},
"required": [
"ConsentId",
"Initiation"
]
}
{
"title": "Data1",
"type": "object",
"properties": {
"ReadRefundAccount": {
"$ref": "#/definitions/ReadRefundAccount"
},
"Initiation": {
"$ref": "#/definitions/Initiation"
},
"Authorisation": {
"$ref": "#/definitions/Authorisation"
},
"SCASupportData": {
"$ref": "#/definitions/OBSCASupportData1"
}
},
"required": [
"Initiation"
]
}
{
"title": "Data2",
"type": "object",
"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": {
"$ref": "#/definitions/Status"
},
"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": {
"$ref": "#/definitions/ReadRefundAccount"
},
"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": {
"$ref": "#/definitions/Charge"
}
},
"Initiation": {
"$ref": "#/definitions/Initiation"
},
"Authorisation": {
"$ref": "#/definitions/Authorisation"
},
"SCASupportData": {
"$ref": "#/definitions/OBSCASupportData1"
},
"Debtor": {
"$ref": "#/definitions/OBCashAccountDebtor4"
}
},
"required": [
"ConsentId",
"CreationDateTime",
"Status",
"StatusUpdateDateTime",
"Initiation"
]
}
{
"title": "Data3",
"type": "object",
"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": {
"$ref": "#/definitions/Status1"
},
"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": {
"$ref": "#/definitions/Refund"
},
"Charges": {
"type": "array",
"items": {
"$ref": "#/definitions/Charge"
}
},
"Initiation": {
"$ref": "#/definitions/Initiation"
},
"MultiAuthorisation": {
"$ref": "#/definitions/MultiAuthorisation"
},
"Debtor": {
"$ref": "#/definitions/OBCashAccountDebtor4"
}
},
"required": [
"DomesticPaymentId",
"ConsentId",
"CreationDateTime",
"Status",
"StatusUpdateDateTime",
"Initiation"
]
}
{
"title": "Data4",
"type": "object",
"properties": {
"ConsentId": {
"description": "OB: Unique identification as assigned by the ASPSP to uniquely identify the consent resource.",
"type": "string",
"minLength": 1,
"maxLength": 128
},
"Initiation": {
"$ref": "#/definitions/Initiation4"
}
},
"required": [
"ConsentId",
"Initiation"
]
}
{
"title": "Data5",
"type": "object",
"properties": {
"Permission": {
"description": "Specifies the Open Banking service request types.",
"example": "Create",
"type": "string",
"default": "Create"
},
"ReadRefundAccount": {
"$ref": "#/definitions/ReadRefundAccount"
},
"Initiation": {
"$ref": "#/definitions/Initiation4"
},
"Authorisation": {
"$ref": "#/definitions/Authorisation"
},
"SCASupportData": {
"$ref": "#/definitions/OBSCASupportData1"
}
},
"required": [
"Permission",
"Initiation"
]
}
{
"title": "Data6",
"type": "object",
"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": {
"$ref": "#/definitions/Status"
},
"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.",
"example": "Create",
"type": "string",
"default": "Create"
},
"ReadRefundAccount": {
"$ref": "#/definitions/ReadRefundAccount"
},
"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": {
"$ref": "#/definitions/Charge"
}
},
"Initiation": {
"$ref": "#/definitions/Initiation4"
},
"Authorisation": {
"$ref": "#/definitions/Authorisation"
},
"SCASupportData": {
"$ref": "#/definitions/OBSCASupportData1"
},
"Debtor": {
"$ref": "#/definitions/OBCashAccountDebtor4"
}
},
"required": [
"ConsentId",
"CreationDateTime",
"Status",
"StatusUpdateDateTime",
"Permission",
"Initiation"
]
}
{
"title": "Data7",
"type": "object",
"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": {
"$ref": "#/definitions/Status4"
},
"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": {
"$ref": "#/definitions/Refund"
},
"Charges": {
"type": "array",
"items": {
"$ref": "#/definitions/Charge"
}
},
"Initiation": {
"$ref": "#/definitions/Initiation4"
},
"MultiAuthorisation": {
"$ref": "#/definitions/MultiAuthorisation"
},
"Debtor": {
"$ref": "#/definitions/OBCashAccountDebtor4"
}
},
"required": [
"DomesticScheduledPaymentId",
"ConsentId",
"CreationDateTime",
"Status",
"StatusUpdateDateTime",
"Initiation"
]
}
{
"title": "Data8",
"type": "object",
"properties": {
"ConsentId": {
"description": "OB: Unique identification as assigned by the ASPSP to uniquely identify the consent resource.",
"type": "string",
"minLength": 1,
"maxLength": 128
},
"Initiation": {
"$ref": "#/definitions/Initiation8"
}
},
"required": [
"ConsentId",
"Initiation"
]
}
{
"title": "Data9",
"type": "object",
"properties": {
"Permission": {
"description": "Specifies the Open Banking service request types.",
"example": "Create",
"type": "string",
"default": "Create"
},
"ReadRefundAccount": {
"$ref": "#/definitions/ReadRefundAccount"
},
"Initiation": {
"$ref": "#/definitions/Initiation8"
},
"Authorisation": {
"$ref": "#/definitions/Authorisation"
},
"SCASupportData": {
"$ref": "#/definitions/OBSCASupportData1"
}
},
"required": [
"Permission",
"Initiation"
]
}
{
"title": "Data10",
"type": "object",
"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": {
"$ref": "#/definitions/Status"
},
"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.",
"example": "Create",
"type": "string",
"default": "Create"
},
"ReadRefundAccount": {
"$ref": "#/definitions/ReadRefundAccount"
},
"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": {
"$ref": "#/definitions/Charge"
}
},
"Initiation": {
"$ref": "#/definitions/Initiation10"
},
"Authorisation": {
"$ref": "#/definitions/Authorisation"
},
"SCASupportData": {
"$ref": "#/definitions/OBSCASupportData1"
},
"Debtor": {
"$ref": "#/definitions/OBCashAccountDebtor4"
}
},
"required": [
"ConsentId",
"CreationDateTime",
"Status",
"StatusUpdateDateTime",
"Permission",
"Initiation"
]
}
{
"title": "Data11",
"type": "object",
"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": {
"$ref": "#/definitions/Status4"
},
"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": {
"$ref": "#/definitions/Refund"
},
"Charges": {
"type": "array",
"items": {
"$ref": "#/definitions/Charge"
}
},
"Initiation": {
"$ref": "#/definitions/Initiation10"
},
"MultiAuthorisation": {
"$ref": "#/definitions/MultiAuthorisation"
},
"Debtor": {
"$ref": "#/definitions/OBCashAccountDebtor4"
}
},
"required": [
"DomesticStandingOrderId",
"ConsentId",
"CreationDateTime",
"Status",
"StatusUpdateDateTime",
"Initiation"
]
}
{
"title": "Data12",
"type": "object",
"properties": {
"ConsentId": {
"description": "OB: Unique identification as assigned by the ASPSP to uniquely identify the consent resource.",
"type": "string",
"minLength": 1,
"maxLength": 128
},
"Initiation": {
"$ref": "#/definitions/Initiation12"
}
},
"required": [
"ConsentId",
"Initiation"
]
}
{
"title": "Data13",
"type": "object",
"properties": {
"Initiation": {
"$ref": "#/definitions/Initiation12"
},
"Authorisation": {
"$ref": "#/definitions/Authorisation"
},
"SCASupportData": {
"$ref": "#/definitions/OBSCASupportData1"
}
},
"required": [
"Initiation"
]
}
{
"title": "Data14",
"type": "object",
"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": {
"$ref": "#/definitions/Status9"
},
"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": {
"$ref": "#/definitions/Charge"
}
},
"Initiation": {
"$ref": "#/definitions/Initiation12"
},
"Authorisation": {
"$ref": "#/definitions/Authorisation"
},
"SCASupportData": {
"$ref": "#/definitions/OBSCASupportData1"
},
"Debtor": {
"$ref": "#/definitions/OBCashAccountDebtor4"
}
},
"required": [
"ConsentId",
"CreationDateTime",
"Status",
"StatusUpdateDateTime",
"Initiation"
]
}
{
"title": "Data15",
"type": "object",
"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": {
"$ref": "#/definitions/Status10"
},
"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": {
"$ref": "#/definitions/Charge"
}
},
"Initiation": {
"$ref": "#/definitions/Initiation12"
},
"MultiAuthorisation": {
"$ref": "#/definitions/MultiAuthorisation"
},
"Debtor": {
"$ref": "#/definitions/OBCashAccountDebtor4"
}
},
"required": [
"FilePaymentId",
"ConsentId",
"CreationDateTime",
"Status",
"StatusUpdateDateTime",
"Initiation"
]
}
{
"title": "Data16",
"type": "object",
"properties": {
"FundsAvailableResult": {
"$ref": "#/definitions/FundsAvailableResult"
},
"SupplementaryData": {
"description": "Additional information that can not be captured in the structured fields and/or any other specific block.",
"type": "object"
}
}
}
{
"title": "Data17",
"type": "object",
"properties": {
"ConsentId": {
"description": "OB: Unique identification as assigned by the ASPSP to uniquely identify the consent resource.",
"type": "string",
"minLength": 1,
"maxLength": 128
},
"Initiation": {
"$ref": "#/definitions/Initiation16"
}
},
"required": [
"ConsentId",
"Initiation"
]
}
{
"title": "Data18",
"type": "object",
"properties": {
"ReadRefundAccount": {
"$ref": "#/definitions/ReadRefundAccount"
},
"Initiation": {
"$ref": "#/definitions/Initiation16"
},
"Authorisation": {
"$ref": "#/definitions/Authorisation"
},
"SCASupportData": {
"$ref": "#/definitions/OBSCASupportData1"
}
},
"required": [
"Initiation"
]
}
{
"title": "Data19",
"type": "object",
"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": {
"$ref": "#/definitions/Status"
},
"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": {
"$ref": "#/definitions/ReadRefundAccount"
},
"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": {
"$ref": "#/definitions/Charge"
}
},
"ExchangeRateInformation": {
"$ref": "#/definitions/ExchangeRateInformation2"
},
"Initiation": {
"$ref": "#/definitions/Initiation16"
},
"Authorisation": {
"$ref": "#/definitions/Authorisation"
},
"SCASupportData": {
"$ref": "#/definitions/OBSCASupportData1"
},
"Debtor": {
"$ref": "#/definitions/OBCashAccountDebtor4"
}
},
"required": [
"ConsentId",
"CreationDateTime",
"Status",
"StatusUpdateDateTime",
"Initiation"
]
}
{
"title": "Data20",
"type": "object",
"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": {
"$ref": "#/definitions/Status1"
},
"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": {
"$ref": "#/definitions/Refund3"
},
"Charges": {
"type": "array",
"items": {
"$ref": "#/definitions/Charge"
}
},
"ExchangeRateInformation": {
"$ref": "#/definitions/ExchangeRateInformation2"
},
"Initiation": {
"$ref": "#/definitions/Initiation16"
},
"MultiAuthorisation": {
"$ref": "#/definitions/MultiAuthorisation"
},
"Debtor": {
"$ref": "#/definitions/OBCashAccountDebtor4"
}
},
"required": [
"InternationalPaymentId",
"ConsentId",
"CreationDateTime",
"Status",
"StatusUpdateDateTime",
"Initiation"
]
}
{
"title": "Data21",
"type": "object",
"properties": {
"ConsentId": {
"description": "OB: Unique identification as assigned by the ASPSP to uniquely identify the consent resource.",
"type": "string",
"minLength": 1,
"maxLength": 128
},
"Initiation": {
"$ref": "#/definitions/Initiation20"
}
},
"required": [
"ConsentId",
"Initiation"
]
}
{
"title": "Data22",
"type": "object",
"properties": {
"Permission": {
"description": "Specifies the Open Banking service request types.",
"example": "Create",
"type": "string",
"default": "Create"
},
"ReadRefundAccount": {
"$ref": "#/definitions/ReadRefundAccount"
},
"Initiation": {
"$ref": "#/definitions/Initiation20"
},
"Authorisation": {
"$ref": "#/definitions/Authorisation"
},
"SCASupportData": {
"$ref": "#/definitions/OBSCASupportData1"
}
},
"required": [
"Permission",
"Initiation"
]
}
{
"title": "Data23",
"type": "object",
"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": {
"$ref": "#/definitions/Status"
},
"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.",
"example": "Create",
"type": "string",
"default": "Create"
},
"ReadRefundAccount": {
"$ref": "#/definitions/ReadRefundAccount"
},
"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": {
"$ref": "#/definitions/Charge"
}
},
"ExchangeRateInformation": {
"$ref": "#/definitions/ExchangeRateInformation2"
},
"Initiation": {
"$ref": "#/definitions/Initiation22"
},
"Authorisation": {
"$ref": "#/definitions/Authorisation"
},
"SCASupportData": {
"$ref": "#/definitions/OBSCASupportData1"
},
"Debtor": {
"$ref": "#/definitions/OBCashAccountDebtor4"
}
},
"required": [
"ConsentId",
"CreationDateTime",
"Status",
"StatusUpdateDateTime",
"Permission",
"Initiation"
]
}
{
"title": "Data24",
"type": "object",
"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": {
"$ref": "#/definitions/Status4"
},
"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": {
"$ref": "#/definitions/Refund3"
},
"Charges": {
"type": "array",
"items": {
"$ref": "#/definitions/Charge"
}
},
"ExchangeRateInformation": {
"$ref": "#/definitions/ExchangeRateInformation2"
},
"Initiation": {
"$ref": "#/definitions/Initiation20"
},
"MultiAuthorisation": {
"$ref": "#/definitions/MultiAuthorisation"
},
"Debtor": {
"$ref": "#/definitions/OBCashAccountDebtor4"
}
},
"required": [
"InternationalScheduledPaymentId",
"ConsentId",
"CreationDateTime",
"Status",
"StatusUpdateDateTime",
"Initiation"
]
}
{
"title": "Data25",
"type": "object",
"properties": {
"ConsentId": {
"description": "OB: Unique identification as assigned by the ASPSP to uniquely identify the consent resource.",
"type": "string",
"minLength": 1,
"maxLength": 128
},
"Initiation": {
"$ref": "#/definitions/Initiation24"
}
},
"required": [
"ConsentId",
"Initiation"
]
}
{
"title": "Data26",
"type": "object",
"properties": {
"Permission": {
"description": "Specifies the Open Banking service request types.",
"example": "Create",
"type": "string",
"default": "Create"
},
"ReadRefundAccount": {
"$ref": "#/definitions/ReadRefundAccount"
},
"Initiation": {
"$ref": "#/definitions/Initiation24"
},
"Authorisation": {
"$ref": "#/definitions/Authorisation"
},
"SCASupportData": {
"$ref": "#/definitions/OBSCASupportData1"
}
},
"required": [
"Permission",
"Initiation"
]
}
{
"title": "Data27",
"type": "object",
"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": {
"$ref": "#/definitions/Status18"
},
"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.",
"example": "Create",
"type": "string",
"default": "Create"
},
"ReadRefundAccount": {
"$ref": "#/definitions/ReadRefundAccount"
},
"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": {
"$ref": "#/definitions/Charge"
}
},
"Initiation": {
"$ref": "#/definitions/Initiation26"
},
"Authorisation": {
"$ref": "#/definitions/Authorisation"
},
"SCASupportData": {
"$ref": "#/definitions/OBSCASupportData1"
},
"Debtor": {
"$ref": "#/definitions/OBCashAccountDebtor4"
}
},
"required": [
"ConsentId",
"CreationDateTime",
"Status",
"StatusUpdateDateTime",
"Permission",
"Initiation"
]
}
{
"title": "Data28",
"type": "object",
"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": {
"$ref": "#/definitions/Status19"
},
"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": {
"$ref": "#/definitions/Refund5"
},
"Charges": {
"type": "array",
"items": {
"$ref": "#/definitions/Charge"
}
},
"Initiation": {
"$ref": "#/definitions/Initiation26"
},
"MultiAuthorisation": {
"$ref": "#/definitions/MultiAuthorisation"
},
"Debtor": {
"$ref": "#/definitions/OBCashAccountDebtor4"
}
},
"required": [
"InternationalStandingOrderId",
"ConsentId",
"CreationDateTime",
"Status",
"StatusUpdateDateTime",
"Initiation"
]
}
{
"title": "Data29",
"type": "object",
"properties": {
"PaymentStatus": {
"type": "array",
"items": {
"$ref": "#/definitions/PaymentStatus"
}
}
}
}
Unambiguous identification of the account of the debtor to which a debit entry will be made as a result of the transaction.
{
"title": "DebtorAccount",
"type": "object",
"properties": {
"SchemeName": {
"description": "Name of the identification scheme, in a coded form as published in an external list.",
"type": "string"
},
"Identification": {
"description": "Identification assigned by an institution to identify an account. This identification is known by the account owner.",
"type": "string",
"minLength": 1,
"maxLength": 256
},
"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.\nNote, the account name is not the product name or the nickname of the account.",
"type": "string",
"minLength": 1,
"maxLength": 350
},
"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
}
},
"required": [
"SchemeName",
"Identification"
]
}
Provides the details to identify the debtor account.
{
"title": "DebtorAccount8",
"type": "object",
"properties": {
"SchemeName": {
"description": "Name of the identification scheme, in a coded form as published in an external list.",
"type": "string"
},
"Identification": {
"description": "Identification assigned by an institution to identify an account. This identification is known by the account owner.",
"type": "string",
"minLength": 1,
"maxLength": 256
},
"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.\nNote, the account name is not the product name or the nickname of the account.",
"type": "string",
"minLength": 1,
"maxLength": 350
},
"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
}
},
"required": [
"SchemeName",
"Identification"
]
}
Information that locates and identifies a specific address, as defined by postal services or in free format text.
{
"title": "DeliveryAddress",
"type": "object",
"properties": {
"AddressLine": {
"type": "array",
"items": {
"type": "string",
"minLength": 1,
"maxLength": 70
},
"minLength": 1,
"maxLength": 70,
"minItems": 0,
"maxItems": 2
},
"StreetName": {
"description": "Name of a street or thoroughfare.",
"type": "string",
"minLength": 1,
"maxLength": 70
},
"BuildingNumber": {
"description": "Number that identifies the position of a building on a street.",
"type": "string",
"minLength": 1,
"maxLength": 16
},
"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
},
"TownName": {
"description": "Name of a built-up area, with defined boundaries, and a local government.",
"type": "string",
"minLength": 1,
"maxLength": 35
},
"CountrySubDivision": {
"description": "Identifies a subdivision of a country such as state, region, county.",
"type": "string",
"minLength": 1,
"maxLength": 35
},
"Country": {
"description": "Nation with its own government.",
"type": "string",
"pattern": "^[A-Z]{2,2}$"
}
},
"required": [
"TownName",
"Country"
]
}
Provides details on the currency exchange rate and contract.
{
"title": "ExchangeRateInformation",
"type": "object",
"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",
"format": "double"
},
"RateType": {
"$ref": "#/definitions/RateType"
},
"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
}
},
"required": [
"UnitCurrency",
"RateType"
]
}
Further detailed information on the exchange rate that has been used in the payment transaction.
{
"title": "ExchangeRateInformation2",
"type": "object",
"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",
"format": "double"
},
"RateType": {
"$ref": "#/definitions/RateType"
},
"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"
}
},
"required": [
"UnitCurrency",
"ExchangeRate",
"RateType"
]
}
The amount of the final Standing Order
{
"title": "FinalPaymentAmount",
"type": "object",
"properties": {
"Amount": {
"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}$"
},
"Currency": {
"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}$"
}
},
"required": [
"Amount",
"Currency"
]
}
The amount of the first Standing Order
{
"title": "FirstPaymentAmount",
"type": "object",
"properties": {
"Amount": {
"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}$"
},
"Currency": {
"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}$"
}
},
"required": [
"Amount",
"Currency"
]
}
Result of a funds availability check.
{
"title": "FundsAvailableResult",
"type": "object",
"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"
}
},
"required": [
"FundsAvailableDateTime",
"FundsAvailable"
]
}
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.
{
"title": "Initiation",
"type": "object",
"properties": {
"InstructionIdentification": {
"description": "Unique identification as assigned by an instructing party for an instructed party to unambiguously identify the instruction.\nUsage: 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.\nUsage: 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.\nOB: The Faster Payments Scheme can only access 31 characters for the EndToEndIdentification field.",
"type": "string",
"minLength": 1,
"maxLength": 35
},
"LocalInstrument": {
"description": "User community specific instrument.\nUsage: This element is used to specify a local instrument, local clearing option and/or further qualify the service or service level.",
"type": "string"
},
"InstructedAmount": {
"$ref": "#/definitions/InstructedAmount"
},
"DebtorAccount": {
"$ref": "#/definitions/DebtorAccount"
},
"CreditorAccount": {
"$ref": "#/definitions/CreditorAccount"
},
"CreditorPostalAddress": {
"$ref": "#/definitions/OBPostalAddress6"
},
"RemittanceInformation": {
"$ref": "#/definitions/RemittanceInformation"
},
"SupplementaryData": {
"description": "Additional information that can not be captured in the structured fields and/or any other specific block.",
"type": "object"
}
},
"required": [
"InstructionIdentification",
"EndToEndIdentification",
"InstructedAmount",
"CreditorAccount"
]
}
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.
{
"title": "Initiation4",
"type": "object",
"properties": {
"InstructionIdentification": {
"description": "Unique identification as assigned by an instructing party for an instructed party to unambiguously identify the instruction.\nUsage: 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.\nUsage: 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.\nOB: The Faster Payments Scheme can only access 31 characters for the EndToEndIdentification field.",
"type": "string",
"minLength": 1,
"maxLength": 35
},
"LocalInstrument": {
"description": "User community specific instrument.\nUsage: This element is used to specify a local instrument, local clearing option and/or further qualify the service or service level.",
"type": "string"
},
"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": {
"$ref": "#/definitions/InstructedAmount"
},
"DebtorAccount": {
"$ref": "#/definitions/DebtorAccount"
},
"CreditorAccount": {
"$ref": "#/definitions/CreditorAccount"
},
"CreditorPostalAddress": {
"$ref": "#/definitions/OBPostalAddress6"
},
"RemittanceInformation": {
"$ref": "#/definitions/RemittanceInformation"
},
"SupplementaryData": {
"description": "Additional information that can not be captured in the structured fields and/or any other specific block.",
"type": "object"
}
},
"required": [
"InstructionIdentification",
"RequestedExecutionDateTime",
"InstructedAmount",
"CreditorAccount"
]
}
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.
{
"title": "Initiation8",
"type": "object",
"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.\nUsage: 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.\nIf 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": {
"$ref": "#/definitions/FirstPaymentAmount"
},
"RecurringPaymentAmount": {
"$ref": "#/definitions/RecurringPaymentAmount"
},
"FinalPaymentAmount": {
"$ref": "#/definitions/FinalPaymentAmount"
},
"DebtorAccount": {
"$ref": "#/definitions/DebtorAccount8"
},
"CreditorAccount": {
"$ref": "#/definitions/CreditorAccount8"
},
"SupplementaryData": {
"description": "Additional information that can not be captured in the structured fields and/or any other specific block.",
"type": "object"
}
},
"required": [
"Frequency",
"FirstPaymentDateTime",
"FirstPaymentAmount",
"CreditorAccount"
]
}
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.
{
"title": "Initiation10",
"type": "object",
"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.\nUsage: 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.\nIf 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": {
"$ref": "#/definitions/FirstPaymentAmount"
},
"RecurringPaymentAmount": {
"$ref": "#/definitions/RecurringPaymentAmount"
},
"FinalPaymentAmount": {
"$ref": "#/definitions/FinalPaymentAmount"
},
"DebtorAccount": {
"$ref": "#/definitions/DebtorAccount"
},
"CreditorAccount": {
"$ref": "#/definitions/CreditorAccount8"
},
"SupplementaryData": {
"description": "Additional information that can not be captured in the structured fields and/or any other specific block.",
"type": "object"
}
},
"required": [
"Frequency",
"FirstPaymentDateTime",
"FirstPaymentAmount",
"CreditorAccount"
]
}
The Initiation payload is sent by the initiating party to the ASPSP. It is used to request movement of funds using a payment file.
{
"title": "Initiation12",
"type": "object",
"properties": {
"FileType": {
"description": "Specifies the payment file type.",
"type": "string"
},
"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",
"format": "double"
},
"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": {
"description": "User community specific instrument.\nUsage: This element is used to specify a local instrument, local clearing option and/or further qualify the service or service level.",
"type": "string"
},
"DebtorAccount": {
"$ref": "#/definitions/DebtorAccount"
},
"RemittanceInformation": {
"$ref": "#/definitions/RemittanceInformation"
},
"SupplementaryData": {
"description": "Additional information that can not be captured in the structured fields and/or any other specific block.",
"type": "object"
}
},
"required": [
"FileType",
"FileHash"
]
}
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.
{
"title": "Initiation16",
"type": "object",
"properties": {
"InstructionIdentification": {
"description": "Unique identification as assigned by an instructing party for an instructed party to unambiguously identify the instruction.\nUsage: 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.\nUsage: 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.\nOB: The Faster Payments Scheme can only access 31 characters for the EndToEndIdentification field.",
"type": "string",
"minLength": 1,
"maxLength": 35
},
"LocalInstrument": {
"description": "User community specific instrument.\nUsage: This element is used to specify a local instrument, local clearing option and/or further qualify the service or service level.",
"type": "string"
},
"InstructionPriority": {
"$ref": "#/definitions/InstructionPriority"
},
"Purpose": {
"description": "Specifies the external purpose code in the format of character string with a maximum length of 4 characters.\nThe list of valid codes is an external code list published separately.\nExternal 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": {
"$ref": "#/definitions/InstructedAmount"
},
"ExchangeRateInformation": {
"$ref": "#/definitions/ExchangeRateInformation"
},
"DebtorAccount": {
"$ref": "#/definitions/DebtorAccount"
},
"Creditor": {
"$ref": "#/definitions/Creditor"
},
"CreditorAgent": {
"$ref": "#/definitions/CreditorAgent"
},
"CreditorAccount": {
"$ref": "#/definitions/CreditorAccount"
},
"RemittanceInformation": {
"$ref": "#/definitions/RemittanceInformation"
},
"SupplementaryData": {
"description": "Additional information that can not be captured in the structured fields and/or any other specific block.",
"type": "object"
}
},
"required": [
"InstructionIdentification",
"EndToEndIdentification",
"CurrencyOfTransfer",
"InstructedAmount",
"CreditorAccount"
]
}
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.
{
"title": "Initiation20",
"type": "object",
"properties": {
"InstructionIdentification": {
"description": "Unique identification as assigned by an instructing party for an instructed party to unambiguously identify the instruction.\nUsage: 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.\nUsage: 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.\nOB: The Faster Payments Scheme can only access 31 characters for the EndToEndIdentification field.",
"type": "string",
"minLength": 1,
"maxLength": 35
},
"LocalInstrument": {
"description": "User community specific instrument.\nUsage: This element is used to specify a local instrument, local clearing option and/or further qualify the service or service level.",
"type": "string"
},
"InstructionPriority": {
"$ref": "#/definitions/InstructionPriority"
},
"Purpose": {
"description": "Specifies the external purpose code in the format of character string with a maximum length of 4 characters.\nThe list of valid codes is an external code list published separately.\nExternal 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": {
"$ref": "#/definitions/InstructedAmount"
},
"ExchangeRateInformation": {
"$ref": "#/definitions/ExchangeRateInformation"
},
"DebtorAccount": {
"$ref": "#/definitions/DebtorAccount"
},
"Creditor": {
"$ref": "#/definitions/Creditor"
},
"CreditorAgent": {
"$ref": "#/definitions/CreditorAgent"
},
"CreditorAccount": {
"$ref": "#/definitions/CreditorAccount"
},
"RemittanceInformation": {
"$ref": "#/definitions/RemittanceInformation"
},
"SupplementaryData": {
"description": "Additional information that can not be captured in the structured fields and/or any other specific block.",
"type": "object"
}
},
"required": [
"InstructionIdentification",
"RequestedExecutionDateTime",
"CurrencyOfTransfer",
"InstructedAmount",
"CreditorAccount"
]
}
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.
{
"title": "Initiation22",
"type": "object",
"properties": {
"InstructionIdentification": {
"description": "Unique identification as assigned by an instructing party for an instructed party to unambiguously identify the instruction.\nUsage: 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.\nUsage: 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.\nOB: The Faster Payments Scheme can only access 31 characters for the EndToEndIdentification field.",
"type": "string",
"minLength": 1,
"maxLength": 35
},
"LocalInstrument": {
"description": "User community specific instrument.\nUsage: This element is used to specify a local instrument, local clearing option and/or further qualify the service or service level.",
"type": "string"
},
"InstructionPriority": {
"$ref": "#/definitions/InstructionPriority"
},
"Purpose": {
"description": "Specifies the external purpose code in the format of character string with a maximum length of 4 characters.\nThe list of valid codes is an external code list published separately.\nExternal 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": {
"$ref": "#/definitions/InstructedAmount"
},
"ExchangeRateInformation": {
"$ref": "#/definitions/ExchangeRateInformation"
},
"DebtorAccount": {
"$ref": "#/definitions/DebtorAccount"
},
"Creditor": {
"$ref": "#/definitions/Creditor7"
},
"CreditorAgent": {
"$ref": "#/definitions/CreditorAgent"
},
"CreditorAccount": {
"$ref": "#/definitions/CreditorAccount"
},
"RemittanceInformation": {
"$ref": "#/definitions/RemittanceInformation"
},
"SupplementaryData": {
"description": "Additional information that can not be captured in the structured fields and/or any other specific block.",
"type": "object"
}
},
"required": [
"InstructionIdentification",
"RequestedExecutionDateTime",
"CurrencyOfTransfer",
"InstructedAmount",
"CreditorAccount"
]
}
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.
{
"title": "Initiation24",
"type": "object",
"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.\nUsage: 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.\nIf 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.\nThe list of valid codes is an external code list published separately.\nExternal 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": {
"$ref": "#/definitions/InstructedAmount"
},
"DebtorAccount": {
"$ref": "#/definitions/DebtorAccount8"
},
"Creditor": {
"$ref": "#/definitions/Creditor7"
},
"CreditorAgent": {
"$ref": "#/definitions/CreditorAgent8"
},
"CreditorAccount": {
"$ref": "#/definitions/CreditorAccount20"
},
"SupplementaryData": {
"description": "Additional information that can not be captured in the structured fields and/or any other specific block.",
"type": "object"
}
},
"required": [
"Frequency",
"FirstPaymentDateTime",
"CurrencyOfTransfer",
"InstructedAmount",
"CreditorAccount"
]
}
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.
{
"title": "Initiation26",
"type": "object",
"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.\nUsage: 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.\nIf 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.\nThe list of valid codes is an external code list published separately.\nExternal 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": {
"$ref": "#/definitions/InstructedAmount"
},
"DebtorAccount": {
"$ref": "#/definitions/DebtorAccount"
},
"Creditor": {
"$ref": "#/definitions/Creditor7"
},
"CreditorAgent": {
"$ref": "#/definitions/CreditorAgent8"
},
"CreditorAccount": {
"$ref": "#/definitions/CreditorAccount20"
},
"SupplementaryData": {
"description": "Additional information that can not be captured in the structured fields and/or any other specific block.",
"type": "object"
}
},
"required": [
"Frequency",
"FirstPaymentDateTime",
"CurrencyOfTransfer",
"InstructedAmount",
"CreditorAccount"
]
}
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.
{
"title": "InstructedAmount",
"type": "object",
"properties": {
"Amount": {
"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}$"
},
"Currency": {
"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}$"
}
},
"required": [
"Amount",
"Currency"
]
}
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.
{
"title": "InstructionPriority",
"example": "Normal",
"type": "string",
"enum": [
"Normal",
"Urgent"
]
}
The multiple authorisation flow response from the ASPSP.
{
"title": "MultiAuthorisation",
"type": "object",
"properties": {
"Status": {
"$ref": "#/definitions/Status2"
},
"NumberRequired": {
"description": "Number of authorisations required for payment order (total required at the start of the multi authorisation journey).",
"type": "integer",
"format": "int32"
},
"NumberReceived": {
"description": "Number of authorisations received.",
"type": "integer",
"format": "int32"
},
"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"
}
},
"required": [
"Status"
]
}
Specifies the payment context
- BillPayment - @deprecated
- EcommerceGoods - @deprecated
- EcommerceServices - @deprecated
- Other - @deprecated
- PartyToParty - @deprecated
{
"title": "PaymentContextCode",
"example": "BillingGoodsAndServicesInAdvance",
"type": "string",
"enum": [
"BillingGoodsAndServicesInAdvance",
"BillingGoodsAndServicesInArrears",
"PispPayee",
"EcommerceMerchantInitiatedPayment",
"FaceToFacePointOfSale",
"TransferToSelf",
"TransferToThirdParty",
"BillPayment",
"EcommerceGoods",
"EcommerceServices",
"Other",
"PartyToParty"
]
}
Payment status details.
{
"title": "PaymentStatus",
"type": "object",
"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": {
"$ref": "#/definitions/Status21"
},
"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": {
"$ref": "#/definitions/StatusDetail"
}
},
"required": [
"PaymentTransactionId",
"Status",
"StatusUpdateDateTime"
]
}
Specifies the type used to complete the currency exchange.
{
"title": "RateType",
"example": "Actual",
"type": "string",
"enum": [
"Actual",
"Agreed",
"Indicative"
]
}
Specifies to share the refund account details with PISP
{
"title": "ReadRefundAccount",
"example": "No",
"type": "string",
"enum": [
"No",
"Yes"
]
}
The amount of the recurring Standing Order
{
"title": "RecurringPaymentAmount",
"type": "object",
"properties": {
"Amount": {
"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}$"
},
"Currency": {
"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}$"
}
},
"required": [
"Amount",
"Currency"
]
}
Unambiguous identification of the refund account to which a refund will be made as a result of the transaction.
{
"title": "Refund",
"type": "object",
"properties": {
"Account": {
"$ref": "#/definitions/Account"
}
},
"required": [
"Account"
]
}
{
"title": "Refund3",
"type": "object",
"properties": {
"Creditor": {
"$ref": "#/definitions/Creditor3"
},
"Agent": {
"$ref": "#/definitions/Agent"
},
"Account": {
"$ref": "#/definitions/Account"
}
},
"required": [
"Account"
]
}
{
"title": "Refund5",
"type": "object",
"properties": {
"Creditor": {
"$ref": "#/definitions/Creditor13"
},
"Agent": {
"$ref": "#/definitions/Agent"
},
"Account": {
"$ref": "#/definitions/Account"
}
},
"required": [
"Account"
]
}
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.
{
"title": "RemittanceInformation",
"type": "object",
"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.\nUsage: 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.\nIf 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.\nOB: 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
}
}
}
This field allows a PISP to request specific SCA Exemption for a Payment Initiation
{
"title": "RequestedSCAExemptionType",
"example": "BillPayment",
"type": "string",
"enum": [
"BillPayment",
"ContactlessTravel",
"EcommerceGoods",
"EcommerceServices",
"Kiosk",
"Parking",
"PartyToParty"
]
}
Specifies the status of consent resource in code form.
{
"title": "Status",
"example": "Authorised",
"type": "string",
"enum": [
"Authorised",
"AwaitingAuthorisation",
"Consumed",
"Rejected"
]
}
Specifies the status of the payment information group.
{
"title": "Status1",
"example": "AcceptedCreditSettlementCompleted",
"type": "string",
"enum": [
"AcceptedCreditSettlementCompleted",
"AcceptedSettlementCompleted",
"AcceptedSettlementInProcess",
"AcceptedWithoutPosting",
"Pending",
"Rejected"
]
}
Specifies the status of the authorisation flow in code form.
{
"title": "Status2",
"example": "Authorised",
"type": "string",
"enum": [
"Authorised",
"AwaitingFurtherAuthorisation",
"Rejected"
]
}
Specifies the status of the payment order resource.
{
"title": "Status4",
"example": "Cancelled",
"type": "string",
"enum": [
"Cancelled",
"InitiationCompleted",
"InitiationFailed",
"InitiationPending"
]
}
Specifies the status of consent resource in code form.
{
"title": "Status9",
"example": "Authorised",
"type": "string",
"enum": [
"Authorised",
"AwaitingAuthorisation",
"AwaitingUpload",
"Consumed",
"Rejected"
]
}
Specifies the status of the payment order resource.
{
"title": "Status10",
"example": "InitiationCompleted",
"type": "string",
"enum": [
"InitiationCompleted",
"InitiationFailed",
"InitiationPending"
]
}
Specifies the status of resource in code form.
{
"title": "Status18",
"example": "Authorised",
"type": "string",
"enum": [
"Authorised",
"AwaitingAuthorisation",
"Consumed",
"Rejected"
]
}
Specifies the status of resource in code form.
{
"title": "Status19",
"example": "Cancelled",
"type": "string",
"enum": [
"Cancelled",
"InitiationCompleted",
"InitiationFailed",
"InitiationPending"
]
}
Status of a transfe, as assigned by the transaction administrator.
{
"title": "Status21",
"example": "Accepted",
"type": "string",
"enum": [
"Accepted",
"AcceptedCancellationRequest",
"AcceptedCreditSettlementCompleted",
"AcceptedCustomerProfile",
"AcceptedFundsChecked",
"AcceptedSettlementCompleted",
"AcceptedSettlementInProcess",
"AcceptedTechnicalValidation",
"AcceptedWithChange",
"AcceptedWithoutPosting",
"Cancelled",
"NoCancellationProcess",
"PartiallyAcceptedCancellationRequest",
"PartiallyAcceptedTechnicalCorrect",
"PaymentCancelled",
"Pending",
"PendingCancellationRequest",
"Received",
"Rejected",
"RejectedCancellationRequest"
]
}
Payment status details as per underlying Payment Rail.
{
"title": "StatusDetail",
"type": "object",
"properties": {
"LocalInstrument": {
"description": "User community specific instrument.\nUsage: This element is used to specify a local instrument, local clearing option and/or further qualify the service or service level.",
"type": "string"
},
"Status": {
"description": "Status of a transfer, as assigned by the transaction administrator.",
"type": "string",
"minLength": 1,
"maxLength": 128
},
"StatusReason": {
"$ref": "#/definitions/StatusReason"
},
"StatusReasonDescription": {
"description": "Reason provided for the status of a transfer.",
"type": "string",
"minLength": 1,
"maxLength": 256
}
},
"required": [
"Status"
]
}
Reason Code provided for the status of a transfer.
{
"title": "StatusReason",
"example": "Cancelled",
"type": "string",
"enum": [
"Cancelled",
"PendingFailingSettlement",
"PendingSettlement",
"Proprietary",
"ProprietaryRejection",
"Suspended",
"Unmatched"
]
}