Account and Transactions V3

Description

This API, provides the ability for approved/authorised account information providers (AISPs) to access a customer’s (payment service user, PSU) account and transaction information for domestic business current accounts (BCAs) and personal current accounts (PCAs), Credit Cards, Savings Payment Accounts and Multi-Currency Payment Accounts only when the PSU grants consent. This API is developed according to the Open Banking Read/Write API Specifications and fulfils PSD2 regulation. see https://www.openbanking.org.uk

API Information

Title	Account and Transactions V3
Protocol	TLS-MA
Open Banking Specification Version	3.1.6
Access	Free to use but subscription is required

Key Features:

Transaction details: transactions in and out, description
Account details: Account Type and Account Subtype, overdraft information
Balances
Saved payees
Recurring payments
Product Details

New in this version:

We are introducing a new /transactions endpoint field called “mutability” which allows you to distinguish between transactions whose description and other details might be subject to change (“mutable”) against those that are not subject to change (“immutable”).
We have added the field RepresentativeAPR field in PCA/BCA Product endpoints.

Contact information

Support Mailbox

openbankingAPI@santander.co.uk

License

https://www.openbanking.org.uk/terms

Endpoints

production

https://openbanking-ma.santander.co.uk/sanuk/external

Endpoint for Open Banking TLS MA only

Santander Internal Release Version: 3.1.60

Paths

/account-access-consents

Account Access

Summary

Create Account Access Consents

Security

TPPOAuth2Security

(oauth2 application)

TPP client credential authorisation flow with the ASPSP

Token URL

https://openbanking-ma.santander.co.uk/sanuk/external/open-banking/openid-connect-provider/v1/oauth2/token

Scopes

accounts

Ability to read Accounts information

Parameters

OBReadConsent1Param

Required in body

Default

{
    "schema": {
        "type": "object",
        "required": [
            "Data",
            "Risk"
        ],
        "properties": {
            "Data": {
                "type": "object",
                "required": [
                    "Permissions"
                ],
                "properties": {
                    "Permissions": {
                        "type": "array",
                        "items": {
                            "description": "Specifies the Open Banking account access data types. This is a list of the data clusters being consented by the PSU, and requested for authorisation with the ASPSP.",
                            "type": "string",
                            "enum": [
                                "ReadAccountsBasic",
                                "ReadAccountsDetail",
                                "ReadBalances",
                                "ReadBeneficiariesBasic",
                                "ReadBeneficiariesDetail",
                                "ReadDirectDebits",
                                "ReadOffers",
                                "ReadPAN",
                                "ReadParty",
                                "ReadPartyPSU",
                                "ReadProducts",
                                "ReadScheduledPaymentsBasic",
                                "ReadScheduledPaymentsDetail",
                                "ReadStandingOrdersBasic",
                                "ReadStandingOrdersDetail",
                                "ReadStatementsBasic",
                                "ReadStatementsDetail",
                                "ReadTransactionsBasic",
                                "ReadTransactionsCredits",
                                "ReadTransactionsDebits",
                                "ReadTransactionsDetail"
                            ]
                        },
                        "minItems": 1
                    },
                    "ExpirationDateTime": {
                        "description": "Specified date and time the permissions will expire.\nIf this is not populated, the permissions will be open ended.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"
                    },
                    "TransactionFromDateTime": {
                        "description": "Specified start date and time for the transaction query period.\nIf this is not populated, the start date will be open ended, and data will be returned from the earliest available transaction.All dates in the JSON payloads are represented in ISO 8601 date-time format. \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"
                    },
                    "TransactionToDateTime": {
                        "description": "Specified end date and time for the transaction query period.\nIf this is not populated, the end date will be open ended, and data will be returned to the latest available transaction.All dates in the JSON payloads are represented in ISO 8601 date-time format. \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"
                    }
                }
            },
            "Risk": {
                "$ref": "#\/definitions\/OBRisk2"
            }
        },
        "additionalProperties": false
    }
}

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.

Content-Type

Optional in header

string

application/json; charset=utf-8
application/jose+jwe

Optional in header

string

application/json; charset=utf-8
application/jose+jwe

Responses

201

Attribute description not found

OBReadConsentResponse1

400

Attribute description not found

OBErrorResponse1

401

Attribute description not found

403

Attribute description not found

OBErrorResponse1

