NAV Navigation
Shell HTTP JavaScript Node.js

Equals CardOneMoney APIs v1.0.0

Scroll down for code samples, example requests and responses. Select a language for code samples from the tabs above or the mobile navigation menu.

Onboarding

OAuth2 API Access

If you would like to use our APIs to access the data of our customers, with their consent, you will need to get in touch with us by sending an email to openbanking@equalsmoney.com. It's a manual on-boarding process, but to speed things up, please have the following information ready

Company Details

OAuth2 Application Details - most of these will be displayed to the user when asking for consent

Security

OAuth2 Authorization Code Flow

The authorization code flow begins with the client directing the user to the /auth endpoint. In this request, the client requests the offline and accounts access. Without offline, the resulting response would not contain the refresh_token

https://oauth.fairfx.io/oauth2/auth?
client_id=f0d39020-6793-4d8c-8b40-498f9cb62adb&
response_type=code&
state=1234567890&
scope=offline+accounts

At this point, the user will be asked to enter their credentials and complete the authentication. After that, we will ask the user to consent to the required permissions.

Once the user authenticates and grants consent, we will return a response to your app at the indicated redirect_uri.

Now that you've acquired an authorization_code and have been granted permission by the user, you can redeem the code for an access_token to the desired resource. Do this by sending a POST request to the /token endpoint:

POST /oauth2/auth HTTP/1.1
Host: https://oauth.fairfx.io
Content-Type: application/x-www-form-urlencoded

grant_type=authorization_code&
code={AUTHORIZATION_CODE}&
redirect_uri={REDIRECT_URI}&
client_id={CLIENT_ID}&
client_assertion_type=urn:ietf:params:oauth:client-assertion-type:jwt-bearer
&client_assertion={CLIENT_ASSERTION}

For client_assertion see https://tools.ietf.org/html/rfc7523#section-2.2

After a successful request, you should now get an access_token and a refresh_token that you can use to make API calls and get back the data of the consenting user.

Base URLs:

Authentication

Scope Scope Description
accounts Ability to read Accounts information
payments Ability to initiate Domestic Payments

Accounts

Information about an account such as the sort code and account numbers

Get Accounts

Code samples

# You can also use wget
curl -X GET https://develop-api.fairfx.io/open-banking/proxy/cob/v3.1/aisp/accounts/{AccountId} \
  -H 'Accept: application/json' \
  -H 'x-fapi-auth-date: string' \
  -H 'x-fapi-customer-ip-address: string' \
  -H 'x-fapi-interaction-id: string' \
  -H 'Authorization: string'

GET https://develop-api.fairfx.io/open-banking/proxy/cob/v3.1/aisp/accounts/{AccountId} HTTP/1.1
Host: develop-api.fairfx.io
Accept: application/json
x-fapi-auth-date: string
x-fapi-customer-ip-address: string
x-fapi-interaction-id: string
Authorization: string

var headers = {
  'Accept':'application/json',
  'x-fapi-auth-date':'string',
  'x-fapi-customer-ip-address':'string',
  'x-fapi-interaction-id':'string',
  'Authorization':'string'

};

$.ajax({
  url: 'https://develop-api.fairfx.io/open-banking/proxy/cob/v3.1/aisp/accounts/{AccountId}',
  method: 'get',

  headers: headers,
  success: function(data) {
    console.log(JSON.stringify(data));
  }
})

const fetch = require('node-fetch');

const headers = {
  'Accept':'application/json',
  'x-fapi-auth-date':'string',
  'x-fapi-customer-ip-address':'string',
  'x-fapi-interaction-id':'string',
  'Authorization':'string'

};

fetch('https://develop-api.fairfx.io/open-banking/proxy/cob/v3.1/aisp/accounts/{AccountId}',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

GET /aisp/accounts/{AccountId}

Parameters

Name In Type Required Description
AccountId path string true AccountId
x-fapi-auth-date header string false The time when the PSU last logged in with the TPP.
x-fapi-customer-ip-address header string false The PSU's IP address if the PSU is currently logged in with the TPP.
x-fapi-interaction-id header string false An RFC4122 UID used as a correlation id.
Authorization header string true An Authorisation Token as per https://tools.ietf.org/html/rfc6750

Detailed descriptions

x-fapi-auth-date: The time when the PSU last logged in with the TPP. All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: Sun, 10 Sep 2017 19:43:31 UTC

Example responses

200 Response

{
  "Data": {
    "Account": [
      {
        "AccountId": "string",
        "Status": "Deleted",
        "StatusUpdateDateTime": "2020-10-23T10:23:58Z",
        "Currency": "string",
        "AccountType": "Business",
        "AccountSubType": "ChargeCard",
        "Description": "string",
        "Nickname": "string"
      }
    ]
  },
  "Links": {
    "Self": "http://example.com",
    "First": "http://example.com",
    "Prev": "http://example.com",
    "Next": "http://example.com",
    "Last": "http://example.com"
  },
  "Meta": {
    "TotalPages": 0,
    "FirstAvailableDateTime": "2020-10-23T10:23:58Z",
    "LastAvailableDateTime": "2020-10-23T10:23:58Z"
  }
}

Responses

Status Meaning Description Schema
200 OK Accounts Read OBReadAccount4
400 Bad Request Bad request OBErrorResponse1
401 Unauthorized Unauthorized None
403 Forbidden Forbidden OBErrorResponse1
404 Not Found Not found None
405 Method Not Allowed Method Not Allowed None
406 Not Acceptable Not Acceptable None
429 Too Many Requests Too Many Requests None
500 Internal Server Error Internal Server Error OBErrorResponse1

Response Headers

Status Header Type Format Description
200 x-fapi-interaction-id string An RFC4122 UID used as a correlation id.
400 x-fapi-interaction-id string An RFC4122 UID used as a correlation id.
401 x-fapi-interaction-id string An RFC4122 UID used as a correlation id.
403 x-fapi-interaction-id string An RFC4122 UID used as a correlation id.
404 x-fapi-interaction-id string An RFC4122 UID used as a correlation id.
405 x-fapi-interaction-id string An RFC4122 UID used as a correlation id.
406 x-fapi-interaction-id string An RFC4122 UID used as a correlation id.
429 Retry-After integer Number in seconds to wait
429 x-fapi-interaction-id string An RFC4122 UID used as a correlation id.
500 x-fapi-interaction-id string An RFC4122 UID used as a correlation id.

Applications

Applying for an account for new customers

Create a new business

Code samples

# You can also use wget
curl -X POST https://develop-api.fairfx.io/open-banking/proxy/cob/v3.1/aasp/application \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

POST https://develop-api.fairfx.io/open-banking/proxy/cob/v3.1/aasp/application HTTP/1.1
Host: develop-api.fairfx.io
Content-Type: application/json
Accept: application/json

var headers = {
  'Content-Type':'application/json',
  'Accept':'application/json',
  'Authorization':'Bearer {access-token}'

};

$.ajax({
  url: 'https://develop-api.fairfx.io/open-banking/proxy/cob/v3.1/aasp/application',
  method: 'post',

  headers: headers,
  success: function(data) {
    console.log(JSON.stringify(data));
  }
})

const fetch = require('node-fetch');
const inputBody = '{
  "Data": {
    "BusinessName": "string",
    "DateEstablished": "2020-10-23T10:23:58Z",
    "CompanyType": 1,
    "MainBusinessActivity": "string",
    "BusinessPhoneNumber": "string",
    "BusinessEmailAddress": "user@example.com",
    "BusinessWebsite": "http://example.com",
    "TradingAddress": {
      "AddressLine": [
        "string"
      ],
      "StreetName": "string",
      "BuildingNumber": "string",
      "PostCode": "string",
      "TownName": "string",
      "CountrySubDivision": [
        "string"
      ],
      "Country": "string"
    },
    "VATNumber": "string",
    "CompanyNumber": "string",
    "EnteringInsolvency": true,
    "ApproxAnnualTurnover": 0,
    "NumberOfFullTimeStaff": 0,
    "NumberOfPartTimeStaff": 0,
    "Personnel": [
      {
        "Title": 1,
        "FirstName": "string",
        "MiddleInitials": "string",
        "Surname": "string",
        "NationalID": "string",
        "DateOfBirth": "2020-10-23T10:23:58Z",
        "JobTitle": "string",
        "Gender": "Male",
        "CompanyPosition": 1,
        "EmailAddress": "user@example.com",
        "MobileNumber": "string",
        "HomeNumber": "string",
        "WorkNumber": "string",
        "Nationality": 1,
        "PersonalAddress": {
          "AddressLine": [
            "string"
          ],
          "StreetName": "string",
          "BuildingNumber": "string",
          "PostCode": "string",
          "TownName": "string",
          "CountrySubDivision": [
            "string"
          ],
          "Country": "string"
        },
        "CanWeContact": true,
        "IsShareholderACompany": true,
        "ShareholderLivesAbroad": true,
        "PercentageOfShares": 1,
        "AccountPrivileges": {}
      }
    ],
    "ThirdPartyReference": "string"
  }
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json',
  'Authorization':'Bearer {access-token}'

};

fetch('https://develop-api.fairfx.io/open-banking/proxy/cob/v3.1/aasp/application',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

POST /aasp/application

Body parameter

{
  "Data": {
    "BusinessName": "string",
    "DateEstablished": "2020-10-23T10:23:58Z",
    "CompanyType": 1,
    "MainBusinessActivity": "string",
    "BusinessPhoneNumber": "string",
    "BusinessEmailAddress": "user@example.com",
    "BusinessWebsite": "http://example.com",
    "TradingAddress": {
      "AddressLine": [
        "string"
      ],
      "StreetName": "string",
      "BuildingNumber": "string",
      "PostCode": "string",
      "TownName": "string",
      "CountrySubDivision": [
        "string"
      ],
      "Country": "string"
    },
    "VATNumber": "string",
    "CompanyNumber": "string",
    "EnteringInsolvency": true,
    "ApproxAnnualTurnover": 0,
    "NumberOfFullTimeStaff": 0,
    "NumberOfPartTimeStaff": 0,
    "Personnel": [
      {
        "Title": 1,
        "FirstName": "string",
        "MiddleInitials": "string",
        "Surname": "string",
        "NationalID": "string",
        "DateOfBirth": "2020-10-23T10:23:58Z",
        "JobTitle": "string",
        "Gender": "Male",
        "CompanyPosition": 1,
        "EmailAddress": "user@example.com",
        "MobileNumber": "string",
        "HomeNumber": "string",
        "WorkNumber": "string",
        "Nationality": 1,
        "PersonalAddress": {
          "AddressLine": [
            "string"
          ],
          "StreetName": "string",
          "BuildingNumber": "string",
          "PostCode": "string",
          "TownName": "string",
          "CountrySubDivision": [
            "string"
          ],
          "Country": "string"
        },
        "CanWeContact": true,
        "IsShareholderACompany": true,
        "ShareholderLivesAbroad": true,
        "PercentageOfShares": 1,
        "AccountPrivileges": {}
      }
    ],
    "ThirdPartyReference": "string"
  }
}

Parameters

Name In Type Required Description
body body OBAccountApplication true Application request object

Example responses

201 Response

{
  "Data": {
    "OwnerID": "string",
    "Accounts": [
      {
        "AccountId": "string",
        "Currency": "string",
        "AccountType": "Business",
        "AccountSubType": "ChargeCard",
        "Description": "string",
        "Nickname": "string"
      }
    ]
  }
}

Responses

Status Meaning Description Schema
201 Created Response object after a successful application OBAccountApplicationResponse
400 Bad Request Invalid request OBErrorResponse1
429 Too Many Requests Too many requests have been made in succession None
500 Internal Server Error An unexpected error occured OBErrorResponse1

Balances

Retrieving account and card balances

Get Balances

Code samples

# You can also use wget
curl -X GET https://develop-api.fairfx.io/open-banking/proxy/cob/v3.1/aisp/balances \
  -H 'Accept: application/json' \
  -H 'x-fapi-auth-date: string' \
  -H 'x-fapi-customer-ip-address: string' \
  -H 'x-fapi-interaction-id: string' \
  -H 'Authorization: string'

GET https://develop-api.fairfx.io/open-banking/proxy/cob/v3.1/aisp/balances HTTP/1.1
Host: develop-api.fairfx.io
Accept: application/json
x-fapi-auth-date: string
x-fapi-customer-ip-address: string
x-fapi-interaction-id: string
Authorization: string

var headers = {
  'Accept':'application/json',
  'x-fapi-auth-date':'string',
  'x-fapi-customer-ip-address':'string',
  'x-fapi-interaction-id':'string',
  'Authorization':'string'

};

$.ajax({
  url: 'https://develop-api.fairfx.io/open-banking/proxy/cob/v3.1/aisp/balances',
  method: 'get',

  headers: headers,
  success: function(data) {
    console.log(JSON.stringify(data));
  }
})

const fetch = require('node-fetch');

const headers = {
  'Accept':'application/json',
  'x-fapi-auth-date':'string',
  'x-fapi-customer-ip-address':'string',
  'x-fapi-interaction-id':'string',
  'Authorization':'string'

};

fetch('https://develop-api.fairfx.io/open-banking/proxy/cob/v3.1/aisp/balances',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

GET /aisp/balances

Parameters

Name In Type Required Description
x-fapi-auth-date header string false The time when the PSU last logged in with the TPP.
x-fapi-customer-ip-address header string false The PSU's IP address if the PSU is currently logged in with the TPP.
x-fapi-interaction-id header string false An RFC4122 UID used as a correlation id.
Authorization header string true An Authorisation Token as per https://tools.ietf.org/html/rfc6750

Detailed descriptions

x-fapi-auth-date: The time when the PSU last logged in with the TPP. All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: Sun, 10 Sep 2017 19:43:31 UTC

Example responses

200 Response

{
  "Data": {
    "Balance": [
      {
        "AccountId": "string",
        "CreditDebitIndicator": "Credit",
        "Type": "ClosingAvailable",
        "DateTime": "2020-10-23T10:23:58Z",
        "Amount": {
          "Amount": "string",
          "Currency": "string"
        },
        "CreditLine": [
          {
            "Included": true,
            "Type": "Available",
            "Amount": {
              "Amount": "string",
              "Currency": "string"
            }
          }
        ]
      }
    ]
  },
  "Links": {
    "Self": "http://example.com",
    "First": "http://example.com",
    "Prev": "http://example.com",
    "Next": "http://example.com",
    "Last": "http://example.com"
  },
  "Meta": {
    "TotalPages": 0,
    "FirstAvailableDateTime": "2020-10-23T10:23:58Z",
    "LastAvailableDateTime": "2020-10-23T10:23:58Z"
  }
}

Responses

Status Meaning Description Schema
200 OK Balances Read OBReadBalance1
400 Bad Request Bad request OBErrorResponse1
401 Unauthorized Unauthorized None
403 Forbidden Forbidden OBErrorResponse1
404 Not Found Not found None
405 Method Not Allowed Method Not Allowed None
406 Not Acceptable Not Acceptable None
429 Too Many Requests Too Many Requests None
500 Internal Server Error Internal Server Error OBErrorResponse1

Response Headers

Status Header Type Format Description
200 x-fapi-interaction-id string An RFC4122 UID used as a correlation id.
400 x-fapi-interaction-id string An RFC4122 UID used as a correlation id.
401 x-fapi-interaction-id string An RFC4122 UID used as a correlation id.
403 x-fapi-interaction-id string An RFC4122 UID used as a correlation id.
404 x-fapi-interaction-id string An RFC4122 UID used as a correlation id.
405 x-fapi-interaction-id string An RFC4122 UID used as a correlation id.
406 x-fapi-interaction-id string An RFC4122 UID used as a correlation id.
429 Retry-After integer Number in seconds to wait
429 x-fapi-interaction-id string An RFC4122 UID used as a correlation id.
500 x-fapi-interaction-id string An RFC4122 UID used as a correlation id.

Beneficiaries

Obtaining a list of payment beneficiaries

Get Beneficiaries

Code samples

# You can also use wget
curl -X GET https://develop-api.fairfx.io/open-banking/proxy/cob/v3.1/aisp/beneficiaries \
  -H 'Accept: application/json' \
  -H 'x-fapi-auth-date: string' \
  -H 'x-fapi-customer-ip-address: string' \
  -H 'x-fapi-interaction-id: string' \
  -H 'Authorization: string'

GET https://develop-api.fairfx.io/open-banking/proxy/cob/v3.1/aisp/beneficiaries HTTP/1.1
Host: develop-api.fairfx.io
Accept: application/json
x-fapi-auth-date: string
x-fapi-customer-ip-address: string
x-fapi-interaction-id: string
Authorization: string

var headers = {
  'Accept':'application/json',
  'x-fapi-auth-date':'string',
  'x-fapi-customer-ip-address':'string',
  'x-fapi-interaction-id':'string',
  'Authorization':'string'

};

$.ajax({
  url: 'https://develop-api.fairfx.io/open-banking/proxy/cob/v3.1/aisp/beneficiaries',
  method: 'get',

  headers: headers,
  success: function(data) {
    console.log(JSON.stringify(data));
  }
})

const fetch = require('node-fetch');

const headers = {
  'Accept':'application/json',
  'x-fapi-auth-date':'string',
  'x-fapi-customer-ip-address':'string',
  'x-fapi-interaction-id':'string',
  'Authorization':'string'

};

fetch('https://develop-api.fairfx.io/open-banking/proxy/cob/v3.1/aisp/beneficiaries',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

GET /aisp/beneficiaries

Parameters

Name In Type Required Description
x-fapi-auth-date header string false The time when the PSU last logged in with the TPP.
x-fapi-customer-ip-address header string false The PSU's IP address if the PSU is currently logged in with the TPP.
x-fapi-interaction-id header string false An RFC4122 UID used as a correlation id.
Authorization header string true An Authorisation Token as per https://tools.ietf.org/html/rfc6750

Detailed descriptions

x-fapi-auth-date: The time when the PSU last logged in with the TPP. All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: Sun, 10 Sep 2017 19:43:31 UTC

Example responses

200 Response

{
  "Data": {
    "Beneficiary": [
      {
        "AccountId": "string",
        "BeneficiaryId": "string",
        "Reference": "string"
      }
    ]
  },
  "Links": {
    "Self": "http://example.com",
    "First": "http://example.com",
    "Prev": "http://example.com",
    "Next": "http://example.com",
    "Last": "http://example.com"
  },
  "Meta": {
    "TotalPages": 0,
    "FirstAvailableDateTime": "2020-10-23T10:23:58Z",
    "LastAvailableDateTime": "2020-10-23T10:23:58Z"
  }
}

Responses

Status Meaning Description Schema
200 OK Beneficiaries Read OBReadBeneficiary3
400 Bad Request Bad request OBErrorResponse1
401 Unauthorized Unauthorized None
403 Forbidden Forbidden OBErrorResponse1
404 Not Found Not found None
405 Method Not Allowed Method Not Allowed None
406 Not Acceptable Not Acceptable None
429 Too Many Requests Too Many Requests None
500 Internal Server Error Internal Server Error OBErrorResponse1

Response Headers

Status Header Type Format Description
200 x-fapi-interaction-id string An RFC4122 UID used as a correlation id.
400 x-fapi-interaction-id string An RFC4122 UID used as a correlation id.
401 x-fapi-interaction-id string An RFC4122 UID used as a correlation id.
403 x-fapi-interaction-id string An RFC4122 UID used as a correlation id.
404 x-fapi-interaction-id string An RFC4122 UID used as a correlation id.
405 x-fapi-interaction-id string An RFC4122 UID used as a correlation id.
406 x-fapi-interaction-id string An RFC4122 UID used as a correlation id.
429 Retry-After integer Number in seconds to wait
429 x-fapi-interaction-id string An RFC4122 UID used as a correlation id.
500 x-fapi-interaction-id string An RFC4122 UID used as a correlation id.

Child Accounts

Retrieving information about child accounts

Get the details of a all child accounts

Code samples

# You can also use wget
curl -X GET https://develop-api.fairfx.io/open-banking/proxy/cob/v3.1/aisp/child-accounts \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

GET https://develop-api.fairfx.io/open-banking/proxy/cob/v3.1/aisp/child-accounts HTTP/1.1
Host: develop-api.fairfx.io
Accept: application/json

var headers = {
  'Accept':'application/json',
  'Authorization':'Bearer {access-token}'

};

$.ajax({
  url: 'https://develop-api.fairfx.io/open-banking/proxy/cob/v3.1/aisp/child-accounts',
  method: 'get',

  headers: headers,
  success: function(data) {
    console.log(JSON.stringify(data));
  }
})

const fetch = require('node-fetch');

const headers = {
  'Accept':'application/json',
  'Authorization':'Bearer {access-token}'

};

fetch('https://develop-api.fairfx.io/open-banking/proxy/cob/v3.1/aisp/child-accounts',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

GET /aisp/child-accounts

Example responses

200 Response

{
  "Data": {
    "Account": [
      {
        "OwnerID": "string",
        "Accounts": [
          {
            "AccountId": "string",
            "Currency": "string",
            "AccountType": "Business",
            "AccountSubType": "ChargeCard",
            "Description": "string",
            "Nickname": "string"
          }
        ]
      }
    ]
  }
}

Responses

Status Meaning Description Schema
200 OK Response object after getting child accounts ChildAccountsResponse
400 Bad Request Invalid request OBErrorResponse1
500 Internal Server Error An unexpected error occured OBErrorResponse1

Get the details of a single child account

Code samples

# You can also use wget
curl -X GET https://develop-api.fairfx.io/open-banking/proxy/cob/v3.1/aisp/child-accounts/{ownerID} \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

GET https://develop-api.fairfx.io/open-banking/proxy/cob/v3.1/aisp/child-accounts/{ownerID} HTTP/1.1
Host: develop-api.fairfx.io
Accept: application/json

var headers = {
  'Accept':'application/json',
  'Authorization':'Bearer {access-token}'

};

$.ajax({
  url: 'https://develop-api.fairfx.io/open-banking/proxy/cob/v3.1/aisp/child-accounts/{ownerID}',
  method: 'get',

  headers: headers,
  success: function(data) {
    console.log(JSON.stringify(data));
  }
})

const fetch = require('node-fetch');

const headers = {
  'Accept':'application/json',
  'Authorization':'Bearer {access-token}'

};

fetch('https://develop-api.fairfx.io/open-banking/proxy/cob/v3.1/aisp/child-accounts/{ownerID}',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

GET /aisp/child-accounts/{ownerID}

Parameters

Name In Type Required Description
ownerID path string true none

Example responses

200 Response

{
  "Data": {
    "Account": {
      "OwnerID": "string",
      "Accounts": [
        {
          "AccountId": "string",
          "Currency": "string",
          "AccountType": "Business",
          "AccountSubType": "ChargeCard",
          "Description": "string",
          "Nickname": "string"
        }
      ]
    }
  }
}

Responses

Status Meaning Description Schema
200 OK Respons object after getting a single child account ChildAccountsByOwnerIDResponse
400 Bad Request Invalid request, or unknown account Inline
500 Internal Server Error An unexpected error occured OBErrorResponse1

Response Schema

Close a single account

Code samples

# You can also use wget
curl -X POST https://develop-api.fairfx.io/open-banking/proxy/cob/v3.1/aisp/close-account \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

POST https://develop-api.fairfx.io/open-banking/proxy/cob/v3.1/aisp/close-account HTTP/1.1
Host: develop-api.fairfx.io
Content-Type: application/json
Accept: application/json

var headers = {
  'Content-Type':'application/json',
  'Accept':'application/json',
  'Authorization':'Bearer {access-token}'

};

$.ajax({
  url: 'https://develop-api.fairfx.io/open-banking/proxy/cob/v3.1/aisp/close-account',
  method: 'post',

  headers: headers,
  success: function(data) {
    console.log(JSON.stringify(data));
  }
})

const fetch = require('node-fetch');
const inputBody = '{
  "Data": {
    "AccountID": "string"
  }
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json',
  'Authorization':'Bearer {access-token}'

};

fetch('https://develop-api.fairfx.io/open-banking/proxy/cob/v3.1/aisp/close-account',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

POST /aisp/close-account

Body parameter

{
  "Data": {
    "AccountID": "string"
  }
}

Parameters

Name In Type Required Description
body body OBCloseAccountRequest true Close account request object

Example responses

400 Response

null

Responses

Status Meaning Description Schema
204 No Content The account was successfully closed None
400 Bad Request Invalid request, or unknown account Inline
500 Internal Server Error An unexpected error occured OBErrorResponse1

Response Schema

Create a single account

Code samples

# You can also use wget
curl -X POST https://develop-api.fairfx.io/open-banking/proxy/cob/v3.1/aisp/create-account \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

POST https://develop-api.fairfx.io/open-banking/proxy/cob/v3.1/aisp/create-account HTTP/1.1
Host: develop-api.fairfx.io
Content-Type: application/json
Accept: application/json

var headers = {
  'Content-Type':'application/json',
  'Accept':'application/json',
  'Authorization':'Bearer {access-token}'

};

$.ajax({
  url: 'https://develop-api.fairfx.io/open-banking/proxy/cob/v3.1/aisp/create-account',
  method: 'post',

  headers: headers,
  success: function(data) {
    console.log(JSON.stringify(data));
  }
})

const fetch = require('node-fetch');
const inputBody = '{
  "Data": {
    "CurrencyCode": "GBP",
    "OwnerID": "string"
  }
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json',
  'Authorization':'Bearer {access-token}'

};

fetch('https://develop-api.fairfx.io/open-banking/proxy/cob/v3.1/aisp/create-account',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

POST /aisp/create-account

Body parameter

{
  "Data": {
    "CurrencyCode": "GBP",
    "OwnerID": "string"
  }
}

Parameters

Name In Type Required Description
body body OBCreateAccountRequest true Create account request object

Example responses

201 Response

{
  "Data": {
    "Account": {
      "Data": {
        "AccountId": "string",
        "Currency": "string",
        "AccountType": "Business",
        "AccountSubType": "ChargeCard",
        "Description": "string",
        "Nickname": "string"
      }
    }
  }
}

Responses

Status Meaning Description Schema
201 Created Response object after creating an account OBCreateAccountResponse
400 Bad Request Invalid request, or unknown account Inline
500 Internal Server Error An unexpected error occured OBErrorResponse1

Response Schema

Domestic Payments

Making new UK domestic payments and obtaining information about existing payments

Code samples

# You can also use wget
curl -X GET https://develop-api.fairfx.io/open-banking/proxy/cob/v3.1/pisp/domestic-payments-by-consent/{consentId} \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

GET https://develop-api.fairfx.io/open-banking/proxy/cob/v3.1/pisp/domestic-payments-by-consent/{consentId} HTTP/1.1
Host: develop-api.fairfx.io
Accept: application/json

var headers = {
  'Accept':'application/json',
  'Authorization':'Bearer {access-token}'

};

$.ajax({
  url: 'https://develop-api.fairfx.io/open-banking/proxy/cob/v3.1/pisp/domestic-payments-by-consent/{consentId}',
  method: 'get',

  headers: headers,
  success: function(data) {
    console.log(JSON.stringify(data));
  }
})

const fetch = require('node-fetch');

const headers = {
  'Accept':'application/json',
  'Authorization':'Bearer {access-token}'

};

fetch('https://develop-api.fairfx.io/open-banking/proxy/cob/v3.1/pisp/domestic-payments-by-consent/{consentId}',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

GET /pisp/domestic-payments-by-consent/{consentId}

Name In Type Required Description
consentId path string true none

Example responses

200 Response

{
  "Data": {
    "DomesticPaymentId": "string",
    "ConsentId": "string",
    "CreationDateTime": "2020-10-23T10:23:58Z",
    "Status": "AcceptedCreditSettlementCompleted",
    "StatusUpdateDateTime": "2020-10-23T10:23:58Z",
    "ExpectedExecutionDateTime": "2020-10-23T10:23:58Z",
    "ExpectedSettlementDateTime": "2020-10-23T10:23:58Z",
    "Charges": [
      {
        "ChargeBearer": "BorneByCreditor",
        "Type": "string",
        "Amount": {
          "Amount": "string",
          "Currency": "string"
        }
      }
    ],
    "Initiation": {
      "InstructionIdentification": "string",
      "EndToEndIdentification": "string",
      "LocalInstrument": "string",
      "InstructedAmount": {
        "Amount": "string",
        "Currency": "string"
      },
      "DebtorAccount": {
        "SchemeName": "string",
        "Identification": "string",
        "Name": "string",
        "SecondaryIdentification": "string"
      },
      "CreditorAccount": {
        "SchemeName": "string",
        "Identification": "string",
        "Name": "string",
        "SecondaryIdentification": "string"
      },
      "CreditorPostalAddress": {
        "AddressType": "Business",
        "Department": "string",
        "SubDepartment": "string",
        "StreetName": "string",
        "BuildingNumber": "string",
        "PostCode": "string",
        "TownName": "string",
        "CountrySubDivision": "string",
        "Country": "string",
        "AddressLine": [
          "string"
        ]
      },
      "RemittanceInformation": {
        "Unstructured": "string",
        "Reference": "string"
      },
      "SupplementaryData": {}
    },
    "MultiAuthorisation": {
      "Status": "Authorised",
      "NumberRequired": 0,
      "NumberReceived": 0,
      "LastUpdateDateTime": "2020-10-23T10:23:58Z",
      "ExpirationDateTime": "2020-10-23T10:23:58Z"
    }
  },
  "Links": {
    "Self": "http://example.com",
    "First": "http://example.com",
    "Prev": "http://example.com",
    "Next": "http://example.com",
    "Last": "http://example.com"
  },
  "Meta": {
    "TotalPages": 0,
    "FirstAvailableDateTime": "2020-10-23T10:23:58Z",
    "LastAvailableDateTime": "2020-10-23T10:23:58Z"
  }
}
Status Meaning Description Schema
200 OK Domestic Payments Read OBWriteDomesticResponse3
400 Bad Request The provided ID was not recognised OBErrorResponse1
500 Internal Server Error An unexpected error occured OBErrorResponse1

Response Headers

Status Header Type Format Description
200 x-fapi-interaction-id string An RFC4122 UID used as a correlation id.
200 x-jws-signature string Header containing a detached JWS signature of the body of the payload.

Create Domestic Payment Consents

Code samples

# You can also use wget
curl -X POST https://develop-api.fairfx.io/open-banking/proxy/cob/v3.1/pisp/domestic-payment-consents \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'x-fapi-auth-date: string' \
  -H 'x-fapi-customer-ip-address: string' \
  -H 'x-fapi-interaction-id: string' \
  -H 'Authorization: string' \
  -H 'x-idempotency-key: string' \
  -H 'x-jws-signature: string'

POST https://develop-api.fairfx.io/open-banking/proxy/cob/v3.1/pisp/domestic-payment-consents HTTP/1.1
Host: develop-api.fairfx.io
Content-Type: application/json
Accept: application/json
x-fapi-auth-date: string
x-fapi-customer-ip-address: string
x-fapi-interaction-id: string
Authorization: string
x-idempotency-key: string
x-jws-signature: string

var headers = {
  'Content-Type':'application/json',
  'Accept':'application/json',
  'x-fapi-auth-date':'string',
  'x-fapi-customer-ip-address':'string',
  'x-fapi-interaction-id':'string',
  'Authorization':'string',
  'x-idempotency-key':'string',
  'x-jws-signature':'string'

};

$.ajax({
  url: 'https://develop-api.fairfx.io/open-banking/proxy/cob/v3.1/pisp/domestic-payment-consents',
  method: 'post',

  headers: headers,
  success: function(data) {
    console.log(JSON.stringify(data));
  }
})

const fetch = require('node-fetch');
const inputBody = '{
  "Data": {
    "Initiation": {
      "InstructionIdentification": "string",
      "EndToEndIdentification": "string",
      "LocalInstrument": "string",
      "InstructedAmount": {
        "Amount": "string",
        "Currency": "string"
      },
      "DebtorAccount": {
        "SchemeName": "string",
        "Identification": "string",
        "Name": "string",
        "SecondaryIdentification": "string"
      },
      "CreditorAccount": {
        "SchemeName": "string",
        "Identification": "string",
        "Name": "string",
        "SecondaryIdentification": "string"
      },
      "CreditorPostalAddress": {
        "AddressType": "Business",
        "Department": "string",
        "SubDepartment": "string",
        "StreetName": "string",
        "BuildingNumber": "string",
        "PostCode": "string",
        "TownName": "string",
        "CountrySubDivision": "string",
        "Country": "string",
        "AddressLine": [
          "string"
        ]
      },
      "RemittanceInformation": {
        "Unstructured": "string",
        "Reference": "string"
      },
      "SupplementaryData": {}
    },
    "Authorisation": {
      "AuthorisationType": "Any",
      "CompletionDateTime": "2020-10-23T10:23:58Z"
    },
    "SCASupportData": {
      "RequestedSCAExemptionType": "BillPayment",
      "AppliedAuthenticationApproach": "CA",
      "ReferencePaymentOrderId": "string"
    }
  },
  "Risk": {
    "PaymentContextCode": "BillPayment",
    "MerchantCategoryCode": "stri",
    "MerchantCustomerIdentification": "string",
    "DeliveryAddress": {
      "AddressLine": [
        "string"
      ],
      "StreetName": "string",
      "BuildingNumber": "string",
      "PostCode": "string",
      "TownName": "string",
      "CountrySubDivision": [
        "string"
      ],
      "Country": "string"
    }
  }
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json',
  'x-fapi-auth-date':'string',
  'x-fapi-customer-ip-address':'string',
  'x-fapi-interaction-id':'string',
  'Authorization':'string',
  'x-idempotency-key':'string',
  'x-jws-signature':'string'

};

fetch('https://develop-api.fairfx.io/open-banking/proxy/cob/v3.1/pisp/domestic-payment-consents',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

POST /pisp/domestic-payment-consents

Body parameter

{
  "Data": {
    "Initiation": {
      "InstructionIdentification": "string",
      "EndToEndIdentification": "string",
      "LocalInstrument": "string",
      "InstructedAmount": {
        "Amount": "string",
        "Currency": "string"
      },
      "DebtorAccount": {
        "SchemeName": "string",
        "Identification": "string",
        "Name": "string",
        "SecondaryIdentification": "string"
      },
      "CreditorAccount": {
        "SchemeName": "string",
        "Identification": "string",
        "Name": "string",
        "SecondaryIdentification": "string"
      },
      "CreditorPostalAddress": {
        "AddressType": "Business",
        "Department": "string",
        "SubDepartment": "string",
        "StreetName": "string",
        "BuildingNumber": "string",
        "PostCode": "string",
        "TownName": "string",
        "CountrySubDivision": "string",
        "Country": "string",
        "AddressLine": [
          "string"
        ]
      },
      "RemittanceInformation": {
        "Unstructured": "string",
        "Reference": "string"
      },
      "SupplementaryData": {}
    },
    "Authorisation": {
      "AuthorisationType": "Any",
      "CompletionDateTime": "2020-10-23T10:23:58Z"
    },
    "SCASupportData": {
      "RequestedSCAExemptionType": "BillPayment",
      "AppliedAuthenticationApproach": "CA",
      "ReferencePaymentOrderId": "string"
    }
  },
  "Risk": {
    "PaymentContextCode": "BillPayment",
    "MerchantCategoryCode": "stri",
    "MerchantCustomerIdentification": "string",
    "DeliveryAddress": {
      "AddressLine": [
        "string"
      ],
      "StreetName": "string",
      "BuildingNumber": "string",
      "PostCode": "string",
      "TownName": "string",
      "CountrySubDivision": [
        "string"
      ],
      "Country": "string"
    }
  }
}

Parameters

Name In Type Required Description
x-fapi-auth-date header string false The time when the PSU last logged in with the TPP.
x-fapi-customer-ip-address header string false The PSU's IP address if the PSU is currently logged in with the TPP.
x-fapi-interaction-id header string false An RFC4122 UID used as a correlation id.
Authorization header string true An Authorisation Token as per https://tools.ietf.org/html/rfc6750
x-idempotency-key header string true Every request will be processed only once per x-idempotency-key. The
x-jws-signature header string true A detached JWS signature of the body of the payload.
body body OBWriteDomesticConsent3Param true Default

Detailed descriptions

x-fapi-auth-date: The time when the PSU last logged in with the TPP. All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: Sun, 10 Sep 2017 19:43:31 UTC

x-idempotency-key: Every request will be processed only once per x-idempotency-key. The Idempotency Key will be valid for 24 hours.

Example responses

201 Response

{
  "Data": {
    "ConsentId": "string",
    "CreationDateTime": "2020-10-23T10:23:58Z",
    "Status": "Authorised",
    "StatusUpdateDateTime": "2020-10-23T10:23:58Z",
    "CutOffDateTime": "2020-10-23T10:23:58Z",
    "ExpectedExecutionDateTime": "2020-10-23T10:23:58Z",
    "ExpectedSettlementDateTime": "2020-10-23T10:23:58Z",
    "Charges": [
      {
        "ChargeBearer": "BorneByCreditor",
        "Type": "string",
        "Amount": {
          "Amount": "string",
          "Currency": "string"
        }
      }
    ],
    "Initiation": {
      "InstructionIdentification": "string",
      "EndToEndIdentification": "string",
      "LocalInstrument": "string",
      "InstructedAmount": {
        "Amount": "string",
        "Currency": "string"
      },
      "DebtorAccount": {
        "SchemeName": "string",
        "Identification": "string",
        "Name": "string",
        "SecondaryIdentification": "string"
      },
      "CreditorAccount": {
        "SchemeName": "string",
        "Identification": "string",
        "Name": "string",
        "SecondaryIdentification": "string"
      },
      "CreditorPostalAddress": {
        "AddressType": "Business",
        "Department": "string",
        "SubDepartment": "string",
        "StreetName": "string",
        "BuildingNumber": "string",
        "PostCode": "string",
        "TownName": "string",
        "CountrySubDivision": "string",
        "Country": "string",
        "AddressLine": [
          "string"
        ]
      },
      "RemittanceInformation": {
        "Unstructured": "string",
        "Reference": "string"
      },
      "SupplementaryData": {}
    },
    "Authorisation": {
      "AuthorisationType": "Any",
      "CompletionDateTime": "2020-10-23T10:23:58Z"
    },
    "SCASupportData": {
      "RequestedSCAExemptionType": "BillPayment",
      "AppliedAuthenticationApproach": "CA",
      "ReferencePaymentOrderId": "string"
    }
  },
  "Risk": {
    "PaymentContextCode": "BillPayment",
    "MerchantCategoryCode": "stri",
    "MerchantCustomerIdentification": "string",
    "DeliveryAddress": {
      "AddressLine": [
        "string"
      ],
      "StreetName": "string",
      "BuildingNumber": "string",
      "PostCode": "string",
      "TownName": "string",
      "CountrySubDivision": [
        "string"
      ],
      "Country": "string"
    }
  },
  "Links": {
    "Self": "http://example.com",
    "First": "http://example.com",
    "Prev": "http://example.com",
    "Next": "http://example.com",
    "Last": "http://example.com"
  },
  "Meta": {
    "TotalPages": 0,
    "FirstAvailableDateTime": "2020-10-23T10:23:58Z",
    "LastAvailableDateTime": "2020-10-23T10:23:58Z"
  }
}

Responses

Status Meaning Description Schema
201 Created Domestic Payment Consents Created OBWriteDomesticConsentResponse3
400 Bad Request Bad request OBErrorResponse1
401 Unauthorized Unauthorized None
403 Forbidden Forbidden OBErrorResponse1
404 Not Found Not found None
405 Method Not Allowed Method Not Allowed None
406 Not Acceptable Not Acceptable None
429 Too Many Requests Too Many Requests None
500 Internal Server Error Internal Server Error OBErrorResponse1

Response Headers

Status Header Type Format Description
201 x-fapi-interaction-id string An RFC4122 UID used as a correlation id.
201 x-jws-signature string Header containing a detached JWS signature of the body of the payload.
400 x-fapi-interaction-id string An RFC4122 UID used as a correlation id.
401 x-fapi-interaction-id string An RFC4122 UID used as a correlation id.
403 x-fapi-interaction-id string An RFC4122 UID used as a correlation id.
404 x-fapi-interaction-id string An RFC4122 UID used as a correlation id.
405 x-fapi-interaction-id string An RFC4122 UID used as a correlation id.
406 x-fapi-interaction-id string An RFC4122 UID used as a correlation id.
429 Retry-After integer Number in seconds to wait
429 x-fapi-interaction-id string An RFC4122 UID used as a correlation id.
500 x-fapi-interaction-id string An RFC4122 UID used as a correlation id.

Get Domestic Payment Consents

Code samples

# You can also use wget
curl -X GET https://develop-api.fairfx.io/open-banking/proxy/cob/v3.1/pisp/domestic-payment-consents/{ConsentId}/funds-confirmation \
  -H 'Accept: application/json' \
  -H 'x-fapi-auth-date: string' \
  -H 'x-fapi-customer-ip-address: string' \
  -H 'x-fapi-interaction-id: string' \
  -H 'Authorization: string'

GET https://develop-api.fairfx.io/open-banking/proxy/cob/v3.1/pisp/domestic-payment-consents/{ConsentId}/funds-confirmation HTTP/1.1
Host: develop-api.fairfx.io
Accept: application/json
x-fapi-auth-date: string
x-fapi-customer-ip-address: string
x-fapi-interaction-id: string
Authorization: string

var headers = {
  'Accept':'application/json',
  'x-fapi-auth-date':'string',
  'x-fapi-customer-ip-address':'string',
  'x-fapi-interaction-id':'string',
  'Authorization':'string'

};

$.ajax({
  url: 'https://develop-api.fairfx.io/open-banking/proxy/cob/v3.1/pisp/domestic-payment-consents/{ConsentId}/funds-confirmation',
  method: 'get',

  headers: headers,
  success: function(data) {
    console.log(JSON.stringify(data));
  }
})

const fetch = require('node-fetch');

const headers = {
  'Accept':'application/json',
  'x-fapi-auth-date':'string',
  'x-fapi-customer-ip-address':'string',
  'x-fapi-interaction-id':'string',
  'Authorization':'string'

};

fetch('https://develop-api.fairfx.io/open-banking/proxy/cob/v3.1/pisp/domestic-payment-consents/{ConsentId}/funds-confirmation',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

GET /pisp/domestic-payment-consents/{ConsentId}/funds-confirmation

Parameters

Name In Type Required Description
ConsentId path string true ConsentId
x-fapi-auth-date header string false The time when the PSU last logged in with the TPP.
x-fapi-customer-ip-address header string false The PSU's IP address if the PSU is currently logged in with the TPP.
x-fapi-interaction-id header string false An RFC4122 UID used as a correlation id.
Authorization header string true An Authorisation Token as per https://tools.ietf.org/html/rfc6750

Detailed descriptions

x-fapi-auth-date: The time when the PSU last logged in with the TPP. All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: Sun, 10 Sep 2017 19:43:31 UTC

Example responses

200 Response

{
  "Data": {
    "FundsAvailableResult": {
      "FundsAvailableDateTime": "2020-10-23T10:23:58Z",
      "FundsAvailable": true
    },
    "SupplementaryData": {}
  },
  "Links": {
    "Self": "http://example.com",
    "First": "http://example.com",
    "Prev": "http://example.com",
    "Next": "http://example.com",
    "Last": "http://example.com"
  },
  "Meta": {
    "TotalPages": 0,
    "FirstAvailableDateTime": "2020-10-23T10:23:58Z",
    "LastAvailableDateTime": "2020-10-23T10:23:58Z"
  }
}

Responses

Status Meaning Description Schema
200 OK Domestic Payment Consents Read OBWriteFundsConfirmationResponse1
400 Bad Request Bad request OBErrorResponse1
401 Unauthorized Unauthorized None
403 Forbidden Forbidden OBErrorResponse1
404 Not Found Not found None
405 Method Not Allowed Method Not Allowed None
406 Not Acceptable Not Acceptable None
429 Too Many Requests Too Many Requests None
500 Internal Server Error Internal Server Error OBErrorResponse1

Response Headers

Status Header Type Format Description
200 x-fapi-interaction-id string An RFC4122 UID used as a correlation id.
200 x-jws-signature string Header containing a detached JWS signature of the body of the payload.
400 x-fapi-interaction-id string An RFC4122 UID used as a correlation id.
401 x-fapi-interaction-id string An RFC4122 UID used as a correlation id.
403 x-fapi-interaction-id string An RFC4122 UID used as a correlation id.
404 x-fapi-interaction-id string An RFC4122 UID used as a correlation id.
405 x-fapi-interaction-id string An RFC4122 UID used as a correlation id.
406 x-fapi-interaction-id string An RFC4122 UID used as a correlation id.
429 Retry-After integer Number in seconds to wait
429 x-fapi-interaction-id string An RFC4122 UID used as a correlation id.
500 x-fapi-interaction-id string An RFC4122 UID used as a correlation id.

Create Domestic Payments

Code samples

# You can also use wget
curl -X POST https://develop-api.fairfx.io/open-banking/proxy/cob/v3.1/pisp/domestic-payments \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'x-fapi-auth-date: string' \
  -H 'x-fapi-customer-ip-address: string' \
  -H 'x-fapi-interaction-id: string' \
  -H 'Authorization: string' \
  -H 'x-idempotency-key: string' \
  -H 'x-jws-signature: string'

POST https://develop-api.fairfx.io/open-banking/proxy/cob/v3.1/pisp/domestic-payments HTTP/1.1
Host: develop-api.fairfx.io
Content-Type: application/json
Accept: application/json
x-fapi-auth-date: string
x-fapi-customer-ip-address: string
x-fapi-interaction-id: string
Authorization: string
x-idempotency-key: string
x-jws-signature: string

var headers = {
  'Content-Type':'application/json',
  'Accept':'application/json',
  'x-fapi-auth-date':'string',
  'x-fapi-customer-ip-address':'string',
  'x-fapi-interaction-id':'string',
  'Authorization':'string',
  'x-idempotency-key':'string',
  'x-jws-signature':'string'

};

$.ajax({
  url: 'https://develop-api.fairfx.io/open-banking/proxy/cob/v3.1/pisp/domestic-payments',
  method: 'post',

  headers: headers,
  success: function(data) {
    console.log(JSON.stringify(data));
  }
})

const fetch = require('node-fetch');
const inputBody = '{
  "Data": {
    "ConsentId": "string",
    "Initiation": {
      "InstructionIdentification": "string",
      "EndToEndIdentification": "string",
      "LocalInstrument": "string",
      "InstructedAmount": {
        "Amount": "string",
        "Currency": "string"
      },
      "DebtorAccount": {
        "SchemeName": "string",
        "Identification": "string",
        "Name": "string",
        "SecondaryIdentification": "string"
      },
      "CreditorAccount": {
        "SchemeName": "string",
        "Identification": "string",
        "Name": "string",
        "SecondaryIdentification": "string"
      },
      "CreditorPostalAddress": {
        "AddressType": "Business",
        "Department": "string",
        "SubDepartment": "string",
        "StreetName": "string",
        "BuildingNumber": "string",
        "PostCode": "string",
        "TownName": "string",
        "CountrySubDivision": "string",
        "Country": "string",
        "AddressLine": [
          "string"
        ]
      },
      "RemittanceInformation": {
        "Unstructured": "string",
        "Reference": "string"
      },
      "SupplementaryData": {}
    }
  },
  "Risk": {
    "PaymentContextCode": "BillPayment",
    "MerchantCategoryCode": "stri",
    "MerchantCustomerIdentification": "string",
    "DeliveryAddress": {
      "AddressLine": [
        "string"
      ],
      "StreetName": "string",
      "BuildingNumber": "string",
      "PostCode": "string",
      "TownName": "string",
      "CountrySubDivision": [
        "string"
      ],
      "Country": "string"
    }
  }
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json',
  'x-fapi-auth-date':'string',
  'x-fapi-customer-ip-address':'string',
  'x-fapi-interaction-id':'string',
  'Authorization':'string',
  'x-idempotency-key':'string',
  'x-jws-signature':'string'

};

fetch('https://develop-api.fairfx.io/open-banking/proxy/cob/v3.1/pisp/domestic-payments',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

POST /pisp/domestic-payments

Body parameter

{
  "Data": {
    "ConsentId": "string",
    "Initiation": {
      "InstructionIdentification": "string",
      "EndToEndIdentification": "string",
      "LocalInstrument": "string",
      "InstructedAmount": {
        "Amount": "string",
        "Currency": "string"
      },
      "DebtorAccount": {
        "SchemeName": "string",
        "Identification": "string",
        "Name": "string",
        "SecondaryIdentification": "string"
      },
      "CreditorAccount": {
        "SchemeName": "string",
        "Identification": "string",
        "Name": "string",
        "SecondaryIdentification": "string"
      },
      "CreditorPostalAddress": {
        "AddressType": "Business",
        "Department": "string",
        "SubDepartment": "string",
        "StreetName": "string",
        "BuildingNumber": "string",
        "PostCode": "string",
        "TownName": "string",
        "CountrySubDivision": "string",
        "Country": "string",
        "AddressLine": [
          "string"
        ]
      },
      "RemittanceInformation": {
        "Unstructured": "string",
        "Reference": "string"
      },
      "SupplementaryData": {}
    }
  },
  "Risk": {
    "PaymentContextCode": "BillPayment",
    "MerchantCategoryCode": "stri",
    "MerchantCustomerIdentification": "string",
    "DeliveryAddress": {
      "AddressLine": [
        "string"
      ],
      "StreetName": "string",
      "BuildingNumber": "string",
      "PostCode": "string",
      "TownName": "string",
      "CountrySubDivision": [
        "string"
      ],
      "Country": "string"
    }
  }
}

Parameters

Name In Type Required Description
x-fapi-auth-date header string false The time when the PSU last logged in with the TPP.
x-fapi-customer-ip-address header string false The PSU's IP address if the PSU is currently logged in with the TPP.
x-fapi-interaction-id header string false An RFC4122 UID used as a correlation id.
Authorization header string true An Authorisation Token as per https://tools.ietf.org/html/rfc6750
x-idempotency-key header string true Every request will be processed only once per x-idempotency-key. The
x-jws-signature header string true A detached JWS signature of the body of the payload.
body body OBWriteDomestic2Param true Default

Detailed descriptions

x-fapi-auth-date: The time when the PSU last logged in with the TPP. All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: Sun, 10 Sep 2017 19:43:31 UTC

x-idempotency-key: Every request will be processed only once per x-idempotency-key. The Idempotency Key will be valid for 24 hours.

Example responses

201 Response

{
  "Data": {
    "DomesticPaymentId": "string",
    "ConsentId": "string",
    "CreationDateTime": "2020-10-23T10:23:58Z",
    "Status": "AcceptedCreditSettlementCompleted",
    "StatusUpdateDateTime": "2020-10-23T10:23:58Z",
    "ExpectedExecutionDateTime": "2020-10-23T10:23:58Z",
    "ExpectedSettlementDateTime": "2020-10-23T10:23:58Z",
    "Charges": [
      {
        "ChargeBearer": "BorneByCreditor",
        "Type": "string",
        "Amount": {
          "Amount": "string",
          "Currency": "string"
        }
      }
    ],
    "Initiation": {
      "InstructionIdentification": "string",
      "EndToEndIdentification": "string",
      "LocalInstrument": "string",
      "InstructedAmount": {
        "Amount": "string",
        "Currency": "string"
      },
      "DebtorAccount": {
        "SchemeName": "string",
        "Identification": "string",
        "Name": "string",
        "SecondaryIdentification": "string"
      },
      "CreditorAccount": {
        "SchemeName": "string",
        "Identification": "string",
        "Name": "string",
        "SecondaryIdentification": "string"
      },
      "CreditorPostalAddress": {
        "AddressType": "Business",
        "Department": "string",
        "SubDepartment": "string",
        "StreetName": "string",
        "BuildingNumber": "string",
        "PostCode": "string",
        "TownName": "string",
        "CountrySubDivision": "string",
        "Country": "string",
        "AddressLine": [
          "string"
        ]
      },
      "RemittanceInformation": {
        "Unstructured": "string",
        "Reference": "string"
      },
      "SupplementaryData": {}
    },
    "MultiAuthorisation": {
      "Status": "Authorised",
      "NumberRequired": 0,
      "NumberReceived": 0,
      "LastUpdateDateTime": "2020-10-23T10:23:58Z",
      "ExpirationDateTime": "2020-10-23T10:23:58Z"
    }
  },
  "Links": {
    "Self": "http://example.com",
    "First": "http://example.com",
    "Prev": "http://example.com",
    "Next": "http://example.com",
    "Last": "http://example.com"
  },
  "Meta": {
    "TotalPages": 0,
    "FirstAvailableDateTime": "2020-10-23T10:23:58Z",
    "LastAvailableDateTime": "2020-10-23T10:23:58Z"
  }
}

Responses

Status Meaning Description Schema
201 Created Domestic Payments Created OBWriteDomesticResponse3
400 Bad Request Bad request OBErrorResponse1
401 Unauthorized Unauthorized None
403 Forbidden Forbidden OBErrorResponse1
404 Not Found Not found None
405 Method Not Allowed Method Not Allowed None
406 Not Acceptable Not Acceptable None
429 Too Many Requests Too Many Requests None
500 Internal Server Error Internal Server Error OBErrorResponse1

Response Headers

Status Header Type Format Description
201 x-fapi-interaction-id string An RFC4122 UID used as a correlation id.
201 x-jws-signature string Header containing a detached JWS signature of the body of the payload.
400 x-fapi-interaction-id string An RFC4122 UID used as a correlation id.
401 x-fapi-interaction-id string An RFC4122 UID used as a correlation id.
403 x-fapi-interaction-id string An RFC4122 UID used as a correlation id.
404 x-fapi-interaction-id string An RFC4122 UID used as a correlation id.
405 x-fapi-interaction-id string An RFC4122 UID used as a correlation id.
406 x-fapi-interaction-id string An RFC4122 UID used as a correlation id.
429 Retry-After integer Number in seconds to wait
429 x-fapi-interaction-id string An RFC4122 UID used as a correlation id.
500 x-fapi-interaction-id string An RFC4122 UID used as a correlation id.

Get Domestic Payments

Code samples

# You can also use wget
curl -X GET https://develop-api.fairfx.io/open-banking/proxy/cob/v3.1/pisp/domestic-payments/{DomesticPaymentId} \
  -H 'Accept: application/json' \
  -H 'x-fapi-auth-date: string' \
  -H 'x-fapi-customer-ip-address: string' \
  -H 'x-fapi-interaction-id: string' \
  -H 'Authorization: string'

GET https://develop-api.fairfx.io/open-banking/proxy/cob/v3.1/pisp/domestic-payments/{DomesticPaymentId} HTTP/1.1
Host: develop-api.fairfx.io
Accept: application/json
x-fapi-auth-date: string
x-fapi-customer-ip-address: string
x-fapi-interaction-id: string
Authorization: string

var headers = {
  'Accept':'application/json',
  'x-fapi-auth-date':'string',
  'x-fapi-customer-ip-address':'string',
  'x-fapi-interaction-id':'string',
  'Authorization':'string'

};

$.ajax({
  url: 'https://develop-api.fairfx.io/open-banking/proxy/cob/v3.1/pisp/domestic-payments/{DomesticPaymentId}',
  method: 'get',

  headers: headers,
  success: function(data) {
    console.log(JSON.stringify(data));
  }
})

const fetch = require('node-fetch');

const headers = {
  'Accept':'application/json',
  'x-fapi-auth-date':'string',
  'x-fapi-customer-ip-address':'string',
  'x-fapi-interaction-id':'string',
  'Authorization':'string'

};

fetch('https://develop-api.fairfx.io/open-banking/proxy/cob/v3.1/pisp/domestic-payments/{DomesticPaymentId}',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

GET /pisp/domestic-payments/{DomesticPaymentId}

Parameters

Name In Type Required Description
DomesticPaymentId path string true DomesticPaymentId
x-fapi-auth-date header string false The time when the PSU last logged in with the TPP.
x-fapi-customer-ip-address header string false The PSU's IP address if the PSU is currently logged in with the TPP.
x-fapi-interaction-id header string false An RFC4122 UID used as a correlation id.
Authorization header string true An Authorisation Token as per https://tools.ietf.org/html/rfc6750

Detailed descriptions

x-fapi-auth-date: The time when the PSU last logged in with the TPP. All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: Sun, 10 Sep 2017 19:43:31 UTC

Example responses

200 Response

{
  "Data": {
    "DomesticPaymentId": "string",
    "ConsentId": "string",
    "CreationDateTime": "2020-10-23T10:23:58Z",
    "Status": "AcceptedCreditSettlementCompleted",
    "StatusUpdateDateTime": "2020-10-23T10:23:58Z",
    "ExpectedExecutionDateTime": "2020-10-23T10:23:58Z",
    "ExpectedSettlementDateTime": "2020-10-23T10:23:58Z",
    "Charges": [
      {
        "ChargeBearer": "BorneByCreditor",
        "Type": "string",
        "Amount": {
          "Amount": "string",
          "Currency": "string"
        }
      }
    ],
    "Initiation": {
      "InstructionIdentification": "string",
      "EndToEndIdentification": "string",
      "LocalInstrument": "string",
      "InstructedAmount": {
        "Amount": "string",
        "Currency": "string"
      },
      "DebtorAccount": {
        "SchemeName": "string",
        "Identification": "string",
        "Name": "string",
        "SecondaryIdentification": "string"
      },
      "CreditorAccount": {
        "SchemeName": "string",
        "Identification": "string",
        "Name": "string",
        "SecondaryIdentification": "string"
      },
      "CreditorPostalAddress": {
        "AddressType": "Business",
        "Department": "string",
        "SubDepartment": "string",
        "StreetName": "string",
        "BuildingNumber": "string",
        "PostCode": "string",
        "TownName": "string",
        "CountrySubDivision": "string",
        "Country": "string",
        "AddressLine": [
          "string"
        ]
      },
      "RemittanceInformation": {
        "Unstructured": "string",
        "Reference": "string"
      },
      "SupplementaryData": {}
    },
    "MultiAuthorisation": {
      "Status": "Authorised",
      "NumberRequired": 0,
      "NumberReceived": 0,
      "LastUpdateDateTime": "2020-10-23T10:23:58Z",
      "ExpirationDateTime": "2020-10-23T10:23:58Z"
    }
  },
  "Links": {
    "Self": "http://example.com",
    "First": "http://example.com",
    "Prev": "http://example.com",
    "Next": "http://example.com",
    "Last": "http://example.com"
  },
  "Meta": {
    "TotalPages": 0,
    "FirstAvailableDateTime": "2020-10-23T10:23:58Z",
    "LastAvailableDateTime": "2020-10-23T10:23:58Z"
  }
}

Responses

Status Meaning Description Schema
200 OK Domestic Payments Read OBWriteDomesticResponse3
400 Bad Request Bad request OBErrorResponse1
401 Unauthorized Unauthorized None
403 Forbidden Forbidden OBErrorResponse1
404 Not Found Not found None
405 Method Not Allowed Method Not Allowed None
406 Not Acceptable Not Acceptable None
429 Too Many Requests Too Many Requests None
500 Internal Server Error Internal Server Error OBErrorResponse1

Response Headers

Status Header Type Format Description
200 x-fapi-interaction-id string An RFC4122 UID used as a correlation id.
200 x-jws-signature string Header containing a detached JWS signature of the body of the payload.
400 x-fapi-interaction-id string An RFC4122 UID used as a correlation id.
401 x-fapi-interaction-id string An RFC4122 UID used as a correlation id.
403 x-fapi-interaction-id string An RFC4122 UID used as a correlation id.
404 x-fapi-interaction-id string An RFC4122 UID used as a correlation id.
405 x-fapi-interaction-id string An RFC4122 UID used as a correlation id.
406 x-fapi-interaction-id string An RFC4122 UID used as a correlation id.
429 Retry-After integer Number in seconds to wait
429 x-fapi-interaction-id string An RFC4122 UID used as a correlation id.
500 x-fapi-interaction-id string An RFC4122 UID used as a correlation id.

Get Payment Details

Code samples

# You can also use wget
curl -X GET https://develop-api.fairfx.io/open-banking/proxy/cob/v3.1/pisp/domestic-payments/{DomesticPaymentId}/payment-details \
  -H 'Accept: application/json' \
  -H 'x-fapi-auth-date: string' \
  -H 'x-fapi-customer-ip-address: string' \
  -H 'x-fapi-interaction-id: string' \
  -H 'Authorization: string'

GET https://develop-api.fairfx.io/open-banking/proxy/cob/v3.1/pisp/domestic-payments/{DomesticPaymentId}/payment-details HTTP/1.1
Host: develop-api.fairfx.io
Accept: application/json
x-fapi-auth-date: string
x-fapi-customer-ip-address: string
x-fapi-interaction-id: string
Authorization: string

var headers = {
  'Accept':'application/json',
  'x-fapi-auth-date':'string',
  'x-fapi-customer-ip-address':'string',
  'x-fapi-interaction-id':'string',
  'Authorization':'string'

};

$.ajax({
  url: 'https://develop-api.fairfx.io/open-banking/proxy/cob/v3.1/pisp/domestic-payments/{DomesticPaymentId}/payment-details',
  method: 'get',

  headers: headers,
  success: function(data) {
    console.log(JSON.stringify(data));
  }
})

const fetch = require('node-fetch');

const headers = {
  'Accept':'application/json',
  'x-fapi-auth-date':'string',
  'x-fapi-customer-ip-address':'string',
  'x-fapi-interaction-id':'string',
  'Authorization':'string'

};

fetch('https://develop-api.fairfx.io/open-banking/proxy/cob/v3.1/pisp/domestic-payments/{DomesticPaymentId}/payment-details',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

GET /pisp/domestic-payments/{DomesticPaymentId}/payment-details

Parameters

Name In Type Required Description
DomesticPaymentId path string true DomesticPaymentId
x-fapi-auth-date header string false The time when the PSU last logged in with the TPP.
x-fapi-customer-ip-address header string false The PSU's IP address if the PSU is currently logged in with the TPP.
x-fapi-interaction-id header string false An RFC4122 UID used as a correlation id.
Authorization header string true An Authorisation Token as per https://tools.ietf.org/html/rfc6750

Detailed descriptions

x-fapi-auth-date: The time when the PSU last logged in with the TPP. All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: Sun, 10 Sep 2017 19:43:31 UTC

Example responses

200 Response

{
  "Data": {
    "PaymentStatus": [
      {
        "PaymentTransactionId": "string",
        "Status": "Accepted",
        "StatusUpdateDateTime": "2020-10-23T10:23:58Z",
        "StatusDetail": {
          "LocalInstrument": "string",
          "Status": "string",
          "StatusReason": "Cancelled",
          "StatusReasonDescription": "string"
        }
      }
    ]
  },
  "Links": {
    "Self": "http://example.com",
    "First": "http://example.com",
    "Prev": "http://example.com",
    "Next": "http://example.com",
    "Last": "http://example.com"
  },
  "Meta": {
    "TotalPages": 0,
    "FirstAvailableDateTime": "2020-10-23T10:23:58Z",
    "LastAvailableDateTime": "2020-10-23T10:23:58Z"
  }
}

Responses

Status Meaning Description Schema
200 OK Payment Details Read OBWritePaymentDetailsResponse1
400 Bad Request Bad request OBErrorResponse1
401 Unauthorized Unauthorized None
403 Forbidden Forbidden OBErrorResponse1
404 Not Found Not found None
405 Method Not Allowed Method Not Allowed None
406 Not Acceptable Not Acceptable None
429 Too Many Requests Too Many Requests None
500 Internal Server Error Internal Server Error OBErrorResponse1

Response Headers

Status Header Type Format Description
200 x-fapi-interaction-id string An RFC4122 UID used as a correlation id.
200 x-jws-signature string Header containing a detached JWS signature of the body of the payload.
400 x-fapi-interaction-id string An RFC4122 UID used as a correlation id.
401 x-fapi-interaction-id string An RFC4122 UID used as a correlation id.
403 x-fapi-interaction-id string An RFC4122 UID used as a correlation id.
404 x-fapi-interaction-id string An RFC4122 UID used as a correlation id.
405 x-fapi-interaction-id string An RFC4122 UID used as a correlation id.
406 x-fapi-interaction-id string An RFC4122 UID used as a correlation id.
429 Retry-After integer Number in seconds to wait
429 x-fapi-interaction-id string An RFC4122 UID used as a correlation id.
500 x-fapi-interaction-id string An RFC4122 UID used as a correlation id.

Direct Debits

Retrieving information about direct debits set up on an account

Get Direct Debits

Code samples

# You can also use wget
curl -X GET https://develop-api.fairfx.io/open-banking/proxy/cob/v3.1/aisp/direct-debits \
  -H 'Accept: application/json' \
  -H 'x-fapi-auth-date: string' \
  -H 'x-fapi-customer-ip-address: string' \
  -H 'x-fapi-interaction-id: string' \
  -H 'Authorization: string'

GET https://develop-api.fairfx.io/open-banking/proxy/cob/v3.1/aisp/direct-debits HTTP/1.1
Host: develop-api.fairfx.io
Accept: application/json
x-fapi-auth-date: string
x-fapi-customer-ip-address: string
x-fapi-interaction-id: string
Authorization: string

var headers = {
  'Accept':'application/json',
  'x-fapi-auth-date':'string',
  'x-fapi-customer-ip-address':'string',
  'x-fapi-interaction-id':'string',
  'Authorization':'string'

};

$.ajax({
  url: 'https://develop-api.fairfx.io/open-banking/proxy/cob/v3.1/aisp/direct-debits',
  method: 'get',

  headers: headers,
  success: function(data) {
    console.log(JSON.stringify(data));
  }
})

const fetch = require('node-fetch');

const headers = {
  'Accept':'application/json',
  'x-fapi-auth-date':'string',
  'x-fapi-customer-ip-address':'string',
  'x-fapi-interaction-id':'string',
  'Authorization':'string'

};

fetch('https://develop-api.fairfx.io/open-banking/proxy/cob/v3.1/aisp/direct-debits',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

GET /aisp/direct-debits

Parameters

Name In Type Required Description
x-fapi-auth-date header string false The time when the PSU last logged in with the TPP.
x-fapi-customer-ip-address header string false The PSU's IP address if the PSU is currently logged in with the TPP.
x-fapi-interaction-id header string false An RFC4122 UID used as a correlation id.
Authorization header string true An Authorisation Token as per https://tools.ietf.org/html/rfc6750

Detailed descriptions

x-fapi-auth-date: The time when the PSU last logged in with the TPP. All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: Sun, 10 Sep 2017 19:43:31 UTC

Example responses

200 Response

{
  "Data": {
    "DirectDebit": [
      {
        "AccountId": "string",
        "DirectDebitId": "string",
        "MandateIdentification": "string",
        "DirectDebitStatusCode": "Active",
        "Name": "string",
        "PreviousPaymentDateTime": "2020-10-23T10:23:58Z",
        "PreviousPaymentAmount": {
          "Amount": "string",
          "Currency": "string"
        }
      }
    ]
  },
  "Links": {
    "Self": "http://example.com",
    "First": "http://example.com",
    "Prev": "http://example.com",
    "Next": "http://example.com",
    "Last": "http://example.com"
  },
  "Meta": {
    "TotalPages": 0,
    "FirstAvailableDateTime": "2020-10-23T10:23:58Z",
    "LastAvailableDateTime": "2020-10-23T10:23:58Z"
  }
}

Responses

Status Meaning Description Schema
200 OK Direct Debits Read OBReadDirectDebit1
400 Bad Request Bad request OBErrorResponse1
401 Unauthorized Unauthorized None
403 Forbidden Forbidden OBErrorResponse1
404 Not Found Not found None
405 Method Not Allowed Method Not Allowed None
406 Not Acceptable Not Acceptable None
429 Too Many Requests Too Many Requests None
500 Internal Server Error Internal Server Error OBErrorResponse1

Response Headers

Status Header Type Format Description
200 x-fapi-interaction-id string An RFC4122 UID used as a correlation id.
400 x-fapi-interaction-id string An RFC4122 UID used as a correlation id.
401 x-fapi-interaction-id string An RFC4122 UID used as a correlation id.
403 x-fapi-interaction-id string An RFC4122 UID used as a correlation id.
404 x-fapi-interaction-id string An RFC4122 UID used as a correlation id.
405 x-fapi-interaction-id string An RFC4122 UID used as a correlation id.
406 x-fapi-interaction-id string An RFC4122 UID used as a correlation id.
429 Retry-After integer Number in seconds to wait
429 x-fapi-interaction-id string An RFC4122 UID used as a correlation id.
500 x-fapi-interaction-id string An RFC4122 UID used as a correlation id.

Offers

Information regarding any special offers applied to the account

Get Offers

Code samples

# You can also use wget
curl -X GET https://develop-api.fairfx.io/open-banking/proxy/cob/v3.1/aisp/offers \
  -H 'Accept: application/json' \
  -H 'x-fapi-auth-date: string' \
  -H 'x-fapi-customer-ip-address: string' \
  -H 'x-fapi-interaction-id: string' \
  -H 'Authorization: string'

GET https://develop-api.fairfx.io/open-banking/proxy/cob/v3.1/aisp/offers HTTP/1.1
Host: develop-api.fairfx.io
Accept: application/json
x-fapi-auth-date: string
x-fapi-customer-ip-address: string
x-fapi-interaction-id: string
Authorization: string

var headers = {
  'Accept':'application/json',
  'x-fapi-auth-date':'string',
  'x-fapi-customer-ip-address':'string',
  'x-fapi-interaction-id':'string',
  'Authorization':'string'

};

$.ajax({
  url: 'https://develop-api.fairfx.io/open-banking/proxy/cob/v3.1/aisp/offers',
  method: 'get',

  headers: headers,
  success: function(data) {
    console.log(JSON.stringify(data));
  }
})

const fetch = require('node-fetch');

const headers = {
  'Accept':'application/json',
  'x-fapi-auth-date':'string',
  'x-fapi-customer-ip-address':'string',
  'x-fapi-interaction-id':'string',
  'Authorization':'string'

};

fetch('https://develop-api.fairfx.io/open-banking/proxy/cob/v3.1/aisp/offers',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

GET /aisp/offers

Parameters

Name In Type Required Description
x-fapi-auth-date header string false The time when the PSU last logged in with the TPP.
x-fapi-customer-ip-address header string false The PSU's IP address if the PSU is currently logged in with the TPP.
x-fapi-interaction-id header string false An RFC4122 UID used as a correlation id.
Authorization header string true An Authorisation Token as per https://tools.ietf.org/html/rfc6750

Detailed descriptions

x-fapi-auth-date: The time when the PSU last logged in with the TPP. All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: Sun, 10 Sep 2017 19:43:31 UTC

Example responses

200 Response

{
  "Data": {
    "Offer": [
      {
        "AccountId": "string",
        "OfferId": "string",
        "OfferType": "BalanceTransfer",
        "Description": "string",
        "StartDateTime": "2020-10-23T10:23:58Z",
        "EndDateTime": "2020-10-23T10:23:58Z",
        "Rate": "string",
        "Value": 0,
        "Term": "string",
        "URL": "string",
        "Amount": {
          "Amount": "string",
          "Currency": "string"
        },
        "Fee": {
          "Amount": "string",
          "Currency": "string"
        }
      }
    ]
  },
  "Links": {
    "Self": "http://example.com",
    "First": "http://example.com",
    "Prev": "http://example.com",
    "Next": "http://example.com",
    "Last": "http://example.com"
  },
  "Meta": {
    "TotalPages": 0,
    "FirstAvailableDateTime": "2020-10-23T10:23:58Z",
    "LastAvailableDateTime": "2020-10-23T10:23:58Z"
  }
}

Responses

Status Meaning Description Schema
200 OK Offers Read OBReadOffer1
400 Bad Request Bad request OBErrorResponse1
401 Unauthorized Unauthorized None
403 Forbidden Forbidden OBErrorResponse1
404 Not Found Not found None
405 Method Not Allowed Method Not Allowed None
406 Not Acceptable Not Acceptable None
429 Too Many Requests Too Many Requests None
500 Internal Server Error Internal Server Error OBErrorResponse1

Response Headers

Status Header Type Format Description
200 x-fapi-interaction-id string An RFC4122 UID used as a correlation id.
400 x-fapi-interaction-id string An RFC4122 UID used as a correlation id.
401 x-fapi-interaction-id string An RFC4122 UID used as a correlation id.
403 x-fapi-interaction-id string An RFC4122 UID used as a correlation id.
404 x-fapi-interaction-id string An RFC4122 UID used as a correlation id.
405 x-fapi-interaction-id string An RFC4122 UID used as a correlation id.
406 x-fapi-interaction-id string An RFC4122 UID used as a correlation id.
429 Retry-After integer Number in seconds to wait
429 x-fapi-interaction-id string An RFC4122 UID used as a correlation id.
500 x-fapi-interaction-id string An RFC4122 UID used as a correlation id.

Parties

Information about the customer held against the account

Get Parties

Code samples

# You can also use wget
curl -X GET https://develop-api.fairfx.io/open-banking/proxy/cob/v3.1/aisp/party \
  -H 'Accept: application/json' \
  -H 'x-fapi-auth-date: string' \
  -H 'x-fapi-customer-ip-address: string' \
  -H 'x-fapi-interaction-id: string' \
  -H 'Authorization: string'

GET https://develop-api.fairfx.io/open-banking/proxy/cob/v3.1/aisp/party HTTP/1.1
Host: develop-api.fairfx.io
Accept: application/json
x-fapi-auth-date: string
x-fapi-customer-ip-address: string
x-fapi-interaction-id: string
Authorization: string

var headers = {
  'Accept':'application/json',
  'x-fapi-auth-date':'string',
  'x-fapi-customer-ip-address':'string',
  'x-fapi-interaction-id':'string',
  'Authorization':'string'

};

$.ajax({
  url: 'https://develop-api.fairfx.io/open-banking/proxy/cob/v3.1/aisp/party',
  method: 'get',

  headers: headers,
  success: function(data) {
    console.log(JSON.stringify(data));
  }
})

const fetch = require('node-fetch');

const headers = {
  'Accept':'application/json',
  'x-fapi-auth-date':'string',
  'x-fapi-customer-ip-address':'string',
  'x-fapi-interaction-id':'string',
  'Authorization':'string'

};

fetch('https://develop-api.fairfx.io/open-banking/proxy/cob/v3.1/aisp/party',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

GET /aisp/party

Parameters

Name In Type Required Description
x-fapi-auth-date header string false The time when the PSU last logged in with the TPP.
x-fapi-customer-ip-address header string false The PSU's IP address if the PSU is currently logged in with the TPP.
x-fapi-interaction-id header string false An RFC4122 UID used as a correlation id.
Authorization header string true An Authorisation Token as per https://tools.ietf.org/html/rfc6750

Detailed descriptions

x-fapi-auth-date: The time when the PSU last logged in with the TPP. All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: Sun, 10 Sep 2017 19:43:31 UTC

Example responses

200 Response

{
  "Data": {
    "Party": {
      "PartyId": "string",
      "PartyNumber": "string",
      "PartyType": "Delegate",
      "Name": "string",
      "FullLegalName": "string",
      "LegalStructure": "string",
      "BeneficialOwnership": true,
      "AccountRole": "string",
      "EmailAddress": "string",
      "Phone": "string",
      "Mobile": "string",
      "Relationships": {
        "Account": {
          "Related": "http://example.com",
          "Id": "string"
        }
      },
      "Address": [
        {
          "AddressType": "Business",
          "AddressLine": [
            "string"
          ],
          "StreetName": "string",
          "BuildingNumber": "string",
          "PostCode": "string",
          "TownName": "string",
          "CountrySubDivision": "string",
          "Country": "string"
        }
      ]
    }
  },
  "Links": {
    "Self": "http://example.com",
    "First": "http://example.com",
    "Prev": "http://example.com",
    "Next": "http://example.com",
    "Last": "http://example.com"
  },
  "Meta": {
    "TotalPages": 0,
    "FirstAvailableDateTime": "2020-10-23T10:23:58Z",
    "LastAvailableDateTime": "2020-10-23T10:23:58Z"
  }
}

Responses

Status Meaning Description Schema
200 OK Parties Read OBReadParty2
400 Bad Request Bad request OBErrorResponse1
401 Unauthorized Unauthorized None
403 Forbidden Forbidden OBErrorResponse1
404 Not Found Not found None
405 Method Not Allowed Method Not Allowed None
406 Not Acceptable Not Acceptable None
429 Too Many Requests Too Many Requests None
500 Internal Server Error Internal Server Error OBErrorResponse1

Response Headers

Status Header Type Format Description
200 x-fapi-interaction-id string An RFC4122 UID used as a correlation id.
400 x-fapi-interaction-id string An RFC4122 UID used as a correlation id.
401 x-fapi-interaction-id string An RFC4122 UID used as a correlation id.
403 x-fapi-interaction-id string An RFC4122 UID used as a correlation id.
404 x-fapi-interaction-id string An RFC4122 UID used as a correlation id.
405 x-fapi-interaction-id string An RFC4122 UID used as a correlation id.
406 x-fapi-interaction-id string An RFC4122 UID used as a correlation id.
429 Retry-After integer Number in seconds to wait
429 x-fapi-interaction-id string An RFC4122 UID used as a correlation id.
500 x-fapi-interaction-id string An RFC4122 UID used as a correlation id.

Products

Details about the account product

Get Products

Code samples

# You can also use wget
curl -X GET https://develop-api.fairfx.io/open-banking/proxy/cob/v3.1/aisp/products \
  -H 'Accept: application/json' \
  -H 'x-fapi-auth-date: string' \
  -H 'x-fapi-customer-ip-address: string' \
  -H 'x-fapi-interaction-id: string' \
  -H 'Authorization: string'

GET https://develop-api.fairfx.io/open-banking/proxy/cob/v3.1/aisp/products HTTP/1.1
Host: develop-api.fairfx.io
Accept: application/json
x-fapi-auth-date: string
x-fapi-customer-ip-address: string
x-fapi-interaction-id: string
Authorization: string

var headers = {
  'Accept':'application/json',
  'x-fapi-auth-date':'string',
  'x-fapi-customer-ip-address':'string',
  'x-fapi-interaction-id':'string',
  'Authorization':'string'

};

$.ajax({
  url: 'https://develop-api.fairfx.io/open-banking/proxy/cob/v3.1/aisp/products',
  method: 'get',

  headers: headers,
  success: function(data) {
    console.log(JSON.stringify(data));
  }
})

const fetch = require('node-fetch');

const headers = {
  'Accept':'application/json',
  'x-fapi-auth-date':'string',
  'x-fapi-customer-ip-address':'string',
  'x-fapi-interaction-id':'string',
  'Authorization':'string'

};

fetch('https://develop-api.fairfx.io/open-banking/proxy/cob/v3.1/aisp/products',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

GET /aisp/products

Parameters

Name In Type Required Description
x-fapi-auth-date header string false The time when the PSU last logged in with the TPP.
x-fapi-customer-ip-address header string false The PSU's IP address if the PSU is currently logged in with the TPP.
x-fapi-interaction-id header string false An RFC4122 UID used as a correlation id.
Authorization header string true An Authorisation Token as per https://tools.ietf.org/html/rfc6750

Detailed descriptions

x-fapi-auth-date: The time when the PSU last logged in with the TPP. All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: Sun, 10 Sep 2017 19:43:31 UTC

Example responses

200 Response

{
  "Data": {
    "Product": [
      {
        "ProductName": "string",
        "ProductId": "string",
        "AccountId": "string",
        "SecondaryProductId": "string",
        "ProductType": "BusinessCurrentAccount",
        "MarketingStateId": "string",
        "OtherProductType": {
          "Name": "string",
          "Description": "string",
          "ProductDetails": {
            "Segment": [
              "GEAS"
            ],
            "FeeFreeLength": 0,
            "FeeFreeLengthPeriod": "PACT",
            "MonthlyMaximumCharge": "string",
            "Notes": [
              "string"
            ],
            "OtherSegment": {
              "Code": "string",
              "Name": "string",
              "Description": "string"
            }
          },
          "CreditInterest": {
            "TierBandSet": [
              {
                "TierBandMethod": "INBA",
                "CalculationMethod": "ITCO",
                "Destination": "INOT",
                "Notes": [
                  "string"
                ],
                "OtherCalculationMethod": {
                  "Code": "string",
                  "Name": "string",
                  "Description": "string"
                },
                "OtherDestination": {
                  "Code": "string",
                  "Name": "string",
                  "Description": "string"
                },
                "TierBand": [
                  {
                    "Identification": "string",
                    "TierValueMinimum": "string",
                    "TierValueMaximum": "string",
                    "CalculationFrequency": "FQAT",
                    "ApplicationFrequency": "FQAT",
                    "DepositInterestAppliedCoverage": "INBA",
                    "FixedVariableInterestRateType": "INFI",
                    "AER": "string",
                    "BankInterestRateType": "INBB",
                    "BankInterestRate": "string",
                    "Notes": [
                      "string"
                    ],
                    "OtherBankInterestType": {
                      "Code": "string",
                      "Name": "string",
                      "Description": "string"
                    },
                    "OtherApplicationFrequency": {
                      "Code": "string",
                      "Name": "string",
                      "Description": "string"
                    },
                    "OtherCalculationFrequency": {
                      "Code": "string",
                      "Name": "string",
                      "Description": "string"
                    }
                  }
                ]
              }
            ]
          },
          "Overdraft": {
            "Notes": [
              "string"
            ],
            "OverdraftTierBandSet": [
              {
                "TierBandMethod": "INBA",
                "OverdraftType": "OVCO",
                "Identification": "string",
                "AuthorisedIndicator": true,
                "BufferAmount": "string",
                "Notes": [
                  "string"
                ],
                "OverdraftTierBand": [
                  {
                    "Identification": "string",
                    "TierValueMin": "string",
                    "TierValueMax": "string",
                    "EAR": "string",
                    "AgreementLengthMin": 0,
                    "AgreementLengthMax": 0,
                    "AgreementPeriod": "PACT",
                    "OverdraftInterestChargingCoverage": "INBA",
                    "BankGuaranteedIndicator": true,
                    "Notes": [
                      "string"
                    ],
                    "OverdraftFeesCharges": [
                      {
                        "OverdraftFeeChargeCap": [
                          {
                            "FeeType": [
                              "FBAO"
                            ],
                            "MinMaxType": "FMMN",
                            "FeeCapOccurrence": 0,
                            "FeeCapAmount": "string",
                            "CappingPeriod": "PACT",
                            "Notes": [
                              "string"
                            ],
                            "OtherFeeType": [
                              {
                                "Code": "string",
                                "Name": "string",
                                "Description": "string"
                              }
                            ]
                          }
                        ],
                        "OverdraftFeeChargeDetail": [
                          {
                            "FeeType": "FBAO",
                            "NegotiableIndicator": true,
                            "OverdraftControlIndicator": true,
                            "IncrementalBorrowingAmount": "string",
                            "FeeAmount": "string",
                            "FeeRate": "string",
                            "FeeRateType": "INBB",
                            "ApplicationFrequency": "FEAC",
                            "CalculationFrequency": "FEAC",
                            "Notes": [
                              "string"
                            ],
                            "OverdraftFeeChargeCap": [
                              {
                                "FeeType": [
                                  "FBAO"
                                ],
                                "MinMaxType": "FMMN",
                                "FeeCapOccurrence": 0,
                                "FeeCapAmount": "string",
                                "CappingPeriod": "PACT",
                                "Notes": [
                                  "string"
                                ],
                                "OtherFeeType": [
                                  {
                                    "Code": "string",
                                    "Name": "string",
                                    "Description": "string"
                                  }
                                ]
                              }
                            ],
                            "OtherFeeType": {
                              "Code": "string",
                              "Name": "string",
                              "Description": "string"
                            },
                            "OtherFeeRateType": {
                              "Code": "string",
                              "Name": "string",
                              "Description": "string"
                            },
                            "OtherApplicationFrequency": {
                              "Code": "string",
                              "Name": "string",
                              "Description": "string"
                            },
                            "OtherCalculationFrequency": {
                              "Code": "string",
                              "Name": "string",
                              "Description": "string"
                            }
                          }
                        ]
                      }
                    ]
                  }
                ],
                "OverdraftFeesCharges": [
                  {
                    "OverdraftFeeChargeCap": [
                      {
                        "FeeType": [
                          "FBAO"
                        ],
                        "MinMaxType": "FMMN",
                        "FeeCapOccurrence": 0,
                        "FeeCapAmount": "string",
                        "CappingPeriod": "PACT",
                        "Notes": [
                          "string"
                        ],
                        "OtherFeeType": [
                          {
                            "Code": "string",
                            "Name": "string",
                            "Description": "string"
                          }
                        ]
                      }
                    ],
                    "OverdraftFeeChargeDetail": [
                      {
                        "FeeType": "FBAO",
                        "NegotiableIndicator": true,
                        "OverdraftControlIndicator": true,
                        "IncrementalBorrowingAmount": "string",
                        "FeeAmount": "string",
                        "FeeRate": "string",
                        "FeeRateType": "INBB",
                        "ApplicationFrequency": "FEAC",
                        "CalculationFrequency": "FEAC",
                        "Notes": [
                          "string"
                        ],
                        "OverdraftFeeChargeCap": [
                          {
                            "FeeType": [
                              "FBAO"
                            ],
                            "MinMaxType": "FMMN",
                            "FeeCapOccurrence": 0,
                            "FeeCapAmount": "string",
                            "CappingPeriod": "PACT",
                            "Notes": [
                              "string"
                            ],
                            "OtherFeeType": [
                              {
                                "Code": "string",
                                "Name": "string",
                                "Description": "string"
                              }
                            ]
                          }
                        ],
                        "OtherFeeType": {
                          "Code": "string",
                          "Name": "string",
                          "Description": "string"
                        },
                        "OtherFeeRateType": {
                          "Code": "string",
                          "Name": "string",
                          "Description": "string"
                        },
                        "OtherApplicationFrequency": {
                          "Code": "string",
                          "Name": "string",
                          "Description": "string"
                        },
                        "OtherCalculationFrequency": {
                          "Code": "string",
                          "Name": "string",
                          "Description": "string"
                        }
                      }
                    ]
                  }
                ]
              }
            ]
          },
          "LoanInterest": {
            "Notes": [
              "string"
            ],
            "LoanInterestTierBandSet": [
              {
                "TierBandMethod": "INBA",
                "Identification": "string",
                "CalculationMethod": "ITCO",
                "Notes": [
                  "string"
                ],
                "OtherCalculationMethod": {
                  "Code": "string",
                  "Name": "string",
                  "Description": "string"
                },
                "LoanInterestTierBand": [
                  {
                    "Identification": "string",
                    "TierValueMinimum": "string",
                    "TierValueMaximum": "string",
                    "TierValueMinTerm": 0,
                    "MinTermPeriod": "PACT",
                    "TierValueMaxTerm": 0,
                    "MaxTermPeriod": "PACT",
                    "FixedVariableInterestRateType": "INFI",
                    "RepAPR": "string",
                    "LoanProviderInterestRateType": "INBB",
                    "LoanProviderInterestRate": "string",
                    "Notes": [
                      "string"
                    ],
                    "OtherLoanProviderInterestRateType": {
                      "Code": "string",
                      "Name": "string",
                      "Description": "string"
                    },
                    "LoanInterestFeesCharges": [
                      {
                        "LoanInterestFeeChargeDetail": [
                          {
                            "FeeType": "FEPF",
                            "NegotiableIndicator": true,
                            "FeeAmount": "string",
                            "FeeRate": "string",
                            "FeeRateType": "INBB",
                            "ApplicationFrequency": "FEAC",
                            "CalculationFrequency": "FEAC",
                            "Notes": [
                              "string"
                            ],
                            "OtherFeeType": {
                              "Code": "string",
                              "FeeCategory": "FCOT",
                              "Name": "string",
                              "Description": "string"
                            },
                            "OtherFeeRateType": {
                              "Code": "string",
                              "Name": "string",
                              "Description": "string"
                            },
                            "OtherApplicationFrequency": {
                              "Code": "string",
                              "Name": "string",
                              "Description": "string"
                            },
                            "OtherCalculationFrequency": {
                              "Code": "string",
                              "Name": "string",
                              "Description": "string"
                            }
                          }
                        ],
                        "LoanInterestFeeChargeCap": [
                          {
                            "FeeType": [
                              "FEPF"
                            ],
                            "MinMaxType": "FMMN",
                            "FeeCapOccurrence": 0,
                            "FeeCapAmount": "string",
                            "CappingPeriod": "FEAC",
                            "Notes": [
                              "string"
                            ],
                            "OtherFeeType": [
                              {
                                "Code": "string",
                                "Name": "string",
                                "Description": "string"
                              }
                            ]
                          }
                        ]
                      }
                    ]
                  }
                ],
                "LoanInterestFeesCharges": [
                  {
                    "LoanInterestFeeChargeDetail": [
                      {
                        "FeeType": "FEPF",
                        "NegotiableIndicator": true,
                        "FeeAmount": "string",
                        "FeeRate": "string",
                        "FeeRateType": "INBB",
                        "ApplicationFrequency": "FEAC",
                        "CalculationFrequency": "FEAC",
                        "Notes": [
                          "string"
                        ],
                        "OtherFeeType": {
                          "Code": "string",
                          "FeeCategory": "FCOT",
                          "Name": "string",
                          "Description": "string"
                        },
                        "OtherFeeRateType": {
                          "Code": "string",
                          "Name": "string",
                          "Description": "string"
                        },
                        "OtherApplicationFrequency": {
                          "Code": "string",
                          "Name": "string",
                          "Description": "string"
                        },
                        "OtherCalculationFrequency": {
                          "Code": "string",
                          "Name": "string",
                          "Description": "string"
                        }
                      }
                    ],
                    "LoanInterestFeeChargeCap": [
                      {
                        "FeeType": [
                          "FEPF"
                        ],
                        "MinMaxType": "FMMN",
                        "FeeCapOccurrence": 0,
                        "FeeCapAmount": "string",
                        "CappingPeriod": "FEAC",
                        "Notes": [
                          "string"
                        ],
                        "OtherFeeType": [
                          {
                            "Code": "string",
                            "Name": "string",
                            "Description": "string"
                          }
                        ]
                      }
                    ]
                  }
                ]
              }
            ]
          },
          "Repayment": {
            "RepaymentType": "USBA",
            "RepaymentFrequency": "SMDA",
            "AmountType": "RABD",
            "Notes": [
              "string"
            ],
            "OtherRepaymentType": {
              "Code": "string",
              "Name": "string",
              "Description": "string"
            },
            "OtherRepaymentFrequency": {
              "Code": "string",
              "Name": "string",
              "Description": "string"
            },
            "OtherAmountType": {
              "Code": "string",
              "Name": "string",
              "Description": "string"
            },
            "RepaymentFeeCharges": {
              "RepaymentFeeChargeDetail": [
                {
                  "FeeType": "FEPF",
                  "NegotiableIndicator": true,
                  "FeeAmount": "string",
                  "FeeRate": "string",
                  "FeeRateType": "INBB",
                  "ApplicationFrequency": "FEAC",
                  "CalculationFrequency": "FEAC",
                  "Notes": [
                    "string"
                  ],
                  "OtherFeeType": {
                    "Code": "string",
                    "FeeCategory": "FCOT",
                    "Name": "string",
                    "Description": "string"
                  },
                  "OtherFeeRateType": {
                    "Code": "string",
                    "Name": "string",
                    "Description": "string"
                  },
                  "OtherApplicationFrequency": {
                    "Code": "string",
                    "Name": "string",
                    "Description": "string"
                  },
                  "OtherCalculationFrequency": {
                    "Code": "string",
                    "Name": "string",
                    "Description": "string"
                  }
                }
              ],
              "RepaymentFeeChargeCap": [
                {
                  "FeeType": [
                    "FEPF"
                  ],
                  "MinMaxType": "FMMN",
                  "FeeCapOccurrence": 0,
                  "FeeCapAmount": "string",
                  "CappingPeriod": "PACT",
                  "Notes": [
                    "string"
                  ],
                  "OtherFeeType": [
                    {
                      "Code": "string",
                      "Name": "string",
                      "Description": "string"
                    }
                  ]
                }
              ]
            },
            "RepaymentHoliday": [
              {
                "MaxHolidayLength": 0,
                "MaxHolidayPeriod": "PACT",
                "Notes": [
                  "string"
                ]
              }
            ]
          },
          "OtherFeesCharges": [
            {
              "TariffType": "TTEL",
              "TariffName": "string",
              "OtherTariffType": {
                "Code": "string",
                "Name": "string",
                "Description": "string"
              },
              "FeeChargeDetail": [
                {
                  "FeeCategory": "FCOT",
                  "FeeType": "FEPF",
                  "NegotiableIndicator": true,
                  "FeeAmount": "string",
                  "FeeRate": "string",
                  "FeeRateType": "INBB",
                  "ApplicationFrequency": "FEAC",
                  "CalculationFrequency": "FEAC",
                  "Notes": [
                    "string"
                  ],
                  "FeeChargeCap": [
                    {
                      "FeeType": [
                        "FEPF"
                      ],
                      "MinMaxType": "FMMN",
                      "FeeCapOccurrence": 0,
                      "FeeCapAmount": "string",
                      "CappingPeriod": "PACT",
                      "Notes": [
                        "string"
                      ],
                      "OtherFeeType": [
                        {
                          "Code": "string",
                          "Name": "string",
                          "Description": "string"
                        }
                      ]
                    }
                  ],
                  "OtherFeeCategoryType": {
                    "Code": "string",
                    "Name": "string",
                    "Description": "string"
                  },
                  "OtherFeeType": {
                    "Code": "string",
                    "FeeCategory": "FCOT",
                    "Name": "string",
                    "Description": "string"
                  },
                  "OtherFeeRateType": {
                    "Code": "string",
                    "Name": "string",
                    "Description": "string"
                  },
                  "OtherApplicationFrequency": {
                    "Code": "string",
                    "Name": "string",
                    "Description": "string"
                  },
                  "OtherCalculationFrequency": {
                    "Code": "string",
                    "Name": "string",
                    "Description": "string"
                  },
                  "FeeApplicableRange": {
                    "MinimumAmount": "string",
                    "MaximumAmount": "string",
                    "MinimumRate": "string",
                    "MaximumRate": "string"
                  }
                }
              ],
              "FeeChargeCap": [
                {
                  "FeeType": [
                    "FEPF"
                  ],
                  "MinMaxType": "FMMN",
                  "FeeCapOccurrence": 0,
                  "FeeCapAmount": "string",
                  "CappingPeriod": "PACT",
                  "Notes": [
                    "string"
                  ],
                  "OtherFeeType": [
                    {
                      "Code": "string",
                      "Name": "string",
                      "Description": "string"
                    }
                  ]
                }
              ]
            }
          ],
          "SupplementaryData": {}
        },
        "BCA": {
          "ProductDetails": {
            "Segment": [
              "ClientAccount"
            ],
            "FeeFreeLength": 0,
            "FeeFreeLengthPeriod": "Day",
            "Notes": [
              "string"
            ]
          },
          "CreditInterest": {
            "TierBandSet": [
              {
                "TierBandMethod": "Banded",
                "CalculationMethod": "Compound",
                "Destination": "PayAway",
                "Notes": [
                  "string"
                ],
                "TierBand": [
                  {
                    "Identification": "string",
                    "TierValueMinimum": "string",
                    "TierValueMaximum": "string",
                    "CalculationFrequency": "Daily",
                    "ApplicationFrequency": "Daily",
                    "DepositInterestAppliedCoverage": "Banded",
                    "FixedVariableInterestRateType": "Fixed",
                    "AER": "string",
                    "BankInterestRateType": "Gross",
                    "BankInterestRate": "string",
                    "Notes": [
                      "string"
                    ],
                    "OtherBankInterestType": {
                      "Code": "stri",
                      "Name": "string",
                      "Description": "string"
                    },
                    "OtherApplicationFrequency": {
                      "Code": "stri",
                      "Name": "string",
                      "Description": "string"
                    },
                    "OtherCalculationFrequency": {
                      "Code": "stri",
                      "Name": "string",
                      "Description": "string"
                    }
                  }
                ]
              }
            ]
          },
          "Overdraft": {
            "Notes": [
              "string"
            ],
            "OverdraftTierBandSet": [
              {
                "TierBandMethod": "Banded",
                "OverdraftType": "Committed",
                "Identification": "string",
                "AuthorisedIndicator": true,
                "BufferAmount": "string",
                "Notes": [
                  "string"
                ],
                "OverdraftTierBand": [
                  {
                    "Identification": "string",
                    "TierValueMin": "string",
                    "TierValueMax": "string",
                    "EAR": "string",
                    "AgreementLengthMin": 0,
                    "AgreementLengthMax": 0,
                    "AgreementPeriod": "Day",
                    "OverdraftInterestChargingCoverage": "Banded",
                    "BankGuaranteedIndicator": true,
                    "Notes": [
                      "string"
                    ],
                    "OverdraftFeesCharges": [
                      {
                        "OverdraftFeeChargeCap": [
                          {
                            "FeeType": [
                              "ArrangedOverdraft"
                            ],
                            "MinMaxType": "Minimum",
                            "FeeCapOccurrence": 0,
                            "FeeCapAmount": "string",
                            "CappingPeriod": "Day",
                            "Notes": [
                              "string"
                            ],
                            "OtherFeeType": [
                              {
                                "Code": "stri",
                                "Name": "string",
                                "Description": "string"
                              }
                            ]
                          }
                        ],
                        "OverdraftFeeChargeDetail": [
                          {
                            "FeeType": "ArrangedOverdraft",
                            "NegotiableIndicator": true,
                            "OverdraftControlIndicator": true,
                            "IncrementalBorrowingAmount": "string",
                            "FeeAmount": "string",
                            "FeeRate": "string",
                            "FeeRateType": "Gross",
                            "ApplicationFrequency": "OnClosing",
                            "CalculationFrequency": "OnClosing",
                            "Notes": [
                              "string"
                            ],
                            "OverdraftFeeChargeCap": [
                              {
                                "FeeType": [
                                  "ArrangedOverdraft"
                                ],
                                "MinMaxType": "Minimum",
                                "FeeCapOccurrence": 0,
                                "FeeCapAmount": "string",
                                "CappingPeriod": "Day",
                                "Notes": [
                                  "string"
                                ],
                                "OtherFeeType": [
                                  {
                                    "Code": "stri",
                                    "Name": "string",
                                    "Description": "string"
                                  }
                                ]
                              }
                            ],
                            "OtherFeeType": {
                              "Code": "stri",
                              "Name": "string",
                              "Description": "string"
                            },
                            "OtherFeeRateType": {
                              "Code": "stri",
                              "Name": "string",
                              "Description": "string"
                            },
                            "OtherApplicationFrequency": {
                              "Code": "stri",
                              "Name": "string",
                              "Description": "string"
                            },
                            "OtherCalculationFrequency": {
                              "Code": "stri",
                              "Name": "string",
                              "Description": "string"
                            }
                          }
                        ]
                      }
                    ]
                  }
                ],
                "OverdraftFeesCharges": [
                  {
                    "OverdraftFeeChargeCap": [
                      {
                        "FeeType": [
                          "ArrangedOverdraft"
                        ],
                        "MinMaxType": "Minimum",
                        "FeeCapOccurrence": 0,
                        "FeeCapAmount": "string",
                        "CappingPeriod": "Day",
                        "Notes": [
                          "string"
                        ],
                        "OtherFeeType": [
                          {
                            "Code": "stri",
                            "Name": "string",
                            "Description": "string"
                          }
                        ]
                      }
                    ],
                    "OverdraftFeeChargeDetail": [
                      {
                        "FeeType": "ArrangedOverdraft",
                        "NegotiableIndicator": true,
                        "OverdraftControlIndicator": true,
                        "IncrementalBorrowingAmount": "string",
                        "FeeAmount": "string",
                        "FeeRate": "string",
                        "FeeRateType": "Gross",
                        "ApplicationFrequency": "OnClosing",
                        "CalculationFrequency": "OnClosing",
                        "Notes": [
                          "string"
                        ],
                        "OverdraftFeeChargeCap": [
                          {
                            "FeeType": [
                              "ArrangedOverdraft"
                            ],
                            "MinMaxType": "Minimum",
                            "FeeCapOccurrence": 0,
                            "FeeCapAmount": "string",
                            "CappingPeriod": "Day",
                            "Notes": [
                              "string"
                            ],
                            "OtherFeeType": [
                              {
                                "Code": "stri",
                                "Name": "string",
                                "Description": "string"
                              }
                            ]
                          }
                        ],
                        "OtherFeeType": {
                          "Code": "stri",
                          "Name": "string",
                          "Description": "string"
                        },
                        "OtherFeeRateType": {
                          "Code": "stri",
                          "Name": "string",
                          "Description": "string"
                        },
                        "OtherApplicationFrequency": {
                          "Code": "stri",
                          "Name": "string",
                          "Description": "string"
                        },
                        "OtherCalculationFrequency": {
                          "Code": "stri",
                          "Name": "string",
                          "Description": "string"
                        }
                      }
                    ]
                  }
                ]
              }
            ]
          },
          "OtherFeesCharges": [
            {
              "TariffType": "Electronic",
              "TariffName": "string",
              "OtherTariffType": {
                "Code": "stri",
                "Name": "string",
                "Description": "string"
              },
              "FeeChargeDetail": [
                {
                  "FeeCategory": "Other",
                  "FeeType": "Other",
                  "NegotiableIndicator": true,
                  "FeeAmount": "string",
                  "FeeRate": "string",
                  "FeeRateType": "Gross",
                  "ApplicationFrequency": "OnClosing",
                  "CalculationFrequency": "OnClosing",
                  "Notes": [
                    "string"
                  ],
                  "FeeChargeCap": [
                    {
                      "FeeType": [
                        "Other"
                      ],
                      "MinMaxType": "Minimum",
                      "FeeCapOccurrence": 0,
                      "FeeCapAmount": "string",
                      "CappingPeriod": "Day",
                      "Notes": [
                        "string"
                      ],
                      "OtherFeeType": [
                        {
                          "Code": "stri",
                          "Name": "string",
                          "Description": "string"
                        }
                      ]
                    }
                  ],
                  "OtherFeeCategoryType": {
                    "Code": "stri",
                    "Name": "string",
                    "Description": "string"
                  },
                  "OtherFeeType": {
                    "Code": "stri",
                    "FeeCategory": "Other",
                    "Name": "string",
                    "Description": "string"
                  },
                  "OtherFeeRateType": {
                    "Code": "stri",
                    "Name": "string",
                    "Description": "string"
                  },
                  "OtherApplicationFrequency": {
                    "Code": "stri",
                    "Name": "string",
                    "Description": "string"
                  },
                  "OtherCalculationFrequency": {
                    "Code": "stri",
                    "Name": "string",
                    "Description": "string"
                  },
                  "FeeApplicableRange": {
                    "MinimumAmount": "string",
                    "MaximumAmount": "string",
                    "MinimumRate": "string",
                    "MaximumRate": "string"
                  }
                }
              ],
              "FeeChargeCap": [
                {
                  "FeeType": [
                    "Other"
                  ],
                  "MinMaxType": "Minimum",
                  "FeeCapOccurrence": 0,
                  "FeeCapAmount": "string",
                  "CappingPeriod": "Day",
                  "Notes": [
                    "string"
                  ],
                  "OtherFeeType": [
                    {
                      "Code": "stri",
                      "Name": "string",
                      "Description": "string"
                    }
                  ]
                }
              ]
            }
          ]
        },
        "PCA": {
          "ProductDetails": {
            "Segment": [
              "Basic"
            ],
            "MonthlyMaximumCharge": "string",
            "Notes": [
              "string"
            ]
          },
          "CreditInterest": {
            "TierBandSet": [
              {
                "TierBandMethod": "Tiered",
                "CalculationMethod": "Compound",
                "Destination": "PayAway",
                "Notes": [
                  "string"
                ],
                "TierBand": [
                  {
                    "Identification": "string",
                    "TierValueMinimum": "string",
                    "TierValueMaximum": "string",
                    "CalculationFrequency": "PerAcademicTerm",
                    "ApplicationFrequency": "PerAcademicTerm",
                    "DepositInterestAppliedCoverage": "Tiered",
                    "FixedVariableInterestRateType": "Fixed",
                    "AER": "string",
                    "BankInterestRateType": "LinkedBaseRate",
                    "BankInterestRate": "string",
                    "Notes": [
                      "string"
                    ],
                    "OtherBankInterestType": {
                      "Code": "stri",
                      "Name": "string",
                      "Description": "string"
                    },
                    "OtherApplicationFrequency": {
                      "Code": "stri",
                      "Name": "string",
                      "Description": "string"
                    },
                    "OtherCalculationFrequency": {
                      "Code": "stri",
                      "Name": "string",
                      "Description": "string"
                    }
                  }
                ]
              }
            ]
          },
          "Overdraft": {
            "Notes": [
              "string"
            ],
            "OverdraftTierBandSet": [
              {
                "TierBandMethod": "Tiered",
                "OverdraftType": "Committed",
                "Identification": "string",
                "AuthorisedIndicator": true,
                "BufferAmount": "string",
                "Notes": [
                  "string"
                ],
                "OverdraftTierBand": [
                  {
                    "Identification": "string",
                    "TierValueMin": "string",
                    "TierValueMax": "string",
                    "OverdraftInterestChargingCoverage": "Tiered",
                    "BankGuaranteedIndicator": true,
                    "EAR": "string",
                    "Notes": [
                      "string"
                    ],
                    "OverdraftFeesCharges": [
                      {
                        "OverdraftFeeChargeCap": [
                          {
                            "FeeType": [
                              "ArrangedOverdraft"
                            ],
                            "OverdraftControlIndicator": true,
                            "MinMaxType": "Minimum",
                            "FeeCapOccurrence": 0,
                            "FeeCapAmount": "string",
                            "CappingPeriod": "AcademicTerm",
                            "Notes": [
                              "string"
                            ],
                            "OtherFeeType": [
                              {
                                "Code": "stri",
                                "Name": "string",
                                "Description": "string"
                              }
                            ]
                          }
                        ],
                        "OverdraftFeeChargeDetail": [
                          {
                            "FeeType": "ArrangedOverdraft",
                            "OverdraftControlIndicator": true,
                            "IncrementalBorrowingAmount": "string",
                            "FeeAmount": "string",
                            "FeeRate": "string",
                            "FeeRateType": "LinkedBaseRate",
                            "ApplicationFrequency": "AccountClosing",
                            "CalculationFrequency": "AccountClosing",
                            "Notes": [
                              "string"
                            ],
                            "OtherFeeType": {
                              "Code": "stri",
                              "Name": "string",
                              "Description": "string"
                            },
                            "OtherFeeRateType": {
                              "Code": "stri",
                              "Name": "string",
                              "Description": "string"
                            },
                            "OtherApplicationFrequency": {
                              "Code": "stri",
                              "Name": "string",
                              "Description": "string"
                            },
                            "OtherCalculationFrequency": {
                              "Code": "stri",
                              "Name": "string",
                              "Description": "string"
                            },
                            "OverdraftFeeChargeCap": {
                              "FeeType": [
                                "ArrangedOverdraft"
                              ],
                              "OverdraftControlIndicator": true,
                              "MinMaxType": "Minimum",
                              "FeeCapOccurrence": 0,
                              "FeeCapAmount": "string",
                              "CappingPeriod": "AcademicTerm",
                              "Notes": [
                                "string"
                              ],
                              "OtherFeeType": [
                                {
                                  "Code": "stri",
                                  "Name": "string",
                                  "Description": "string"
                                }
                              ]
                            }
                          }
                        ]
                      }
                    ]
                  }
                ],
                "OverdraftFeesCharges": [
                  {
                    "OverdraftFeeChargeCap": [
                      {
                        "FeeType": [
                          "ArrangedOverdraft"
                        ],
                        "OverdraftControlIndicator": true,
                        "MinMaxType": "Minimum",
                        "FeeCapOccurrence": 0,
                        "FeeCapAmount": "string",
                        "CappingPeriod": "AcademicTerm",
                        "Notes": [
                          "string"
                        ],
                        "OtherFeeType": [
                          {
                            "Code": "stri",
                            "Name": "string",
                            "Description": "string"
                          }
                        ]
                      }
                    ],
                    "OverdraftFeeChargeDetail": [
                      {
                        "FeeType": "ArrangedOverdraft",
                        "OverdraftControlIndicator": true,
                        "IncrementalBorrowingAmount": "string",
                        "FeeAmount": "string",
                        "FeeRate": "string",
                        "FeeRateType": "LinkedBaseRate",
                        "ApplicationFrequency": "AccountClosing",
                        "CalculationFrequency": "AccountClosing",
                        "Notes": [
                          "string"
                        ],
                        "OtherFeeType": {
                          "Code": "stri",
                          "Name": "string",
                          "Description": "string"
                        },
                        "OtherFeeRateType": {
                          "Code": "stri",
                          "Name": "string",
                          "Description": "string"
                        },
                        "OtherApplicationFrequency": {
                          "Code": "stri",
                          "Name": "string",
                          "Description": "string"
                        },
                        "OtherCalculationFrequency": {
                          "Code": "stri",
                          "Name": "string",
                          "Description": "string"
                        },
                        "OverdraftFeeChargeCap": {
                          "FeeType": [
                            "ArrangedOverdraft"
                          ],
                          "OverdraftControlIndicator": true,
                          "MinMaxType": "Minimum",
                          "FeeCapOccurrence": 0,
                          "FeeCapAmount": "string",
                          "CappingPeriod": "AcademicTerm",
                          "Notes": [
                            "string"
                          ],
                          "OtherFeeType": [
                            {
                              "Code": "stri",
                              "Name": "string",
                              "Description": "string"
                            }
                          ]
                        }
                      }
                    ]
                  }
                ]
              }
            ]
          },
          "OtherFeesCharges": {
            "FeeChargeDetail": [
              {
                "FeeCategory": "Other",
                "FeeType": "ServiceCAccountFee",
                "FeeAmount": "string",
                "FeeRate": "string",
                "FeeRateType": "LinkedBaseRate",
                "ApplicationFrequency": "AccountClosing",
                "CalculationFrequency": "AccountClosing",
                "Notes": [
                  "string"
                ],
                "OtherFeeCategoryType": {
                  "Code": "stri",
                  "Name": "string",
                  "Description": "string"
                },
                "OtherFeeType": {
                  "Code": "stri",
                  "FeeCategory": "Other",
                  "Name": "string",
                  "Description": "string"
                },
                "OtherFeeRateType": {
                  "Code": "stri",
                  "Name": "string",
                  "Description": "string"
                },
                "OtherApplicationFrequency": {
                  "Code": "stri",
                  "Name": "string",
                  "Description": "string"
                },
                "OtherCalculationFrequency": {
                  "Code": "stri",
                  "Name": "string",
                  "Description": "string"
                },
                "FeeChargeCap": [
                  {
                    "FeeType": [
                      "ServiceCAccountFee"
                    ],
                    "MinMaxType": "Minimum",
                    "FeeCapOccurrence": 0,
                    "FeeCapAmount": "string",
                    "CappingPeriod": "AcademicTerm",
                    "Notes": [
                      "string"
                    ],
                    "OtherFeeType": [
                      {
                        "Code": "stri",
                        "Name": "string",
                        "Description": "string"
                      }
                    ]
                  }
                ],
                "FeeApplicableRange": {
                  "MinimumAmount": "string",
                  "MaximumAmount": "string",
                  "MinimumRate": "string",
                  "MaximumRate": "string"
                }
              }
            ],
            "FeeChargeCap": [
              {
                "FeeType": [
                  "ServiceCAccountFee"
                ],
                "MinMaxType": "Minimum",
                "FeeCapOccurrence": 0,
                "FeeCapAmount": "string",
                "CappingPeriod": "AcademicTerm",
                "Notes": [
                  "string"
                ],
                "OtherFeeType": [
                  {
                    "Code": "stri",
                    "Name": "string",
                    "Description": "string"
                  }
                ]
              }
            ]
          }
        }
      }
    ]
  },
  "Links": {
    "Self": "http://example.com",
    "First": "http://example.com",
    "Prev": "http://example.com",
    "Next": "http://example.com",
    "Last": "http://example.com"
  },
  "Meta": {
    "TotalPages": 0,
    "FirstAvailableDateTime": "2020-10-23T10:23:58Z",
    "LastAvailableDateTime": "2020-10-23T10:23:58Z"
  }
}

Responses

Status Meaning Description Schema
200 OK Products Read OBReadProduct2
400 Bad Request Bad request OBErrorResponse1
401 Unauthorized Unauthorized None
403 Forbidden Forbidden OBErrorResponse1
404 Not Found Not found None
405 Method Not Allowed Method Not Allowed None
406 Not Acceptable Not Acceptable None
429 Too Many Requests Too Many Requests None
500 Internal Server Error Internal Server Error OBErrorResponse1

Response Headers

Status Header Type Format Description
200 x-fapi-interaction-id string An RFC4122 UID used as a correlation id.
400 x-fapi-interaction-id string An RFC4122 UID used as a correlation id.
401 x-fapi-interaction-id string An RFC4122 UID used as a correlation id.
403 x-fapi-interaction-id string An RFC4122 UID used as a correlation id.
404 x-fapi-interaction-id string An RFC4122 UID used as a correlation id.
405 x-fapi-interaction-id string An RFC4122 UID used as a correlation id.
406 x-fapi-interaction-id string An RFC4122 UID used as a correlation id.
429 Retry-After integer Number in seconds to wait
429 x-fapi-interaction-id string An RFC4122 UID used as a correlation id.
500 x-fapi-interaction-id string An RFC4122 UID used as a correlation id.

Scheduled Payments

Details about single one-off payments scheduled for a future date

Get Scheduled Payments

Code samples

# You can also use wget
curl -X GET https://develop-api.fairfx.io/open-banking/proxy/cob/v3.1/aisp/scheduled-payments \
  -H 'Accept: application/json' \
  -H 'x-fapi-auth-date: string' \
  -H 'x-fapi-customer-ip-address: string' \
  -H 'x-fapi-interaction-id: string' \
  -H 'Authorization: string'

GET https://develop-api.fairfx.io/open-banking/proxy/cob/v3.1/aisp/scheduled-payments HTTP/1.1
Host: develop-api.fairfx.io
Accept: application/json
x-fapi-auth-date: string
x-fapi-customer-ip-address: string
x-fapi-interaction-id: string
Authorization: string

var headers = {
  'Accept':'application/json',
  'x-fapi-auth-date':'string',
  'x-fapi-customer-ip-address':'string',
  'x-fapi-interaction-id':'string',
  'Authorization':'string'

};

$.ajax({
  url: 'https://develop-api.fairfx.io/open-banking/proxy/cob/v3.1/aisp/scheduled-payments',
  method: 'get',

  headers: headers,
  success: function(data) {
    console.log(JSON.stringify(data));
  }
})

const fetch = require('node-fetch');

const headers = {
  'Accept':'application/json',
  'x-fapi-auth-date':'string',
  'x-fapi-customer-ip-address':'string',
  'x-fapi-interaction-id':'string',
  'Authorization':'string'

};

fetch('https://develop-api.fairfx.io/open-banking/proxy/cob/v3.1/aisp/scheduled-payments',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

GET /aisp/scheduled-payments

Parameters

Name In Type Required Description
x-fapi-auth-date header string false The time when the PSU last logged in with the TPP.
x-fapi-customer-ip-address header string false The PSU's IP address if the PSU is currently logged in with the TPP.
x-fapi-interaction-id header string false An RFC4122 UID used as a correlation id.
Authorization header string true An Authorisation Token as per https://tools.ietf.org/html/rfc6750

Detailed descriptions

x-fapi-auth-date: The time when the PSU last logged in with the TPP. All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: Sun, 10 Sep 2017 19:43:31 UTC

Example responses

200 Response

{
  "Data": {
    "ScheduledPayment": [
      {
        "AccountId": "string",
        "ScheduledPaymentId": "string",
        "ScheduledPaymentDateTime": "2020-10-23T10:23:58Z",
        "ScheduledType": "Arrival",
        "Reference": "string",
        "InstructedAmount": {
          "Amount": "string",
          "Currency": "string"
        }
      }
    ]
  },
  "Links": {
    "Self": "http://example.com",
    "First": "http://example.com",
    "Prev": "http://example.com",
    "Next": "http://example.com",
    "Last": "http://example.com"
  },
  "Meta": {
    "TotalPages": 0,
    "FirstAvailableDateTime": "2020-10-23T10:23:58Z",
    "LastAvailableDateTime": "2020-10-23T10:23:58Z"
  }
}

Responses

Status Meaning Description Schema
200 OK Scheduled Payments Read OBReadScheduledPayment2
400 Bad Request Bad request OBErrorResponse1
401 Unauthorized Unauthorized None
403 Forbidden Forbidden OBErrorResponse1
404 Not Found Not found None
405 Method Not Allowed Method Not Allowed None
406 Not Acceptable Not Acceptable None
429 Too Many Requests Too Many Requests None
500 Internal Server Error Internal Server Error OBErrorResponse1

Response Headers

Status Header Type Format Description
200 x-fapi-interaction-id string An RFC4122 UID used as a correlation id.
400 x-fapi-interaction-id string An RFC4122 UID used as a correlation id.
401 x-fapi-interaction-id string An RFC4122 UID used as a correlation id.
403 x-fapi-interaction-id string An RFC4122 UID used as a correlation id.
404 x-fapi-interaction-id string An RFC4122 UID used as a correlation id.
405 x-fapi-interaction-id string An RFC4122 UID used as a correlation id.
406 x-fapi-interaction-id string An RFC4122 UID used as a correlation id.
429 Retry-After integer Number in seconds to wait
429 x-fapi-interaction-id string An RFC4122 UID used as a correlation id.
500 x-fapi-interaction-id string An RFC4122 UID used as a correlation id.

Standing Orders

Retrieving information about Standing Orders set up on an account

Get Standing Orders

Code samples

# You can also use wget
curl -X GET https://develop-api.fairfx.io/open-banking/proxy/cob/v3.1/aisp/standing-orders \
  -H 'Accept: application/json' \
  -H 'x-fapi-auth-date: string' \
  -H 'x-fapi-customer-ip-address: string' \
  -H 'x-fapi-interaction-id: string' \
  -H 'Authorization: string'

GET https://develop-api.fairfx.io/open-banking/proxy/cob/v3.1/aisp/standing-orders HTTP/1.1
Host: develop-api.fairfx.io
Accept: application/json
x-fapi-auth-date: string
x-fapi-customer-ip-address: string
x-fapi-interaction-id: string
Authorization: string

var headers = {
  'Accept':'application/json',
  'x-fapi-auth-date':'string',
  'x-fapi-customer-ip-address':'string',
  'x-fapi-interaction-id':'string',
  'Authorization':'string'

};

$.ajax({
  url: 'https://develop-api.fairfx.io/open-banking/proxy/cob/v3.1/aisp/standing-orders',
  method: 'get',

  headers: headers,
  success: function(data) {
    console.log(JSON.stringify(data));
  }
})

const fetch = require('node-fetch');

const headers = {
  'Accept':'application/json',
  'x-fapi-auth-date':'string',
  'x-fapi-customer-ip-address':'string',
  'x-fapi-interaction-id':'string',
  'Authorization':'string'

};

fetch('https://develop-api.fairfx.io/open-banking/proxy/cob/v3.1/aisp/standing-orders',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

GET /aisp/standing-orders

Parameters

Name In Type Required Description
x-fapi-auth-date header string false The time when the PSU last logged in with the TPP.
x-fapi-customer-ip-address header string false The PSU's IP address if the PSU is currently logged in with the TPP.
x-fapi-interaction-id header string false An RFC4122 UID used as a correlation id.
Authorization header string true An Authorisation Token as per https://tools.ietf.org/html/rfc6750

Detailed descriptions

x-fapi-auth-date: The time when the PSU last logged in with the TPP. All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: Sun, 10 Sep 2017 19:43:31 UTC

Example responses

200 Response

{
  "Data": {
    "StandingOrder": [
      {
        "AccountId": "string",
        "StandingOrderId": "string",
        "Frequency": "string",
        "Reference": "string",
        "FirstPaymentDateTime": "2020-10-23T10:23:58Z",
        "NextPaymentDateTime": "2020-10-23T10:23:58Z",
        "FinalPaymentDateTime": "2020-10-23T10:23:58Z",
        "StandingOrderStatusCode": "Active",
        "FirstPaymentAmount": {
          "Amount": "string",
          "Currency": "string"
        },
        "NextPaymentAmount": {
          "Amount": "string",
          "Currency": "string"
        },
        "FinalPaymentAmount": {
          "Amount": "string",
          "Currency": "string"
        },
        "SupplementaryData": {}
      }
    ]
  },
  "Links": {
    "Self": "http://example.com",
    "First": "http://example.com",
    "Prev": "http://example.com",
    "Next": "http://example.com",
    "Last": "http://example.com"
  },
  "Meta": {
    "TotalPages": 0,
    "FirstAvailableDateTime": "2020-10-23T10:23:58Z",
    "LastAvailableDateTime": "2020-10-23T10:23:58Z"
  }
}

Responses

Status Meaning Description Schema
200 OK Standing Orders Read OBReadStandingOrder5
400 Bad Request Bad request OBErrorResponse1
401 Unauthorized Unauthorized None
403 Forbidden Forbidden OBErrorResponse1
404 Not Found Not found None
405 Method Not Allowed Method Not Allowed None
406 Not Acceptable Not Acceptable None
429 Too Many Requests Too Many Requests None
500 Internal Server Error Internal Server Error OBErrorResponse1

Response Headers

Status Header Type Format Description
200 x-fapi-interaction-id string An RFC4122 UID used as a correlation id.
400 x-fapi-interaction-id string An RFC4122 UID used as a correlation id.
401 x-fapi-interaction-id string An RFC4122 UID used as a correlation id.
403 x-fapi-interaction-id string An RFC4122 UID used as a correlation id.
404 x-fapi-interaction-id string An RFC4122 UID used as a correlation id.
405 x-fapi-interaction-id string An RFC4122 UID used as a correlation id.
406 x-fapi-interaction-id string An RFC4122 UID used as a correlation id.
429 Retry-After integer Number in seconds to wait
429 x-fapi-interaction-id string An RFC4122 UID used as a correlation id.
500 x-fapi-interaction-id string An RFC4122 UID used as a correlation id.

Transactions

Listing transactions for an account

Get Transactions

Code samples

# You can also use wget
curl -X GET https://develop-api.fairfx.io/open-banking/proxy/cob/v3.1/aisp/transactions \
  -H 'Accept: application/json' \
  -H 'x-fapi-auth-date: string' \
  -H 'x-fapi-customer-ip-address: string' \
  -H 'x-fapi-interaction-id: string' \
  -H 'Authorization: string'

GET https://develop-api.fairfx.io/open-banking/proxy/cob/v3.1/aisp/transactions HTTP/1.1
Host: develop-api.fairfx.io
Accept: application/json
x-fapi-auth-date: string
x-fapi-customer-ip-address: string
x-fapi-interaction-id: string
Authorization: string

var headers = {
  'Accept':'application/json',
  'x-fapi-auth-date':'string',
  'x-fapi-customer-ip-address':'string',
  'x-fapi-interaction-id':'string',
  'Authorization':'string'

};

$.ajax({
  url: 'https://develop-api.fairfx.io/open-banking/proxy/cob/v3.1/aisp/transactions',
  method: 'get',

  headers: headers,
  success: function(data) {
    console.log(JSON.stringify(data));
  }
})

const fetch = require('node-fetch');

const headers = {
  'Accept':'application/json',
  'x-fapi-auth-date':'string',
  'x-fapi-customer-ip-address':'string',
  'x-fapi-interaction-id':'string',
  'Authorization':'string'

};

fetch('https://develop-api.fairfx.io/open-banking/proxy/cob/v3.1/aisp/transactions',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

GET /aisp/transactions

Parameters

Name In Type Required Description
x-fapi-auth-date header string false The time when the PSU last logged in with the TPP.
x-fapi-customer-ip-address header string false The PSU's IP address if the PSU is currently logged in with the TPP.
x-fapi-interaction-id header string false An RFC4122 UID used as a correlation id.
Authorization header string true An Authorisation Token as per https://tools.ietf.org/html/rfc6750
fromBookingDateTime query string(date-time) false The UTC ISO 8601 Date Time to filter transactions FROM
toBookingDateTime query string(date-time) false The UTC ISO 8601 Date Time to filter transactions TO

Detailed descriptions

x-fapi-auth-date: The time when the PSU last logged in with the TPP. All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: Sun, 10 Sep 2017 19:43:31 UTC

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

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

Example responses

200 Response

{
  "Data": {
    "Transaction": [
      {
        "AccountId": "string",
        "TransactionId": "string",
        "TransactionReference": "string",
        "StatementReference": [
          "string"
        ],
        "CreditDebitIndicator": "Credit",
        "Status": "Booked",
        "BookingDateTime": "2020-10-23T10:23:58Z",
        "ValueDateTime": "2020-10-23T10:23:58Z",
        "AddressLine": "string",
        "Amount": {
          "Amount": "string",
          "Currency": "string"
        },
        "ChargeAmount": {
          "Amount": "string",
          "Currency": "string"
        },
        "CurrencyExchange": {
          "SourceCurrency": "string",
          "TargetCurrency": "string",
          "UnitCurrency": "string",
          "ExchangeRate": 0,
          "ContractIdentification": "string",
          "QuotationDate": "2020-10-23T10:23:58Z",
          "InstructedAmount": {
            "Amount": "string",
            "Currency": "string"
          }
        },
        "BankTransactionCode": {
          "Code": "string",
          "SubCode": "string"
        },
        "ProprietaryBankTransactionCode": {
          "Code": "string",
          "Issuer": "string"
        },
        "CardInstrument": {
          "CardSchemeName": "AmericanExpress",
          "AuthorisationType": "ConsumerDevice",
          "Name": "string",
          "Identification": "string"
        },
        "SupplementaryData": {}
      }
    ]
  },
  "Links": {
    "Self": "http://example.com",
    "First": "http://example.com",
    "Prev": "http://example.com",
    "Next": "http://example.com",
    "Last": "http://example.com"
  },
  "Meta": {
    "TotalPages": 0,
    "FirstAvailableDateTime": "2020-10-23T10:23:58Z",
    "LastAvailableDateTime": "2020-10-23T10:23:58Z"
  }
}

Responses

Status Meaning Description Schema
200 OK Transactions Read OBReadTransaction5
400 Bad Request Bad request OBErrorResponse1
401 Unauthorized Unauthorized None
403 Forbidden Forbidden OBErrorResponse1
404 Not Found Not found None
405 Method Not Allowed Method Not Allowed None
406 Not Acceptable Not Acceptable None
429 Too Many Requests Too Many Requests None
500 Internal Server Error Internal Server Error OBErrorResponse1

Response Headers

Status Header Type Format Description
200 x-fapi-interaction-id string An RFC4122 UID used as a correlation id.
400 x-fapi-interaction-id string An RFC4122 UID used as a correlation id.
401 x-fapi-interaction-id string An RFC4122 UID used as a correlation id.
403 x-fapi-interaction-id string An RFC4122 UID used as a correlation id.
404 x-fapi-interaction-id string An RFC4122 UID used as a correlation id.
405 x-fapi-interaction-id string An RFC4122 UID used as a correlation id.
406 x-fapi-interaction-id string An RFC4122 UID used as a correlation id.
429 Retry-After integer Number in seconds to wait
429 x-fapi-interaction-id string An RFC4122 UID used as a correlation id.
500 x-fapi-interaction-id string An RFC4122 UID used as a correlation id.

Webhooks

Subscribing to and replaying webhook notifications

Request webhook events to be resent

Code samples

# You can also use wget
curl -X POST https://develop-api.fairfx.io/open-banking/proxy/cob/v3.1/webhook/replay \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

POST https://develop-api.fairfx.io/open-banking/proxy/cob/v3.1/webhook/replay HTTP/1.1
Host: develop-api.fairfx.io
Content-Type: application/json
Accept: application/json

var headers = {
  'Content-Type':'application/json',
  'Accept':'application/json',
  'Authorization':'Bearer {access-token}'

};

$.ajax({
  url: 'https://develop-api.fairfx.io/open-banking/proxy/cob/v3.1/webhook/replay',
  method: 'post',

  headers: headers,
  success: function(data) {
    console.log(JSON.stringify(data));
  }
})

const fetch = require('node-fetch');
const inputBody = '{
  "Data": {
    "StartDate": "2020-10-23T10:23:58Z",
    "EndDate": "2020-10-23T10:23:58Z",
    "IncludeSent": true
  }
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json',
  'Authorization':'Bearer {access-token}'

};

fetch('https://develop-api.fairfx.io/open-banking/proxy/cob/v3.1/webhook/replay',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

POST /webhook/replay

Body parameter

{
  "Data": {
    "StartDate": "2020-10-23T10:23:58Z",
    "EndDate": "2020-10-23T10:23:58Z",
    "IncludeSent": true
  }
}

Parameters

Name In Type Required Description
body body OBReplayWebhook true Replay webhook request object

Example responses

400 Response

{
  "Code": "string",
  "Id": "string",
  "Message": "string",
  "Errors": [
    {
      "ErrorCode": "string",
      "Message": "string",
      "Path": "string",
      "Url": "string"
    }
  ]
}

Responses

Status Meaning Description Schema
204 No Content Any matching events have been requested to be resent None
400 Bad Request Invalid request OBErrorResponse1
500 Internal Server Error An unexpected error occured OBErrorResponse1

Create a new subscription to a particular webhook event type

Code samples

# You can also use wget
curl -X POST https://develop-api.fairfx.io/open-banking/proxy/cob/v3.1/webhook/setup \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

POST https://develop-api.fairfx.io/open-banking/proxy/cob/v3.1/webhook/setup HTTP/1.1
Host: develop-api.fairfx.io
Content-Type: application/json
Accept: application/json

var headers = {
  'Content-Type':'application/json',
  'Accept':'application/json',
  'Authorization':'Bearer {access-token}'

};

$.ajax({
  url: 'https://develop-api.fairfx.io/open-banking/proxy/cob/v3.1/webhook/setup',
  method: 'post',

  headers: headers,
  success: function(data) {
    console.log(JSON.stringify(data));
  }
})

const fetch = require('node-fetch');
const inputBody = '{
  "Data": {
    "OwnerID": "string",
    "AccountID": "string",
    "EventType": 1,
    "URL": "http://example.com"
  }
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json',
  'Authorization':'Bearer {access-token}'

};

fetch('https://develop-api.fairfx.io/open-banking/proxy/cob/v3.1/webhook/setup',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

POST /webhook/setup

Body parameter

{
  "Data": {
    "OwnerID": "string",
    "AccountID": "string",
    "EventType": 1,
    "URL": "http://example.com"
  }
}

Parameters

Name In Type Required Description
body body OBSetupWebhook true Setup webhook request object

Example responses

400 Response

{
  "Code": "string",
  "Id": "string",
  "Message": "string",
  "Errors": [
    {
      "ErrorCode": "string",
      "Message": "string",
      "Path": "string",
      "Url": "string"
    }
  ]
}

Responses

Status Meaning Description Schema
204 No Content The new subscription has been successfully created None
400 Bad Request Invalid request OBErrorResponse1
500 Internal Server Error An unexpected error occured OBErrorResponse1

Schemas

ActiveOrHistoricCurrencyCode

"string"

A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 "Codes for the representation of currencies and funds".

Properties

Name Type Required Restrictions Description
anonymous string false none A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 "Codes for the representation of currencies and funds".

BuildingNumber

"string"

Number that identifies the position of a building on a street.

Properties

Name Type Required Restrictions Description
anonymous string false none Number that identifies the position of a building on a street.

CountryCode

"string"

Nation with its own government.

Properties

Name Type Required Restrictions Description
anonymous string false none Nation with its own government.

CountrySubDivision

"string"

Identifies a subdivision of a country such as state, region, county.

Properties

Name Type Required Restrictions Description
anonymous string false none Identifies a subdivision of a country such as state, region, county.

Department

"string"

Identification of a division of a large organisation or building.

Properties

Name Type Required Restrictions Description
anonymous string false none Identification of a division of a large organisation or building.

File

{}

Properties

None

ISODateTime

"2020-10-23T10:23:58Z"

All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00

Properties

Name Type Required Restrictions Description
anonymous string(date-time) false none All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00

Identification

"string"

Identification assigned by an institution to identify an account. This identification is known by the account owner.

Properties

Name Type Required Restrictions Description
anonymous string false none Identification assigned by an institution to identify an account. This identification is known by the account owner.

{
  "Self": "http://example.com",
  "First": "http://example.com",
  "Prev": "http://example.com",
  "Next": "http://example.com",
  "Last": "http://example.com"
}

Links relevant to the payload

Properties

Name Type Required Restrictions Description
Self string(uri) true none none
First string(uri) false none none
Prev string(uri) false none none
Next string(uri) false none none
Last string(uri) false none none

Meta

{
  "TotalPages": 0,
  "FirstAvailableDateTime": "2020-10-23T10:23:58Z",
  "LastAvailableDateTime": "2020-10-23T10:23:58Z"
}

MetaData

Properties

Name Type Required Restrictions Description
TotalPages integer(int32) false none none
FirstAvailableDateTime ISODateTime false none All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00
LastAvailableDateTime ISODateTime false none All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00

OBActiveCurrencyAndAmount_SimpleType

"string"

A number of monetary units specified in an active currency where the unit of currency is explicit and compliant with ISO 4217.

Properties

Name Type Required Restrictions Description
anonymous string false none A number of monetary units specified in an active currency where the unit of currency is explicit and compliant with ISO 4217.

OBActiveOrHistoricCurrencyAndAmount

{
  "Amount": "string",
  "Currency": "string"
}

Amount of money associated with the charge type.

Properties

Name Type Required Restrictions Description
Amount OBActiveCurrencyAndAmount_SimpleType true none A number of monetary units specified in an active currency where the unit of currency is explicit and compliant with ISO 4217.
Currency ActiveOrHistoricCurrencyCode true none A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 "Codes for the representation of currencies and funds".

OBAddressTypeCode

"Business"

Identifies the nature of the postal address.

Properties

Name Type Required Restrictions Description
anonymous string false none Identifies the nature of the postal address.

Enumerated Values

Property Value
anonymous Business
anonymous Correspondence
anonymous DeliveryTo
anonymous MailTo
anonymous POBox
anonymous Postal
anonymous Residential
anonymous Statement

OBChargeBearerType1Code

"BorneByCreditor"

Specifies which party/parties will bear the charges associated with the processing of the payment transaction.

Properties

Name Type Required Restrictions Description
anonymous string false none Specifies which party/parties will bear the charges associated with the processing of the payment transaction.

Enumerated Values

Property Value
anonymous BorneByCreditor
anonymous BorneByDebtor
anonymous FollowingServiceLevel
anonymous Shared

OBError1

{
  "ErrorCode": "string",
  "Message": "string",
  "Path": "string",
  "Url": "string"
}

Properties

Name Type Required Restrictions Description
ErrorCode string true none Low level textual error code, e.g., UK.OBIE.Field.Missing
Message string true none A description of the error that occurred. e.g., 'A mandatory field isn't supplied' or 'RequestedExecutionDateTime must be in future' OBIE doesn't standardise this field
Path string false none Recommended but optional reference to the JSON Path of the field with error, e.g., Data.Initiation.InstructedAmount.Currency
Url string false none URL to help remediate the problem, or provide more information, or to API Reference, or help etc

OBErrorResponse1

{
  "Code": "string",
  "Id": "string",
  "Message": "string",
  "Errors": [
    {
      "ErrorCode": "string",
      "Message": "string",
      "Path": "string",
      "Url": "string"
    }
  ]
}

An array of detail error codes, and messages, and URLs to documentation to help remediation.

Properties

Name Type Required Restrictions Description
Code string true none High level textual error code, to help categorize the errors.
Id string false none A unique reference for the error instance, for audit purposes, in case of unknown/unclassified errors.
Message string true none Brief Error message, e.g., 'There is something wrong with the request parameters provided'
Errors [OBError1] true none none

OBExternalAccountIdentification4Code

"string"

Name of the identification scheme, in a coded form as published in an external list.

Properties

Name Type Required Restrictions Description
anonymous string false none Name of the identification scheme, in a coded form as published in an external list.

OBExternalLocalInstrument1Code

"string"

User community specific instrument. Usage: This element is used to specify a local instrument, local clearing option and/or further qualify the service or service level.

Properties

Name Type Required Restrictions Description
anonymous string false none User community specific instrument. Usage: This element is used to specify a local instrument, local clearing option and/or further qualify the service or service level.

OBExternalPaymentChargeType1Code

"string"

Charge type, in a coded form.

Properties

Name Type Required Restrictions Description
anonymous string false none Charge type, in a coded form.

OBPostalAddress6

{
  "AddressType": "Business",
  "Department": "string",
  "SubDepartment": "string",
  "StreetName": "string",
  "BuildingNumber": "string",
  "PostCode": "string",
  "TownName": "string",
  "CountrySubDivision": "string",
  "Country": "string",
  "AddressLine": [
    "string"
  ]
}

Information that locates and identifies a specific address, as defined by postal services.

Properties

Name Type Required Restrictions Description
AddressType OBAddressTypeCode false none Identifies the nature of the postal address.
Department Department false none Identification of a division of a large organisation or building.
SubDepartment SubDepartment false none Identification of a sub-division of a large organisation or building.
StreetName StreetName false none Name of a street or thoroughfare.
BuildingNumber BuildingNumber false none Number that identifies the position of a building on a street.
PostCode PostCode false none Identifier consisting of a group of letters and/or numbers that is added to a postal address to assist the sorting of mail.
TownName TownName false none Name of a built-up area, with defined boundaries, and a local government.
CountrySubDivision CountrySubDivision false none Identifies a subdivision of a country such as state, region, county.
Country CountryCode false none Nation with its own government.
AddressLine [string] false none none

OBRisk1

{
  "PaymentContextCode": "BillPayment",
  "MerchantCategoryCode": "stri",
  "MerchantCustomerIdentification": "string",
  "DeliveryAddress": {
    "AddressLine": [
      "string"
    ],
    "StreetName": "string",
    "BuildingNumber": "string",
    "PostCode": "string",
    "TownName": "string",
    "CountrySubDivision": [
      "string"
    ],
    "Country": "string"
  }
}

The Risk section is sent by the initiating party to the ASPSP. It is used to specify additional details for risk scoring for Payments.

Properties

Name Type Required Restrictions Description
PaymentContextCode string false none Specifies the payment context
MerchantCategoryCode string false none Category code conform to ISO 18245, related to the type of services or goods the merchant provides for the transaction.
MerchantCustomerIdentification string false none The unique customer identifier of the PSU with the merchant.
DeliveryAddress object false none Information that locates and identifies a specific address, as defined by postal services or in free format text.
» AddressLine [string] false none none
» StreetName StreetName false none Name of a street or thoroughfare.
» BuildingNumber BuildingNumber false none Number that identifies the position of a building on a street.
» PostCode PostCode false none Identifier consisting of a group of letters and/or numbers that is added to a postal address to assist the sorting of mail.
» TownName TownName true none Name of a built-up area, with defined boundaries, and a local government.
» CountrySubDivision [string] false none none
» Country string true none Nation with its own government, occupying a particular territory.

Enumerated Values

Property Value
PaymentContextCode BillPayment
PaymentContextCode EcommerceGoods
PaymentContextCode EcommerceServices
PaymentContextCode Other
PaymentContextCode PartyToParty

OBSupplementaryData1

{}

Additional information that can not be captured in the structured fields and/or any other specific block.

Properties

None

OBWriteDomestic2

{
  "Data": {
    "ConsentId": "string",
    "Initiation": {
      "InstructionIdentification": "string",
      "EndToEndIdentification": "string",
      "LocalInstrument": "string",
      "InstructedAmount": {
        "Amount": "string",
        "Currency": "string"
      },
      "DebtorAccount": {
        "SchemeName": "string",
        "Identification": "string",
        "Name": "string",
        "SecondaryIdentification": "string"
      },
      "CreditorAccount": {
        "SchemeName": "string",
        "Identification": "string",
        "Name": "string",
        "SecondaryIdentification": "string"
      },
      "CreditorPostalAddress": {
        "AddressType": "Business",
        "Department": "string",
        "SubDepartment": "string",
        "StreetName": "string",
        "BuildingNumber": "string",
        "PostCode": "string",
        "TownName": "string",
        "CountrySubDivision": "string",
        "Country": "string",
        "AddressLine": [
          "string"
        ]
      },
      "RemittanceInformation": {
        "Unstructured": "string",
        "Reference": "string"
      },
      "SupplementaryData": {}
    }
  },
  "Risk": {
    "PaymentContextCode": "BillPayment",
    "MerchantCategoryCode": "stri",
    "MerchantCustomerIdentification": "string",
    "DeliveryAddress": {
      "AddressLine": [
        "string"
      ],
      "StreetName": "string",
      "BuildingNumber": "string",
      "PostCode": "string",
      "TownName": "string",
      "CountrySubDivision": [
        "string"
      ],
      "Country": "string"
    }
  }
}

Properties

Name Type Required Restrictions Description
Data object true none none
» ConsentId string true none OB: Unique identification as assigned by the ASPSP to uniquely identify the consent resource.
» Initiation object true none The Initiation payload is sent by the initiating party to the ASPSP. It is used to request movement of funds from the debtor account to a creditor for a single domestic payment.
»» InstructionIdentification string true none Unique identification as assigned by an instructing party for an instructed party to unambiguously identify the instruction. Usage: the instruction identification is a point to point reference that can be used between the instructing party and the instructed party to refer to the individual instruction. It can be included in several messages related to the instruction.
»» EndToEndIdentification string true none Unique identification assigned by the initiating party to unambiguously identify the transaction. This identification is passed on, unchanged, throughout the entire end-to-end chain. Usage: The end-to-end identification can be used for reconciliation or to link tasks relating to the transaction. It can be included in several messages related to the transaction. OB: The Faster Payments Scheme can only access 31 characters for the EndToEndIdentification field.
»» LocalInstrument OBExternalLocalInstrument1Code false none User community specific instrument. Usage: This element is used to specify a local instrument, local clearing option and/or further qualify the service or service level.
»» InstructedAmount object true none Amount of money to be moved between the debtor and creditor, before deduction of charges, expressed in the currency as ordered by the initiating party. Usage: This amount has to be transported unchanged through the transaction chain.
»»» Amount OBActiveCurrencyAndAmount_SimpleType true none A number of monetary units specified in an active currency where the unit of currency is explicit and compliant with ISO 4217.
»»» Currency ActiveOrHistoricCurrencyCode true none A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 "Codes for the representation of currencies and funds".
»» DebtorAccount object false none Unambiguous identification of the account of the debtor to which a debit entry will be made as a result of the transaction.
»»» SchemeName OBExternalAccountIdentification4Code true none Name of the identification scheme, in a coded form as published in an external list.
»»» Identification Identification true none Identification assigned by an institution to identify an account. This identification is known by the account owner.
»»» Name string false none The account name is the name or names of the account owner(s) represented at an account level, as displayed by the ASPSP's online channels. Note, the account name is not the product name or the nickname of the account.
»»» SecondaryIdentification SecondaryIdentification false none This is secondary identification of the account, as assigned by the account servicing institution. This can be used by building societies to additionally identify accounts with a roll number (in addition to a sort code and account number combination).
»» CreditorAccount object true none Unambiguous identification of the account of the creditor to which a credit entry will be posted as a result of the payment transaction.
»»» SchemeName OBExternalAccountIdentification4Code true none Name of the identification scheme, in a coded form as published in an external list.
»»» Identification Identification true none Identification assigned by an institution to identify an account. This identification is known by the account owner.
»»» Name string true none The account name is the name or names of the account owner(s) represented at an account level. Note, the account name is not the product name or the nickname of the account. OB: ASPSPs may carry out name validation for Confirmation of Payee, but it is not mandatory.
»»» SecondaryIdentification SecondaryIdentification false none This is secondary identification of the account, as assigned by the account servicing institution. This can be used by building societies to additionally identify accounts with a roll number (in addition to a sort code and account number combination).
»» CreditorPostalAddress OBPostalAddress6 false none Information that locates and identifies a specific address, as defined by postal services.
»» RemittanceInformation object false none Information supplied to enable the matching of an entry with the items that the transfer is intended to settle, such as commercial invoices in an accounts' receivable system.
»»» Unstructured string false none Information supplied to enable the matching/reconciliation of an entry with the items that the payment is intended to settle, such as commercial invoices in an accounts' receivable system, in an unstructured form.
»»» Reference string false none Unique reference, as assigned by the creditor, to unambiguously refer to the payment transaction. Usage: If available, the initiating party should provide this reference in the structured remittance information, to enable reconciliation by the creditor upon receipt of the amount of money. If the business context requires the use of a creditor reference or a payment remit identification, and only one identifier can be passed through the end-to-end chain, the creditor's reference or payment remittance identification should be quoted in the end-to-end transaction identification. OB: The Faster Payments Scheme can only accept 18 characters for the ReferenceInformation field - which is where this ISO field will be mapped.
»» SupplementaryData OBSupplementaryData1 false none Additional information that can not be captured in the structured fields and/or any other specific block.
» Risk OBRisk1 true none The Risk section is sent by the initiating party to the ASPSP. It is used to specify additional details for risk scoring for Payments.

OBWriteDomesticConsent3

{
  "Data": {
    "Initiation": {
      "InstructionIdentification": "string",
      "EndToEndIdentification": "string",
      "LocalInstrument": "string",
      "InstructedAmount": {
        "Amount": "string",
        "Currency": "string"
      },
      "DebtorAccount": {
        "SchemeName": "string",
        "Identification": "string",
        "Name": "string",
        "SecondaryIdentification": "string"
      },
      "CreditorAccount": {
        "SchemeName": "string",
        "Identification": "string",
        "Name": "string",
        "SecondaryIdentification": "string"
      },
      "CreditorPostalAddress": {
        "AddressType": "Business",
        "Department": "string",
        "SubDepartment": "string",
        "StreetName": "string",
        "BuildingNumber": "string",
        "PostCode": "string",
        "TownName": "string",
        "CountrySubDivision": "string",
        "Country": "string",
        "AddressLine": [
          "string"
        ]
      },
      "RemittanceInformation": {
        "Unstructured": "string",
        "Reference": "string"
      },
      "SupplementaryData": {}
    },
    "Authorisation": {
      "AuthorisationType": "Any",
      "CompletionDateTime": "2020-10-23T10:23:58Z"
    },
    "SCASupportData": {
      "RequestedSCAExemptionType": "BillPayment",
      "AppliedAuthenticationApproach": "CA",
      "ReferencePaymentOrderId": "string"
    }
  },
  "Risk": {
    "PaymentContextCode": "BillPayment",
    "MerchantCategoryCode": "stri",
    "MerchantCustomerIdentification": "string",
    "DeliveryAddress": {
      "AddressLine": [
        "string"
      ],
      "StreetName": "string",
      "BuildingNumber": "string",
      "PostCode": "string",
      "TownName": "string",
      "CountrySubDivision": [
        "string"
      ],
      "Country": "string"
    }
  }
}

Properties

Name Type Required Restrictions Description
Data object true none none
» Initiation object true none The Initiation payload is sent by the initiating party to the ASPSP. It is used to request movement of funds from the debtor account to a creditor for a single domestic payment.
»» InstructionIdentification string true none Unique identification as assigned by an instructing party for an instructed party to unambiguously identify the instruction. Usage: the instruction identification is a point to point reference that can be used between the instructing party and the instructed party to refer to the individual instruction. It can be included in several messages related to the instruction.
»» EndToEndIdentification string true none Unique identification assigned by the initiating party to unambiguously identify the transaction. This identification is passed on, unchanged, throughout the entire end-to-end chain. Usage: The end-to-end identification can be used for reconciliation or to link tasks relating to the transaction. It can be included in several messages related to the transaction. OB: The Faster Payments Scheme can only access 31 characters for the EndToEndIdentification field.
»» LocalInstrument OBExternalLocalInstrument1Code false none User community specific instrument. Usage: This element is used to specify a local instrument, local clearing option and/or further qualify the service or service level.
»» InstructedAmount object true none Amount of money to be moved between the debtor and creditor, before deduction of charges, expressed in the currency as ordered by the initiating party. Usage: This amount has to be transported unchanged through the transaction chain.
»»» Amount OBActiveCurrencyAndAmount_SimpleType true none A number of monetary units specified in an active currency where the unit of currency is explicit and compliant with ISO 4217.
»»» Currency ActiveOrHistoricCurrencyCode true none A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 "Codes for the representation of currencies and funds".
»» DebtorAccount object false none Unambiguous identification of the account of the debtor to which a debit entry will be made as a result of the transaction.
»»» SchemeName OBExternalAccountIdentification4Code true none Name of the identification scheme, in a coded form as published in an external list.
»»» Identification Identification true none Identification assigned by an institution to identify an account. This identification is known by the account owner.
»»» Name string false none The account name is the name or names of the account owner(s) represented at an account level, as displayed by the ASPSP's online channels. Note, the account name is not the product name or the nickname of the account.
»»» SecondaryIdentification SecondaryIdentification false none This is secondary identification of the account, as assigned by the account servicing institution. This can be used by building societies to additionally identify accounts with a roll number (in addition to a sort code and account number combination).
»» CreditorAccount object true none Unambiguous identification of the account of the creditor to which a credit entry will be posted as a result of the payment transaction.
»»» SchemeName OBExternalAccountIdentification4Code true none Name of the identification scheme, in a coded form as published in an external list.
»»» Identification Identification true none Identification assigned by an institution to identify an account. This identification is known by the account owner.
»»» Name string true none The account name is the name or names of the account owner(s) represented at an account level. Note, the account name is not the product name or the nickname of the account. OB: ASPSPs may carry out name validation for Confirmation of Payee, but it is not mandatory.
»»» SecondaryIdentification SecondaryIdentification false none This is secondary identification of the account, as assigned by the account servicing institution. This can be used by building societies to additionally identify accounts with a roll number (in addition to a sort code and account number combination).
»» CreditorPostalAddress OBPostalAddress6 false none Information that locates and identifies a specific address, as defined by postal services.
»» RemittanceInformation object false none Information supplied to enable the matching of an entry with the items that the transfer is intended to settle, such as commercial invoices in an accounts' receivable system.
»»» Unstructured string false none Information supplied to enable the matching/reconciliation of an entry with the items that the payment is intended to settle, such as commercial invoices in an accounts' receivable system, in an unstructured form.
»»» Reference string false none Unique reference, as assigned by the creditor, to unambiguously refer to the payment transaction. Usage: If available, the initiating party should provide this reference in the structured remittance information, to enable reconciliation by the creditor upon receipt of the amount of money. If the business context requires the use of a creditor reference or a payment remit identification, and only one identifier can be passed through the end-to-end chain, the creditor's reference or payment remittance identification should be quoted in the end-to-end transaction identification. OB: The Faster Payments Scheme can only accept 18 characters for the ReferenceInformation field - which is where this ISO field will be mapped.
»» SupplementaryData OBSupplementaryData1 false none Additional information that can not be captured in the structured fields and/or any other specific block.
» Authorisation object false none The authorisation type request from the TPP.
»» AuthorisationType string true none Type of authorisation flow requested.
»» CompletionDateTime string(date-time) false none Date and time at which the requested authorisation flow must be completed.All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00
» SCASupportData object false none Supporting Data provided by TPP, when requesting SCA Exemption.
»» RequestedSCAExemptionType string false none This field allows a PISP to request specific SCA Exemption for a Payment Initiation
»» AppliedAuthenticationApproach string false none Specifies a character string with a maximum length of 40 characters. Usage: This field indicates whether the PSU was subject to SCA performed by the TPP
»» ReferencePaymentOrderId string false none Specifies a character string with a maximum length of 140 characters. Usage: If the payment is recurring then the transaction identifier of the previous payment occurrence so that the ASPSP can verify that the PISP, amount and the payee are the same as the previous occurrence.
» Risk OBRisk1 true none The Risk section is sent by the initiating party to the ASPSP. It is used to specify additional details for risk scoring for Payments.

Enumerated Values

Property Value
AuthorisationType Any
AuthorisationType Single
RequestedSCAExemptionType BillPayment
RequestedSCAExemptionType ContactlessTravel
RequestedSCAExemptionType EcommerceGoods
RequestedSCAExemptionType EcommerceServices
RequestedSCAExemptionType Kiosk
RequestedSCAExemptionType Parking
RequestedSCAExemptionType PartyToParty
AppliedAuthenticationApproach CA
AppliedAuthenticationApproach SCA

OBWriteDomesticConsentResponse3

{
  "Data": {
    "ConsentId": "string",
    "CreationDateTime": "2020-10-23T10:23:58Z",
    "Status": "Authorised",
    "StatusUpdateDateTime": "2020-10-23T10:23:58Z",
    "CutOffDateTime": "2020-10-23T10:23:58Z",
    "ExpectedExecutionDateTime": "2020-10-23T10:23:58Z",
    "ExpectedSettlementDateTime": "2020-10-23T10:23:58Z",
    "Charges": [
      {
        "ChargeBearer": "BorneByCreditor",
        "Type": "string",
        "Amount": {
          "Amount": "string",
          "Currency": "string"
        }
      }
    ],
    "Initiation": {
      "InstructionIdentification": "string",
      "EndToEndIdentification": "string",
      "LocalInstrument": "string",
      "InstructedAmount": {
        "Amount": "string",
        "Currency": "string"
      },
      "DebtorAccount": {
        "SchemeName": "string",
        "Identification": "string",
        "Name": "string",
        "SecondaryIdentification": "string"
      },
      "CreditorAccount": {
        "SchemeName": "string",
        "Identification": "string",
        "Name": "string",
        "SecondaryIdentification": "string"
      },
      "CreditorPostalAddress": {
        "AddressType": "Business",
        "Department": "string",
        "SubDepartment": "string",
        "StreetName": "string",
        "BuildingNumber": "string",
        "PostCode": "string",
        "TownName": "string",
        "CountrySubDivision": "string",
        "Country": "string",
        "AddressLine": [
          "string"
        ]
      },
      "RemittanceInformation": {
        "Unstructured": "string",
        "Reference": "string"
      },
      "SupplementaryData": {}
    },
    "Authorisation": {
      "AuthorisationType": "Any",
      "CompletionDateTime": "2020-10-23T10:23:58Z"
    },
    "SCASupportData": {
      "RequestedSCAExemptionType": "BillPayment",
      "AppliedAuthenticationApproach": "CA",
      "ReferencePaymentOrderId": "string"
    }
  },
  "Risk": {
    "PaymentContextCode": "BillPayment",
    "MerchantCategoryCode": "stri",
    "MerchantCustomerIdentification": "string",
    "DeliveryAddress": {
      "AddressLine": [
        "string"
      ],
      "StreetName": "string",
      "BuildingNumber": "string",
      "PostCode": "string",
      "TownName": "string",
      "CountrySubDivision": [
        "string"
      ],
      "Country": "string"
    }
  },
  "Links": {
    "Self": "http://example.com",
    "First": "http://example.com",
    "Prev": "http://example.com",
    "Next": "http://example.com",
    "Last": "http://example.com"
  },
  "Meta": {
    "TotalPages": 0,
    "FirstAvailableDateTime": "2020-10-23T10:23:58Z",
    "LastAvailableDateTime": "2020-10-23T10:23:58Z"
  }
}

Properties

Name Type Required Restrictions Description
Data object true none none
» ConsentId string true none OB: Unique identification as assigned by the ASPSP to uniquely identify the consent resource.
» CreationDateTime string(date-time) true none Date and time at which the resource was created.All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00
» Status string true none Specifies the status of consent resource in code form.
» StatusUpdateDateTime string(date-time) true none Date and time at which the resource status was updated.All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00
» CutOffDateTime string(date-time) false none Specified cut-off date and time for the payment consent.All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00
» ExpectedExecutionDateTime string(date-time) false none Expected execution date and time for the payment resource.All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00
» ExpectedSettlementDateTime string(date-time) false none Expected settlement date and time for the payment resource.All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00
» Charges [object] false none none
»» ChargeBearer OBChargeBearerType1Code true none Specifies which party/parties will bear the charges associated with the processing of the payment transaction.
»» Type OBExternalPaymentChargeType1Code true none Charge type, in a coded form.
»» Amount OBActiveOrHistoricCurrencyAndAmount true none Amount of money associated with the charge type.
» Initiation object true none The Initiation payload is sent by the initiating party to the ASPSP. It is used to request movement of funds from the debtor account to a creditor for a single domestic payment.
»» InstructionIdentification string true none Unique identification as assigned by an instructing party for an instructed party to unambiguously identify the instruction. Usage: the instruction identification is a point to point reference that can be used between the instructing party and the instructed party to refer to the individual instruction. It can be included in several messages related to the instruction.
»» EndToEndIdentification string true none Unique identification assigned by the initiating party to unambiguously identify the transaction. This identification is passed on, unchanged, throughout the entire end-to-end chain. Usage: The end-to-end identification can be used for reconciliation or to link tasks relating to the transaction. It can be included in several messages related to the transaction. OB: The Faster Payments Scheme can only access 31 characters for the EndToEndIdentification field.
»» LocalInstrument OBExternalLocalInstrument1Code false none User community specific instrument. Usage: This element is used to specify a local instrument, local clearing option and/or further qualify the service or service level.
»» InstructedAmount object true none Amount of money to be moved between the debtor and creditor, before deduction of charges, expressed in the currency as ordered by the initiating party. Usage: This amount has to be transported unchanged through the transaction chain.
»»» Amount OBActiveCurrencyAndAmount_SimpleType true none A number of monetary units specified in an active currency where the unit of currency is explicit and compliant with ISO 4217.
»»» Currency ActiveOrHistoricCurrencyCode true none A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 "Codes for the representation of currencies and funds".
»» DebtorAccount object false none Unambiguous identification of the account of the debtor to which a debit entry will be made as a result of the transaction.
»»» SchemeName OBExternalAccountIdentification4Code true none Name of the identification scheme, in a coded form as published in an external list.
»»» Identification Identification true none Identification assigned by an institution to identify an account. This identification is known by the account owner.
»»» Name string false none The account name is the name or names of the account owner(s) represented at an account level, as displayed by the ASPSP's online channels. Note, the account name is not the product name or the nickname of the account.
»»» SecondaryIdentification SecondaryIdentification false none This is secondary identification of the account, as assigned by the account servicing institution. This can be used by building societies to additionally identify accounts with a roll number (in addition to a sort code and account number combination).
»» CreditorAccount object true none Unambiguous identification of the account of the creditor to which a credit entry will be posted as a result of the payment transaction.
»»» SchemeName OBExternalAccountIdentification4Code true none Name of the identification scheme, in a coded form as published in an external list.
»»» Identification Identification true none Identification assigned by an institution to identify an account. This identification is known by the account owner.
»»» Name string true none The account name is the name or names of the account owner(s) represented at an account level. Note, the account name is not the product name or the nickname of the account. OB: ASPSPs may carry out name validation for Confirmation of Payee, but it is not mandatory.
»»» SecondaryIdentification SecondaryIdentification false none This is secondary identification of the account, as assigned by the account servicing institution. This can be used by building societies to additionally identify accounts with a roll number (in addition to a sort code and account number combination).
»» CreditorPostalAddress OBPostalAddress6 false none Information that locates and identifies a specific address, as defined by postal services.
»» RemittanceInformation object false none Information supplied to enable the matching of an entry with the items that the transfer is intended to settle, such as commercial invoices in an accounts' receivable system.
»»» Unstructured string false none Information supplied to enable the matching/reconciliation of an entry with the items that the payment is intended to settle, such as commercial invoices in an accounts' receivable system, in an unstructured form.
»»» Reference string false none Unique reference, as assigned by the creditor, to unambiguously refer to the payment transaction. Usage: If available, the initiating party should provide this reference in the structured remittance information, to enable reconciliation by the creditor upon receipt of the amount of money. If the business context requires the use of a creditor reference or a payment remit identification, and only one identifier can be passed through the end-to-end chain, the creditor's reference or payment remittance identification should be quoted in the end-to-end transaction identification. OB: The Faster Payments Scheme can only accept 18 characters for the ReferenceInformation field - which is where this ISO field will be mapped.
»» SupplementaryData OBSupplementaryData1 false none Additional information that can not be captured in the structured fields and/or any other specific block.
» Authorisation object false none The authorisation type request from the TPP.
»» AuthorisationType string true none Type of authorisation flow requested.
»» CompletionDateTime string(date-time) false none Date and time at which the requested authorisation flow must be completed.All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00
» SCASupportData object false none Supporting Data provided by TPP, when requesting SCA Exemption.
»» RequestedSCAExemptionType string false none This field allows a PISP to request specific SCA Exemption for a Payment Initiation
»» AppliedAuthenticationApproach string false none Specifies a character string with a maximum length of 40 characters. Usage: This field indicates whether the PSU was subject to SCA performed by the TPP
»» ReferencePaymentOrderId string false none Specifies a character string with a maximum length of 140 characters. Usage: If the payment is recurring then the transaction identifier of the previous payment occurrence so that the ASPSP can verify that the PISP, amount and the payee are the same as the previous occurrence.
» Risk OBRisk1 true none The Risk section is sent by the initiating party to the ASPSP. It is used to specify additional details for risk scoring for Payments.
» Links Links false none Links relevant to the payload
» Meta Meta false none Meta Data relevant to the payload

Enumerated Values

Property Value
Status Authorised
Status AwaitingAuthorisation
Status Consumed
Status Rejected
AuthorisationType Any
AuthorisationType Single
RequestedSCAExemptionType BillPayment
RequestedSCAExemptionType ContactlessTravel
RequestedSCAExemptionType EcommerceGoods
RequestedSCAExemptionType EcommerceServices
RequestedSCAExemptionType Kiosk
RequestedSCAExemptionType Parking
RequestedSCAExemptionType PartyToParty
AppliedAuthenticationApproach CA
AppliedAuthenticationApproach SCA

OBWriteDomesticResponse3

{
  "Data": {
    "DomesticPaymentId": "string",
    "ConsentId": "string",
    "CreationDateTime": "2020-10-23T10:23:58Z",
    "Status": "AcceptedCreditSettlementCompleted",
    "StatusUpdateDateTime": "2020-10-23T10:23:58Z",
    "ExpectedExecutionDateTime": "2020-10-23T10:23:58Z",
    "ExpectedSettlementDateTime": "2020-10-23T10:23:58Z",
    "Charges": [
      {
        "ChargeBearer": "BorneByCreditor",
        "Type": "string",
        "Amount": {
          "Amount": "string",
          "Currency": "string"
        }
      }
    ],
    "Initiation": {
      "InstructionIdentification": "string",
      "EndToEndIdentification": "string",
      "LocalInstrument": "string",
      "InstructedAmount": {
        "Amount": "string",
        "Currency": "string"
      },
      "DebtorAccount": {
        "SchemeName": "string",
        "Identification": "string",
        "Name": "string",
        "SecondaryIdentification": "string"
      },
      "CreditorAccount": {
        "SchemeName": "string",
        "Identification": "string",
        "Name": "string",
        "SecondaryIdentification": "string"
      },
      "CreditorPostalAddress": {
        "AddressType": "Business",
        "Department": "string",
        "SubDepartment": "string",
        "StreetName": "string",
        "BuildingNumber": "string",
        "PostCode": "string",
        "TownName": "string",
        "CountrySubDivision": "string",
        "Country": "string",
        "AddressLine": [
          "string"
        ]
      },
      "RemittanceInformation": {
        "Unstructured": "string",
        "Reference": "string"
      },
      "SupplementaryData": {}
    },
    "MultiAuthorisation": {
      "Status": "Authorised",
      "NumberRequired": 0,
      "NumberReceived": 0,
      "LastUpdateDateTime": "2020-10-23T10:23:58Z",
      "ExpirationDateTime": "2020-10-23T10:23:58Z"
    }
  },
  "Links": {
    "Self": "http://example.com",
    "First": "http://example.com",
    "Prev": "http://example.com",
    "Next": "http://example.com",
    "Last": "http://example.com"
  },
  "Meta": {
    "TotalPages": 0,
    "FirstAvailableDateTime": "2020-10-23T10:23:58Z",
    "LastAvailableDateTime": "2020-10-23T10:23:58Z"
  }
}

Properties

Name Type Required Restrictions Description
Data object true none none
» DomesticPaymentId string true none OB: Unique identification as assigned by the ASPSP to uniquely identify the domestic payment resource.
» ConsentId string true none OB: Unique identification as assigned by the ASPSP to uniquely identify the consent resource.
» CreationDateTime string(date-time) true none Date and time at which the message was created.All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00
» Status string true none Specifies the status of the payment information group.
» StatusUpdateDateTime string(date-time) true none Date and time at which the resource status was updated.All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00
» ExpectedExecutionDateTime string(date-time) false none Expected execution date and time for the payment resource.All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00
» ExpectedSettlementDateTime string(date-time) false none Expected settlement date and time for the payment resource.All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00
» Charges [object] false none none
»» ChargeBearer OBChargeBearerType1Code true none Specifies which party/parties will bear the charges associated with the processing of the payment transaction.
»» Type OBExternalPaymentChargeType1Code true none Charge type, in a coded form.
»» Amount OBActiveOrHistoricCurrencyAndAmount true none Amount of money associated with the charge type.
» Initiation object true none The Initiation payload is sent by the initiating party to the ASPSP. It is used to request movement of funds from the debtor account to a creditor for a single domestic payment.
»» InstructionIdentification string true none Unique identification as assigned by an instructing party for an instructed party to unambiguously identify the instruction. Usage: the instruction identification is a point to point reference that can be used between the instructing party and the instructed party to refer to the individual instruction. It can be included in several messages related to the instruction.
»» EndToEndIdentification string true none Unique identification assigned by the initiating party to unambiguously identify the transaction. This identification is passed on, unchanged, throughout the entire end-to-end chain. Usage: The end-to-end identification can be used for reconciliation or to link tasks relating to the transaction. It can be included in several messages related to the transaction. OB: The Faster Payments Scheme can only access 31 characters for the EndToEndIdentification field.
»» LocalInstrument OBExternalLocalInstrument1Code false none User community specific instrument. Usage: This element is used to specify a local instrument, local clearing option and/or further qualify the service or service level.
»» InstructedAmount object true none Amount of money to be moved between the debtor and creditor, before deduction of charges, expressed in the currency as ordered by the initiating party. Usage: This amount has to be transported unchanged through the transaction chain.
»»» Amount OBActiveCurrencyAndAmount_SimpleType true none A number of monetary units specified in an active currency where the unit of currency is explicit and compliant with ISO 4217.
»»» Currency ActiveOrHistoricCurrencyCode true none A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 "Codes for the representation of currencies and funds".
»» DebtorAccount object false none Unambiguous identification of the account of the debtor to which a debit entry will be made as a result of the transaction.
»»» SchemeName OBExternalAccountIdentification4Code true none Name of the identification scheme, in a coded form as published in an external list.
»»» Identification Identification true none Identification assigned by an institution to identify an account. This identification is known by the account owner.
»»» Name string false none The account name is the name or names of the account owner(s) represented at an account level, as displayed by the ASPSP's online channels. Note, the account name is not the product name or the nickname of the account.
»»» SecondaryIdentification SecondaryIdentification false none This is secondary identification of the account, as assigned by the account servicing institution. This can be used by building societies to additionally identify accounts with a roll number (in addition to a sort code and account number combination).
»» CreditorAccount object true none Unambiguous identification of the account of the creditor to which a credit entry will be posted as a result of the payment transaction.
»»» SchemeName OBExternalAccountIdentification4Code true none Name of the identification scheme, in a coded form as published in an external list.
»»» Identification Identification true none Identification assigned by an institution to identify an account. This identification is known by the account owner.
»»» Name string true none The account name is the name or names of the account owner(s) represented at an account level. Note, the account name is not the product name or the nickname of the account. OB: ASPSPs may carry out name validation for Confirmation of Payee, but it is not mandatory.
»»» SecondaryIdentification SecondaryIdentification false none This is secondary identification of the account, as assigned by the account servicing institution. This can be used by building societies to additionally identify accounts with a roll number (in addition to a sort code and account number combination).
»» CreditorPostalAddress OBPostalAddress6 false none Information that locates and identifies a specific address, as defined by postal services.
»» RemittanceInformation object false none Information supplied to enable the matching of an entry with the items that the transfer is intended to settle, such as commercial invoices in an accounts' receivable system.
»»» Unstructured string false none Information supplied to enable the matching/reconciliation of an entry with the items that the payment is intended to settle, such as commercial invoices in an accounts' receivable system, in an unstructured form.
»»» Reference string false none Unique reference, as assigned by the creditor, to unambiguously refer to the payment transaction. Usage: If available, the initiating party should provide this reference in the structured remittance information, to enable reconciliation by the creditor upon receipt of the amount of money. If the business context requires the use of a creditor reference or a payment remit identification, and only one identifier can be passed through the end-to-end chain, the creditor's reference or payment remittance identification should be quoted in the end-to-end transaction identification. OB: The Faster Payments Scheme can only accept 18 characters for the ReferenceInformation field - which is where this ISO field will be mapped.
»» SupplementaryData OBSupplementaryData1 false none Additional information that can not be captured in the structured fields and/or any other specific block.
» MultiAuthorisation object false none The multiple authorisation flow response from the ASPSP.
»» Status string true none Specifies the status of the authorisation flow in code form.
»» NumberRequired integer false none Number of authorisations required for payment order (total required at the start of the multi authorisation journey).
»» NumberReceived integer false none Number of authorisations received.
»» LastUpdateDateTime string(date-time) false none Last date and time at the authorisation flow was updated.All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00
»» ExpirationDateTime string(date-time) false none Date and time at which the requested authorisation flow must be completed.All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00
» Links Links false none Links relevant to the payload
» Meta Meta false none Meta Data relevant to the payload

Enumerated Values

Property Value
Status AcceptedCreditSettlementCompleted
Status AcceptedSettlementCompleted
Status AcceptedSettlementInProcess
Status AcceptedWithoutPosting
Status Pending
Status Rejected
Status Authorised
Status AwaitingFurtherAuthorisation
Status Rejected

OBWriteDomesticScheduled2

{
  "Data": {
    "ConsentId": "string",
    "Initiation": {
      "InstructionIdentification": "string",
      "EndToEndIdentification": "string",
      "LocalInstrument": "string",
      "RequestedExecutionDateTime": "2020-10-23T10:23:58Z",
      "InstructedAmount": {
        "Amount": "string",
        "Currency": "string"
      },
      "DebtorAccount": {
        "SchemeName": "string",
        "Identification": "string",
        "Name": "string",
        "SecondaryIdentification": "string"
      },
      "CreditorAccount": {
        "SchemeName": "string",
        "Identification": "string",
        "Name": "string",
        "SecondaryIdentification": "string"
      },
      "CreditorPostalAddress": {
        "AddressType": "Business",
        "Department": "string",
        "SubDepartment": "string",
        "StreetName": "string",
        "BuildingNumber": "string",
        "PostCode": "string",
        "TownName": "string",
        "CountrySubDivision": "string",
        "Country": "string",
        "AddressLine": [
          "string"
        ]
      },
      "RemittanceInformation": {
        "Unstructured": "string",
        "Reference": "string"
      },
      "SupplementaryData": {}
    }
  },
  "Risk": {
    "PaymentContextCode": "BillPayment",
    "MerchantCategoryCode": "stri",
    "MerchantCustomerIdentification": "string",
    "DeliveryAddress": {
      "AddressLine": [
        "string"
      ],
      "StreetName": "string",
      "BuildingNumber": "string",
      "PostCode": "string",
      "TownName": "string",
      "CountrySubDivision": [
        "string"
      ],
      "Country": "string"
    }
  }
}

Properties

Name Type Required Restrictions Description
Data object true none none
» ConsentId string true none OB: Unique identification as assigned by the ASPSP to uniquely identify the consent resource.
» Initiation object true none The Initiation payload is sent by the initiating party to the ASPSP. It is used to request movement of funds from the debtor account to a creditor for a single scheduled domestic payment.
»» InstructionIdentification string true none Unique identification as assigned by an instructing party for an instructed party to unambiguously identify the instruction. Usage: the instruction identification is a point to point reference that can be used between the instructing party and the instructed party to refer to the individual instruction. It can be included in several messages related to the instruction.
»» EndToEndIdentification string false none Unique identification assigned by the initiating party to unambiguously identify the transaction. This identification is passed on, unchanged, throughout the entire end-to-end chain. Usage: The end-to-end identification can be used for reconciliation or to link tasks relating to the transaction. It can be included in several messages related to the transaction. OB: The Faster Payments Scheme can only access 31 characters for the EndToEndIdentification field.
»» LocalInstrument OBExternalLocalInstrument1Code false none User community specific instrument. Usage: This element is used to specify a local instrument, local clearing option and/or further qualify the service or service level.
»» RequestedExecutionDateTime string(date-time) true none Date at which the initiating party requests the clearing agent to process the payment. Usage: This is the date on which the debtor's account is to be debited.All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00
»» InstructedAmount object true none Amount of money to be moved between the debtor and creditor, before deduction of charges, expressed in the currency as ordered by the initiating party. Usage: This amount has to be transported unchanged through the transaction chain.
»»» Amount OBActiveCurrencyAndAmount_SimpleType true none A number of monetary units specified in an active currency where the unit of currency is explicit and compliant with ISO 4217.
»»» Currency ActiveOrHistoricCurrencyCode true none A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 "Codes for the representation of currencies and funds".
»» DebtorAccount object false none Unambiguous identification of the account of the debtor to which a debit entry will be made as a result of the transaction.
»»» SchemeName OBExternalAccountIdentification4Code true none Name of the identification scheme, in a coded form as published in an external list.
»»» Identification Identification true none Identification assigned by an institution to identify an account. This identification is known by the account owner.
»»» Name string false none The account name is the name or names of the account owner(s) represented at an account level, as displayed by the ASPSP's online channels. Note, the account name is not the product name or the nickname of the account.
»»» SecondaryIdentification SecondaryIdentification false none This is secondary identification of the account, as assigned by the account servicing institution. This can be used by building societies to additionally identify accounts with a roll number (in addition to a sort code and account number combination).
»» CreditorAccount object true none Unambiguous identification of the account of the creditor to which a credit entry will be posted as a result of the payment transaction.
»»» SchemeName OBExternalAccountIdentification4Code true none Name of the identification scheme, in a coded form as published in an external list.
»»» Identification Identification true none Identification assigned by an institution to identify an account. This identification is known by the account owner.
»»» Name string true none The account name is the name or names of the account owner(s) represented at an account level. Note, the account name is not the product name or the nickname of the account. OB: ASPSPs may carry out name validation for Confirmation of Payee, but it is not mandatory.
»»» SecondaryIdentification SecondaryIdentification false none This is secondary identification of the account, as assigned by the account servicing institution. This can be used by building societies to additionally identify accounts with a roll number (in addition to a sort code and account number combination).
»» CreditorPostalAddress OBPostalAddress6 false none Information that locates and identifies a specific address, as defined by postal services.
»» RemittanceInformation object false none Information supplied to enable the matching of an entry with the items that the transfer is intended to settle, such as commercial invoices in an accounts' receivable system.
»»» Unstructured string false none Information supplied to enable the matching/reconciliation of an entry with the items that the payment is intended to settle, such as commercial invoices in an accounts' receivable system, in an unstructured form.
»»» Reference string false none Unique reference, as assigned by the creditor, to unambiguously refer to the payment transaction. Usage: If available, the initiating party should provide this reference in the structured remittance information, to enable reconciliation by the creditor upon receipt of the amount of money. If the business context requires the use of a creditor reference or a payment remit identification, and only one identifier can be passed through the end-to-end chain, the creditor's reference or payment remittance identification should be quoted in the end-to-end transaction identification. OB: The Faster Payments Scheme can only accept 18 characters for the ReferenceInformation field - which is where this ISO field will be mapped.
»» SupplementaryData OBSupplementaryData1 false none Additional information that can not be captured in the structured fields and/or any other specific block.
» Risk OBRisk1 true none The Risk section is sent by the initiating party to the ASPSP. It is used to specify additional details for risk scoring for Payments.

OBWriteDomesticScheduledConsent3

{
  "Data": {
    "Permission": "Create",
    "Initiation": {
      "InstructionIdentification": "string",
      "EndToEndIdentification": "string",
      "LocalInstrument": "string",
      "RequestedExecutionDateTime": "2020-10-23T10:23:58Z",
      "InstructedAmount": {
        "Amount": "string",
        "Currency": "string"
      },
      "DebtorAccount": {
        "SchemeName": "string",
        "Identification": "string",
        "Name": "string",
        "SecondaryIdentification": "string"
      },
      "CreditorAccount": {
        "SchemeName": "string",
        "Identification": "string",
        "Name": "string",
        "SecondaryIdentification": "string"
      },
      "CreditorPostalAddress": {
        "AddressType": "Business",
        "Department": "string",
        "SubDepartment": "string",
        "StreetName": "string",
        "BuildingNumber": "string",
        "PostCode": "string",
        "TownName": "string",
        "CountrySubDivision": "string",
        "Country": "string",
        "AddressLine": [
          "string"
        ]
      },
      "RemittanceInformation": {
        "Unstructured": "string",
        "Reference": "string"
      },
      "SupplementaryData": {}
    },
    "Authorisation": {
      "AuthorisationType": "Any",
      "CompletionDateTime": "2020-10-23T10:23:58Z"
    },
    "SCASupportData": {
      "RequestedSCAExemptionType": "BillPayment",
      "AppliedAuthenticationApproach": "CA",
      "ReferencePaymentOrderId": "string"
    }
  },
  "Risk": {
    "PaymentContextCode": "BillPayment",
    "MerchantCategoryCode": "stri",
    "MerchantCustomerIdentification": "string",
    "DeliveryAddress": {
      "AddressLine": [
        "string"
      ],
      "StreetName": "string",
      "BuildingNumber": "string",
      "PostCode": "string",
      "TownName": "string",
      "CountrySubDivision": [
        "string"
      ],
      "Country": "string"
    }
  }
}

Properties

Name Type Required Restrictions Description
Data object true none none
» Permission string true none Specifies the Open Banking service request types.
» Initiation object true none The Initiation payload is sent by the initiating party to the ASPSP. It is used to request movement of funds from the debtor account to a creditor for a single scheduled domestic payment.
»» InstructionIdentification string true none Unique identification as assigned by an instructing party for an instructed party to unambiguously identify the instruction. Usage: the instruction identification is a point to point reference that can be used between the instructing party and the instructed party to refer to the individual instruction. It can be included in several messages related to the instruction.
»» EndToEndIdentification string false none Unique identification assigned by the initiating party to unambiguously identify the transaction. This identification is passed on, unchanged, throughout the entire end-to-end chain. Usage: The end-to-end identification can be used for reconciliation or to link tasks relating to the transaction. It can be included in several messages related to the transaction. OB: The Faster Payments Scheme can only access 31 characters for the EndToEndIdentification field.
»» LocalInstrument OBExternalLocalInstrument1Code false none User community specific instrument. Usage: This element is used to specify a local instrument, local clearing option and/or further qualify the service or service level.
»» RequestedExecutionDateTime string(date-time) true none Date at which the initiating party requests the clearing agent to process the payment. Usage: This is the date on which the debtor's account is to be debited.All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00
»» InstructedAmount object true none Amount of money to be moved between the debtor and creditor, before deduction of charges, expressed in the currency as ordered by the initiating party. Usage: This amount has to be transported unchanged through the transaction chain.
»»» Amount OBActiveCurrencyAndAmount_SimpleType true none A number of monetary units specified in an active currency where the unit of currency is explicit and compliant with ISO 4217.
»»» Currency ActiveOrHistoricCurrencyCode true none A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 "Codes for the representation of currencies and funds".
»» DebtorAccount object false none Unambiguous identification of the account of the debtor to which a debit entry will be made as a result of the transaction.
»»» SchemeName OBExternalAccountIdentification4Code true none Name of the identification scheme, in a coded form as published in an external list.
»»» Identification Identification true none Identification assigned by an institution to identify an account. This identification is known by the account owner.
»»» Name string false none The account name is the name or names of the account owner(s) represented at an account level, as displayed by the ASPSP's online channels. Note, the account name is not the product name or the nickname of the account.
»»» SecondaryIdentification SecondaryIdentification false none This is secondary identification of the account, as assigned by the account servicing institution. This can be used by building societies to additionally identify accounts with a roll number (in addition to a sort code and account number combination).
»» CreditorAccount object true none Unambiguous identification of the account of the creditor to which a credit entry will be posted as a result of the payment transaction.
»»» SchemeName OBExternalAccountIdentification4Code true none Name of the identification scheme, in a coded form as published in an external list.
»»» Identification Identification true none Identification assigned by an institution to identify an account. This identification is known by the account owner.
»»» Name string true none The account name is the name or names of the account owner(s) represented at an account level. Note, the account name is not the product name or the nickname of the account. OB: ASPSPs may carry out name validation for Confirmation of Payee, but it is not mandatory.
»»» SecondaryIdentification SecondaryIdentification false none This is secondary identification of the account, as assigned by the account servicing institution. This can be used by building societies to additionally identify accounts with a roll number (in addition to a sort code and account number combination).
»» CreditorPostalAddress OBPostalAddress6 false none Information that locates and identifies a specific address, as defined by postal services.
»» RemittanceInformation object false none Information supplied to enable the matching of an entry with the items that the transfer is intended to settle, such as commercial invoices in an accounts' receivable system.
»»» Unstructured string false none Information supplied to enable the matching/reconciliation of an entry with the items that the payment is intended to settle, such as commercial invoices in an accounts' receivable system, in an unstructured form.
»»» Reference string false none Unique reference, as assigned by the creditor, to unambiguously refer to the payment transaction. Usage: If available, the initiating party should provide this reference in the structured remittance information, to enable reconciliation by the creditor upon receipt of the amount of money. If the business context requires the use of a creditor reference or a payment remit identification, and only one identifier can be passed through the end-to-end chain, the creditor's reference or payment remittance identification should be quoted in the end-to-end transaction identification. OB: The Faster Payments Scheme can only accept 18 characters for the ReferenceInformation field - which is where this ISO field will be mapped.
»» SupplementaryData OBSupplementaryData1 false none Additional information that can not be captured in the structured fields and/or any other specific block.
» Authorisation object false none The authorisation type request from the TPP.
»» AuthorisationType string true none Type of authorisation flow requested.
»» CompletionDateTime string(date-time) false none Date and time at which the requested authorisation flow must be completed.All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00
» SCASupportData object false none Supporting Data provided by TPP, when requesting SCA Exemption.
»» RequestedSCAExemptionType string false none This field allows a PISP to request specific SCA Exemption for a Payment Initiation
»» AppliedAuthenticationApproach string false none Specifies a character string with a maximum length of 40 characters. Usage: This field indicates whether the PSU was subject to SCA performed by the TPP
»» ReferencePaymentOrderId string false none Specifies a character string with a maximum length of 140 characters. Usage: If the payment is recurring then the transaction identifier of the previous payment occurrence so that the ASPSP can verify that the PISP, amount and the payee are the same as the previous occurrence.
» Risk OBRisk1 true none The Risk section is sent by the initiating party to the ASPSP. It is used to specify additional details for risk scoring for Payments.

Enumerated Values

Property Value
Permission Create
AuthorisationType Any
AuthorisationType Single
RequestedSCAExemptionType BillPayment
RequestedSCAExemptionType ContactlessTravel
RequestedSCAExemptionType EcommerceGoods
RequestedSCAExemptionType EcommerceServices
RequestedSCAExemptionType Kiosk
RequestedSCAExemptionType Parking
RequestedSCAExemptionType PartyToParty
AppliedAuthenticationApproach CA
AppliedAuthenticationApproach SCA

OBWriteDomesticScheduledConsentResponse3

{
  "Data": {
    "ConsentId": "string",
    "CreationDateTime": "2020-10-23T10:23:58Z",
    "Status": "Authorised",
    "StatusUpdateDateTime": "2020-10-23T10:23:58Z",
    "Permission": "Create",
    "CutOffDateTime": "2020-10-23T10:23:58Z",
    "ExpectedExecutionDateTime": "2020-10-23T10:23:58Z",
    "ExpectedSettlementDateTime": "2020-10-23T10:23:58Z",
    "Charges": [
      {
        "ChargeBearer": "BorneByCreditor",
        "Type": "string",
        "Amount": {
          "Amount": "string",
          "Currency": "string"
        }
      }
    ],
    "Initiation": {
      "InstructionIdentification": "string",
      "EndToEndIdentification": "string",
      "LocalInstrument": "string",
      "RequestedExecutionDateTime": "2020-10-23T10:23:58Z",
      "InstructedAmount": {
        "Amount": "string",
        "Currency": "string"
      },
      "DebtorAccount": {
        "SchemeName": "string",
        "Identification": "string",
        "Name": "string",
        "SecondaryIdentification": "string"
      },
      "CreditorAccount": {
        "SchemeName": "string",
        "Identification": "string",
        "Name": "string",
        "SecondaryIdentification": "string"
      },
      "CreditorPostalAddress": {
        "AddressType": "Business",
        "Department": "string",
        "SubDepartment": "string",
        "StreetName": "string",
        "BuildingNumber": "string",
        "PostCode": "string",
        "TownName": "string",
        "CountrySubDivision": "string",
        "Country": "string",
        "AddressLine": [
          "string"
        ]
      },
      "RemittanceInformation": {
        "Unstructured": "string",
        "Reference": "string"
      },
      "SupplementaryData": {}
    },
    "Authorisation": {
      "AuthorisationType": "Any",
      "CompletionDateTime": "2020-10-23T10:23:58Z"
    },
    "SCASupportData": {
      "RequestedSCAExemptionType": "BillPayment",
      "AppliedAuthenticationApproach": "CA",
      "ReferencePaymentOrderId": "string"
    }
  },
  "Risk": {
    "PaymentContextCode": "BillPayment",
    "MerchantCategoryCode": "stri",
    "MerchantCustomerIdentification": "string",
    "DeliveryAddress": {
      "AddressLine": [
        "string"
      ],
      "StreetName": "string",
      "BuildingNumber": "string",
      "PostCode": "string",
      "TownName": "string",
      "CountrySubDivision": [
        "string"
      ],
      "Country": "string"
    }
  },
  "Links": {
    "Self": "http://example.com",
    "First": "http://example.com",
    "Prev": "http://example.com",
    "Next": "http://example.com",
    "Last": "http://example.com"
  },
  "Meta": {
    "TotalPages": 0,
    "FirstAvailableDateTime": "2020-10-23T10:23:58Z",
    "LastAvailableDateTime": "2020-10-23T10:23:58Z"
  }
}

Properties

Name Type Required Restrictions Description
Data object true none none
» ConsentId string true none OB: Unique identification as assigned by the ASPSP to uniquely identify the consent resource.
» CreationDateTime string(date-time) true none Date and time at which the resource was created.All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00
» Status string true none Specifies the status of consent resource in code form.
» StatusUpdateDateTime string(date-time) true none Date and time at which the consent resource status was updated.All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00
» Permission string true none Specifies the Open Banking service request types.
» CutOffDateTime string(date-time) false none Specified cut-off date and time for the payment consent.All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00
» ExpectedExecutionDateTime string(date-time) false none Expected execution date and time for the payment resource.All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00
» ExpectedSettlementDateTime string(date-time) false none Expected settlement date and time for the payment resource.All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00
» Charges [object] false none none
»» ChargeBearer OBChargeBearerType1Code true none Specifies which party/parties will bear the charges associated with the processing of the payment transaction.
»» Type OBExternalPaymentChargeType1Code true none Charge type, in a coded form.
»» Amount OBActiveOrHistoricCurrencyAndAmount true none Amount of money associated with the charge type.
» Initiation object true none The Initiation payload is sent by the initiating party to the ASPSP. It is used to request movement of funds from the debtor account to a creditor for a single scheduled domestic payment.
»» InstructionIdentification string true none Unique identification as assigned by an instructing party for an instructed party to unambiguously identify the instruction. Usage: the instruction identification is a point to point reference that can be used between the instructing party and the instructed party to refer to the individual instruction. It can be included in several messages related to the instruction.
»» EndToEndIdentification string false none Unique identification assigned by the initiating party to unambiguously identify the transaction. This identification is passed on, unchanged, throughout the entire end-to-end chain. Usage: The end-to-end identification can be used for reconciliation or to link tasks relating to the transaction. It can be included in several messages related to the transaction. OB: The Faster Payments Scheme can only access 31 characters for the EndToEndIdentification field.
»» LocalInstrument OBExternalLocalInstrument1Code false none User community specific instrument. Usage: This element is used to specify a local instrument, local clearing option and/or further qualify the service or service level.
»» RequestedExecutionDateTime string(date-time) true none Date at which the initiating party requests the clearing agent to process the payment. Usage: This is the date on which the debtor's account is to be debited.All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00
»» InstructedAmount object true none Amount of money to be moved between the debtor and creditor, before deduction of charges, expressed in the currency as ordered by the initiating party. Usage: This amount has to be transported unchanged through the transaction chain.
»»» Amount OBActiveCurrencyAndAmount_SimpleType true none A number of monetary units specified in an active currency where the unit of currency is explicit and compliant with ISO 4217.
»»» Currency ActiveOrHistoricCurrencyCode true none A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 "Codes for the representation of currencies and funds".
»» DebtorAccount object false none Unambiguous identification of the account of the debtor to which a debit entry will be made as a result of the transaction.
»»» SchemeName OBExternalAccountIdentification4Code true none Name of the identification scheme, in a coded form as published in an external list.
»»» Identification Identification true none Identification assigned by an institution to identify an account. This identification is known by the account owner.
»»» Name string false none The account name is the name or names of the account owner(s) represented at an account level, as displayed by the ASPSP's online channels. Note, the account name is not the product name or the nickname of the account.
»»» SecondaryIdentification SecondaryIdentification false none This is secondary identification of the account, as assigned by the account servicing institution. This can be used by building societies to additionally identify accounts with a roll number (in addition to a sort code and account number combination).
»» CreditorAccount object true none Unambiguous identification of the account of the creditor to which a credit entry will be posted as a result of the payment transaction.
»»» SchemeName OBExternalAccountIdentification4Code true none Name of the identification scheme, in a coded form as published in an external list.
»»» Identification Identification true none Identification assigned by an institution to identify an account. This identification is known by the account owner.
»»» Name string true none The account name is the name or names of the account owner(s) represented at an account level. Note, the account name is not the product name or the nickname of the account. OB: ASPSPs may carry out name validation for Confirmation of Payee, but it is not mandatory.
»»» SecondaryIdentification SecondaryIdentification false none This is secondary identification of the account, as assigned by the account servicing institution. This can be used by building societies to additionally identify accounts with a roll number (in addition to a sort code and account number combination).
»» CreditorPostalAddress OBPostalAddress6 false none Information that locates and identifies a specific address, as defined by postal services.
»» RemittanceInformation object false none Information supplied to enable the matching of an entry with the items that the transfer is intended to settle, such as commercial invoices in an accounts' receivable system.
»»» Unstructured string false none Information supplied to enable the matching/reconciliation of an entry with the items that the payment is intended to settle, such as commercial invoices in an accounts' receivable system, in an unstructured form.
»»» Reference string false none Unique reference, as assigned by the creditor, to unambiguously refer to the payment transaction. Usage: If available, the initiating party should provide this reference in the structured remittance information, to enable reconciliation by the creditor upon receipt of the amount of money. If the business context requires the use of a creditor reference or a payment remit identification, and only one identifier can be passed through the end-to-end chain, the creditor's reference or payment remittance identification should be quoted in the end-to-end transaction identification. OB: The Faster Payments Scheme can only accept 18 characters for the ReferenceInformation field - which is where this ISO field will be mapped.
»» SupplementaryData OBSupplementaryData1 false none Additional information that can not be captured in the structured fields and/or any other specific block.
» Authorisation object false none The authorisation type request from the TPP.
»» AuthorisationType string true none Type of authorisation flow requested.
»» CompletionDateTime string(date-time) false none Date and time at which the requested authorisation flow must be completed.All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00
» SCASupportData object false none Supporting Data provided by TPP, when requesting SCA Exemption.
»» RequestedSCAExemptionType string false none This field allows a PISP to request specific SCA Exemption for a Payment Initiation
»» AppliedAuthenticationApproach string false none Specifies a character string with a maximum length of 40 characters. Usage: This field indicates whether the PSU was subject to SCA performed by the TPP
»» ReferencePaymentOrderId string false none Specifies a character string with a maximum length of 140 characters. Usage: If the payment is recurring then the transaction identifier of the previous payment occurrence so that the ASPSP can verify that the PISP, amount and the payee are the same as the previous occurrence.
» Risk OBRisk1 true none The Risk section is sent by the initiating party to the ASPSP. It is used to specify additional details for risk scoring for Payments.
» Links Links false none Links relevant to the payload
» Meta Meta false none Meta Data relevant to the payload

Enumerated Values

Property Value
Status Authorised
Status AwaitingAuthorisation
Status Consumed
Status Rejected
Permission Create
AuthorisationType Any
AuthorisationType Single
RequestedSCAExemptionType BillPayment
RequestedSCAExemptionType ContactlessTravel
RequestedSCAExemptionType EcommerceGoods
RequestedSCAExemptionType EcommerceServices
RequestedSCAExemptionType Kiosk
RequestedSCAExemptionType Parking
RequestedSCAExemptionType PartyToParty
AppliedAuthenticationApproach CA
AppliedAuthenticationApproach SCA

OBWriteDomesticScheduledResponse3

{
  "Data": {
    "DomesticScheduledPaymentId": "string",
    "ConsentId": "string",
    "CreationDateTime": "2020-10-23T10:23:58Z",
    "Status": "Cancelled",
    "StatusUpdateDateTime": "2020-10-23T10:23:58Z",
    "ExpectedExecutionDateTime": "2020-10-23T10:23:58Z",
    "ExpectedSettlementDateTime": "2020-10-23T10:23:58Z",
    "Charges": [
      {
        "ChargeBearer": "BorneByCreditor",
        "Type": "string",
        "Amount": {
          "Amount": "string",
          "Currency": "string"
        }
      }
    ],
    "Initiation": {
      "InstructionIdentification": "string",
      "EndToEndIdentification": "string",
      "LocalInstrument": "string",
      "RequestedExecutionDateTime": "2020-10-23T10:23:58Z",
      "InstructedAmount": {
        "Amount": "string",
        "Currency": "string"
      },
      "DebtorAccount": {
        "SchemeName": "string",
        "Identification": "string",
        "Name": "string",
        "SecondaryIdentification": "string"
      },
      "CreditorAccount": {
        "SchemeName": "string",
        "Identification": "string",
        "Name": "string",
        "SecondaryIdentification": "string"
      },
      "CreditorPostalAddress": {
        "AddressType": "Business",
        "Department": "string",
        "SubDepartment": "string",
        "StreetName": "string",
        "BuildingNumber": "string",
        "PostCode": "string",
        "TownName": "string",
        "CountrySubDivision": "string",
        "Country": "string",
        "AddressLine": [
          "string"
        ]
      },
      "RemittanceInformation": {
        "Unstructured": "string",
        "Reference": "string"
      },
      "SupplementaryData": {}
    },
    "MultiAuthorisation": {
      "Status": "Authorised",
      "NumberRequired": 0,
      "NumberReceived": 0,
      "LastUpdateDateTime": "2020-10-23T10:23:58Z",
      "ExpirationDateTime": "2020-10-23T10:23:58Z"
    }
  },
  "Links": {
    "Self": "http://example.com",
    "First": "http://example.com",
    "Prev": "http://example.com",
    "Next": "http://example.com",
    "Last": "http://example.com"
  },
  "Meta": {
    "TotalPages": 0,
    "FirstAvailableDateTime": "2020-10-23T10:23:58Z",
    "LastAvailableDateTime": "2020-10-23T10:23:58Z"
  }
}

Properties

Name Type Required Restrictions Description
Data object true none none
» DomesticScheduledPaymentId string true none OB: Unique identification as assigned by the ASPSP to uniquely identify the domestic schedule payment resource.
» ConsentId string true none OB: Unique identification as assigned by the ASPSP to uniquely identify the consent resource.
» CreationDateTime string(date-time) true none Date and time at which the message was created.All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00
» Status string true none Specifies the status of the payment order resource.
» StatusUpdateDateTime string(date-time) true none Date and time at which the resource status was updated.All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00
» ExpectedExecutionDateTime string(date-time) false none Expected execution date and time for the payment resource.All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00
» ExpectedSettlementDateTime string(date-time) false none Expected settlement date and time for the payment resource.All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00
» Charges [object] false none none
»» ChargeBearer OBChargeBearerType1Code true none Specifies which party/parties will bear the charges associated with the processing of the payment transaction.
»» Type OBExternalPaymentChargeType1Code true none Charge type, in a coded form.
»» Amount OBActiveOrHistoricCurrencyAndAmount true none Amount of money associated with the charge type.
» Initiation object true none The Initiation payload is sent by the initiating party to the ASPSP. It is used to request movement of funds from the debtor account to a creditor for a single scheduled domestic payment.
»» InstructionIdentification string true none Unique identification as assigned by an instructing party for an instructed party to unambiguously identify the instruction. Usage: the instruction identification is a point to point reference that can be used between the instructing party and the instructed party to refer to the individual instruction. It can be included in several messages related to the instruction.
»» EndToEndIdentification string false none Unique identification assigned by the initiating party to unambiguously identify the transaction. This identification is passed on, unchanged, throughout the entire end-to-end chain. Usage: The end-to-end identification can be used for reconciliation or to link tasks relating to the transaction. It can be included in several messages related to the transaction. OB: The Faster Payments Scheme can only access 31 characters for the EndToEndIdentification field.
»» LocalInstrument OBExternalLocalInstrument1Code false none User community specific instrument. Usage: This element is used to specify a local instrument, local clearing option and/or further qualify the service or service level.
»» RequestedExecutionDateTime string(date-time) true none Date at which the initiating party requests the clearing agent to process the payment. Usage: This is the date on which the debtor's account is to be debited.All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00
»» InstructedAmount object true none Amount of money to be moved between the debtor and creditor, before deduction of charges, expressed in the currency as ordered by the initiating party. Usage: This amount has to be transported unchanged through the transaction chain.
»»» Amount OBActiveCurrencyAndAmount_SimpleType true none A number of monetary units specified in an active currency where the unit of currency is explicit and compliant with ISO 4217.
»»» Currency ActiveOrHistoricCurrencyCode true none A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 "Codes for the representation of currencies and funds".
»» DebtorAccount object false none Unambiguous identification of the account of the debtor to which a debit entry will be made as a result of the transaction.
»»» SchemeName OBExternalAccountIdentification4Code true none Name of the identification scheme, in a coded form as published in an external list.
»»» Identification Identification true none Identification assigned by an institution to identify an account. This identification is known by the account owner.
»»» Name string false none The account name is the name or names of the account owner(s) represented at an account level, as displayed by the ASPSP's online channels. Note, the account name is not the product name or the nickname of the account.
»»» SecondaryIdentification SecondaryIdentification false none This is secondary identification of the account, as assigned by the account servicing institution. This can be used by building societies to additionally identify accounts with a roll number (in addition to a sort code and account number combination).
»» CreditorAccount object true none Unambiguous identification of the account of the creditor to which a credit entry will be posted as a result of the payment transaction.
»»» SchemeName OBExternalAccountIdentification4Code true none Name of the identification scheme, in a coded form as published in an external list.
»»» Identification Identification true none Identification assigned by an institution to identify an account. This identification is known by the account owner.
»»» Name string true none The account name is the name or names of the account owner(s) represented at an account level. Note, the account name is not the product name or the nickname of the account. OB: ASPSPs may carry out name validation for Confirmation of Payee, but it is not mandatory.
»»» SecondaryIdentification SecondaryIdentification false none This is secondary identification of the account, as assigned by the account servicing institution. This can be used by building societies to additionally identify accounts with a roll number (in addition to a sort code and account number combination).
»» CreditorPostalAddress OBPostalAddress6 false none Information that locates and identifies a specific address, as defined by postal services.
»» RemittanceInformation object false none Information supplied to enable the matching of an entry with the items that the transfer is intended to settle, such as commercial invoices in an accounts' receivable system.
»»» Unstructured string false none Information supplied to enable the matching/reconciliation of an entry with the items that the payment is intended to settle, such as commercial invoices in an accounts' receivable system, in an unstructured form.
»»» Reference string false none Unique reference, as assigned by the creditor, to unambiguously refer to the payment transaction. Usage: If available, the initiating party should provide this reference in the structured remittance information, to enable reconciliation by the creditor upon receipt of the amount of money. If the business context requires the use of a creditor reference or a payment remit identification, and only one identifier can be passed through the end-to-end chain, the creditor's reference or payment remittance identification should be quoted in the end-to-end transaction identification. OB: The Faster Payments Scheme can only accept 18 characters for the ReferenceInformation field - which is where this ISO field will be mapped.
»» SupplementaryData OBSupplementaryData1 false none Additional information that can not be captured in the structured fields and/or any other specific block.
» MultiAuthorisation object false none The multiple authorisation flow response from the ASPSP.
»» Status string true none Specifies the status of the authorisation flow in code form.
»» NumberRequired integer false none Number of authorisations required for payment order (total required at the start of the multi authorisation journey).
»» NumberReceived integer false none Number of authorisations received.
»» LastUpdateDateTime string(date-time) false none Last date and time at the authorisation flow was updated.All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00
»» ExpirationDateTime string(date-time) false none Date and time at which the requested authorisation flow must be completed.All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00
» Links Links false none Links relevant to the payload
» Meta Meta false none Meta Data relevant to the payload

Enumerated Values

Property Value
Status Cancelled
Status InitiationCompleted
Status InitiationFailed
Status InitiationPending
Status Authorised
Status AwaitingFurtherAuthorisation
Status Rejected

OBWriteDomesticStandingOrder3

{
  "Data": {
    "ConsentId": "string",
    "Initiation": {
      "Frequency": "string",
      "Reference": "string",
      "NumberOfPayments": "string",
      "FirstPaymentDateTime": "2020-10-23T10:23:58Z",
      "RecurringPaymentDateTime": "2020-10-23T10:23:58Z",
      "FinalPaymentDateTime": "2020-10-23T10:23:58Z",
      "FirstPaymentAmount": {
        "Amount": "string",
        "Currency": "string"
      },
      "RecurringPaymentAmount": {
        "Amount": "string",
        "Currency": "string"
      },
      "FinalPaymentAmount": {
        "Amount": "string",
        "Currency": "string"
      },
      "DebtorAccount": {
        "SchemeName": "string",
        "Identification": "string",
        "Name": "string",
        "SecondaryIdentification": "string"
      },
      "CreditorAccount": {
        "SchemeName": "string",
        "Identification": "string",
        "Name": "string",
        "SecondaryIdentification": "string"
      },
      "SupplementaryData": {}
    }
  },
  "Risk": {
    "PaymentContextCode": "BillPayment",
    "MerchantCategoryCode": "stri",
    "MerchantCustomerIdentification": "string",
    "DeliveryAddress": {
      "AddressLine": [
        "string"
      ],
      "StreetName": "string",
      "BuildingNumber": "string",
      "PostCode": "string",
      "TownName": "string",
      "CountrySubDivision": [
        "string"
      ],
      "Country": "string"
    }
  }
}

Properties

Name Type Required Restrictions Description
Data object true none none
» ConsentId string true none OB: Unique identification as assigned by the ASPSP to uniquely identify the consent resource.
» Initiation object true none The Initiation payload is sent by the initiating party to the ASPSP. It is used to request movement of funds from the debtor account to a creditor for a domestic standing order.
»» Frequency string true none Individual Definitions: EvryDay - Every day EvryWorkgDay - Every working day IntrvlWkDay - An interval specified in weeks (01 to 09), and the day within the week (01 to 07) WkInMnthDay - A monthly interval, specifying the week of the month (01 to 05) and day within the week (01 to 07) IntrvlMnthDay - An interval specified in months (between 01 to 06, 12, 24), specifying the day within the month (-5 to -1, 1 to 31) QtrDay - Quarterly (either ENGLISH, SCOTTISH, or RECEIVED). ENGLISH = Paid on the 25th March, 24th June, 29th September and 25th December. SCOTTISH = Paid on the 2nd February, 15th May, 1st August and 11th November. RECEIVED = Paid on the 20th March, 19th June, 24th September and 20th December. Individual Patterns: EvryDay (ScheduleCode) EvryWorkgDay (ScheduleCode) IntrvlWkDay:IntervalInWeeks:DayInWeek (ScheduleCode + IntervalInWeeks + DayInWeek) WkInMnthDay:WeekInMonth:DayInWeek (ScheduleCode + WeekInMonth + DayInWeek) IntrvlMnthDay:IntervalInMonths:DayInMonth (ScheduleCode + IntervalInMonths + DayInMonth) QtrDay: + either (ENGLISH, SCOTTISH or RECEIVED) ScheduleCode + QuarterDay The regular expression for this element combines five smaller versions for each permitted pattern. To aid legibility - the components are presented individually here: EvryDay EvryWorkgDay IntrvlWkDay:0[1-9]:0[1-7] WkInMnthDay:0[1-5]:0[1-7] IntrvlMnthDay:(0[1-6]
»» Reference string false none Unique reference, as assigned by the creditor, to unambiguously refer to the payment transaction. Usage: If available, the initiating party should provide this reference in the structured remittance information, to enable reconciliation by the creditor upon receipt of the amount of money. If the business context requires the use of a creditor reference or a payment remit identification, and only one identifier can be passed through the end-to-end chain, the creditor's reference or payment remittance identification should be quoted in the end-to-end transaction identification.
»» NumberOfPayments string false none Number of the payments that will be made in completing this frequency sequence including any executed since the sequence start date.
»» FirstPaymentDateTime string(date-time) true none The date on which the first payment for a Standing Order schedule will be made.All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00
»» RecurringPaymentDateTime string(date-time) false none The date on which the first recurring payment for a Standing Order schedule will be made. Usage: This must be populated only if the first recurring date is different to the first payment date.All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00
»» FinalPaymentDateTime string(date-time) false none The date on which the final payment for a Standing Order schedule will be made.All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00
»» FirstPaymentAmount object true none The amount of the first Standing Order
»»» Amount OBActiveCurrencyAndAmount_SimpleType true none A number of monetary units specified in an active currency where the unit of currency is explicit and compliant with ISO 4217.
»»» Currency ActiveOrHistoricCurrencyCode true none A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 "Codes for the representation of currencies and funds".
»» RecurringPaymentAmount object false none The amount of the recurring Standing Order
»»» Amount OBActiveCurrencyAndAmount_SimpleType true none A number of monetary units specified in an active currency where the unit of currency is explicit and compliant with ISO 4217.
»»» Currency ActiveOrHistoricCurrencyCode true none A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 "Codes for the representation of currencies and funds".
»» FinalPaymentAmount object false none The amount of the final Standing Order
»»» Amount OBActiveCurrencyAndAmount_SimpleType true none A number of monetary units specified in an active currency where the unit of currency is explicit and compliant with ISO 4217.
»»» Currency ActiveOrHistoricCurrencyCode true none A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 "Codes for the representation of currencies and funds".
»» DebtorAccount object false none Provides the details to identify the debtor account.
»»» SchemeName OBExternalAccountIdentification4Code true none Name of the identification scheme, in a coded form as published in an external list.
»»» Identification Identification true none Identification assigned by an institution to identify an account. This identification is known by the account owner.
»»» Name string false none The account name is the name or names of the account owner(s) represented at an account level, as displayed by the ASPSP's online channels. Note, the account name is not the product name or the nickname of the account.
»»» SecondaryIdentification SecondaryIdentification false none This is secondary identification of the account, as assigned by the account servicing institution. This can be used by building societies to additionally identify accounts with a roll number (in addition to a sort code and account number combination).
»» CreditorAccount object true none Identification assigned by an institution to identify an account. This identification is known by the account owner.
»»» SchemeName OBExternalAccountIdentification4Code true none Name of the identification scheme, in a coded form as published in an external list.
»»» Identification Identification true none Identification assigned by an institution to identify an account. This identification is known by the account owner.
»»» Name string true none The account name is the name or names of the account owner(s) represented at an account level. Note, the account name is not the product name or the nickname of the account. OB: ASPSPs may carry out name validation for Confirmation of Payee, but it is not mandatory.
»»» SecondaryIdentification SecondaryIdentification false none This is secondary identification of the account, as assigned by the account servicing institution. This can be used by building societies to additionally identify accounts with a roll number (in addition to a sort code and account number combination).
»» SupplementaryData OBSupplementaryData1 false none Additional information that can not be captured in the structured fields and/or any other specific block.
» Risk OBRisk1 true none The Risk section is sent by the initiating party to the ASPSP. It is used to specify additional details for risk scoring for Payments.

OBWriteDomesticStandingOrderConsent4

{
  "Data": {
    "Permission": "Create",
    "Initiation": {
      "Frequency": "string",
      "Reference": "string",
      "NumberOfPayments": "string",
      "FirstPaymentDateTime": "2020-10-23T10:23:58Z",
      "RecurringPaymentDateTime": "2020-10-23T10:23:58Z",
      "FinalPaymentDateTime": "2020-10-23T10:23:58Z",
      "FirstPaymentAmount": {
        "Amount": "string",
        "Currency": "string"
      },
      "RecurringPaymentAmount": {
        "Amount": "string",
        "Currency": "string"
      },
      "FinalPaymentAmount": {
        "Amount": "string",
        "Currency": "string"
      },
      "DebtorAccount": {
        "SchemeName": "string",
        "Identification": "string",
        "Name": "string",
        "SecondaryIdentification": "string"
      },
      "CreditorAccount": {
        "SchemeName": "string",
        "Identification": "string",
        "Name": "string",
        "SecondaryIdentification": "string"
      },
      "SupplementaryData": {}
    },
    "Authorisation": {
      "AuthorisationType": "Any",
      "CompletionDateTime": "2020-10-23T10:23:58Z"
    },
    "SCASupportData": {
      "RequestedSCAExemptionType": "BillPayment",
      "AppliedAuthenticationApproach": "CA",
      "ReferencePaymentOrderId": "string"
    }
  },
  "Risk": {
    "PaymentContextCode": "BillPayment",
    "MerchantCategoryCode": "stri",
    "MerchantCustomerIdentification": "string",
    "DeliveryAddress": {
      "AddressLine": [
        "string"
      ],
      "StreetName": "string",
      "BuildingNumber": "string",
      "PostCode": "string",
      "TownName": "string",
      "CountrySubDivision": [
        "string"
      ],
      "Country": "string"
    }
  }
}

Properties

Name Type Required Restrictions Description
Data object true none none
» Permission string true none Specifies the Open Banking service request types.
» Initiation object true none The Initiation payload is sent by the initiating party to the ASPSP. It is used to request movement of funds from the debtor account to a creditor for a domestic standing order.
»» Frequency string true none Individual Definitions: EvryDay - Every day EvryWorkgDay - Every working day IntrvlWkDay - An interval specified in weeks (01 to 09), and the day within the week (01 to 07) WkInMnthDay - A monthly interval, specifying the week of the month (01 to 05) and day within the week (01 to 07) IntrvlMnthDay - An interval specified in months (between 01 to 06, 12, 24), specifying the day within the month (-5 to -1, 1 to 31) QtrDay - Quarterly (either ENGLISH, SCOTTISH, or RECEIVED). ENGLISH = Paid on the 25th March, 24th June, 29th September and 25th December. SCOTTISH = Paid on the 2nd February, 15th May, 1st August and 11th November. RECEIVED = Paid on the 20th March, 19th June, 24th September and 20th December. Individual Patterns: EvryDay (ScheduleCode) EvryWorkgDay (ScheduleCode) IntrvlWkDay:IntervalInWeeks:DayInWeek (ScheduleCode + IntervalInWeeks + DayInWeek) WkInMnthDay:WeekInMonth:DayInWeek (ScheduleCode + WeekInMonth + DayInWeek) IntrvlMnthDay:IntervalInMonths:DayInMonth (ScheduleCode + IntervalInMonths + DayInMonth) QtrDay: + either (ENGLISH, SCOTTISH or RECEIVED) ScheduleCode + QuarterDay The regular expression for this element combines five smaller versions for each permitted pattern. To aid legibility - the components are presented individually here: EvryDay EvryWorkgDay IntrvlWkDay:0[1-9]:0[1-7] WkInMnthDay:0[1-5]:0[1-7] IntrvlMnthDay:(0[1-6]
»» Reference string false none Unique reference, as assigned by the creditor, to unambiguously refer to the payment transaction. Usage: If available, the initiating party should provide this reference in the structured remittance information, to enable reconciliation by the creditor upon receipt of the amount of money. If the business context requires the use of a creditor reference or a payment remit identification, and only one identifier can be passed through the end-to-end chain, the creditor's reference or payment remittance identification should be quoted in the end-to-end transaction identification.
»» NumberOfPayments string false none Number of the payments that will be made in completing this frequency sequence including any executed since the sequence start date.
»» FirstPaymentDateTime string(date-time) true none The date on which the first payment for a Standing Order schedule will be made.All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00
»» RecurringPaymentDateTime string(date-time) false none The date on which the first recurring payment for a Standing Order schedule will be made. Usage: This must be populated only if the first recurring date is different to the first payment date.All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00
»» FinalPaymentDateTime string(date-time) false none The date on which the final payment for a Standing Order schedule will be made.All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00
»» FirstPaymentAmount object true none The amount of the first Standing Order
»»» Amount OBActiveCurrencyAndAmount_SimpleType true none A number of monetary units specified in an active currency where the unit of currency is explicit and compliant with ISO 4217.
»»» Currency ActiveOrHistoricCurrencyCode true none A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 "Codes for the representation of currencies and funds".
»» RecurringPaymentAmount object false none The amount of the recurring Standing Order
»»» Amount OBActiveCurrencyAndAmount_SimpleType true none A number of monetary units specified in an active currency where the unit of currency is explicit and compliant with ISO 4217.
»»» Currency ActiveOrHistoricCurrencyCode true none A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 "Codes for the representation of currencies and funds".
»» FinalPaymentAmount object false none The amount of the final Standing Order
»»» Amount OBActiveCurrencyAndAmount_SimpleType true none A number of monetary units specified in an active currency where the unit of currency is explicit and compliant with ISO 4217.
»»» Currency ActiveOrHistoricCurrencyCode true none A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 "Codes for the representation of currencies and funds".
»» DebtorAccount object false none Provides the details to identify the debtor account.
»»» SchemeName OBExternalAccountIdentification4Code true none Name of the identification scheme, in a coded form as published in an external list.
»»» Identification Identification true none Identification assigned by an institution to identify an account. This identification is known by the account owner.
»»» Name string false none The account name is the name or names of the account owner(s) represented at an account level, as displayed by the ASPSP's online channels. Note, the account name is not the product name or the nickname of the account.
»»» SecondaryIdentification SecondaryIdentification false none This is secondary identification of the account, as assigned by the account servicing institution. This can be used by building societies to additionally identify accounts with a roll number (in addition to a sort code and account number combination).
»» CreditorAccount object true none Identification assigned by an institution to identify an account. This identification is known by the account owner.
»»» SchemeName OBExternalAccountIdentification4Code true none Name of the identification scheme, in a coded form as published in an external list.
»»» Identification Identification true none Identification assigned by an institution to identify an account. This identification is known by the account owner.
»»» Name string true none The account name is the name or names of the account owner(s) represented at an account level. Note, the account name is not the product name or the nickname of the account. OB: ASPSPs may carry out name validation for Confirmation of Payee, but it is not mandatory.
»»» SecondaryIdentification SecondaryIdentification false none This is secondary identification of the account, as assigned by the account servicing institution. This can be used by building societies to additionally identify accounts with a roll number (in addition to a sort code and account number combination).
»» SupplementaryData OBSupplementaryData1 false none Additional information that can not be captured in the structured fields and/or any other specific block.
» Authorisation object false none The authorisation type request from the TPP.
»» AuthorisationType string true none Type of authorisation flow requested.
»» CompletionDateTime string(date-time) false none Date and time at which the requested authorisation flow must be completed.All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00
» SCASupportData object false none Supporting Data provided by TPP, when requesting SCA Exemption.
»» RequestedSCAExemptionType string false none This field allows a PISP to request specific SCA Exemption for a Payment Initiation
»» AppliedAuthenticationApproach string false none Specifies a character string with a maximum length of 40 characters. Usage: This field indicates whether the PSU was subject to SCA performed by the TPP
»» ReferencePaymentOrderId string false none Specifies a character string with a maximum length of 140 characters. Usage: If the payment is recurring then the transaction identifier of the previous payment occurrence so that the ASPSP can verify that the PISP, amount and the payee are the same as the previous occurrence.
» Risk OBRisk1 true none The Risk section is sent by the initiating party to the ASPSP. It is used to specify additional details for risk scoring for Payments.

Enumerated Values

Property Value
Permission Create
AuthorisationType Any
AuthorisationType Single
RequestedSCAExemptionType BillPayment
RequestedSCAExemptionType ContactlessTravel
RequestedSCAExemptionType EcommerceGoods
RequestedSCAExemptionType EcommerceServices
RequestedSCAExemptionType Kiosk
RequestedSCAExemptionType Parking
RequestedSCAExemptionType PartyToParty
AppliedAuthenticationApproach CA
AppliedAuthenticationApproach SCA

OBWriteDomesticStandingOrderConsentResponse4

{
  "Data": {
    "ConsentId": "string",
    "CreationDateTime": "2020-10-23T10:23:58Z",
    "Status": "Authorised",
    "StatusUpdateDateTime": "2020-10-23T10:23:58Z",
    "Permission": "Create",
    "CutOffDateTime": "2020-10-23T10:23:58Z",
    "Charges": [
      {
        "ChargeBearer": "BorneByCreditor",
        "Type": "string",
        "Amount": {
          "Amount": "string",
          "Currency": "string"
        }
      }
    ],
    "Initiation": {
      "Frequency": "string",
      "Reference": "string",
      "NumberOfPayments": "string",
      "FirstPaymentDateTime": "2020-10-23T10:23:58Z",
      "RecurringPaymentDateTime": "2020-10-23T10:23:58Z",
      "FinalPaymentDateTime": "2020-10-23T10:23:58Z",
      "FirstPaymentAmount": {
        "Amount": "string",
        "Currency": "string"
      },
      "RecurringPaymentAmount": {
        "Amount": "string",
        "Currency": "string"
      },
      "FinalPaymentAmount": {
        "Amount": "string",
        "Currency": "string"
      },
      "DebtorAccount": {
        "SchemeName": "string",
        "Identification": "string",
        "Name": "string",
        "SecondaryIdentification": "string"
      },
      "CreditorAccount": {
        "SchemeName": "string",
        "Identification": "string",
        "Name": "string",
        "SecondaryIdentification": "string"
      },
      "SupplementaryData": {}
    },
    "Authorisation": {
      "AuthorisationType": "Any",
      "CompletionDateTime": "2020-10-23T10:23:58Z"
    },
    "SCASupportData": {
      "RequestedSCAExemptionType": "BillPayment",
      "AppliedAuthenticationApproach": "CA",
      "ReferencePaymentOrderId": "string"
    }
  },
  "Risk": {
    "PaymentContextCode": "BillPayment",
    "MerchantCategoryCode": "stri",
    "MerchantCustomerIdentification": "string",
    "DeliveryAddress": {
      "AddressLine": [
        "string"
      ],
      "StreetName": "string",
      "BuildingNumber": "string",
      "PostCode": "string",
      "TownName": "string",
      "CountrySubDivision": [
        "string"
      ],
      "Country": "string"
    }
  },
  "Links": {
    "Self": "http://example.com",
    "First": "http://example.com",
    "Prev": "http://example.com",
    "Next": "http://example.com",
    "Last": "http://example.com"
  },
  "Meta": {
    "TotalPages": 0,
    "FirstAvailableDateTime": "2020-10-23T10:23:58Z",
    "LastAvailableDateTime": "2020-10-23T10:23:58Z"
  }
}

Properties

Name Type Required Restrictions Description
Data object true none none
» ConsentId string true none OB: Unique identification as assigned by the ASPSP to uniquely identify the consent resource.
» CreationDateTime string(date-time) true none Date and time at which the resource was created.All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00
» Status string true none Specifies the status of consent resource in code form.
» StatusUpdateDateTime string(date-time) true none Date and time at which the resource status was updated.All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00
» Permission string true none Specifies the Open Banking service request types.
» CutOffDateTime string(date-time) false none Specified cut-off date and time for the payment consent.All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00
» Charges [object] false none none
»» ChargeBearer OBChargeBearerType1Code true none Specifies which party/parties will bear the charges associated with the processing of the payment transaction.
»» Type OBExternalPaymentChargeType1Code true none Charge type, in a coded form.
»» Amount OBActiveOrHistoricCurrencyAndAmount true none Amount of money associated with the charge type.
» Initiation object true none The Initiation payload is sent by the initiating party to the ASPSP. It is used to request movement of funds from the debtor account to a creditor for a domestic standing order.
»» Frequency string true none Individual Definitions: EvryDay - Every day EvryWorkgDay - Every working day IntrvlWkDay - An interval specified in weeks (01 to 09), and the day within the week (01 to 07) WkInMnthDay - A monthly interval, specifying the week of the month (01 to 05) and day within the week (01 to 07) IntrvlMnthDay - An interval specified in months (between 01 to 06, 12, 24), specifying the day within the month (-5 to -1, 1 to 31) QtrDay - Quarterly (either ENGLISH, SCOTTISH, or RECEIVED). ENGLISH = Paid on the 25th March, 24th June, 29th September and 25th December. SCOTTISH = Paid on the 2nd February, 15th May, 1st August and 11th November. RECEIVED = Paid on the 20th March, 19th June, 24th September and 20th December. Individual Patterns: EvryDay (ScheduleCode) EvryWorkgDay (ScheduleCode) IntrvlWkDay:IntervalInWeeks:DayInWeek (ScheduleCode + IntervalInWeeks + DayInWeek) WkInMnthDay:WeekInMonth:DayInWeek (ScheduleCode + WeekInMonth + DayInWeek) IntrvlMnthDay:IntervalInMonths:DayInMonth (ScheduleCode + IntervalInMonths + DayInMonth) QtrDay: + either (ENGLISH, SCOTTISH or RECEIVED) ScheduleCode + QuarterDay The regular expression for this element combines five smaller versions for each permitted pattern. To aid legibility - the components are presented individually here: EvryDay EvryWorkgDay IntrvlWkDay:0[1-9]:0[1-7] WkInMnthDay:0[1-5]:0[1-7] IntrvlMnthDay:(0[1-6]
»» Reference string false none Unique reference, as assigned by the creditor, to unambiguously refer to the payment transaction. Usage: If available, the initiating party should provide this reference in the structured remittance information, to enable reconciliation by the creditor upon receipt of the amount of money. If the business context requires the use of a creditor reference or a payment remit identification, and only one identifier can be passed through the end-to-end chain, the creditor's reference or payment remittance identification should be quoted in the end-to-end transaction identification.
»» NumberOfPayments string false none Number of the payments that will be made in completing this frequency sequence including any executed since the sequence start date.
»» FirstPaymentDateTime string(date-time) true none The date on which the first payment for a Standing Order schedule will be made.All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00
»» RecurringPaymentDateTime string(date-time) false none The date on which the first recurring payment for a Standing Order schedule will be made. Usage: This must be populated only if the first recurring date is different to the first payment date.All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00
»» FinalPaymentDateTime string(date-time) false none The date on which the final payment for a Standing Order schedule will be made.All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00
»» FirstPaymentAmount object true none The amount of the first Standing Order
»»» Amount OBActiveCurrencyAndAmount_SimpleType true none A number of monetary units specified in an active currency where the unit of currency is explicit and compliant with ISO 4217.
»»» Currency ActiveOrHistoricCurrencyCode true none A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 "Codes for the representation of currencies and funds".
»» RecurringPaymentAmount object false none The amount of the recurring Standing Order
»»» Amount OBActiveCurrencyAndAmount_SimpleType true none A number of monetary units specified in an active currency where the unit of currency is explicit and compliant with ISO 4217.
»»» Currency ActiveOrHistoricCurrencyCode true none A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 "Codes for the representation of currencies and funds".
»» FinalPaymentAmount object false none The amount of the final Standing Order
»»» Amount OBActiveCurrencyAndAmount_SimpleType true none A number of monetary units specified in an active currency where the unit of currency is explicit and compliant with ISO 4217.
»»» Currency ActiveOrHistoricCurrencyCode true none A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 "Codes for the representation of currencies and funds".
»» DebtorAccount object false none Provides the details to identify the debtor account.
»»» SchemeName OBExternalAccountIdentification4Code true none Name of the identification scheme, in a coded form as published in an external list.
»»» Identification Identification true none Identification assigned by an institution to identify an account. This identification is known by the account owner.
»»» Name string false none The account name is the name or names of the account owner(s) represented at an account level, as displayed by the ASPSP's online channels. Note, the account name is not the product name or the nickname of the account.
»»» SecondaryIdentification SecondaryIdentification false none This is secondary identification of the account, as assigned by the account servicing institution. This can be used by building societies to additionally identify accounts with a roll number (in addition to a sort code and account number combination).
»» CreditorAccount object true none Identification assigned by an institution to identify an account. This identification is known by the account owner.
»»» SchemeName OBExternalAccountIdentification4Code true none Name of the identification scheme, in a coded form as published in an external list.
»»» Identification Identification true none Identification assigned by an institution to identify an account. This identification is known by the account owner.
»»» Name string true none The account name is the name or names of the account owner(s) represented at an account level. Note, the account name is not the product name or the nickname of the account. OB: ASPSPs may carry out name validation for Confirmation of Payee, but it is not mandatory.
»»» SecondaryIdentification SecondaryIdentification false none This is secondary identification of the account, as assigned by the account servicing institution. This can be used by building societies to additionally identify accounts with a roll number (in addition to a sort code and account number combination).
»» SupplementaryData OBSupplementaryData1 false none Additional information that can not be captured in the structured fields and/or any other specific block.
» Authorisation object false none The authorisation type request from the TPP.
»» AuthorisationType string true none Type of authorisation flow requested.
»» CompletionDateTime string(date-time) false none Date and time at which the requested authorisation flow must be completed.All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00
» SCASupportData object false none Supporting Data provided by TPP, when requesting SCA Exemption.
»» RequestedSCAExemptionType string false none This field allows a PISP to request specific SCA Exemption for a Payment Initiation
»» AppliedAuthenticationApproach string false none Specifies a character string with a maximum length of 40 characters. Usage: This field indicates whether the PSU was subject to SCA performed by the TPP
»» ReferencePaymentOrderId string false none Specifies a character string with a maximum length of 140 characters. Usage: If the payment is recurring then the transaction identifier of the previous payment occurrence so that the ASPSP can verify that the PISP, amount and the payee are the same as the previous occurrence.
» Risk OBRisk1 true none The Risk section is sent by the initiating party to the ASPSP. It is used to specify additional details for risk scoring for Payments.
» Links Links false none Links relevant to the payload
» Meta Meta false none Meta Data relevant to the payload

Enumerated Values

Property Value
Status Authorised
Status AwaitingAuthorisation
Status Consumed
Status Rejected
Permission Create
AuthorisationType Any
AuthorisationType Single
RequestedSCAExemptionType BillPayment
RequestedSCAExemptionType ContactlessTravel
RequestedSCAExemptionType EcommerceGoods
RequestedSCAExemptionType EcommerceServices
RequestedSCAExemptionType Kiosk
RequestedSCAExemptionType Parking
RequestedSCAExemptionType PartyToParty
AppliedAuthenticationApproach CA
AppliedAuthenticationApproach SCA

OBWriteDomesticStandingOrderResponse4

{
  "Data": {
    "DomesticStandingOrderId": "string",
    "ConsentId": "string",
    "CreationDateTime": "2020-10-23T10:23:58Z",
    "Status": "Cancelled",
    "StatusUpdateDateTime": "2020-10-23T10:23:58Z",
    "Charges": [
      {
        "ChargeBearer": "BorneByCreditor",
        "Type": "string",
        "Amount": {
          "Amount": "string",
          "Currency": "string"
        }
      }
    ],
    "Initiation": {
      "Frequency": "string",
      "Reference": "string",
      "NumberOfPayments": "string",
      "FirstPaymentDateTime": "2020-10-23T10:23:58Z",
      "RecurringPaymentDateTime": "2020-10-23T10:23:58Z",
      "FinalPaymentDateTime": "2020-10-23T10:23:58Z",
      "FirstPaymentAmount": {
        "Amount": "string",
        "Currency": "string"
      },
      "RecurringPaymentAmount": {
        "Amount": "string",
        "Currency": "string"
      },
      "FinalPaymentAmount": {
        "Amount": "string",
        "Currency": "string"
      },
      "DebtorAccount": {
        "SchemeName": "string",
        "Identification": "string",
        "Name": "string",
        "SecondaryIdentification": "string"
      },
      "CreditorAccount": {
        "SchemeName": "string",
        "Identification": "string",
        "Name": "string",
        "SecondaryIdentification": "string"
      },
      "SupplementaryData": {}
    },
    "MultiAuthorisation": {
      "Status": "Authorised",
      "NumberRequired": 0,
      "NumberReceived": 0,
      "LastUpdateDateTime": "2020-10-23T10:23:58Z",
      "ExpirationDateTime": "2020-10-23T10:23:58Z"
    }
  },
  "Links": {
    "Self": "http://example.com",
    "First": "http://example.com",
    "Prev": "http://example.com",
    "Next": "http://example.com",
    "Last": "http://example.com"
  },
  "Meta": {
    "TotalPages": 0,
    "FirstAvailableDateTime": "2020-10-23T10:23:58Z",
    "LastAvailableDateTime": "2020-10-23T10:23:58Z"
  }
}

Properties

Name Type Required Restrictions Description
Data object true none none
» DomesticStandingOrderId string true none OB: Unique identification as assigned by the ASPSP to uniquely identify the domestic standing order resource.
» ConsentId string true none OB: Unique identification as assigned by the ASPSP to uniquely identify the consent resource.
» CreationDateTime string(date-time) true none Date and time at which the resource was created.All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00
» Status string true none Specifies the status of the payment order resource.
» StatusUpdateDateTime string(date-time) true none Date and time at which the resource status was updated.All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00
» Charges [object] false none none
»» ChargeBearer OBChargeBearerType1Code true none Specifies which party/parties will bear the charges associated with the processing of the payment transaction.
»» Type OBExternalPaymentChargeType1Code true none Charge type, in a coded form.
»» Amount OBActiveOrHistoricCurrencyAndAmount true none Amount of money associated with the charge type.
» Initiation object true none The Initiation payload is sent by the initiating party to the ASPSP. It is used to request movement of funds from the debtor account to a creditor for a domestic standing order.
»» Frequency string true none Individual Definitions: EvryDay - Every day EvryWorkgDay - Every working day IntrvlWkDay - An interval specified in weeks (01 to 09), and the day within the week (01 to 07) WkInMnthDay - A monthly interval, specifying the week of the month (01 to 05) and day within the week (01 to 07) IntrvlMnthDay - An interval specified in months (between 01 to 06, 12, 24), specifying the day within the month (-5 to -1, 1 to 31) QtrDay - Quarterly (either ENGLISH, SCOTTISH, or RECEIVED). ENGLISH = Paid on the 25th March, 24th June, 29th September and 25th December. SCOTTISH = Paid on the 2nd February, 15th May, 1st August and 11th November. RECEIVED = Paid on the 20th March, 19th June, 24th September and 20th December. Individual Patterns: EvryDay (ScheduleCode) EvryWorkgDay (ScheduleCode) IntrvlWkDay:IntervalInWeeks:DayInWeek (ScheduleCode + IntervalInWeeks + DayInWeek) WkInMnthDay:WeekInMonth:DayInWeek (ScheduleCode + WeekInMonth + DayInWeek) IntrvlMnthDay:IntervalInMonths:DayInMonth (ScheduleCode + IntervalInMonths + DayInMonth) QtrDay: + either (ENGLISH, SCOTTISH or RECEIVED) ScheduleCode + QuarterDay The regular expression for this element combines five smaller versions for each permitted pattern. To aid legibility - the components are presented individually here: EvryDay EvryWorkgDay IntrvlWkDay:0[1-9]:0[1-7] WkInMnthDay:0[1-5]:0[1-7] IntrvlMnthDay:(0[1-6]
»» Reference string false none Unique reference, as assigned by the creditor, to unambiguously refer to the payment transaction. Usage: If available, the initiating party should provide this reference in the structured remittance information, to enable reconciliation by the creditor upon receipt of the amount of money. If the business context requires the use of a creditor reference or a payment remit identification, and only one identifier can be passed through the end-to-end chain, the creditor's reference or payment remittance identification should be quoted in the end-to-end transaction identification.
»» NumberOfPayments string false none Number of the payments that will be made in completing this frequency sequence including any executed since the sequence start date.
»» FirstPaymentDateTime string(date-time) true none The date on which the first payment for a Standing Order schedule will be made.All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00
»» RecurringPaymentDateTime string(date-time) false none The date on which the first recurring payment for a Standing Order schedule will be made. Usage: This must be populated only if the first recurring date is different to the first payment date.All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00
»» FinalPaymentDateTime string(date-time) false none The date on which the final payment for a Standing Order schedule will be made.All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00
»» FirstPaymentAmount object true none The amount of the first Standing Order
»»» Amount OBActiveCurrencyAndAmount_SimpleType true none A number of monetary units specified in an active currency where the unit of currency is explicit and compliant with ISO 4217.
»»» Currency ActiveOrHistoricCurrencyCode true none A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 "Codes for the representation of currencies and funds".
»» RecurringPaymentAmount object false none The amount of the recurring Standing Order
»»» Amount OBActiveCurrencyAndAmount_SimpleType true none A number of monetary units specified in an active currency where the unit of currency is explicit and compliant with ISO 4217.
»»» Currency ActiveOrHistoricCurrencyCode true none A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 "Codes for the representation of currencies and funds".
»» FinalPaymentAmount object false none The amount of the final Standing Order
»»» Amount OBActiveCurrencyAndAmount_SimpleType true none A number of monetary units specified in an active currency where the unit of currency is explicit and compliant with ISO 4217.
»»» Currency ActiveOrHistoricCurrencyCode true none A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 "Codes for the representation of currencies and funds".
»» DebtorAccount object false none Provides the details to identify the debtor account.
»»» SchemeName OBExternalAccountIdentification4Code true none Name of the identification scheme, in a coded form as published in an external list.
»»» Identification Identification true none Identification assigned by an institution to identify an account. This identification is known by the account owner.
»»» Name string false none The account name is the name or names of the account owner(s) represented at an account level, as displayed by the ASPSP's online channels. Note, the account name is not the product name or the nickname of the account.
»»» SecondaryIdentification SecondaryIdentification false none This is secondary identification of the account, as assigned by the account servicing institution. This can be used by building societies to additionally identify accounts with a roll number (in addition to a sort code and account number combination).
»» CreditorAccount object true none Identification assigned by an institution to identify an account. This identification is known by the account owner.
»»» SchemeName OBExternalAccountIdentification4Code true none Name of the identification scheme, in a coded form as published in an external list.
»»» Identification Identification true none Identification assigned by an institution to identify an account. This identification is known by the account owner.
»»» Name string true none The account name is the name or names of the account owner(s) represented at an account level. Note, the account name is not the product name or the nickname of the account. OB: ASPSPs may carry out name validation for Confirmation of Payee, but it is not mandatory.
»»» SecondaryIdentification SecondaryIdentification false none This is secondary identification of the account, as assigned by the account servicing institution. This can be used by building societies to additionally identify accounts with a roll number (in addition to a sort code and account number combination).
»» SupplementaryData OBSupplementaryData1 false none Additional information that can not be captured in the structured fields and/or any other specific block.
» MultiAuthorisation object false none The multiple authorisation flow response from the ASPSP.
»» Status string true none Specifies the status of the authorisation flow in code form.
»» NumberRequired integer false none Number of authorisations required for payment order (total required at the start of the multi authorisation journey).
»» NumberReceived integer false none Number of authorisations received.
»» LastUpdateDateTime string(date-time) false none Last date and time at the authorisation flow was updated.All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00
»» ExpirationDateTime string(date-time) false none Date and time at which the requested authorisation flow must be completed.All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00
» Links Links false none Links relevant to the payload
» Meta Meta false none Meta Data relevant to the payload

Enumerated Values

Property Value
Status Cancelled
Status InitiationCompleted
Status InitiationFailed
Status InitiationPending
Status Authorised
Status AwaitingFurtherAuthorisation
Status Rejected

OBWriteFile2

{
  "Data": {
    "ConsentId": "string",
    "Initiation": {
      "FileType": "string",
      "FileHash": "string",
      "FileReference": "string",
      "NumberOfTransactions": "string",
      "ControlSum": 0,
      "RequestedExecutionDateTime": "2020-10-23T10:23:58Z",
      "LocalInstrument": "string",
      "DebtorAccount": {
        "SchemeName": "string",
        "Identification": "string",
        "Name": "string",
        "SecondaryIdentification": "string"
      },
      "RemittanceInformation": {
        "Unstructured": "string",
        "Reference": "string"
      },
      "SupplementaryData": {}
    }
  }
}

Properties

Name Type Required Restrictions Description
Data object true none none
» ConsentId string true none OB: Unique identification as assigned by the ASPSP to uniquely identify the consent resource.
» Initiation object true none The Initiation payload is sent by the initiating party to the ASPSP. It is used to request movement of funds using a payment file.
»» FileType string true none Specifies the payment file type.
»» FileHash string true none A base64 encoding of a SHA256 hash of the file to be uploaded.
»» FileReference string false none Reference for the file.
»» NumberOfTransactions string false none Number of individual transactions contained in the payment information group.
»» ControlSum number false none Total of all individual amounts included in the group, irrespective of currencies.
»» RequestedExecutionDateTime string(date-time) false none Date at which the initiating party requests the clearing agent to process the payment. Usage: This is the date on which the debtor's account is to be debited.All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00
»» LocalInstrument OBExternalLocalInstrument1Code false none User community specific instrument. Usage: This element is used to specify a local instrument, local clearing option and/or further qualify the service or service level.
»» DebtorAccount object false none Unambiguous identification of the account of the debtor to which a debit entry will be made as a result of the transaction.
»»» SchemeName OBExternalAccountIdentification4Code true none Name of the identification scheme, in a coded form as published in an external list.
»»» Identification Identification true none Identification assigned by an institution to identify an account. This identification is known by the account owner.
»»» Name string false none The account name is the name or names of the account owner(s) represented at an account level, as displayed by the ASPSP's online channels. Note, the account name is not the product name or the nickname of the account.
»»» SecondaryIdentification SecondaryIdentification false none This is secondary identification of the account, as assigned by the account servicing institution. This can be used by building societies to additionally identify accounts with a roll number (in addition to a sort code and account number combination).
»» RemittanceInformation object false none Information supplied to enable the matching of an entry with the items that the transfer is intended to settle, such as commercial invoices in an accounts' receivable system.
»»» Unstructured string false none Information supplied to enable the matching/reconciliation of an entry with the items that the payment is intended to settle, such as commercial invoices in an accounts' receivable system, in an unstructured form.
»»» Reference string false none Unique reference, as assigned by the creditor, to unambiguously refer to the payment transaction. Usage: If available, the initiating party should provide this reference in the structured remittance information, to enable reconciliation by the creditor upon receipt of the amount of money. If the business context requires the use of a creditor reference or a payment remit identification, and only one identifier can be passed through the end-to-end chain, the creditor's reference or payment remittance identification should be quoted in the end-to-end transaction identification. OB: The Faster Payments Scheme can only accept 18 characters for the ReferenceInformation field - which is where this ISO field will be mapped.
»» SupplementaryData OBSupplementaryData1 false none Additional information that can not be captured in the structured fields and/or any other specific block.

OBWriteFileConsent3

{
  "Data": {
    "Initiation": {
      "FileType": "string",
      "FileHash": "string",
      "FileReference": "string",
      "NumberOfTransactions": "string",
      "ControlSum": 0,
      "RequestedExecutionDateTime": "2020-10-23T10:23:58Z",
      "LocalInstrument": "string",
      "DebtorAccount": {
        "SchemeName": "string",
        "Identification": "string",
        "Name": "string",
        "SecondaryIdentification": "string"
      },
      "RemittanceInformation": {
        "Unstructured": "string",
        "Reference": "string"
      },
      "SupplementaryData": {}
    },
    "Authorisation": {
      "AuthorisationType": "Any",
      "CompletionDateTime": "2020-10-23T10:23:58Z"
    },
    "SCASupportData": {
      "RequestedSCAExemptionType": "BillPayment",
      "AppliedAuthenticationApproach": "CA",
      "ReferencePaymentOrderId": "string"
    }
  }
}

Properties

Name Type Required Restrictions Description
Data object true none none
» Initiation object true none The Initiation payload is sent by the initiating party to the ASPSP. It is used to request movement of funds using a payment file.
»» FileType string true none Specifies the payment file type.
»» FileHash string true none A base64 encoding of a SHA256 hash of the file to be uploaded.
»» FileReference string false none Reference for the file.
»» NumberOfTransactions string false none Number of individual transactions contained in the payment information group.
»» ControlSum number false none Total of all individual amounts included in the group, irrespective of currencies.
»» RequestedExecutionDateTime string(date-time) false none Date at which the initiating party requests the clearing agent to process the payment. Usage: This is the date on which the debtor's account is to be debited.All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00
»» LocalInstrument OBExternalLocalInstrument1Code false none User community specific instrument. Usage: This element is used to specify a local instrument, local clearing option and/or further qualify the service or service level.
»» DebtorAccount object false none Unambiguous identification of the account of the debtor to which a debit entry will be made as a result of the transaction.
»»» SchemeName OBExternalAccountIdentification4Code true none Name of the identification scheme, in a coded form as published in an external list.
»»» Identification Identification true none Identification assigned by an institution to identify an account. This identification is known by the account owner.
»»» Name string false none The account name is the name or names of the account owner(s) represented at an account level, as displayed by the ASPSP's online channels. Note, the account name is not the product name or the nickname of the account.
»»» SecondaryIdentification SecondaryIdentification false none This is secondary identification of the account, as assigned by the account servicing institution. This can be used by building societies to additionally identify accounts with a roll number (in addition to a sort code and account number combination).
»» RemittanceInformation object false none Information supplied to enable the matching of an entry with the items that the transfer is intended to settle, such as commercial invoices in an accounts' receivable system.
»»» Unstructured string false none Information supplied to enable the matching/reconciliation of an entry with the items that the payment is intended to settle, such as commercial invoices in an accounts' receivable system, in an unstructured form.
»»» Reference string false none Unique reference, as assigned by the creditor, to unambiguously refer to the payment transaction. Usage: If available, the initiating party should provide this reference in the structured remittance information, to enable reconciliation by the creditor upon receipt of the amount of money. If the business context requires the use of a creditor reference or a payment remit identification, and only one identifier can be passed through the end-to-end chain, the creditor's reference or payment remittance identification should be quoted in the end-to-end transaction identification. OB: The Faster Payments Scheme can only accept 18 characters for the ReferenceInformation field - which is where this ISO field will be mapped.
»» SupplementaryData OBSupplementaryData1 false none Additional information that can not be captured in the structured fields and/or any other specific block.
» Authorisation object false none The authorisation type request from the TPP.
»» AuthorisationType string true none Type of authorisation flow requested.
»» CompletionDateTime string(date-time) false none Date and time at which the requested authorisation flow must be completed.All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00
» SCASupportData object false none Supporting Data provided by TPP, when requesting SCA Exemption.
»» RequestedSCAExemptionType string false none This field allows a PISP to request specific SCA Exemption for a Payment Initiation
»» AppliedAuthenticationApproach string false none Specifies a character string with a maximum length of 40 characters. Usage: This field indicates whether the PSU was subject to SCA performed by the TPP
»» ReferencePaymentOrderId string false none Specifies a character string with a maximum length of 140 characters. Usage: If the payment is recurring then the transaction identifier of the previous payment occurrence so that the ASPSP can verify that the PISP, amount and the payee are the same as the previous occurrence.

Enumerated Values

Property Value
AuthorisationType Any
AuthorisationType Single
RequestedSCAExemptionType BillPayment
RequestedSCAExemptionType ContactlessTravel
RequestedSCAExemptionType EcommerceGoods
RequestedSCAExemptionType EcommerceServices
RequestedSCAExemptionType Kiosk
RequestedSCAExemptionType Parking
RequestedSCAExemptionType PartyToParty
AppliedAuthenticationApproach CA
AppliedAuthenticationApproach SCA

OBWriteFileConsentResponse3

{
  "Data": {
    "ConsentId": "string",
    "CreationDateTime": "2020-10-23T10:23:58Z",
    "Status": "Authorised",
    "StatusUpdateDateTime": "2020-10-23T10:23:58Z",
    "CutOffDateTime": "2020-10-23T10:23:58Z",
    "Charges": [
      {
        "ChargeBearer": "BorneByCreditor",
        "Type": "string",
        "Amount": {
          "Amount": "string",
          "Currency": "string"
        }
      }
    ],
    "Initiation": {
      "FileType": "string",
      "FileHash": "string",
      "FileReference": "string",
      "NumberOfTransactions": "string",
      "ControlSum": 0,
      "RequestedExecutionDateTime": "2020-10-23T10:23:58Z",
      "LocalInstrument": "string",
      "DebtorAccount": {
        "SchemeName": "string",
        "Identification": "string",
        "Name": "string",
        "SecondaryIdentification": "string"
      },
      "RemittanceInformation": {
        "Unstructured": "string",
        "Reference": "string"
      },
      "SupplementaryData": {}
    },
    "Authorisation": {
      "AuthorisationType": "Any",
      "CompletionDateTime": "2020-10-23T10:23:58Z"
    },
    "SCASupportData": {
      "RequestedSCAExemptionType": "BillPayment",
      "AppliedAuthenticationApproach": "CA",
      "ReferencePaymentOrderId": "string"
    }
  },
  "Links": {
    "Self": "http://example.com",
    "First": "http://example.com",
    "Prev": "http://example.com",
    "Next": "http://example.com",
    "Last": "http://example.com"
  },
  "Meta": {
    "TotalPages": 0,
    "FirstAvailableDateTime": "2020-10-23T10:23:58Z",
    "LastAvailableDateTime": "2020-10-23T10:23:58Z"
  }
}

Properties

Name Type Required Restrictions Description
Data object true none none
» ConsentId string true none OB: Unique identification as assigned by the ASPSP to uniquely identify the consent resource.
» CreationDateTime string(date-time) true none Date and time at which the resource was created.All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00
» Status string true none Specifies the status of consent resource in code form.
» StatusUpdateDateTime string(date-time) true none Date and time at which the consent resource status was updated.All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00
» CutOffDateTime string(date-time) false none Specified cut-off date and time for the payment consent.All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00
» Charges [object] false none none
»» ChargeBearer OBChargeBearerType1Code true none Specifies which party/parties will bear the charges associated with the processing of the payment transaction.
»» Type OBExternalPaymentChargeType1Code true none Charge type, in a coded form.
»» Amount OBActiveOrHistoricCurrencyAndAmount true none Amount of money associated with the charge type.
» Initiation object true none The Initiation payload is sent by the initiating party to the ASPSP. It is used to request movement of funds using a payment file.
»» FileType string true none Specifies the payment file type.
»» FileHash string true none A base64 encoding of a SHA256 hash of the file to be uploaded.
»» FileReference string false none Reference for the file.
»» NumberOfTransactions string false none Number of individual transactions contained in the payment information group.
»» ControlSum number false none Total of all individual amounts included in the group, irrespective of currencies.
»» RequestedExecutionDateTime string(date-time) false none Date at which the initiating party requests the clearing agent to process the payment. Usage: This is the date on which the debtor's account is to be debited.All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00
»» LocalInstrument OBExternalLocalInstrument1Code false none User community specific instrument. Usage: This element is used to specify a local instrument, local clearing option and/or further qualify the service or service level.
»» DebtorAccount object false none Unambiguous identification of the account of the debtor to which a debit entry will be made as a result of the transaction.
»»» SchemeName OBExternalAccountIdentification4Code true none Name of the identification scheme, in a coded form as published in an external list.
»»» Identification Identification true none Identification assigned by an institution to identify an account. This identification is known by the account owner.
»»» Name string false none The account name is the name or names of the account owner(s) represented at an account level, as displayed by the ASPSP's online channels. Note, the account name is not the product name or the nickname of the account.
»»» SecondaryIdentification SecondaryIdentification false none This is secondary identification of the account, as assigned by the account servicing institution. This can be used by building societies to additionally identify accounts with a roll number (in addition to a sort code and account number combination).
»» RemittanceInformation object false none Information supplied to enable the matching of an entry with the items that the transfer is intended to settle, such as commercial invoices in an accounts' receivable system.
»»» Unstructured string false none Information supplied to enable the matching/reconciliation of an entry with the items that the payment is intended to settle, such as commercial invoices in an accounts' receivable system, in an unstructured form.
»»» Reference string false none Unique reference, as assigned by the creditor, to unambiguously refer to the payment transaction. Usage: If available, the initiating party should provide this reference in the structured remittance information, to enable reconciliation by the creditor upon receipt of the amount of money. If the business context requires the use of a creditor reference or a payment remit identification, and only one identifier can be passed through the end-to-end chain, the creditor's reference or payment remittance identification should be quoted in the end-to-end transaction identification. OB: The Faster Payments Scheme can only accept 18 characters for the ReferenceInformation field - which is where this ISO field will be mapped.
»» SupplementaryData OBSupplementaryData1 false none Additional information that can not be captured in the structured fields and/or any other specific block.
» Authorisation object false none The authorisation type request from the TPP.
»» AuthorisationType string true none Type of authorisation flow requested.
»» CompletionDateTime string(date-time) false none Date and time at which the requested authorisation flow must be completed.All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00
» SCASupportData object false none Supporting Data provided by TPP, when requesting SCA Exemption.
»» RequestedSCAExemptionType string false none This field allows a PISP to request specific SCA Exemption for a Payment Initiation
»» AppliedAuthenticationApproach string false none Specifies a character string with a maximum length of 40 characters. Usage: This field indicates whether the PSU was subject to SCA performed by the TPP
»» ReferencePaymentOrderId string false none Specifies a character string with a maximum length of 140 characters. Usage: If the payment is recurring then the transaction identifier of the previous payment occurrence so that the ASPSP can verify that the PISP, amount and the payee are the same as the previous occurrence.
» Links Links false none Links relevant to the payload
» Meta Meta false none Meta Data relevant to the payload

Enumerated Values

Property Value
Status Authorised
Status AwaitingAuthorisation
Status AwaitingUpload
Status Consumed
Status Rejected
AuthorisationType Any
AuthorisationType Single
RequestedSCAExemptionType BillPayment
RequestedSCAExemptionType ContactlessTravel
RequestedSCAExemptionType EcommerceGoods
RequestedSCAExemptionType EcommerceServices
RequestedSCAExemptionType Kiosk
RequestedSCAExemptionType Parking
RequestedSCAExemptionType PartyToParty
AppliedAuthenticationApproach CA
AppliedAuthenticationApproach SCA

OBWriteFileResponse2

{
  "Data": {
    "FilePaymentId": "string",
    "ConsentId": "string",
    "CreationDateTime": "2020-10-23T10:23:58Z",
    "Status": "InitiationCompleted",
    "StatusUpdateDateTime": "2020-10-23T10:23:58Z",
    "Charges": [
      {
        "ChargeBearer": "BorneByCreditor",
        "Type": "string",
        "Amount": {
          "Amount": "string",
          "Currency": "string"
        }
      }
    ],
    "Initiation": {
      "FileType": "string",
      "FileHash": "string",
      "FileReference": "string",
      "NumberOfTransactions": "string",
      "ControlSum": 0,
      "RequestedExecutionDateTime": "2020-10-23T10:23:58Z",
      "LocalInstrument": "string",
      "DebtorAccount": {
        "SchemeName": "string",
        "Identification": "string",
        "Name": "string",
        "SecondaryIdentification": "string"
      },
      "RemittanceInformation": {
        "Unstructured": "string",
        "Reference": "string"
      },
      "SupplementaryData": {}
    },
    "MultiAuthorisation": {
      "Status": "Authorised",
      "NumberRequired": 0,
      "NumberReceived": 0,
      "LastUpdateDateTime": "2020-10-23T10:23:58Z",
      "ExpirationDateTime": "2020-10-23T10:23:58Z"
    }
  },
  "Links": {
    "Self": "http://example.com",
    "First": "http://example.com",
    "Prev": "http://example.com",
    "Next": "http://example.com",
    "Last": "http://example.com"
  },
  "Meta": {
    "TotalPages": 0,
    "FirstAvailableDateTime": "2020-10-23T10:23:58Z",
    "LastAvailableDateTime": "2020-10-23T10:23:58Z"
  }
}

Properties

Name Type Required Restrictions Description
Data object true none none
» FilePaymentId string true none OB: Unique identification as assigned by the ASPSP to uniquely identify the file payment resource.
» ConsentId string true none OB: Unique identification as assigned by the ASPSP to uniquely identify the consent resource.
» CreationDateTime string(date-time) true none Date and time at which the message was created.All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00
» Status string true none Specifies the status of the payment order resource.
» StatusUpdateDateTime string(date-time) true none Date and time at which the resource status was updated.All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00
» Charges [object] false none none
»» ChargeBearer OBChargeBearerType1Code true none Specifies which party/parties will bear the charges associated with the processing of the payment transaction.
»» Type OBExternalPaymentChargeType1Code true none Charge type, in a coded form.
»» Amount OBActiveOrHistoricCurrencyAndAmount true none Amount of money associated with the charge type.
» Initiation object true none The Initiation payload is sent by the initiating party to the ASPSP. It is used to request movement of funds using a payment file.
»» FileType string true none Specifies the payment file type.
»» FileHash string true none A base64 encoding of a SHA256 hash of the file to be uploaded.
»» FileReference string false none Reference for the file.
»» NumberOfTransactions string false none Number of individual transactions contained in the payment information group.
»» ControlSum number false none Total of all individual amounts included in the group, irrespective of currencies.
»» RequestedExecutionDateTime string(date-time) false none Date at which the initiating party requests the clearing agent to process the payment. Usage: This is the date on which the debtor's account is to be debited.All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00
»» LocalInstrument OBExternalLocalInstrument1Code false none User community specific instrument. Usage: This element is used to specify a local instrument, local clearing option and/or further qualify the service or service level.
»» DebtorAccount object false none Unambiguous identification of the account of the debtor to which a debit entry will be made as a result of the transaction.
»»» SchemeName OBExternalAccountIdentification4Code true none Name of the identification scheme, in a coded form as published in an external list.
»»» Identification Identification true none Identification assigned by an institution to identify an account. This identification is known by the account owner.
»»» Name string false none The account name is the name or names of the account owner(s) represented at an account level, as displayed by the ASPSP's online channels. Note, the account name is not the product name or the nickname of the account.
»»» SecondaryIdentification SecondaryIdentification false none This is secondary identification of the account, as assigned by the account servicing institution. This can be used by building societies to additionally identify accounts with a roll number (in addition to a sort code and account number combination).
»» RemittanceInformation object false none Information supplied to enable the matching of an entry with the items that the transfer is intended to settle, such as commercial invoices in an accounts' receivable system.
»»» Unstructured string false none Information supplied to enable the matching/reconciliation of an entry with the items that the payment is intended to settle, such as commercial invoices in an accounts' receivable system, in an unstructured form.
»»» Reference string false none Unique reference, as assigned by the creditor, to unambiguously refer to the payment transaction. Usage: If available, the initiating party should provide this reference in the structured remittance information, to enable reconciliation by the creditor upon receipt of the amount of money. If the business context requires the use of a creditor reference or a payment remit identification, and only one identifier can be passed through the end-to-end chain, the creditor's reference or payment remittance identification should be quoted in the end-to-end transaction identification. OB: The Faster Payments Scheme can only accept 18 characters for the ReferenceInformation field - which is where this ISO field will be mapped.
»» SupplementaryData OBSupplementaryData1 false none Additional information that can not be captured in the structured fields and/or any other specific block.
» MultiAuthorisation object false none The multiple authorisation flow response from the ASPSP.
»» Status string true none Specifies the status of the authorisation flow in code form.
»» NumberRequired integer false none Number of authorisations required for payment order (total required at the start of the multi authorisation journey).
»» NumberReceived integer false none Number of authorisations received.
»» LastUpdateDateTime string(date-time) false none Last date and time at the authorisation flow was updated.All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00
»» ExpirationDateTime string(date-time) false none Date and time at which the requested authorisation flow must be completed.All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00
» Links Links false none Links relevant to the payload
» Meta Meta false none Meta Data relevant to the payload

Enumerated Values

Property Value
Status InitiationCompleted
Status InitiationFailed
Status InitiationPending
Status Authorised
Status AwaitingFurtherAuthorisation
Status Rejected

OBWriteFundsConfirmationResponse1

{
  "Data": {
    "FundsAvailableResult": {
      "FundsAvailableDateTime": "2020-10-23T10:23:58Z",
      "FundsAvailable": true
    },
    "SupplementaryData": {}
  },
  "Links": {
    "Self": "http://example.com",
    "First": "http://example.com",
    "Prev": "http://example.com",
    "Next": "http://example.com",
    "Last": "http://example.com"
  },
  "Meta": {
    "TotalPages": 0,
    "FirstAvailableDateTime": "2020-10-23T10:23:58Z",
    "LastAvailableDateTime": "2020-10-23T10:23:58Z"
  }
}

Properties

Name Type Required Restrictions Description
Data object true none none
» FundsAvailableResult object false none Result of a funds availability check.
»» FundsAvailableDateTime string(date-time) true none Date and time at which the funds availability check was generated.All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00
»» FundsAvailable boolean true none Flag to indicate the availability of funds given the Amount in the consent request.
» SupplementaryData OBSupplementaryData1 false none Additional information that can not be captured in the structured fields and/or any other specific block.
Links Links false none Links relevant to the payload
Meta Meta false none Meta Data relevant to the payload

OBWriteInternational2

{
  "Data": {
    "ConsentId": "string",
    "Initiation": {
      "InstructionIdentification": "string",
      "EndToEndIdentification": "string",
      "LocalInstrument": "string",
      "InstructionPriority": "Normal",
      "Purpose": "string",
      "ChargeBearer": "BorneByCreditor",
      "CurrencyOfTransfer": "string",
      "InstructedAmount": {
        "Amount": "string",
        "Currency": "string"
      },
      "ExchangeRateInformation": {
        "UnitCurrency": "string",
        "ExchangeRate": 0,
        "RateType": "Actual",
        "ContractIdentification": "string"
      },
      "DebtorAccount": {
        "SchemeName": "string",
        "Identification": "string",
        "Name": "string",
        "SecondaryIdentification": "string"
      },
      "Creditor": {
        "Name": "string",
        "PostalAddress": {
          "AddressType": "Business",
          "Department": "string",
          "SubDepartment": "string",
          "StreetName": "string",
          "BuildingNumber": "string",
          "PostCode": "string",
          "TownName": "string",
          "CountrySubDivision": "string",
          "Country": "string",
          "AddressLine": [
            "string"
          ]
        }
      },
      "CreditorAgent": {
        "SchemeName": "string",
        "Identification": "string",
        "Name": "string",
        "PostalAddress": {
          "AddressType": "Business",
          "Department": "string",
          "SubDepartment": "string",
          "StreetName": "string",
          "BuildingNumber": "string",
          "PostCode": "string",
          "TownName": "string",
          "CountrySubDivision": "string",
          "Country": "string",
          "AddressLine": [
            "string"
          ]
        }
      },
      "CreditorAccount": {
        "SchemeName": "string",
        "Identification": "string",
        "Name": "string",
        "SecondaryIdentification": "string"
      },
      "RemittanceInformation": {
        "Unstructured": "string",
        "Reference": "string"
      },
      "SupplementaryData": {}
    }
  },
  "Risk": {
    "PaymentContextCode": "BillPayment",
    "MerchantCategoryCode": "stri",
    "MerchantCustomerIdentification": "string",
    "DeliveryAddress": {
      "AddressLine": [
        "string"
      ],
      "StreetName": "string",
      "BuildingNumber": "string",
      "PostCode": "string",
      "TownName": "string",
      "CountrySubDivision": [
        "string"
      ],
      "Country": "string"
    }
  }
}

Properties

Name Type Required Restrictions Description
Data object true none none
» ConsentId string true none OB: Unique identification as assigned by the ASPSP to uniquely identify the consent resource.
» Initiation object true none The Initiation payload is sent by the initiating party to the ASPSP. It is used to request movement of funds from the debtor account to a creditor for a single international payment.
»» InstructionIdentification string true none Unique identification as assigned by an instructing party for an instructed party to unambiguously identify the instruction. Usage: the instruction identification is a point to point reference that can be used between the instructing party and the instructed party to refer to the individual instruction. It can be included in several messages related to the instruction.
»» EndToEndIdentification string true none Unique identification assigned by the initiating party to unambiguously identify the transaction. This identification is passed on, unchanged, throughout the entire end-to-end chain. Usage: The end-to-end identification can be used for reconciliation or to link tasks relating to the transaction. It can be included in several messages related to the transaction. OB: The Faster Payments Scheme can only access 31 characters for the EndToEndIdentification field.
»» LocalInstrument OBExternalLocalInstrument1Code false none User community specific instrument. Usage: This element is used to specify a local instrument, local clearing option and/or further qualify the service or service level.
»» InstructionPriority string false none Indicator of the urgency or order of importance that the instructing party would like the instructed party to apply to the processing of the instruction.
»» Purpose string false none Specifies the external purpose code in the format of character string with a maximum length of 4 characters. The list of valid codes is an external code list published separately. External code sets can be downloaded from www.iso20022.org.
»» ChargeBearer OBChargeBearerType1Code false none Specifies which party/parties will bear the charges associated with the processing of the payment transaction.
»» CurrencyOfTransfer string true none Specifies the currency of the to be transferred amount, which is different from the currency of the debtor's account.
»» InstructedAmount object true none Amount of money to be moved between the debtor and creditor, before deduction of charges, expressed in the currency as ordered by the initiating party. Usage: This amount has to be transported unchanged through the transaction chain.
»»» Amount OBActiveCurrencyAndAmount_SimpleType true none A number of monetary units specified in an active currency where the unit of currency is explicit and compliant with ISO 4217.
»»» Currency ActiveOrHistoricCurrencyCode true none A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 "Codes for the representation of currencies and funds".
»» ExchangeRateInformation object false none Provides details on the currency exchange rate and contract.
»»» UnitCurrency string true none Currency in which the rate of exchange is expressed in a currency exchange. In the example 1GBP = xxxCUR, the unit currency is GBP.
»»» ExchangeRate number false none The factor used for conversion of an amount from one currency to another. This reflects the price at which one currency was bought with another currency.
»»» RateType string true none Specifies the type used to complete the currency exchange.
»»» ContractIdentification string false none Unique and unambiguous reference to the foreign exchange contract agreed between the initiating party/creditor and the debtor agent.
»» DebtorAccount object false none Unambiguous identification of the account of the debtor to which a debit entry will be made as a result of the transaction.
»»» SchemeName OBExternalAccountIdentification4Code true none Name of the identification scheme, in a coded form as published in an external list.
»»» Identification Identification true none Identification assigned by an institution to identify an account. This identification is known by the account owner.
»»» Name string false none The account name is the name or names of the account owner(s) represented at an account level, as displayed by the ASPSP's online channels. Note, the account name is not the product name or the nickname of the account.
»»» SecondaryIdentification SecondaryIdentification false none This is secondary identification of the account, as assigned by the account servicing institution. This can be used by building societies to additionally identify accounts with a roll number (in addition to a sort code and account number combination).
»» Creditor object false none Party to which an amount of money is due.
»»» Name string false none Name by which a party is known and which is usually used to identify that party.
»»» PostalAddress OBPostalAddress6 false none Information that locates and identifies a specific address, as defined by postal services.
»» CreditorAgent object false none Financial institution servicing an account for the creditor.
»»» SchemeName string false none Name of the identification scheme, in a coded form as published in an external list.
»»» Identification string false none Unique and unambiguous identification of a financial institution or a branch of a financial institution.
»»» Name string false none Name by which an agent is known and which is usually used to identify that agent.
»»» PostalAddress OBPostalAddress6 false none Information that locates and identifies a specific address, as defined by postal services.
»» CreditorAccount object true none Unambiguous identification of the account of the creditor to which a credit entry will be posted as a result of the payment transaction.
»»» SchemeName OBExternalAccountIdentification4Code true none Name of the identification scheme, in a coded form as published in an external list.
»»» Identification Identification true none Identification assigned by an institution to identify an account. This identification is known by the account owner.
»»» Name string true none The account name is the name or names of the account owner(s) represented at an account level. Note, the account name is not the product name or the nickname of the account. OB: ASPSPs may carry out name validation for Confirmation of Payee, but it is not mandatory.
»»» SecondaryIdentification SecondaryIdentification false none This is secondary identification of the account, as assigned by the account servicing institution. This can be used by building societies to additionally identify accounts with a roll number (in addition to a sort code and account number combination).
»» RemittanceInformation object false none Information supplied to enable the matching of an entry with the items that the transfer is intended to settle, such as commercial invoices in an accounts' receivable system.
»»» Unstructured string false none Information supplied to enable the matching/reconciliation of an entry with the items that the payment is intended to settle, such as commercial invoices in an accounts' receivable system, in an unstructured form.
»»» Reference string false none Unique reference, as assigned by the creditor, to unambiguously refer to the payment transaction. Usage: If available, the initiating party should provide this reference in the structured remittance information, to enable reconciliation by the creditor upon receipt of the amount of money. If the business context requires the use of a creditor reference or a payment remit identification, and only one identifier can be passed through the end-to-end chain, the creditor's reference or payment remittance identification should be quoted in the end-to-end transaction identification. OB: The Faster Payments Scheme can only accept 18 characters for the ReferenceInformation field - which is where this ISO field will be mapped.
»» SupplementaryData OBSupplementaryData1 false none Additional information that can not be captured in the structured fields and/or any other specific block.
» Risk OBRisk1 true none The Risk section is sent by the initiating party to the ASPSP. It is used to specify additional details for risk scoring for Payments.

Enumerated Values

Property Value
InstructionPriority Normal
InstructionPriority Urgent
RateType Actual
RateType Agreed
RateType Indicative

OBWriteInternationalConsent3

{
  "Data": {
    "Initiation": {
      "InstructionIdentification": "string",
      "EndToEndIdentification": "string",
      "LocalInstrument": "string",
      "InstructionPriority": "Normal",
      "Purpose": "string",
      "ChargeBearer": "BorneByCreditor",
      "CurrencyOfTransfer": "string",
      "InstructedAmount": {
        "Amount": "string",
        "Currency": "string"
      },
      "ExchangeRateInformation": {
        "UnitCurrency": "string",
        "ExchangeRate": 0,
        "RateType": "Actual",
        "ContractIdentification": "string"
      },
      "DebtorAccount": {
        "SchemeName": "string",
        "Identification": "string",
        "Name": "string",
        "SecondaryIdentification": "string"
      },
      "Creditor": {
        "Name": "string",
        "PostalAddress": {
          "AddressType": "Business",
          "Department": "string",
          "SubDepartment": "string",
          "StreetName": "string",
          "BuildingNumber": "string",
          "PostCode": "string",
          "TownName": "string",
          "CountrySubDivision": "string",
          "Country": "string",
          "AddressLine": [
            "string"
          ]
        }
      },
      "CreditorAgent": {
        "SchemeName": "string",
        "Identification": "string",
        "Name": "string",
        "PostalAddress": {
          "AddressType": "Business",
          "Department": "string",
          "SubDepartment": "string",
          "StreetName": "string",
          "BuildingNumber": "string",
          "PostCode": "string",
          "TownName": "string",
          "CountrySubDivision": "string",
          "Country": "string",
          "AddressLine": [
            "string"
          ]
        }
      },
      "CreditorAccount": {
        "SchemeName": "string",
        "Identification": "string",
        "Name": "string",
        "SecondaryIdentification": "string"
      },
      "RemittanceInformation": {
        "Unstructured": "string",
        "Reference": "string"
      },
      "SupplementaryData": {}
    },
    "Authorisation": {
      "AuthorisationType": "Any",
      "CompletionDateTime": "2020-10-23T10:23:58Z"
    },
    "SCASupportData": {
      "RequestedSCAExemptionType": "BillPayment",
      "AppliedAuthenticationApproach": "CA",
      "ReferencePaymentOrderId": "string"
    }
  },
  "Risk": {
    "PaymentContextCode": "BillPayment",
    "MerchantCategoryCode": "stri",
    "MerchantCustomerIdentification": "string",
    "DeliveryAddress": {
      "AddressLine": [
        "string"
      ],
      "StreetName": "string",
      "BuildingNumber": "string",
      "PostCode": "string",
      "TownName": "string",
      "CountrySubDivision": [
        "string"
      ],
      "Country": "string"
    }
  }
}

Properties

Name Type Required Restrictions Description
Data object true none none
» Initiation object true none The Initiation payload is sent by the initiating party to the ASPSP. It is used to request movement of funds from the debtor account to a creditor for a single international payment.
»» InstructionIdentification string true none Unique identification as assigned by an instructing party for an instructed party to unambiguously identify the instruction. Usage: the instruction identification is a point to point reference that can be used between the instructing party and the instructed party to refer to the individual instruction. It can be included in several messages related to the instruction.
»» EndToEndIdentification string true none Unique identification assigned by the initiating party to unambiguously identify the transaction. This identification is passed on, unchanged, throughout the entire end-to-end chain. Usage: The end-to-end identification can be used for reconciliation or to link tasks relating to the transaction. It can be included in several messages related to the transaction. OB: The Faster Payments Scheme can only access 31 characters for the EndToEndIdentification field.
»» LocalInstrument OBExternalLocalInstrument1Code false none User community specific instrument. Usage: This element is used to specify a local instrument, local clearing option and/or further qualify the service or service level.
»» InstructionPriority string false none Indicator of the urgency or order of importance that the instructing party would like the instructed party to apply to the processing of the instruction.
»» Purpose string false none Specifies the external purpose code in the format of character string with a maximum length of 4 characters. The list of valid codes is an external code list published separately. External code sets can be downloaded from www.iso20022.org.
»» ChargeBearer OBChargeBearerType1Code false none Specifies which party/parties will bear the charges associated with the processing of the payment transaction.
»» CurrencyOfTransfer string true none Specifies the currency of the to be transferred amount, which is different from the currency of the debtor's account.
»» InstructedAmount object true none Amount of money to be moved between the debtor and creditor, before deduction of charges, expressed in the currency as ordered by the initiating party. Usage: This amount has to be transported unchanged through the transaction chain.
»»» Amount OBActiveCurrencyAndAmount_SimpleType true none A number of monetary units specified in an active currency where the unit of currency is explicit and compliant with ISO 4217.
»»» Currency ActiveOrHistoricCurrencyCode true none A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 "Codes for the representation of currencies and funds".
»» ExchangeRateInformation object false none Provides details on the currency exchange rate and contract.
»»» UnitCurrency string true none Currency in which the rate of exchange is expressed in a currency exchange. In the example 1GBP = xxxCUR, the unit currency is GBP.
»»» ExchangeRate number false none The factor used for conversion of an amount from one currency to another. This reflects the price at which one currency was bought with another currency.
»»» RateType string true none Specifies the type used to complete the currency exchange.
»»» ContractIdentification string false none Unique and unambiguous reference to the foreign exchange contract agreed between the initiating party/creditor and the debtor agent.
»» DebtorAccount object false none Unambiguous identification of the account of the debtor to which a debit entry will be made as a result of the transaction.
»»» SchemeName OBExternalAccountIdentification4Code true none Name of the identification scheme, in a coded form as published in an external list.
»»» Identification Identification true none Identification assigned by an institution to identify an account. This identification is known by the account owner.
»»» Name string false none The account name is the name or names of the account owner(s) represented at an account level, as displayed by the ASPSP's online channels. Note, the account name is not the product name or the nickname of the account.
»»» SecondaryIdentification SecondaryIdentification false none This is secondary identification of the account, as assigned by the account servicing institution. This can be used by building societies to additionally identify accounts with a roll number (in addition to a sort code and account number combination).
»» Creditor object false none Party to which an amount of money is due.
»»» Name string false none Name by which a party is known and which is usually used to identify that party.
»»» PostalAddress OBPostalAddress6 false none Information that locates and identifies a specific address, as defined by postal services.
»» CreditorAgent object false none Financial institution servicing an account for the creditor.
»»» SchemeName string false none Name of the identification scheme, in a coded form as published in an external list.
»»» Identification string false none Unique and unambiguous identification of a financial institution or a branch of a financial institution.
»»» Name string false none Name by which an agent is known and which is usually used to identify that agent.
»»» PostalAddress OBPostalAddress6 false none Information that locates and identifies a specific address, as defined by postal services.
»» CreditorAccount object true none Unambiguous identification of the account of the creditor to which a credit entry will be posted as a result of the payment transaction.
»»» SchemeName OBExternalAccountIdentification4Code true none Name of the identification scheme, in a coded form as published in an external list.
»»» Identification Identification true none Identification assigned by an institution to identify an account. This identification is known by the account owner.
»»» Name string true none The account name is the name or names of the account owner(s) represented at an account level. Note, the account name is not the product name or the nickname of the account. OB: ASPSPs may carry out name validation for Confirmation of Payee, but it is not mandatory.
»»» SecondaryIdentification SecondaryIdentification false none This is secondary identification of the account, as assigned by the account servicing institution. This can be used by building societies to additionally identify accounts with a roll number (in addition to a sort code and account number combination).
»» RemittanceInformation object false none Information supplied to enable the matching of an entry with the items that the transfer is intended to settle, such as commercial invoices in an accounts' receivable system.
»»» Unstructured string false none Information supplied to enable the matching/reconciliation of an entry with the items that the payment is intended to settle, such as commercial invoices in an accounts' receivable system, in an unstructured form.
»»» Reference string false none Unique reference, as assigned by the creditor, to unambiguously refer to the payment transaction. Usage: If available, the initiating party should provide this reference in the structured remittance information, to enable reconciliation by the creditor upon receipt of the amount of money. If the business context requires the use of a creditor reference or a payment remit identification, and only one identifier can be passed through the end-to-end chain, the creditor's reference or payment remittance identification should be quoted in the end-to-end transaction identification. OB: The Faster Payments Scheme can only accept 18 characters for the ReferenceInformation field - which is where this ISO field will be mapped.
»» SupplementaryData OBSupplementaryData1 false none Additional information that can not be captured in the structured fields and/or any other specific block.
» Authorisation object false none The authorisation type request from the TPP.
»» AuthorisationType string true none Type of authorisation flow requested.
»» CompletionDateTime string(date-time) false none Date and time at which the requested authorisation flow must be completed.All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00
» SCASupportData object false none Supporting Data provided by TPP, when requesting SCA Exemption.
»» RequestedSCAExemptionType string false none This field allows a PISP to request specific SCA Exemption for a Payment Initiation
»» AppliedAuthenticationApproach string false none Specifies a character string with a maximum length of 40 characters. Usage: This field indicates whether the PSU was subject to SCA performed by the TPP
»» ReferencePaymentOrderId string false none Specifies a character string with a maximum length of 140 characters. Usage: If the payment is recurring then the transaction identifier of the previous payment occurrence so that the ASPSP can verify that the PISP, amount and the payee are the same as the previous occurrence.
» Risk OBRisk1 true none The Risk section is sent by the initiating party to the ASPSP. It is used to specify additional details for risk scoring for Payments.

Enumerated Values

Property Value
InstructionPriority Normal
InstructionPriority Urgent
RateType Actual
RateType Agreed
RateType Indicative
AuthorisationType Any
AuthorisationType Single
RequestedSCAExemptionType BillPayment
RequestedSCAExemptionType ContactlessTravel
RequestedSCAExemptionType EcommerceGoods
RequestedSCAExemptionType EcommerceServices
RequestedSCAExemptionType Kiosk
RequestedSCAExemptionType Parking
RequestedSCAExemptionType PartyToParty
AppliedAuthenticationApproach CA
AppliedAuthenticationApproach SCA

OBWriteInternationalConsentResponse3

{
  "Data": {
    "ConsentId": "string",
    "CreationDateTime": "2020-10-23T10:23:58Z",
    "Status": "Authorised",
    "StatusUpdateDateTime": "2020-10-23T10:23:58Z",
    "CutOffDateTime": "2020-10-23T10:23:58Z",
    "ExpectedExecutionDateTime": "2020-10-23T10:23:58Z",
    "ExpectedSettlementDateTime": "2020-10-23T10:23:58Z",
    "Charges": [
      {
        "ChargeBearer": "BorneByCreditor",
        "Type": "string",
        "Amount": {
          "Amount": "string",
          "Currency": "string"
        }
      }
    ],
    "ExchangeRateInformation": {
      "UnitCurrency": "string",
      "ExchangeRate": 0,
      "RateType": "Actual",
      "ContractIdentification": "string",
      "ExpirationDateTime": "2020-10-23T10:23:58Z"
    },
    "Initiation": {
      "InstructionIdentification": "string",
      "EndToEndIdentification": "string",
      "LocalInstrument": "string",
      "InstructionPriority": "Normal",
      "Purpose": "string",
      "ChargeBearer": "BorneByCreditor",
      "CurrencyOfTransfer": "string",
      "InstructedAmount": {
        "Amount": "string",
        "Currency": "string"
      },
      "ExchangeRateInformation": {
        "UnitCurrency": "string",
        "ExchangeRate": 0,
        "RateType": "Actual",
        "ContractIdentification": "string"
      },
      "DebtorAccount": {
        "SchemeName": "string",
        "Identification": "string",
        "Name": "string",
        "SecondaryIdentification": "string"
      },
      "Creditor": {
        "Name": "string",
        "PostalAddress": {
          "AddressType": "Business",
          "Department": "string",
          "SubDepartment": "string",
          "StreetName": "string",
          "BuildingNumber": "string",
          "PostCode": "string",
          "TownName": "string",
          "CountrySubDivision": "string",
          "Country": "string",
          "AddressLine": [
            "string"
          ]
        }
      },
      "CreditorAgent": {
        "SchemeName": "string",
        "Identification": "string",
        "Name": "string",
        "PostalAddress": {
          "AddressType": "Business",
          "Department": "string",
          "SubDepartment": "string",
          "StreetName": "string",
          "BuildingNumber": "string",
          "PostCode": "string",
          "TownName": "string",
          "CountrySubDivision": "string",
          "Country": "string",
          "AddressLine": [
            "string"
          ]
        }
      },
      "CreditorAccount": {
        "SchemeName": "string",
        "Identification": "string",
        "Name": "string",
        "SecondaryIdentification": "string"
      },
      "RemittanceInformation": {
        "Unstructured": "string",
        "Reference": "string"
      },
      "SupplementaryData": {}
    },
    "Authorisation": {
      "AuthorisationType": "Any",
      "CompletionDateTime": "2020-10-23T10:23:58Z"
    },
    "SCASupportData": {
      "RequestedSCAExemptionType": "BillPayment",
      "AppliedAuthenticationApproach": "CA",
      "ReferencePaymentOrderId": "string"
    }
  },
  "Risk": {
    "PaymentContextCode": "BillPayment",
    "MerchantCategoryCode": "stri",
    "MerchantCustomerIdentification": "string",
    "DeliveryAddress": {
      "AddressLine": [
        "string"
      ],
      "StreetName": "string",
      "BuildingNumber": "string",
      "PostCode": "string",
      "TownName": "string",
      "CountrySubDivision": [
        "string"
      ],
      "Country": "string"
    }
  },
  "Links": {
    "Self": "http://example.com",
    "First": "http://example.com",
    "Prev": "http://example.com",
    "Next": "http://example.com",
    "Last": "http://example.com"
  },
  "Meta": {
    "TotalPages": 0,
    "FirstAvailableDateTime": "2020-10-23T10:23:58Z",
    "LastAvailableDateTime": "2020-10-23T10:23:58Z"
  }
}

Properties

Name Type Required Restrictions Description
Data object true none none
» ConsentId string true none OB: Unique identification as assigned by the ASPSP to uniquely identify the consent resource.
» CreationDateTime string(date-time) true none Date and time at which the resource was created.All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00
» Status string true none Specifies the status of consent resource in code form.
» StatusUpdateDateTime string(date-time) true none Date and time at which the resource status was updated.All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00
» CutOffDateTime string(date-time) false none Specified cut-off date and time for the payment consent.All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00
» ExpectedExecutionDateTime string(date-time) false none Expected execution date and time for the payment resource.All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00
» ExpectedSettlementDateTime string(date-time) false none Expected settlement date and time for the payment resource.All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00
» Charges [object] false none none
»» ChargeBearer OBChargeBearerType1Code true none Specifies which party/parties will bear the charges associated with the processing of the payment transaction.
»» Type OBExternalPaymentChargeType1Code true none Charge type, in a coded form.
»» Amount OBActiveOrHistoricCurrencyAndAmount true none Amount of money associated with the charge type.
» ExchangeRateInformation object false none Further detailed information on the exchange rate that has been used in the payment transaction.
»» UnitCurrency string true none Currency in which the rate of exchange is expressed in a currency exchange. In the example 1GBP = xxxCUR, the unit currency is GBP.
»» ExchangeRate number true none The factor used for conversion of an amount from one currency to another. This reflects the price at which one currency was bought with another currency.
»» RateType string true none Specifies the type used to complete the currency exchange.
»» ContractIdentification string false none Unique and unambiguous reference to the foreign exchange contract agreed between the initiating party/creditor and the debtor agent.
»» ExpirationDateTime string(date-time) false none Specified date and time the exchange rate agreement will expire.All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00
» Initiation object true none The Initiation payload is sent by the initiating party to the ASPSP. It is used to request movement of funds from the debtor account to a creditor for a single international payment.
»» InstructionIdentification string true none Unique identification as assigned by an instructing party for an instructed party to unambiguously identify the instruction. Usage: the instruction identification is a point to point reference that can be used between the instructing party and the instructed party to refer to the individual instruction. It can be included in several messages related to the instruction.
»» EndToEndIdentification string true none Unique identification assigned by the initiating party to unambiguously identify the transaction. This identification is passed on, unchanged, throughout the entire end-to-end chain. Usage: The end-to-end identification can be used for reconciliation or to link tasks relating to the transaction. It can be included in several messages related to the transaction. OB: The Faster Payments Scheme can only access 31 characters for the EndToEndIdentification field.
»» LocalInstrument OBExternalLocalInstrument1Code false none User community specific instrument. Usage: This element is used to specify a local instrument, local clearing option and/or further qualify the service or service level.
»» InstructionPriority string false none Indicator of the urgency or order of importance that the instructing party would like the instructed party to apply to the processing of the instruction.
»» Purpose string false none Specifies the external purpose code in the format of character string with a maximum length of 4 characters. The list of valid codes is an external code list published separately. External code sets can be downloaded from www.iso20022.org.
»» ChargeBearer OBChargeBearerType1Code false none Specifies which party/parties will bear the charges associated with the processing of the payment transaction.
»» CurrencyOfTransfer string true none Specifies the currency of the to be transferred amount, which is different from the currency of the debtor's account.
»» InstructedAmount object true none Amount of money to be moved between the debtor and creditor, before deduction of charges, expressed in the currency as ordered by the initiating party. Usage: This amount has to be transported unchanged through the transaction chain.
»»» Amount OBActiveCurrencyAndAmount_SimpleType true none A number of monetary units specified in an active currency where the unit of currency is explicit and compliant with ISO 4217.
»»» Currency ActiveOrHistoricCurrencyCode true none A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 "Codes for the representation of currencies and funds".
»» ExchangeRateInformation object false none Provides details on the currency exchange rate and contract.
»»» UnitCurrency string true none Currency in which the rate of exchange is expressed in a currency exchange. In the example 1GBP = xxxCUR, the unit currency is GBP.
»»» ExchangeRate number false none The factor used for conversion of an amount from one currency to another. This reflects the price at which one currency was bought with another currency.
»»» RateType string true none Specifies the type used to complete the currency exchange.
»»» ContractIdentification string false none Unique and unambiguous reference to the foreign exchange contract agreed between the initiating party/creditor and the debtor agent.
»» DebtorAccount object false none Unambiguous identification of the account of the debtor to which a debit entry will be made as a result of the transaction.
»»» SchemeName OBExternalAccountIdentification4Code true none Name of the identification scheme, in a coded form as published in an external list.
»»» Identification Identification true none Identification assigned by an institution to identify an account. This identification is known by the account owner.
»»» Name string false none The account name is the name or names of the account owner(s) represented at an account level, as displayed by the ASPSP's online channels. Note, the account name is not the product name or the nickname of the account.
»»» SecondaryIdentification SecondaryIdentification false none This is secondary identification of the account, as assigned by the account servicing institution. This can be used by building societies to additionally identify accounts with a roll number (in addition to a sort code and account number combination).
»» Creditor object false none Party to which an amount of money is due.
»»» Name string false none Name by which a party is known and which is usually used to identify that party.
»»» PostalAddress OBPostalAddress6 false none Information that locates and identifies a specific address, as defined by postal services.
»» CreditorAgent object false none Financial institution servicing an account for the creditor.
»»» SchemeName string false none Name of the identification scheme, in a coded form as published in an external list.
»»» Identification string false none Unique and unambiguous identification of a financial institution or a branch of a financial institution.
»»» Name string false none Name by which an agent is known and which is usually used to identify that agent.
»»» PostalAddress OBPostalAddress6 false none Information that locates and identifies a specific address, as defined by postal services.
»» CreditorAccount object true none Unambiguous identification of the account of the creditor to which a credit entry will be posted as a result of the payment transaction.
»»» SchemeName OBExternalAccountIdentification4Code true none Name of the identification scheme, in a coded form as published in an external list.
»»» Identification Identification true none Identification assigned by an institution to identify an account. This identification is known by the account owner.
»»» Name string true none The account name is the name or names of the account owner(s) represented at an account level. Note, the account name is not the product name or the nickname of the account. OB: ASPSPs may carry out name validation for Confirmation of Payee, but it is not mandatory.
»»» SecondaryIdentification SecondaryIdentification false none This is secondary identification of the account, as assigned by the account servicing institution. This can be used by building societies to additionally identify accounts with a roll number (in addition to a sort code and account number combination).
»» RemittanceInformation object false none Information supplied to enable the matching of an entry with the items that the transfer is intended to settle, such as commercial invoices in an accounts' receivable system.
»»» Unstructured string false none Information supplied to enable the matching/reconciliation of an entry with the items that the payment is intended to settle, such as commercial invoices in an accounts' receivable system, in an unstructured form.
»»» Reference string false none Unique reference, as assigned by the creditor, to unambiguously refer to the payment transaction. Usage: If available, the initiating party should provide this reference in the structured remittance information, to enable reconciliation by the creditor upon receipt of the amount of money. If the business context requires the use of a creditor reference or a payment remit identification, and only one identifier can be passed through the end-to-end chain, the creditor's reference or payment remittance identification should be quoted in the end-to-end transaction identification. OB: The Faster Payments Scheme can only accept 18 characters for the ReferenceInformation field - which is where this ISO field will be mapped.
»» SupplementaryData OBSupplementaryData1 false none Additional information that can not be captured in the structured fields and/or any other specific block.
» Authorisation object false none The authorisation type request from the TPP.
»» AuthorisationType string true none Type of authorisation flow requested.
»» CompletionDateTime string(date-time) false none Date and time at which the requested authorisation flow must be completed.All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00
» SCASupportData object false none Supporting Data provided by TPP, when requesting SCA Exemption.
»» RequestedSCAExemptionType string false none This field allows a PISP to request specific SCA Exemption for a Payment Initiation
»» AppliedAuthenticationApproach string false none Specifies a character string with a maximum length of 40 characters. Usage: This field indicates whether the PSU was subject to SCA performed by the TPP
»» ReferencePaymentOrderId string false none Specifies a character string with a maximum length of 140 characters. Usage: If the payment is recurring then the transaction identifier of the previous payment occurrence so that the ASPSP can verify that the PISP, amount and the payee are the same as the previous occurrence.
» Risk OBRisk1 true none The Risk section is sent by the initiating party to the ASPSP. It is used to specify additional details for risk scoring for Payments.
» Links Links false none Links relevant to the payload
» Meta Meta false none Meta Data relevant to the payload

Enumerated Values

Property Value
Status Authorised
Status AwaitingAuthorisation
Status Consumed
Status Rejected
RateType Actual
RateType Agreed
RateType Indicative
InstructionPriority Normal
InstructionPriority Urgent
RateType Actual
RateType Agreed
RateType Indicative
AuthorisationType Any
AuthorisationType Single
RequestedSCAExemptionType BillPayment
RequestedSCAExemptionType ContactlessTravel
RequestedSCAExemptionType EcommerceGoods
RequestedSCAExemptionType EcommerceServices
RequestedSCAExemptionType Kiosk
RequestedSCAExemptionType Parking
RequestedSCAExemptionType PartyToParty
AppliedAuthenticationApproach CA
AppliedAuthenticationApproach SCA

OBWriteInternationalResponse3

{
  "Data": {
    "InternationalPaymentId": "string",
    "ConsentId": "string",
    "CreationDateTime": "2020-10-23T10:23:58Z",
    "Status": "AcceptedCreditSettlementCompleted",
    "StatusUpdateDateTime": "2020-10-23T10:23:58Z",
    "ExpectedExecutionDateTime": "2020-10-23T10:23:58Z",
    "ExpectedSettlementDateTime": "2020-10-23T10:23:58Z",
    "Charges": [
      {
        "ChargeBearer": "BorneByCreditor",
        "Type": "string",
        "Amount": {
          "Amount": "string",
          "Currency": "string"
        }
      }
    ],
    "ExchangeRateInformation": {
      "UnitCurrency": "string",
      "ExchangeRate": 0,
      "RateType": "Actual",
      "ContractIdentification": "string",
      "ExpirationDateTime": "2020-10-23T10:23:58Z"
    },
    "Initiation": {
      "InstructionIdentification": "string",
      "EndToEndIdentification": "string",
      "LocalInstrument": "string",
      "InstructionPriority": "Normal",
      "Purpose": "string",
      "ChargeBearer": "BorneByCreditor",
      "CurrencyOfTransfer": "string",
      "InstructedAmount": {
        "Amount": "string",
        "Currency": "string"
      },
      "ExchangeRateInformation": {
        "UnitCurrency": "string",
        "ExchangeRate": 0,
        "RateType": "Actual",
        "ContractIdentification": "string"
      },
      "DebtorAccount": {
        "SchemeName": "string",
        "Identification": "string",
        "Name": "string",
        "SecondaryIdentification": "string"
      },
      "Creditor": {
        "Name": "string",
        "PostalAddress": {
          "AddressType": "Business",
          "Department": "string",
          "SubDepartment": "string",
          "StreetName": "string",
          "BuildingNumber": "string",
          "PostCode": "string",
          "TownName": "string",
          "CountrySubDivision": "string",
          "Country": "string",
          "AddressLine": [
            "string"
          ]
        }
      },
      "CreditorAgent": {
        "SchemeName": "string",
        "Identification": "string",
        "Name": "string",
        "PostalAddress": {
          "AddressType": "Business",
          "Department": "string",
          "SubDepartment": "string",
          "StreetName": "string",
          "BuildingNumber": "string",
          "PostCode": "string",
          "TownName": "string",
          "CountrySubDivision": "string",
          "Country": "string",
          "AddressLine": [
            "string"
          ]
        }
      },
      "CreditorAccount": {
        "SchemeName": "string",
        "Identification": "string",
        "Name": "string",
        "SecondaryIdentification": "string"
      },
      "RemittanceInformation": {
        "Unstructured": "string",
        "Reference": "string"
      },
      "SupplementaryData": {}
    },
    "MultiAuthorisation": {
      "Status": "Authorised",
      "NumberRequired": 0,
      "NumberReceived": 0,
      "LastUpdateDateTime": "2020-10-23T10:23:58Z",
      "ExpirationDateTime": "2020-10-23T10:23:58Z"
    }
  },
  "Links": {
    "Self": "http://example.com",
    "First": "http://example.com",
    "Prev": "http://example.com",
    "Next": "http://example.com",
    "Last": "http://example.com"
  },
  "Meta": {
    "TotalPages": 0,
    "FirstAvailableDateTime": "2020-10-23T10:23:58Z",
    "LastAvailableDateTime": "2020-10-23T10:23:58Z"
  }
}

Properties

Name Type Required Restrictions Description
Data object true none none
» InternationalPaymentId string true none OB: Unique identification as assigned by the ASPSP to uniquely identify the international payment resource.
» ConsentId string true none OB: Unique identification as assigned by the ASPSP to uniquely identify the consent resource.
» CreationDateTime string(date-time) true none Date and time at which the message was created.All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00
» Status string true none Specifies the status of the payment information group.
» StatusUpdateDateTime string(date-time) true none Date and time at which the resource status was updated.All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00
» ExpectedExecutionDateTime string(date-time) false none Expected execution date and time for the payment resource.All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00
» ExpectedSettlementDateTime string(date-time) false none Expected settlement date and time for the payment resource.All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00
» Charges [object] false none none
»» ChargeBearer OBChargeBearerType1Code true none Specifies which party/parties will bear the charges associated with the processing of the payment transaction.
»» Type OBExternalPaymentChargeType1Code true none Charge type, in a coded form.
»» Amount OBActiveOrHistoricCurrencyAndAmount true none Amount of money associated with the charge type.
» ExchangeRateInformation object false none Further detailed information on the exchange rate that has been used in the payment transaction.
»» UnitCurrency string true none Currency in which the rate of exchange is expressed in a currency exchange. In the example 1GBP = xxxCUR, the unit currency is GBP.
»» ExchangeRate number true none The factor used for conversion of an amount from one currency to another. This reflects the price at which one currency was bought with another currency.
»» RateType string true none Specifies the type used to complete the currency exchange.
»» ContractIdentification string false none Unique and unambiguous reference to the foreign exchange contract agreed between the initiating party/creditor and the debtor agent.
»» ExpirationDateTime string(date-time) false none Specified date and time the exchange rate agreement will expire.All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00
» Initiation object true none The Initiation payload is sent by the initiating party to the ASPSP. It is used to request movement of funds from the debtor account to a creditor for a single international payment.
»» InstructionIdentification string true none Unique identification as assigned by an instructing party for an instructed party to unambiguously identify the instruction. Usage: the instruction identification is a point to point reference that can be used between the instructing party and the instructed party to refer to the individual instruction. It can be included in several messages related to the instruction.
»» EndToEndIdentification string true none Unique identification assigned by the initiating party to unambiguously identify the transaction. This identification is passed on, unchanged, throughout the entire end-to-end chain. Usage: The end-to-end identification can be used for reconciliation or to link tasks relating to the transaction. It can be included in several messages related to the transaction. OB: The Faster Payments Scheme can only access 31 characters for the EndToEndIdentification field.
»» LocalInstrument OBExternalLocalInstrument1Code false none User community specific instrument. Usage: This element is used to specify a local instrument, local clearing option and/or further qualify the service or service level.
»» InstructionPriority string false none Indicator of the urgency or order of importance that the instructing party would like the instructed party to apply to the processing of the instruction.
»» Purpose string false none Specifies the external purpose code in the format of character string with a maximum length of 4 characters. The list of valid codes is an external code list published separately. External code sets can be downloaded from www.iso20022.org.
»» ChargeBearer OBChargeBearerType1Code false none Specifies which party/parties will bear the charges associated with the processing of the payment transaction.
»» CurrencyOfTransfer string true none Specifies the currency of the to be transferred amount, which is different from the currency of the debtor's account.
»» InstructedAmount object true none Amount of money to be moved between the debtor and creditor, before deduction of charges, expressed in the currency as ordered by the initiating party. Usage: This amount has to be transported unchanged through the transaction chain.
»»» Amount OBActiveCurrencyAndAmount_SimpleType true none A number of monetary units specified in an active currency where the unit of currency is explicit and compliant with ISO 4217.
»»» Currency ActiveOrHistoricCurrencyCode true none A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 "Codes for the representation of currencies and funds".
»» ExchangeRateInformation object false none Provides details on the currency exchange rate and contract.
»»» UnitCurrency string true none Currency in which the rate of exchange is expressed in a currency exchange. In the example 1GBP = xxxCUR, the unit currency is GBP.
»»» ExchangeRate number false none The factor used for conversion of an amount from one currency to another. This reflects the price at which one currency was bought with another currency.
»»» RateType string true none Specifies the type used to complete the currency exchange.
»»» ContractIdentification string false none Unique and unambiguous reference to the foreign exchange contract agreed between the initiating party/creditor and the debtor agent.
»» DebtorAccount object false none Unambiguous identification of the account of the debtor to which a debit entry will be made as a result of the transaction.
»»» SchemeName OBExternalAccountIdentification4Code true none Name of the identification scheme, in a coded form as published in an external list.
»»» Identification Identification true none Identification assigned by an institution to identify an account. This identification is known by the account owner.
»»» Name string false none The account name is the name or names of the account owner(s) represented at an account level, as displayed by the ASPSP's online channels. Note, the account name is not the product name or the nickname of the account.
»»» SecondaryIdentification SecondaryIdentification false none This is secondary identification of the account, as assigned by the account servicing institution. This can be used by building societies to additionally identify accounts with a roll number (in addition to a sort code and account number combination).
»» Creditor object false none Party to which an amount of money is due.
»»» Name string false none Name by which a party is known and which is usually used to identify that party.
»»» PostalAddress OBPostalAddress6 false none Information that locates and identifies a specific address, as defined by postal services.
»» CreditorAgent object false none Financial institution servicing an account for the creditor.
»»» SchemeName string false none Name of the identification scheme, in a coded form as published in an external list.
»»» Identification string false none Unique and unambiguous identification of a financial institution or a branch of a financial institution.
»»» Name string false none Name by which an agent is known and which is usually used to identify that agent.
»»» PostalAddress OBPostalAddress6 false none Information that locates and identifies a specific address, as defined by postal services.
»» CreditorAccount object true none Unambiguous identification of the account of the creditor to which a credit entry will be posted as a result of the payment transaction.
»»» SchemeName OBExternalAccountIdentification4Code true none Name of the identification scheme, in a coded form as published in an external list.
»»» Identification Identification true none Identification assigned by an institution to identify an account. This identification is known by the account owner.
»»» Name string true none The account name is the name or names of the account owner(s) represented at an account level. Note, the account name is not the product name or the nickname of the account. OB: ASPSPs may carry out name validation for Confirmation of Payee, but it is not mandatory.
»»» SecondaryIdentification SecondaryIdentification false none This is secondary identification of the account, as assigned by the account servicing institution. This can be used by building societies to additionally identify accounts with a roll number (in addition to a sort code and account number combination).
»» RemittanceInformation object false none Information supplied to enable the matching of an entry with the items that the transfer is intended to settle, such as commercial invoices in an accounts' receivable system.
»»» Unstructured string false none Information supplied to enable the matching/reconciliation of an entry with the items that the payment is intended to settle, such as commercial invoices in an accounts' receivable system, in an unstructured form.
»»» Reference string false none Unique reference, as assigned by the creditor, to unambiguously refer to the payment transaction. Usage: If available, the initiating party should provide this reference in the structured remittance information, to enable reconciliation by the creditor upon receipt of the amount of money. If the business context requires the use of a creditor reference or a payment remit identification, and only one identifier can be passed through the end-to-end chain, the creditor's reference or payment remittance identification should be quoted in the end-to-end transaction identification. OB: The Faster Payments Scheme can only accept 18 characters for the ReferenceInformation field - which is where this ISO field will be mapped.
»» SupplementaryData OBSupplementaryData1 false none Additional information that can not be captured in the structured fields and/or any other specific block.
» MultiAuthorisation object false none The multiple authorisation flow response from the ASPSP.
»» Status string true none Specifies the status of the authorisation flow in code form.
»» NumberRequired integer false none Number of authorisations required for payment order (total required at the start of the multi authorisation journey).
»» NumberReceived integer false none Number of authorisations received.
»» LastUpdateDateTime string(date-time) false none Last date and time at the authorisation flow was updated.All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00
»» ExpirationDateTime string(date-time) false none Date and time at which the requested authorisation flow must be completed.All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00
» Links Links false none Links relevant to the payload
» Meta Meta false none Meta Data relevant to the payload

Enumerated Values

Property Value
Status AcceptedCreditSettlementCompleted
Status AcceptedSettlementCompleted
Status AcceptedSettlementInProcess
Status AcceptedWithoutPosting
Status Pending
Status Rejected
RateType Actual
RateType Agreed
RateType Indicative
InstructionPriority Normal
InstructionPriority Urgent
RateType Actual
RateType Agreed
RateType Indicative
Status Authorised
Status AwaitingFurtherAuthorisation
Status Rejected

OBWriteInternationalScheduled2

{
  "Data": {
    "ConsentId": "string",
    "Initiation": {
      "InstructionIdentification": "string",
      "EndToEndIdentification": "string",
      "LocalInstrument": "string",
      "InstructionPriority": "Normal",
      "Purpose": "string",
      "ChargeBearer": "BorneByCreditor",
      "RequestedExecutionDateTime": "2020-10-23T10:23:58Z",
      "CurrencyOfTransfer": "string",
      "InstructedAmount": {
        "Amount": "string",
        "Currency": "string"
      },
      "ExchangeRateInformation": {
        "UnitCurrency": "string",
        "ExchangeRate": 0,
        "RateType": "Actual",
        "ContractIdentification": "string"
      },
      "DebtorAccount": {
        "SchemeName": "string",
        "Identification": "string",
        "Name": "string",
        "SecondaryIdentification": "string"
      },
      "Creditor": {
        "Name": "string",
        "PostalAddress": {
          "AddressType": "Business",
          "Department": "string",
          "SubDepartment": "string",
          "StreetName": "string",
          "BuildingNumber": "string",
          "PostCode": "string",
          "TownName": "string",
          "CountrySubDivision": "string",
          "Country": "string",
          "AddressLine": [
            "string"
          ]
        }
      },
      "CreditorAgent": {
        "SchemeName": "string",
        "Identification": "string",
        "Name": "string",
        "PostalAddress": {
          "AddressType": "Business",
          "Department": "string",
          "SubDepartment": "string",
          "StreetName": "string",
          "BuildingNumber": "string",
          "PostCode": "string",
          "TownName": "string",
          "CountrySubDivision": "string",
          "Country": "string",
          "AddressLine": [
            "string"
          ]
        }
      },
      "CreditorAccount": {
        "SchemeName": "string",
        "Identification": "string",
        "Name": "string",
        "SecondaryIdentification": "string"
      },
      "RemittanceInformation": {
        "Unstructured": "string",
        "Reference": "string"
      },
      "SupplementaryData": {}
    }
  },
  "Risk": {
    "PaymentContextCode": "BillPayment",
    "MerchantCategoryCode": "stri",
    "MerchantCustomerIdentification": "string",
    "DeliveryAddress": {
      "AddressLine": [
        "string"
      ],
      "StreetName": "string",
      "BuildingNumber": "string",
      "PostCode": "string",
      "TownName": "string",
      "CountrySubDivision": [
        "string"
      ],
      "Country": "string"
    }
  }
}

Properties

Name Type Required Restrictions Description
Data object true none none
» ConsentId string true none OB: Unique identification as assigned by the ASPSP to uniquely identify the consent resource.
» Initiation object true none The Initiation payload is sent by the initiating party to the ASPSP. It is used to request movement of funds from the debtor account to a creditor for a single scheduled international payment.
»» InstructionIdentification string true none Unique identification as assigned by an instructing party for an instructed party to unambiguously identify the instruction. Usage: the instruction identification is a point to point reference that can be used between the instructing party and the instructed party to refer to the individual instruction. It can be included in several messages related to the instruction.
»» EndToEndIdentification string false none Unique identification assigned by the initiating party to unambiguously identify the transaction. This identification is passed on, unchanged, throughout the entire end-to-end chain. Usage: The end-to-end identification can be used for reconciliation or to link tasks relating to the transaction. It can be included in several messages related to the transaction. OB: The Faster Payments Scheme can only access 31 characters for the EndToEndIdentification field.
»» LocalInstrument OBExternalLocalInstrument1Code false none User community specific instrument. Usage: This element is used to specify a local instrument, local clearing option and/or further qualify the service or service level.
»» InstructionPriority string false none Indicator of the urgency or order of importance that the instructing party would like the instructed party to apply to the processing of the instruction.
»» Purpose string false none Specifies the external purpose code in the format of character string with a maximum length of 4 characters. The list of valid codes is an external code list published separately. External code sets can be downloaded from www.iso20022.org.
»» ChargeBearer OBChargeBearerType1Code false none Specifies which party/parties will bear the charges associated with the processing of the payment transaction.
»» RequestedExecutionDateTime string(date-time) true none Date at which the initiating party requests the clearing agent to process the payment. Usage: This is the date on which the debtor's account is to be debited.All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00
»» CurrencyOfTransfer string true none Specifies the currency of the to be transferred amount, which is different from the currency of the debtor's account.
»» InstructedAmount object true none Amount of money to be moved between the debtor and creditor, before deduction of charges, expressed in the currency as ordered by the initiating party. Usage: This amount has to be transported unchanged through the transaction chain.
»»» Amount OBActiveCurrencyAndAmount_SimpleType true none A number of monetary units specified in an active currency where the unit of currency is explicit and compliant with ISO 4217.
»»» Currency ActiveOrHistoricCurrencyCode true none A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 "Codes for the representation of currencies and funds".
»» ExchangeRateInformation object false none Provides details on the currency exchange rate and contract.
»»» UnitCurrency string true none Currency in which the rate of exchange is expressed in a currency exchange. In the example 1GBP = xxxCUR, the unit currency is GBP.
»»» ExchangeRate number false none The factor used for conversion of an amount from one currency to another. This reflects the price at which one currency was bought with another currency.
»»» RateType string true none Specifies the type used to complete the currency exchange.
»»» ContractIdentification string false none Unique and unambiguous reference to the foreign exchange contract agreed between the initiating party/creditor and the debtor agent.
»» DebtorAccount object false none Unambiguous identification of the account of the debtor to which a debit entry will be made as a result of the transaction.
»»» SchemeName OBExternalAccountIdentification4Code true none Name of the identification scheme, in a coded form as published in an external list.
»»» Identification Identification true none Identification assigned by an institution to identify an account. This identification is known by the account owner.
»»» Name string false none The account name is the name or names of the account owner(s) represented at an account level, as displayed by the ASPSP's online channels. Note, the account name is not the product name or the nickname of the account.
»»» SecondaryIdentification SecondaryIdentification false none This is secondary identification of the account, as assigned by the account servicing institution. This can be used by building societies to additionally identify accounts with a roll number (in addition to a sort code and account number combination).
»» Creditor object false none Party to which an amount of money is due.
»»» Name string false none Name by which a party is known and which is usually used to identify that party.
»»» PostalAddress OBPostalAddress6 false none Information that locates and identifies a specific address, as defined by postal services.
»» CreditorAgent object false none Financial institution servicing an account for the creditor.
»»» SchemeName string false none Name of the identification scheme, in a coded form as published in an external list.
»»» Identification string false none Unique and unambiguous identification of a financial institution or a branch of a financial institution.
»»» Name string false none Name by which an agent is known and which is usually used to identify that agent.
»»» PostalAddress OBPostalAddress6 false none Information that locates and identifies a specific address, as defined by postal services.
»» CreditorAccount object true none Unambiguous identification of the account of the creditor to which a credit entry will be posted as a result of the payment transaction.
»»» SchemeName OBExternalAccountIdentification4Code true none Name of the identification scheme, in a coded form as published in an external list.
»»» Identification Identification true none Identification assigned by an institution to identify an account. This identification is known by the account owner.
»»» Name string true none The account name is the name or names of the account owner(s) represented at an account level. Note, the account name is not the product name or the nickname of the account. OB: ASPSPs may carry out name validation for Confirmation of Payee, but it is not mandatory.
»»» SecondaryIdentification SecondaryIdentification false none This is secondary identification of the account, as assigned by the account servicing institution. This can be used by building societies to additionally identify accounts with a roll number (in addition to a sort code and account number combination).
»» RemittanceInformation object false none Information supplied to enable the matching of an entry with the items that the transfer is intended to settle, such as commercial invoices in an accounts' receivable system.
»»» Unstructured string false none Information supplied to enable the matching/reconciliation of an entry with the items that the payment is intended to settle, such as commercial invoices in an accounts' receivable system, in an unstructured form.
»»» Reference string false none Unique reference, as assigned by the creditor, to unambiguously refer to the payment transaction. Usage: If available, the initiating party should provide this reference in the structured remittance information, to enable reconciliation by the creditor upon receipt of the amount of money. If the business context requires the use of a creditor reference or a payment remit identification, and only one identifier can be passed through the end-to-end chain, the creditor's reference or payment remittance identification should be quoted in the end-to-end transaction identification. OB: The Faster Payments Scheme can only accept 18 characters for the ReferenceInformation field - which is where this ISO field will be mapped.
»» SupplementaryData OBSupplementaryData1 false none Additional information that can not be captured in the structured fields and/or any other specific block.
» Risk OBRisk1 true none The Risk section is sent by the initiating party to the ASPSP. It is used to specify additional details for risk scoring for Payments.

Enumerated Values

Property Value
InstructionPriority Normal
InstructionPriority Urgent
RateType Actual
RateType Agreed
RateType Indicative

OBWriteInternationalScheduledConsent3

{
  "Data": {
    "Permission": "Create",
    "Initiation": {
      "InstructionIdentification": "string",
      "EndToEndIdentification": "string",
      "LocalInstrument": "string",
      "InstructionPriority": "Normal",
      "Purpose": "string",
      "ChargeBearer": "BorneByCreditor",
      "RequestedExecutionDateTime": "2020-10-23T10:23:58Z",
      "CurrencyOfTransfer": "string",
      "InstructedAmount": {
        "Amount": "string",
        "Currency": "string"
      },
      "ExchangeRateInformation": {
        "UnitCurrency": "string",
        "ExchangeRate": 0,
        "RateType": "Actual",
        "ContractIdentification": "string"
      },
      "DebtorAccount": {
        "SchemeName": "string",
        "Identification": "string",
        "Name": "string",
        "SecondaryIdentification": "string"
      },
      "Creditor": {
        "Name": "string",
        "PostalAddress": {
          "AddressType": "Business",
          "Department": "string",
          "SubDepartment": "string",
          "StreetName": "string",
          "BuildingNumber": "string",
          "PostCode": "string",
          "TownName": "string",
          "CountrySubDivision": "string",
          "Country": "string",
          "AddressLine": [
            "string"
          ]
        }
      },
      "CreditorAgent": {
        "SchemeName": "string",
        "Identification": "string",
        "Name": "string",
        "PostalAddress": {
          "AddressType": "Business",
          "Department": "string",
          "SubDepartment": "string",
          "StreetName": "string",
          "BuildingNumber": "string",
          "PostCode": "string",
          "TownName": "string",
          "CountrySubDivision": "string",
          "Country": "string",
          "AddressLine": [
            "string"
          ]
        }
      },
      "CreditorAccount": {
        "SchemeName": "string",
        "Identification": "string",
        "Name": "string",
        "SecondaryIdentification": "string"
      },
      "RemittanceInformation": {
        "Unstructured": "string",
        "Reference": "string"
      },
      "SupplementaryData": {}
    },
    "Authorisation": {
      "AuthorisationType": "Any",
      "CompletionDateTime": "2020-10-23T10:23:58Z"
    },
    "SCASupportData": {
      "RequestedSCAExemptionType": "BillPayment",
      "AppliedAuthenticationApproach": "CA",
      "ReferencePaymentOrderId": "string"
    }
  },
  "Risk": {
    "PaymentContextCode": "BillPayment",
    "MerchantCategoryCode": "stri",
    "MerchantCustomerIdentification": "string",
    "DeliveryAddress": {
      "AddressLine": [
        "string"
      ],
      "StreetName": "string",
      "BuildingNumber": "string",
      "PostCode": "string",
      "TownName": "string",
      "CountrySubDivision": [
        "string"
      ],
      "Country": "string"
    }
  }
}

Properties

Name Type Required Restrictions Description
Data object true none none
» Permission string true none Specifies the Open Banking service request types.
» Initiation object true none The Initiation payload is sent by the initiating party to the ASPSP. It is used to request movement of funds from the debtor account to a creditor for a single scheduled international payment.
»» InstructionIdentification string true none Unique identification as assigned by an instructing party for an instructed party to unambiguously identify the instruction. Usage: the instruction identification is a point to point reference that can be used between the instructing party and the instructed party to refer to the individual instruction. It can be included in several messages related to the instruction.
»» EndToEndIdentification string false none Unique identification assigned by the initiating party to unambiguously identify the transaction. This identification is passed on, unchanged, throughout the entire end-to-end chain. Usage: The end-to-end identification can be used for reconciliation or to link tasks relating to the transaction. It can be included in several messages related to the transaction. OB: The Faster Payments Scheme can only access 31 characters for the EndToEndIdentification field.
»» LocalInstrument OBExternalLocalInstrument1Code false none User community specific instrument. Usage: This element is used to specify a local instrument, local clearing option and/or further qualify the service or service level.
»» InstructionPriority string false none Indicator of the urgency or order of importance that the instructing party would like the instructed party to apply to the processing of the instruction.
»» Purpose string false none Specifies the external purpose code in the format of character string with a maximum length of 4 characters. The list of valid codes is an external code list published separately. External code sets can be downloaded from www.iso20022.org.
»» ChargeBearer OBChargeBearerType1Code false none Specifies which party/parties will bear the charges associated with the processing of the payment transaction.
»» RequestedExecutionDateTime string(date-time) true none Date at which the initiating party requests the clearing agent to process the payment. Usage: This is the date on which the debtor's account is to be debited.All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00
»» CurrencyOfTransfer string true none Specifies the currency of the to be transferred amount, which is different from the currency of the debtor's account.
»» InstructedAmount object true none Amount of money to be moved between the debtor and creditor, before deduction of charges, expressed in the currency as ordered by the initiating party. Usage: This amount has to be transported unchanged through the transaction chain.
»»» Amount OBActiveCurrencyAndAmount_SimpleType true none A number of monetary units specified in an active currency where the unit of currency is explicit and compliant with ISO 4217.
»»» Currency ActiveOrHistoricCurrencyCode true none A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 "Codes for the representation of currencies and funds".
»» ExchangeRateInformation object false none Provides details on the currency exchange rate and contract.
»»» UnitCurrency string true none Currency in which the rate of exchange is expressed in a currency exchange. In the example 1GBP = xxxCUR, the unit currency is GBP.
»»» ExchangeRate number false none The factor used for conversion of an amount from one currency to another. This reflects the price at which one currency was bought with another currency.
»»» RateType string true none Specifies the type used to complete the currency exchange.
»»» ContractIdentification string false none Unique and unambiguous reference to the foreign exchange contract agreed between the initiating party/creditor and the debtor agent.
»» DebtorAccount object false none Unambiguous identification of the account of the debtor to which a debit entry will be made as a result of the transaction.
»»» SchemeName OBExternalAccountIdentification4Code true none Name of the identification scheme, in a coded form as published in an external list.
»»» Identification Identification true none Identification assigned by an institution to identify an account. This identification is known by the account owner.
»»» Name string false none The account name is the name or names of the account owner(s) represented at an account level, as displayed by the ASPSP's online channels. Note, the account name is not the product name or the nickname of the account.
»»» SecondaryIdentification SecondaryIdentification false none This is secondary identification of the account, as assigned by the account servicing institution. This can be used by building societies to additionally identify accounts with a roll number (in addition to a sort code and account number combination).
»» Creditor object false none Party to which an amount of money is due.
»»» Name string false none Name by which a party is known and which is usually used to identify that party.
»»» PostalAddress OBPostalAddress6 false none Information that locates and identifies a specific address, as defined by postal services.
»» CreditorAgent object false none Financial institution servicing an account for the creditor.
»»» SchemeName string false none Name of the identification scheme, in a coded form as published in an external list.
»»» Identification string false none Unique and unambiguous identification of a financial institution or a branch of a financial institution.
»»» Name string false none Name by which an agent is known and which is usually used to identify that agent.
»»» PostalAddress OBPostalAddress6 false none Information that locates and identifies a specific address, as defined by postal services.
»» CreditorAccount object true none Unambiguous identification of the account of the creditor to which a credit entry will be posted as a result of the payment transaction.
»»» SchemeName OBExternalAccountIdentification4Code true none Name of the identification scheme, in a coded form as published in an external list.
»»» Identification Identification true none Identification assigned by an institution to identify an account. This identification is known by the account owner.
»»» Name string true none The account name is the name or names of the account owner(s) represented at an account level. Note, the account name is not the product name or the nickname of the account. OB: ASPSPs may carry out name validation for Confirmation of Payee, but it is not mandatory.
»»» SecondaryIdentification SecondaryIdentification false none This is secondary identification of the account, as assigned by the account servicing institution. This can be used by building societies to additionally identify accounts with a roll number (in addition to a sort code and account number combination).
»» RemittanceInformation object false none Information supplied to enable the matching of an entry with the items that the transfer is intended to settle, such as commercial invoices in an accounts' receivable system.
»»» Unstructured string false none Information supplied to enable the matching/reconciliation of an entry with the items that the payment is intended to settle, such as commercial invoices in an accounts' receivable system, in an unstructured form.
»»» Reference string false none Unique reference, as assigned by the creditor, to unambiguously refer to the payment transaction. Usage: If available, the initiating party should provide this reference in the structured remittance information, to enable reconciliation by the creditor upon receipt of the amount of money. If the business context requires the use of a creditor reference or a payment remit identification, and only one identifier can be passed through the end-to-end chain, the creditor's reference or payment remittance identification should be quoted in the end-to-end transaction identification. OB: The Faster Payments Scheme can only accept 18 characters for the ReferenceInformation field - which is where this ISO field will be mapped.
»» SupplementaryData OBSupplementaryData1 false none Additional information that can not be captured in the structured fields and/or any other specific block.
» Authorisation object false none The authorisation type request from the TPP.
»» AuthorisationType string true none Type of authorisation flow requested.
»» CompletionDateTime string(date-time) false none Date and time at which the requested authorisation flow must be completed.All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00
» SCASupportData object false none Supporting Data provided by TPP, when requesting SCA Exemption.
»» RequestedSCAExemptionType string false none This field allows a PISP to request specific SCA Exemption for a Payment Initiation
»» AppliedAuthenticationApproach string false none Specifies a character string with a maximum length of 40 characters. Usage: This field indicates whether the PSU was subject to SCA performed by the TPP
»» ReferencePaymentOrderId string false none Specifies a character string with a maximum length of 140 characters. Usage: If the payment is recurring then the transaction identifier of the previous payment occurrence so that the ASPSP can verify that the PISP, amount and the payee are the same as the previous occurrence.
» Risk OBRisk1 true none The Risk section is sent by the initiating party to the ASPSP. It is used to specify additional details for risk scoring for Payments.

Enumerated Values

Property Value
Permission Create
InstructionPriority Normal
InstructionPriority Urgent
RateType Actual
RateType Agreed
RateType Indicative
AuthorisationType Any
AuthorisationType Single
RequestedSCAExemptionType BillPayment
RequestedSCAExemptionType ContactlessTravel
RequestedSCAExemptionType EcommerceGoods
RequestedSCAExemptionType EcommerceServices
RequestedSCAExemptionType Kiosk
RequestedSCAExemptionType Parking
RequestedSCAExemptionType PartyToParty
AppliedAuthenticationApproach CA
AppliedAuthenticationApproach SCA

OBWriteInternationalScheduledConsentResponse3

{
  "Data": {
    "ConsentId": "string",
    "CreationDateTime": "2020-10-23T10:23:58Z",
    "Status": "Authorised",
    "StatusUpdateDateTime": "2020-10-23T10:23:58Z",
    "Permission": "Create",
    "CutOffDateTime": "2020-10-23T10:23:58Z",
    "ExpectedExecutionDateTime": "2020-10-23T10:23:58Z",
    "ExpectedSettlementDateTime": "2020-10-23T10:23:58Z",
    "Charges": [
      {
        "ChargeBearer": "BorneByCreditor",
        "Type": "string",
        "Amount": {
          "Amount": "string",
          "Currency": "string"
        }
      }
    ],
    "ExchangeRateInformation": {
      "UnitCurrency": "string",
      "ExchangeRate": 0,
      "RateType": "Actual",
      "ContractIdentification": "string",
      "ExpirationDateTime": "2020-10-23T10:23:58Z"
    },
    "Initiation": {
      "InstructionIdentification": "string",
      "EndToEndIdentification": "string",
      "LocalInstrument": "string",
      "InstructionPriority": "Normal",
      "Purpose": "string",
      "ChargeBearer": "BorneByCreditor",
      "RequestedExecutionDateTime": "2020-10-23T10:23:58Z",
      "CurrencyOfTransfer": "string",
      "InstructedAmount": {
        "Amount": "string",
        "Currency": "string"
      },
      "ExchangeRateInformation": {
        "UnitCurrency": "string",
        "ExchangeRate": 0,
        "RateType": "Actual",
        "ContractIdentification": "string"
      },
      "DebtorAccount": {
        "SchemeName": "string",
        "Identification": "string",
        "Name": "string",
        "SecondaryIdentification": "string"
      },
      "Creditor": {
        "Name": "string",
        "PostalAddress": {
          "AddressType": "Business",
          "Department": "string",
          "SubDepartment": "string",
          "StreetName": "string",
          "BuildingNumber": "string",
          "PostCode": "string",
          "TownName": "string",
          "CountrySubDivision": "string",
          "Country": "string",
          "AddressLine": [
            "string"
          ]
        }
      },
      "CreditorAgent": {
        "SchemeName": "string",
        "Identification": "string",
        "Name": "string",
        "PostalAddress": {
          "AddressType": "Business",
          "Department": "string",
          "SubDepartment": "string",
          "StreetName": "string",
          "BuildingNumber": "string",
          "PostCode": "string",
          "TownName": "string",
          "CountrySubDivision": "string",
          "Country": "string",
          "AddressLine": [
            "string"
          ]
        }
      },
      "CreditorAccount": {
        "SchemeName": "string",
        "Identification": "string",
        "Name": "string",
        "SecondaryIdentification": "string"
      },
      "RemittanceInformation": {
        "Unstructured": "string",
        "Reference": "string"
      },
      "SupplementaryData": {}
    },
    "Authorisation": {
      "AuthorisationType": "Any",
      "CompletionDateTime": "2020-10-23T10:23:58Z"
    },
    "SCASupportData": {
      "RequestedSCAExemptionType": "BillPayment",
      "AppliedAuthenticationApproach": "CA",
      "ReferencePaymentOrderId": "string"
    }
  },
  "Risk": {
    "PaymentContextCode": "BillPayment",
    "MerchantCategoryCode": "stri",
    "MerchantCustomerIdentification": "string",
    "DeliveryAddress": {
      "AddressLine": [
        "string"
      ],
      "StreetName": "string",
      "BuildingNumber": "string",
      "PostCode": "string",
      "TownName": "string",
      "CountrySubDivision": [
        "string"
      ],
      "Country": "string"
    }
  },
  "Links": {
    "Self": "http://example.com",
    "First": "http://example.com",
    "Prev": "http://example.com",
    "Next": "http://example.com",
    "Last": "http://example.com"
  },
  "Meta": {
    "TotalPages": 0,
    "FirstAvailableDateTime": "2020-10-23T10:23:58Z",
    "LastAvailableDateTime": "2020-10-23T10:23:58Z"
  }
}

Properties

Name Type Required Restrictions Description
Data object true none none
» ConsentId string true none OB: Unique identification as assigned by the ASPSP to uniquely identify the consent resource.
» CreationDateTime string(date-time) true none Date and time at which the resource was created.All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00
» Status string true none Specifies the status of consent resource in code form.
» StatusUpdateDateTime string(date-time) true none Date and time at which the resource status was updated.All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00
» Permission string true none Specifies the Open Banking service request types.
» CutOffDateTime string(date-time) false none Specified cut-off date and time for the payment consent.All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00
» ExpectedExecutionDateTime string(date-time) false none Expected execution date and time for the payment resource.All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00
» ExpectedSettlementDateTime string(date-time) false none Expected settlement date and time for the payment resource.All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00
» Charges [object] false none none
»» ChargeBearer OBChargeBearerType1Code true none Specifies which party/parties will bear the charges associated with the processing of the payment transaction.
»» Type OBExternalPaymentChargeType1Code true none Charge type, in a coded form.
»» Amount OBActiveOrHistoricCurrencyAndAmount true none Amount of money associated with the charge type.
» ExchangeRateInformation object false none Further detailed information on the exchange rate that has been used in the payment transaction.
»» UnitCurrency string true none Currency in which the rate of exchange is expressed in a currency exchange. In the example 1GBP = xxxCUR, the unit currency is GBP.
»» ExchangeRate number true none The factor used for conversion of an amount from one currency to another. This reflects the price at which one currency was bought with another currency.
»» RateType string true none Specifies the type used to complete the currency exchange.
»» ContractIdentification string false none Unique and unambiguous reference to the foreign exchange contract agreed between the initiating party/creditor and the debtor agent.
»» ExpirationDateTime string(date-time) false none Specified date and time the exchange rate agreement will expire.All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00
» Initiation object true none The Initiation payload is sent by the initiating party to the ASPSP. It is used to request movement of funds from the debtor account to a creditor for a single scheduled international payment.
»» InstructionIdentification string true none Unique identification as assigned by an instructing party for an instructed party to unambiguously identify the instruction. Usage: the instruction identification is a point to point reference that can be used between the instructing party and the instructed party to refer to the individual instruction. It can be included in several messages related to the instruction.
»» EndToEndIdentification string false none Unique identification assigned by the initiating party to unambiguously identify the transaction. This identification is passed on, unchanged, throughout the entire end-to-end chain. Usage: The end-to-end identification can be used for reconciliation or to link tasks relating to the transaction. It can be included in several messages related to the transaction. OB: The Faster Payments Scheme can only access 31 characters for the EndToEndIdentification field.
»» LocalInstrument OBExternalLocalInstrument1Code false none User community specific instrument. Usage: This element is used to specify a local instrument, local clearing option and/or further qualify the service or service level.
»» InstructionPriority string false none Indicator of the urgency or order of importance that the instructing party would like the instructed party to apply to the processing of the instruction.
»» Purpose string false none Specifies the external purpose code in the format of character string with a maximum length of 4 characters. The list of valid codes is an external code list published separately. External code sets can be downloaded from www.iso20022.org.
»» ChargeBearer OBChargeBearerType1Code false none Specifies which party/parties will bear the charges associated with the processing of the payment transaction.
»» RequestedExecutionDateTime string(date-time) true none Date at which the initiating party requests the clearing agent to process the payment. Usage: This is the date on which the debtor's account is to be debited.All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00
»» CurrencyOfTransfer string true none Specifies the currency of the to be transferred amount, which is different from the currency of the debtor's account.
»» InstructedAmount object true none Amount of money to be moved between the debtor and creditor, before deduction of charges, expressed in the currency as ordered by the initiating party. Usage: This amount has to be transported unchanged through the transaction chain.
»»» Amount OBActiveCurrencyAndAmount_SimpleType true none A number of monetary units specified in an active currency where the unit of currency is explicit and compliant with ISO 4217.
»»» Currency ActiveOrHistoricCurrencyCode true none A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 "Codes for the representation of currencies and funds".
»» ExchangeRateInformation object false none Provides details on the currency exchange rate and contract.
»»» UnitCurrency string true none Currency in which the rate of exchange is expressed in a currency exchange. In the example 1GBP = xxxCUR, the unit currency is GBP.
»»» ExchangeRate number false none The factor used for conversion of an amount from one currency to another. This reflects the price at which one currency was bought with another currency.
»»» RateType string true none Specifies the type used to complete the currency exchange.
»»» ContractIdentification string false none Unique and unambiguous reference to the foreign exchange contract agreed between the initiating party/creditor and the debtor agent.
»» DebtorAccount object false none Unambiguous identification of the account of the debtor to which a debit entry will be made as a result of the transaction.
»»» SchemeName OBExternalAccountIdentification4Code true none Name of the identification scheme, in a coded form as published in an external list.
»»» Identification Identification true none Identification assigned by an institution to identify an account. This identification is known by the account owner.
»»» Name string false none The account name is the name or names of the account owner(s) represented at an account level, as displayed by the ASPSP's online channels. Note, the account name is not the product name or the nickname of the account.
»»» SecondaryIdentification SecondaryIdentification false none This is secondary identification of the account, as assigned by the account servicing institution. This can be used by building societies to additionally identify accounts with a roll number (in addition to a sort code and account number combination).
»» Creditor object false none Party to which an amount of money is due.
»»» Name string false none Name by which a party is known and which is usually used to identify that party.
»»» PostalAddress OBPostalAddress6 false none Information that locates and identifies a specific address, as defined by postal services.
»» CreditorAgent object false none Financial institution servicing an account for the creditor.
»»» SchemeName string false none Name of the identification scheme, in a coded form as published in an external list.
»»» Identification string false none Unique and unambiguous identification of a financial institution or a branch of a financial institution.
»»» Name string false none Name by which an agent is known and which is usually used to identify that agent.
»»» PostalAddress OBPostalAddress6 false none Information that locates and identifies a specific address, as defined by postal services.
»» CreditorAccount object true none Unambiguous identification of the account of the creditor to which a credit entry will be posted as a result of the payment transaction.
»»» SchemeName OBExternalAccountIdentification4Code true none Name of the identification scheme, in a coded form as published in an external list.
»»» Identification Identification true none Identification assigned by an institution to identify an account. This identification is known by the account owner.
»»» Name string true none The account name is the name or names of the account owner(s) represented at an account level. Note, the account name is not the product name or the nickname of the account. OB: ASPSPs may carry out name validation for Confirmation of Payee, but it is not mandatory.
»»» SecondaryIdentification SecondaryIdentification false none This is secondary identification of the account, as assigned by the account servicing institution. This can be used by building societies to additionally identify accounts with a roll number (in addition to a sort code and account number combination).
»» RemittanceInformation object false none Information supplied to enable the matching of an entry with the items that the transfer is intended to settle, such as commercial invoices in an accounts' receivable system.
»»» Unstructured string false none Information supplied to enable the matching/reconciliation of an entry with the items that the payment is intended to settle, such as commercial invoices in an accounts' receivable system, in an unstructured form.
»»» Reference string false none Unique reference, as assigned by the creditor, to unambiguously refer to the payment transaction. Usage: If available, the initiating party should provide this reference in the structured remittance information, to enable reconciliation by the creditor upon receipt of the amount of money. If the business context requires the use of a creditor reference or a payment remit identification, and only one identifier can be passed through the end-to-end chain, the creditor's reference or payment remittance identification should be quoted in the end-to-end transaction identification. OB: The Faster Payments Scheme can only accept 18 characters for the ReferenceInformation field - which is where this ISO field will be mapped.
»» SupplementaryData OBSupplementaryData1 false none Additional information that can not be captured in the structured fields and/or any other specific block.
» Authorisation object false none The authorisation type request from the TPP.
»» AuthorisationType string true none Type of authorisation flow requested.
»» CompletionDateTime string(date-time) false none Date and time at which the requested authorisation flow must be completed.All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00
» SCASupportData object false none Supporting Data provided by TPP, when requesting SCA Exemption.
»» RequestedSCAExemptionType string false none This field allows a PISP to request specific SCA Exemption for a Payment Initiation
»» AppliedAuthenticationApproach string false none Specifies a character string with a maximum length of 40 characters. Usage: This field indicates whether the PSU was subject to SCA performed by the TPP
»» ReferencePaymentOrderId string false none Specifies a character string with a maximum length of 140 characters. Usage: If the payment is recurring then the transaction identifier of the previous payment occurrence so that the ASPSP can verify that the PISP, amount and the payee are the same as the previous occurrence.
» Risk OBRisk1 true none The Risk section is sent by the initiating party to the ASPSP. It is used to specify additional details for risk scoring for Payments.
» Links Links false none Links relevant to the payload
» Meta Meta false none Meta Data relevant to the payload

Enumerated Values

Property Value
Status Authorised
Status AwaitingAuthorisation
Status Consumed
Status Rejected
Permission Create
RateType Actual
RateType Agreed
RateType Indicative
InstructionPriority Normal
InstructionPriority Urgent
RateType Actual
RateType Agreed
RateType Indicative
AuthorisationType Any
AuthorisationType Single
RequestedSCAExemptionType BillPayment
RequestedSCAExemptionType ContactlessTravel
RequestedSCAExemptionType EcommerceGoods
RequestedSCAExemptionType EcommerceServices
RequestedSCAExemptionType Kiosk
RequestedSCAExemptionType Parking
RequestedSCAExemptionType PartyToParty
AppliedAuthenticationApproach CA
AppliedAuthenticationApproach SCA

OBWriteInternationalScheduledResponse3

{
  "Data": {
    "InternationalScheduledPaymentId": "string",
    "ConsentId": "string",
    "CreationDateTime": "2020-10-23T10:23:58Z",
    "Status": "Cancelled",
    "StatusUpdateDateTime": "2020-10-23T10:23:58Z",
    "ExpectedExecutionDateTime": "2020-10-23T10:23:58Z",
    "ExpectedSettlementDateTime": "2020-10-23T10:23:58Z",
    "Charges": [
      {
        "ChargeBearer": "BorneByCreditor",
        "Type": "string",
        "Amount": {
          "Amount": "string",
          "Currency": "string"
        }
      }
    ],
    "ExchangeRateInformation": {
      "UnitCurrency": "string",
      "ExchangeRate": 0,
      "RateType": "Actual",
      "ContractIdentification": "string",
      "ExpirationDateTime": "2020-10-23T10:23:58Z"
    },
    "Initiation": {
      "InstructionIdentification": "string",
      "EndToEndIdentification": "string",
      "LocalInstrument": "string",
      "InstructionPriority": "Normal",
      "Purpose": "string",
      "ChargeBearer": "BorneByCreditor",
      "RequestedExecutionDateTime": "2020-10-23T10:23:58Z",
      "CurrencyOfTransfer": "string",
      "InstructedAmount": {
        "Amount": "string",
        "Currency": "string"
      },
      "ExchangeRateInformation": {
        "UnitCurrency": "string",
        "ExchangeRate": 0,
        "RateType": "Actual",
        "ContractIdentification": "string"
      },
      "DebtorAccount": {
        "SchemeName": "string",
        "Identification": "string",
        "Name": "string",
        "SecondaryIdentification": "string"
      },
      "Creditor": {
        "Name": "string",
        "PostalAddress": {
          "AddressType": "Business",
          "Department": "string",
          "SubDepartment": "string",
          "StreetName": "string",
          "BuildingNumber": "string",
          "PostCode": "string",
          "TownName": "string",
          "CountrySubDivision": "string",
          "Country": "string",
          "AddressLine": [
            "string"
          ]
        }
      },
      "CreditorAgent": {
        "SchemeName": "string",
        "Identification": "string",
        "Name": "string",
        "PostalAddress": {
          "AddressType": "Business",
          "Department": "string",
          "SubDepartment": "string",
          "StreetName": "string",
          "BuildingNumber": "string",
          "PostCode": "string",
          "TownName": "string",
          "CountrySubDivision": "string",
          "Country": "string",
          "AddressLine": [
            "string"
          ]
        }
      },
      "CreditorAccount": {
        "SchemeName": "string",
        "Identification": "string",
        "Name": "string",
        "SecondaryIdentification": "string"
      },
      "RemittanceInformation": {
        "Unstructured": "string",
        "Reference": "string"
      },
      "SupplementaryData": {}
    },
    "MultiAuthorisation": {
      "Status": "Authorised",
      "NumberRequired": 0,
      "NumberReceived": 0,
      "LastUpdateDateTime": "2020-10-23T10:23:58Z",
      "ExpirationDateTime": "2020-10-23T10:23:58Z"
    }
  },
  "Links": {
    "Self": "http://example.com",
    "First": "http://example.com",
    "Prev": "http://example.com",
    "Next": "http://example.com",
    "Last": "http://example.com"
  },
  "Meta": {
    "TotalPages": 0,
    "FirstAvailableDateTime": "2020-10-23T10:23:58Z",
    "LastAvailableDateTime": "2020-10-23T10:23:58Z"
  }
}

Properties

Name Type Required Restrictions Description
Data object true none none
» InternationalScheduledPaymentId string true none OB: Unique identification as assigned by the ASPSP to uniquely identify the international scheduled payment resource.
» ConsentId string true none OB: Unique identification as assigned by the ASPSP to uniquely identify the consent resource.
» CreationDateTime string(date-time) true none Date and time at which the message was created.All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00
» Status string true none Specifies the status of the payment order resource.
» StatusUpdateDateTime string(date-time) true none Date and time at which the resource status was updated.All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00
» ExpectedExecutionDateTime string(date-time) false none Expected execution date and time for the payment resource.All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00
» ExpectedSettlementDateTime string(date-time) false none Expected settlement date and time for the payment resource.All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00
» Charges [object] false none none
»» ChargeBearer OBChargeBearerType1Code true none Specifies which party/parties will bear the charges associated with the processing of the payment transaction.
»» Type OBExternalPaymentChargeType1Code true none Charge type, in a coded form.
»» Amount OBActiveOrHistoricCurrencyAndAmount true none Amount of money associated with the charge type.
» ExchangeRateInformation object false none Further detailed information on the exchange rate that has been used in the payment transaction.
»» UnitCurrency string true none Currency in which the rate of exchange is expressed in a currency exchange. In the example 1GBP = xxxCUR, the unit currency is GBP.
»» ExchangeRate number true none The factor used for conversion of an amount from one currency to another. This reflects the price at which one currency was bought with another currency.
»» RateType string true none Specifies the type used to complete the currency exchange.
»» ContractIdentification string false none Unique and unambiguous reference to the foreign exchange contract agreed between the initiating party/creditor and the debtor agent.
»» ExpirationDateTime string(date-time) false none Specified date and time the exchange rate agreement will expire.All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00
» Initiation object true none The Initiation payload is sent by the initiating party to the ASPSP. It is used to request movement of funds from the debtor account to a creditor for a single scheduled international payment.
»» InstructionIdentification string true none Unique identification as assigned by an instructing party for an instructed party to unambiguously identify the instruction. Usage: the instruction identification is a point to point reference that can be used between the instructing party and the instructed party to refer to the individual instruction. It can be included in several messages related to the instruction.
»» EndToEndIdentification string false none Unique identification assigned by the initiating party to unambiguously identify the transaction. This identification is passed on, unchanged, throughout the entire end-to-end chain. Usage: The end-to-end identification can be used for reconciliation or to link tasks relating to the transaction. It can be included in several messages related to the transaction. OB: The Faster Payments Scheme can only access 31 characters for the EndToEndIdentification field.
»» LocalInstrument OBExternalLocalInstrument1Code false none User community specific instrument. Usage: This element is used to specify a local instrument, local clearing option and/or further qualify the service or service level.
»» InstructionPriority string false none Indicator of the urgency or order of importance that the instructing party would like the instructed party to apply to the processing of the instruction.
»» Purpose string false none Specifies the external purpose code in the format of character string with a maximum length of 4 characters. The list of valid codes is an external code list published separately. External code sets can be downloaded from www.iso20022.org.
»» ChargeBearer OBChargeBearerType1Code false none Specifies which party/parties will bear the charges associated with the processing of the payment transaction.
»» RequestedExecutionDateTime string(date-time) true none Date at which the initiating party requests the clearing agent to process the payment. Usage: This is the date on which the debtor's account is to be debited.All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00
»» CurrencyOfTransfer string true none Specifies the currency of the to be transferred amount, which is different from the currency of the debtor's account.
»» InstructedAmount object true none Amount of money to be moved between the debtor and creditor, before deduction of charges, expressed in the currency as ordered by the initiating party. Usage: This amount has to be transported unchanged through the transaction chain.
»»» Amount OBActiveCurrencyAndAmount_SimpleType true none A number of monetary units specified in an active currency where the unit of currency is explicit and compliant with ISO 4217.
»»» Currency ActiveOrHistoricCurrencyCode true none A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 "Codes for the representation of currencies and funds".
»» ExchangeRateInformation object false none Provides details on the currency exchange rate and contract.
»»» UnitCurrency string true none Currency in which the rate of exchange is expressed in a currency exchange. In the example 1GBP = xxxCUR, the unit currency is GBP.
»»» ExchangeRate number false none The factor used for conversion of an amount from one currency to another. This reflects the price at which one currency was bought with another currency.
»»» RateType string true none Specifies the type used to complete the currency exchange.
»»» ContractIdentification string false none Unique and unambiguous reference to the foreign exchange contract agreed between the initiating party/creditor and the debtor agent.
»» DebtorAccount object false none Unambiguous identification of the account of the debtor to which a debit entry will be made as a result of the transaction.
»»» SchemeName OBExternalAccountIdentification4Code true none Name of the identification scheme, in a coded form as published in an external list.
»»» Identification Identification true none Identification assigned by an institution to identify an account. This identification is known by the account owner.
»»» Name string false none The account name is the name or names of the account owner(s) represented at an account level, as displayed by the ASPSP's online channels. Note, the account name is not the product name or the nickname of the account.
»»» SecondaryIdentification SecondaryIdentification false none This is secondary identification of the account, as assigned by the account servicing institution. This can be used by building societies to additionally identify accounts with a roll number (in addition to a sort code and account number combination).
»» Creditor object false none Party to which an amount of money is due.
»»» Name string false none Name by which a party is known and which is usually used to identify that party.
»»» PostalAddress OBPostalAddress6 false none Information that locates and identifies a specific address, as defined by postal services.
»» CreditorAgent object false none Financial institution servicing an account for the creditor.
»»» SchemeName string false none Name of the identification scheme, in a coded form as published in an external list.
»»» Identification string false none Unique and unambiguous identification of a financial institution or a branch of a financial institution.
»»» Name string false none Name by which an agent is known and which is usually used to identify that agent.
»»» PostalAddress OBPostalAddress6 false none Information that locates and identifies a specific address, as defined by postal services.
»» CreditorAccount object true none Unambiguous identification of the account of the creditor to which a credit entry will be posted as a result of the payment transaction.
»»» SchemeName OBExternalAccountIdentificat