405

Attribute description not found

406

Attribute description not found

415

Attribute description not found

429

Attribute description not found

500

Attribute description not found

OBErrorResponse1

Example Request

Example Response

Definition

POST https://openbanking-ma.santander.co.uk/sanuk/external/open-banking/v3.1/aisp/account-access-consents

Response

Try this operation

https://openbanking-ma.santander.co.uk/sanuk/external/open-banking/v3.1/aisp/account-access-consents

Body

Headers

content-type

x-fapi-auth-date

x-fapi-customer-ip-address

x-fapi-interaction-id

Authorization

x-customer-user-agent

Request

Response

/account-access-consents/{ConsentId}

Account Access

Summary

Get Account Access Consents

Security

TPPOAuth2Security

(oauth2 application)

TPP client credential authorisation flow with the ASPSP

Token URL

https://openbanking-ma.santander.co.uk/sanuk/external/open-banking/openid-connect-provider/v1/oauth2/token

Scopes

accounts

Ability to read Accounts information

Parameters

ConsentId

Required in path

string

ConsentId

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.

Optional in header

string

application/json; charset=utf-8
application/jose+jwe

Responses

200

Attribute description not found

OBReadConsentResponse1

400

Attribute description not found

OBErrorResponse1

401

Attribute description not found

403

Attribute description not found

OBErrorResponse1

405

Attribute description not found

406

Attribute description not found

429

Attribute description not found

500

Attribute description not found

OBErrorResponse1

Example Request

Example Response

Definition

GET https://openbanking-ma.santander.co.uk/sanuk/external/open-banking/v3.1/aisp/account-access-consents/{ConsentId}

Response

Try this operation

https://openbanking-ma.santander.co.uk/sanuk/external/open-banking/v3.1/aisp/account-access-consents/{ConsentId}

Headers

x-fapi-auth-date

x-fapi-customer-ip-address

x-fapi-interaction-id

Authorization

x-customer-user-agent

Parameters

ConsentId

Request

Response

Account Access

Summary

Delete Account Access Consents

Security

TPPOAuth2Security

(oauth2 application)

TPP client credential authorisation flow with the ASPSP

Token URL

https://openbanking-ma.santander.co.uk/sanuk/external/open-banking/openid-connect-provider/v1/oauth2/token

Scopes

accounts

Ability to read Accounts information

Parameters

ConsentId

Required in path

string

ConsentId

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.

Optional in header

string

application/json; charset=utf-8
application/jose+jwe

Responses

204

Attribute description not found

400

Attribute description not found

OBErrorResponse1

401

Attribute description not found

403

Attribute description not found

OBErrorResponse1

405

Attribute description not found

406

Attribute description not found

429

Attribute description not found

500

Attribute description not found

OBErrorResponse1

Example Request

Example Response

Definition

DELETE https://openbanking-ma.santander.co.uk/sanuk/external/open-banking/v3.1/aisp/account-access-consents/{ConsentId}

Response

Try this operation

https://openbanking-ma.santander.co.uk/sanuk/external/open-banking/v3.1/aisp/account-access-consents/{ConsentId}

Headers

x-fapi-auth-date

x-fapi-customer-ip-address

x-fapi-interaction-id

Authorization

x-customer-user-agent

Parameters

ConsentId

Request

Response

/accounts

Accounts

Summary

Get Accounts

Security

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://openbanking.santander.co.uk/sanuk/external/open-banking/openid-connect-provider/v1/oauth2/authorize

Token URL

https://openbanking-ma.santander.co.uk/sanuk/external/open-banking/openid-connect-provider/v1/oauth2/token

Scopes

accounts

Ability to read Accounts information

Parameters

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.

Optional in header

string

application/json; charset=utf-8
application/jose+jwe

Responses

200

Attribute description not found

OBReadAccount5

400

Attribute description not found

OBErrorResponse1

401

Attribute description not found

403

Attribute description not found

OBErrorResponse1

405

Attribute description not found

406

Attribute description not found

429

Attribute description not found

500

Attribute description not found

OBErrorResponse1

Example Request

Example Response

Definition

GET https://openbanking-ma.santander.co.uk/sanuk/external/open-banking/v3.1/aisp/accounts

Response

Try this operation

https://openbanking-ma.santander.co.uk/sanuk/external/open-banking/v3.1/aisp/accounts

Headers

x-fapi-auth-date

x-fapi-customer-ip-address

x-fapi-interaction-id

Authorization

x-customer-user-agent

Request

Response

/accounts/{AccountId}

Accounts

Summary

Get Accounts

Security

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://openbanking.santander.co.uk/sanuk/external/open-banking/openid-connect-provider/v1/oauth2/authorize

Token URL

https://openbanking-ma.santander.co.uk/sanuk/external/open-banking/openid-connect-provider/v1/oauth2/token

Scopes

accounts

Ability to read Accounts information

Parameters

AccountId

Required in path

string

AccountId

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.

Optional in header

string

application/json; charset=utf-8
application/jose+jwe

Responses

200

Attribute description not found

OBReadAccount5

400

Attribute description not found

OBErrorResponse1

401

Attribute description not found

403

Attribute description not found

OBErrorResponse1

405

Attribute description not found

406

Attribute description not found

429

Attribute description not found

500

Attribute description not found

OBErrorResponse1

Example Request

Example Response

Definition

GET https://openbanking-ma.santander.co.uk/sanuk/external/open-banking/v3.1/aisp/accounts/{AccountId}

Response

Try this operation

https://openbanking-ma.santander.co.uk/sanuk/external/open-banking/v3.1/aisp/accounts/{AccountId}

Headers

x-fapi-auth-date

x-fapi-customer-ip-address

x-fapi-interaction-id

Authorization

x-customer-user-agent

Parameters

AccountId

Request

Response

/accounts/{AccountId}/balances

Balances

Summary

Get Balances

Security

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://openbanking.santander.co.uk/sanuk/external/open-banking/openid-connect-provider/v1/oauth2/authorize

Token URL

https://openbanking-ma.santander.co.uk/sanuk/external/open-banking/openid-connect-provider/v1/oauth2/token

Scopes

accounts

Ability to read Accounts information

Parameters

AccountId

Required in path

string

AccountId

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.

Optional in header

string

application/json; charset=utf-8
application/jose+jwe

Responses

200

Attribute description not found

OBReadBalance1

400

Attribute description not found

OBErrorResponse1

401

Attribute description not found

403

Attribute description not found

OBErrorResponse1

405

Attribute description not found

406

Attribute description not found

429

Attribute description not found

500

Attribute description not found

OBErrorResponse1

Example Request

Example Response

Definition

GET https://openbanking-ma.santander.co.uk/sanuk/external/open-banking/v3.1/aisp/accounts/{AccountId}/balances

Response

Try this operation

https://openbanking-ma.santander.co.uk/sanuk/external/open-banking/v3.1/aisp/accounts/{AccountId}/balances

Headers

x-fapi-auth-date

x-fapi-customer-ip-address

x-fapi-interaction-id

Authorization

x-customer-user-agent

Parameters

AccountId

Request

Response

/accounts/{AccountId}/beneficiaries

Beneficiaries

Summary

Get Beneficiaries

Security

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://openbanking.santander.co.uk/sanuk/external/open-banking/openid-connect-provider/v1/oauth2/authorize

Token URL

https://openbanking-ma.santander.co.uk/sanuk/external/open-banking/openid-connect-provider/v1/oauth2/token

Scopes

accounts

Ability to read Accounts information

Parameters

AccountId

Required in path

string

AccountId

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.

Optional in header

string

application/json; charset=utf-8
application/jose+jwe

Responses

200

Attribute description not found

OBReadBeneficiary5

400

Attribute description not found

OBErrorResponse1

401

Attribute description not found

403

Attribute description not found

OBErrorResponse1

404

Attribute description not found

405

Attribute description not found

406

Attribute description not found

429

Attribute description not found

500

Attribute description not found

OBErrorResponse1

Example Request

Example Response

Definition

GET https://openbanking-ma.santander.co.uk/sanuk/external/open-banking/v3.1/aisp/accounts/{AccountId}/beneficiaries

Response

Try this operation

https://openbanking-ma.santander.co.uk/sanuk/external/open-banking/v3.1/aisp/accounts/{AccountId}/beneficiaries

Headers

x-fapi-auth-date

x-fapi-customer-ip-address

x-fapi-interaction-id

Authorization

x-customer-user-agent

Parameters

AccountId

Request

Response

/accounts/{AccountId}/direct-debits

Direct Debits

Summary

Get Direct Debits

Security

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://openbanking.santander.co.uk/sanuk/external/open-banking/openid-connect-provider/v1/oauth2/authorize

Token URL

https://openbanking-ma.santander.co.uk/sanuk/external/open-banking/openid-connect-provider/v1/oauth2/token

Scopes

accounts

Ability to read Accounts information

Parameters

AccountId

Required in path

string

AccountId

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.

Optional in header

string

application/json; charset=utf-8
application/jose+jwe

Responses

200

Attribute description not found

OBReadDirectDebit2

400

Attribute description not found

OBErrorResponse1

401

Attribute description not found

403

Attribute description not found

OBErrorResponse1

404

Attribute description not found

405

Attribute description not found

406

Attribute description not found

429

Attribute description not found

500

Attribute description not found

OBErrorResponse1

Example Request

Example Response

Definition

GET https://openbanking-ma.santander.co.uk/sanuk/external/open-banking/v3.1/aisp/accounts/{AccountId}/direct-debits

Response

Try this operation

https://openbanking-ma.santander.co.uk/sanuk/external/open-banking/v3.1/aisp/accounts/{AccountId}/direct-debits

Headers

x-fapi-auth-date

x-fapi-customer-ip-address

x-fapi-interaction-id

Authorization

x-customer-user-agent

Parameters

AccountId

Request

Response

/accounts/{AccountId}/offers

Offers

Summary

Get Offers

Security

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://openbanking.santander.co.uk/sanuk/external/open-banking/openid-connect-provider/v1/oauth2/authorize

Token URL

https://openbanking-ma.santander.co.uk/sanuk/external/open-banking/openid-connect-provider/v1/oauth2/token

Scopes

accounts

Ability to read Accounts information

Parameters

AccountId

Required in path

string

AccountId

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.

Optional in header

string

application/json; charset=utf-8
application/jose+jwe

Responses

200

Attribute description not found

OBReadOffer1

400

Attribute description not found

OBErrorResponse1

401

Attribute description not found

403

Attribute description not found

OBErrorResponse1

404

Attribute description not found

405

Attribute description not found

406

Attribute description not found

429

Attribute description not found

500

Attribute description not found

OBErrorResponse1

Example Request

Example Response

Definition

GET https://openbanking-ma.santander.co.uk/sanuk/external/open-banking/v3.1/aisp/accounts/{AccountId}/offers

Response

Try this operation

https://openbanking-ma.santander.co.uk/sanuk/external/open-banking/v3.1/aisp/accounts/{AccountId}/offers

Headers

x-fapi-auth-date

x-fapi-customer-ip-address

x-fapi-interaction-id

Authorization

x-customer-user-agent

Parameters

AccountId

Request

Response

/accounts/{AccountId}/parties

Parties

Summary

Get Parties

Security

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://openbanking.santander.co.uk/sanuk/external/open-banking/openid-connect-provider/v1/oauth2/authorize

Token URL

https://openbanking-ma.santander.co.uk/sanuk/external/open-banking/openid-connect-provider/v1/oauth2/token

Scopes

accounts

Ability to read Accounts information

Parameters

AccountId

Required in path

string

AccountId

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.

Optional in header

string

application/json; charset=utf-8
application/jose+jwe

Responses

200

Attribute description not found

OBReadParty3

400

Attribute description not found

OBErrorResponse1

401

Attribute description not found

403

Attribute description not found

OBErrorResponse1

404

Attribute description not found

405

Attribute description not found

406

Attribute description not found

429

Attribute description not found

500

Attribute description not found

OBErrorResponse1

Example Request

Example Response

Definition

GET https://openbanking-ma.santander.co.uk/sanuk/external/open-banking/v3.1/aisp/accounts/{AccountId}/parties

Response

Try this operation

https://openbanking-ma.santander.co.uk/sanuk/external/open-banking/v3.1/aisp/accounts/{AccountId}/parties

Headers

x-fapi-auth-date

x-fapi-customer-ip-address

x-fapi-interaction-id

Authorization

x-customer-user-agent

Parameters

AccountId

Request

Response

/accounts/{AccountId}/party

Parties

Summary

Get Parties

Security

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://openbanking.santander.co.uk/sanuk/external/open-banking/openid-connect-provider/v1/oauth2/authorize

Token URL

https://openbanking-ma.santander.co.uk/sanuk/external/open-banking/openid-connect-provider/v1/oauth2/token

Scopes

accounts

Ability to read Accounts information

Parameters

AccountId

Required in path

string

AccountId

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.

Optional in header

string

application/json; charset=utf-8
application/jose+jwe

Responses

200

Attribute description not found

OBReadParty2

400

Attribute description not found

OBErrorResponse1

401

Attribute description not found

403

Attribute description not found

OBErrorResponse1

404

Attribute description not found

405

Attribute description not found

406

Attribute description not found

429

Attribute description not found

500

Attribute description not found

OBErrorResponse1

Example Request

Example Response

Definition

GET https://openbanking-ma.santander.co.uk/sanuk/external/open-banking/v3.1/aisp/accounts/{AccountId}/party

Response

Try this operation

https://openbanking-ma.santander.co.uk/sanuk/external/open-banking/v3.1/aisp/accounts/{AccountId}/party

Headers

x-fapi-auth-date

x-fapi-customer-ip-address

x-fapi-interaction-id

Authorization

x-customer-user-agent

Parameters

AccountId

Request

Response

/accounts/{AccountId}/product

Products

Summary

Get Products

Security

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://openbanking.santander.co.uk/sanuk/external/open-banking/openid-connect-provider/v1/oauth2/authorize

Token URL

https://openbanking-ma.santander.co.uk/sanuk/external/open-banking/openid-connect-provider/v1/oauth2/token

Scopes

accounts

Ability to read Accounts information

Parameters

AccountId

Required in path

string

AccountId

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.

Optional in header

string

application/json; charset=utf-8
application/jose+jwe

Responses

200

Attribute description not found

OBReadProduct2

400

Attribute description not found

OBErrorResponse1

401

Attribute description not found

403

Attribute description not found

OBErrorResponse1

404

Attribute description not found

405

Attribute description not found

406

Attribute description not found

429

Attribute description not found

500

Attribute description not found

OBErrorResponse1

Example Request

Example Response

Definition

GET https://openbanking-ma.santander.co.uk/sanuk/external/open-banking/v3.1/aisp/accounts/{AccountId}/product

Response

Try this operation

https://openbanking-ma.santander.co.uk/sanuk/external/open-banking/v3.1/aisp/accounts/{AccountId}/product

Headers

x-fapi-auth-date

x-fapi-customer-ip-address

x-fapi-interaction-id

Authorization

x-customer-user-agent

Parameters

AccountId

Request

Response

/accounts/{AccountId}/scheduled-payments

Scheduled Payments

Summary

Get Scheduled Payments

Security

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://openbanking.santander.co.uk/sanuk/external/open-banking/openid-connect-provider/v1/oauth2/authorize

Token URL

https://openbanking-ma.santander.co.uk/sanuk/external/open-banking/openid-connect-provider/v1/oauth2/token

Scopes

accounts

Ability to read Accounts information

Parameters

AccountId

Required in path

string

AccountId

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.

Optional in header

string

application/json; charset=utf-8
application/jose+jwe

Responses

200

Attribute description not found

OBReadScheduledPayment3

400

Attribute description not found

OBErrorResponse1

401

Attribute description not found

403

Attribute description not found

OBErrorResponse1

404

Attribute description not found

405

Attribute description not found

406

Attribute description not found

429

Attribute description not found

500

Attribute description not found

OBErrorResponse1

Example Request

Example Response

Definition

GET https://openbanking-ma.santander.co.uk/sanuk/external/open-banking/v3.1/aisp/accounts/{AccountId}/scheduled-payments

Response

Try this operation

https://openbanking-ma.santander.co.uk/sanuk/external/open-banking/v3.1/aisp/accounts/{AccountId}/scheduled-payments

Headers

x-fapi-auth-date

x-fapi-customer-ip-address

x-fapi-interaction-id

Authorization

x-customer-user-agent

Parameters

AccountId

Request

Response

/accounts/{AccountId}/standing-orders

Standing Orders

Summary

Get Standing Orders

Security

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://openbanking.santander.co.uk/sanuk/external/open-banking/openid-connect-provider/v1/oauth2/authorize

Token URL

https://openbanking-ma.santander.co.uk/sanuk/external/open-banking/openid-connect-provider/v1/oauth2/token

Scopes

accounts

Ability to read Accounts information

Parameters

AccountId

Required in path

string

AccountId

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.

Optional in header

string

application/json; charset=utf-8
application/jose+jwe

Responses

200

Attribute description not found

OBReadStandingOrder6

400

Attribute description not found

OBErrorResponse1

401

Attribute description not found

403

Attribute description not found

OBErrorResponse1

404

Attribute description not found

405

Attribute description not found

406

Attribute description not found

429

Attribute description not found

500

Attribute description not found

OBErrorResponse1

Example Request

Example Response

Definition

GET https://openbanking-ma.santander.co.uk/sanuk/external/open-banking/v3.1/aisp/accounts/{AccountId}/standing-orders

Response

Try this operation

https://openbanking-ma.santander.co.uk/sanuk/external/open-banking/v3.1/aisp/accounts/{AccountId}/standing-orders

Headers

x-fapi-auth-date

x-fapi-customer-ip-address

x-fapi-interaction-id

Authorization

x-customer-user-agent

Parameters

AccountId

Request

Response

/accounts/{AccountId}/statements

Statements

Summary

Get Statements

Security

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://openbanking.santander.co.uk/sanuk/external/open-banking/openid-connect-provider/v1/oauth2/authorize

Token URL

https://openbanking-ma.santander.co.uk/sanuk/external/open-banking/openid-connect-provider/v1/oauth2/token

Scopes

accounts

Ability to read Accounts information

Parameters

AccountId

Required in path

string

AccountId

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.

fromStatementDateTime

Optional in query

string / date-time

The UTC ISO 8601 Date Time to filter statements FROM NB Time component is optional - set to 00:00:00 for just Date. If the Date Time contains a timezone, the ASPSP must ignore the timezone component.

toStatementDateTime

Optional in query

string / date-time

The UTC ISO 8601 Date Time to filter statements TO NB Time component is optional - set to 00:00:00 for just Date. If the Date Time contains a timezone, the ASPSP must ignore the timezone component.

Optional in header

string

application/json; charset=utf-8
application/jose+jwe

Responses

200

Attribute description not found

OBReadStatement2

400

Attribute description not found

OBErrorResponse1

401

Attribute description not found

403

Attribute description not found

OBErrorResponse1

404

Attribute description not found

405

Attribute description not found

406

Attribute description not found

429

Attribute description not found

500

Attribute description not found

OBErrorResponse1

Example Request

Example Response

Definition

GET https://openbanking-ma.santander.co.uk/sanuk/external/open-banking/v3.1/aisp/accounts/{AccountId}/statements

Response

Try this operation

https://openbanking-ma.santander.co.uk/sanuk/external/open-banking/v3.1/aisp/accounts/{AccountId}/statements

Headers

x-fapi-auth-date

x-fapi-customer-ip-address

x-fapi-interaction-id

Authorization

x-customer-user-agent

Parameters

AccountId

fromStatementDateTime

toStatementDateTime

Request

Response

/accounts/{AccountId}/statements/{StatementId}

Statements

Summary

Get Statements

Security

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://openbanking.santander.co.uk/sanuk/external/open-banking/openid-connect-provider/v1/oauth2/authorize

Token URL

https://openbanking-ma.santander.co.uk/sanuk/external/open-banking/openid-connect-provider/v1/oauth2/token

Scopes

accounts

Ability to read Accounts information

Parameters

StatementId

Required in path

string

StatementId

AccountId

Required in path

string

AccountId

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.

Optional in header

string

application/json; charset=utf-8
application/jose+jwe

Responses

200

Attribute description not found

OBReadStatement2

400

Attribute description not found

OBErrorResponse1

401

Attribute description not found

403

Attribute description not found

OBErrorResponse1

404

Attribute description not found

405

Attribute description not found

406

Attribute description not found

429

Attribute description not found

500

Attribute description not found

OBErrorResponse1

Example Request

Example Response

Definition

GET https://openbanking-ma.santander.co.uk/sanuk/external/open-banking/v3.1/aisp/accounts/{AccountId}/statements/{StatementId}

Response

Try this operation

https://openbanking-ma.santander.co.uk/sanuk/external/open-banking/v3.1/aisp/accounts/{AccountId}/statements/{StatementId}