International scheduled payments

Page contents

Endpoint config
API calls
Models

What this API does:

These APIs currently supports SWIFT and SEPA Payments.

These APIs currently supports Indicative rate type.

This API lets you initiate a single scheduled international payment and submit payment requests. It also lets you check the payment status and confirm funds.

Endpoint configuration

POST /international-scheduled-payment-consents

Sandbox: cb.sandbox-api-nc.cybservices.co.uk/open-banking/v3.1/pisp/international-scheduled-payment-consents

Production: api.openbanking.virginmoney.com/open-banking/v3.1/pisp//international-scheduled-payment-consents

The API endpoint lets you ask Virgin Money to create a new international scheduled payment consent resource:

The POST action tells Virgin Money that a international scheduled payment consent has been staged. At this point, it does not identify the customer to Virgin Money; the request payload may not contain information about the account to be debited
The endpoint lets you send a copy of the consent between the customer and you to Virgin Money for the customer to authorise

Virgin Money will create a international scheduled payment consent resource and provide a unique ConsentId for the resource.

Before calling the API, you must have an access token issued by Virgin Money using 'Client Credentials' grant.

GET /international-scheduled-payment-consents/{ConsentId}

Sandbox: cb.sandbox-api-nc.cybservices.co.uk/open-banking/v3.1/pisp/international-scheduled-payment-consents/{ConsentId}

Production: api.openbanking.virginmoney.com/open-banking/v3.1/pisp/international-scheduled-payment-consents/{ConsentId}

Once the customer has authorized the international payment consent, you can submit the payment for processing:

This request instructs Virgin Money to begin the payment journey. Virgin Money will normally execute the payment request immediately, but this may not always be possible, for example, during busy periods
You must ensure the Initiation and Risk sections of the payment match the corresponding sections of the payment consent resource. Any discrepancy will generate an error response and we will not process the request

Check the status of the payment consent.

Before calling the API, you must have an access token issued by Virgin Money using 'Client Credentials' grant.

POST /international-scheduled-payments

Sandbox: cb.sandbox-api-nc.cybservices.co.uk/open-banking/v3.1/pisp/international-scheduled-payments

Production: api.openbanking.virginmoney.com/open-banking/v3.1/pisp/international-scheduled-payments

Once the customer has authorized the international scheduled-payment consent, you can submit the payment for processing:

This request instructs Virgin Money to begin the payment journey. Virgin Money will normally schedule the payment request immediately, but this may not always be possible, for example, during busy periods or if additional approvals are required.
You must ensure the Initiation and Risk sections of the payment match the corresponding sections of the payment consent resource. Any discrepancy will generate an error response and we will not process the request

Before calling the API, you must have an access token issued by Virgin Money using 'Authorization Code' grant.

If rate type is’ Indicative’, on date of scheduled payment, user need to login to bank website to accept the exchange rate before the payment can be executed.

GET /international-scheduled-payments/{InternationalPaymentId}

Sandbox: cb.sandbox-api-nc.cybservices.co.uk/open-banking/v3.1/pisp/international-scheduled-payments/{InternationalPaymentId}

Production: api.openbanking.virginmoney.com/open-banking/v3.1/pisp/international-scheduled-payments/{InternationalPaymentId}

Check the status of the payment.

Before calling the API, you must have an access token issued by Virgin Money using 'Client Credentials' grant.

API calls

POST /open-banking/v3.1/pisp/international-scheduled-payment-consents Create International Scheduled Payment Consents

Name Description

OBWriteInternationalScheduledConsent3Param *

(body)

Default

Example Value Model

{
  "Data": {
    "Permission": "Create",
    "Initiation": {
      "InstructionIdentification": "string",
      "EndToEndIdentification": "string",
      "LocalInstrument": "string",
      "ChargeBearer": "BorneByCreditor",
      "RequestedExecutionDateTime": "2024-06-19T11:55:23.381Z",
      "CurrencyOfTransfer": "string",
      "InstructedAmount": {
        "Amount": "string",
        "Currency": "string"
      },
      "ExchangeRateInformation": {
        "UnitCurrency": "string",
        "ExchangeRate": 0,
        "RateType": "Actual",
        "ContractIdentification": "string"
      },
      "DebtorAccount": {
        "SchemeName": "string",
        "Identification": "string",
        "Name": "string"
      },
      "Creditor": {
        "Name": "string",
        "PostalAddress": {
          "AddressType": "Business",
          "PostCode": "string",
          "TownName": "string",
          "Country": "string",
          "AddressLine": [
            "string"
          ]
        }
      },
      "CreditorAgent": {
        "SchemeName": "string",
        "Identification": "string",
        "Name": "string",
        "PostalAddress": {
          "AddressType": "Business",
          "PostCode": "string",
          "TownName": "string",
          "Country": "string",
          "AddressLine": [
            "string"
          ]
        }
      },
      "CreditorAccount": {
        "SchemeName": "string",
        "Identification": "string",
        "Name": "string"
      },
      "RemittanceInformation": {
        "Unstructured": "string",
        "Reference": "string"
      }
    }
  },
  "Risk": {
    "PaymentContextCode": "BillPayment",
    "MerchantCategoryCode": "string",
    "MerchantCustomerIdentification": "string",
    "DeliveryAddress": {
      "AddressLine": [
        "string"
      ],
      "BuildingNumber": "string",
      "PostCode": "string",
      "TownName": "string",
      "CountrySubDivision": [
        "string"
      ],
      "Country": "string"
    }
  }
}

Parameter content type

#/definitions/OBWriteInternationalScheduledConsent3OBWriteInternationalScheduledConsent3{

Data*

{

Permission*

string

Specifies the Open Banking service request types.

Enum:
[ Create ]

Initiation*

{

description:

The Initiation payload is sent by the initiating party to the ASPSP. It is used to request movement of funds from the debtor account to a creditor for a single scheduled international payment.

InstructionIdentification*

string
minLength: 1
maxLength: 35

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
minLength: 1
maxLength: 35

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

OBExternalLocalInstrument1Codestring

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.

ChargeBearer

OBChargeBearerType1Codestring

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

Enum:
[ BorneByCreditor, BorneByDebtor, FollowingServiceLevel, Shared ]

RequestedExecutionDateTime*

string($date-time)

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
pattern: ^[A-Z]{3,3}$

Specifies the currency of the to be transferred amount, which is different from the currency of the debtor's account.

InstructedAmount*

{

description:	Amount of money to be moved between the debtor and creditor, before deduction of charges, expressed in the currency as ordered by the initiating party. Usage: This amount has to be transported unchanged through the transaction chain.
Amount*	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.
Currency*	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".

}

ExchangeRateInformation

{

description:	Provides details on the currency exchange rate and contract.
UnitCurrency*	`string` pattern: ^[A-Z]{3,3}$ 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 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` Specifies the type used to complete the currency exchange. Enum: [ Actual, Agreed, Indicative ]
ContractIdentification	`string` minLength: 1 maxLength: 256 Unique and unambiguous reference to the foreign exchange contract agreed between the initiating party/creditor and the debtor agent.

}

DebtorAccount

{

description:	Unambiguous identification of the account of the debtor to which a debit entry will be made as a result of the transaction.
SchemeName*	OBExternalAccountIdentification4Code`string` Name of the identification scheme, in a coded form as published in an external list.
Identification*	Identification`string` Identification assigned by an institution to identify an account. This identification is known by the account owner.
Name	`string` minLength: 1 maxLength: 70 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.

}

Creditor

{

description:

Party to which an amount of money is due.

Name

string
minLength: 1
maxLength: 140

Name by which a party is known and which is usually used to identify that party.

PostalAddress

#/definitions/OBPostalAddress6OBPostalAddress6{

description:	Information that locates and identifies a specific address, as defined by postal services.
AddressType	OBAddressTypeCode`string` Identifies the nature of the postal address. Enum: [ Business, Correspondence, DeliveryTo, MailTo, POBox, Postal, Residential, Statement ]
PostCode	PostCode`string` 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`string` Name of a built-up area, with defined boundaries, and a local government.
Country	`string` pattern: ^[A-Z]{2,2}$ Nation with its own government.
AddressLine	[ minItems: 0 maxItems: 2 `string` minLength: 1 maxLength: 70 Information that locates and identifies a specific address, as defined by postal services, presented in free format text. ]

}

CreditorAgent

{

description:

Financial institution servicing an account for the creditor.

SchemeName

string

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

Identification

string
minLength: 1
maxLength: 35

Unique and unambiguous identification of a financial institution or a branch of a financial institution.

Name

string
minLength: 1
maxLength: 140

Name by which an agent is known and which is usually used to identify that agent.

PostalAddress

#/definitions/OBPostalAddress6OBPostalAddress6{

description:	Information that locates and identifies a specific address, as defined by postal services.
AddressType	OBAddressTypeCode`string` Identifies the nature of the postal address. Enum: [ Business, Correspondence, DeliveryTo, MailTo, POBox, Postal, Residential, Statement ]
PostCode	PostCode`string` 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`string` Name of a built-up area, with defined boundaries, and a local government.
Country	`string` pattern: ^[A-Z]{2,2}$ Nation with its own government.
AddressLine	[ minItems: 0 maxItems: 2 `string` minLength: 1 maxLength: 70 Information that locates and identifies a specific address, as defined by postal services, presented in free format text. ]

}

CreditorAccount*

{

description:	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`string` Name of the identification scheme, in a coded form as published in an external list.
Identification*	Identification`string` Identification assigned by an institution to identify an account. This identification is known by the account owner.
Name*	`string` minLength: 1 maxLength: 70 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.

}

RemittanceInformation

{

description:	Information supplied to enable the matching of an entry with the items that the transfer is intended to settle, such as commercial invoices in an accounts' receivable system.
Unstructured	`string` minLength: 1 maxLength: 140 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` minLength: 1 maxLength: 35 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.

}

Risk*

#/definitions/OBRisk1OBRisk1{

description:

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

PaymentContextCode

string

Specifies the payment context

Enum:
[ BillPayment, EcommerceGoods, EcommerceServices, Other, PartyToParty ]

MerchantCategoryCode

string
minLength: 3
maxLength: 4

Category code conform to ISO 18245, related to the type of services or goods the merchant provides for the transaction.

MerchantCustomerIdentification

string
minLength: 1
maxLength: 70

The unique customer identifier of the PSU with the merchant.

DeliveryAddress

{

description:	Information that locates and identifies a specific address, as defined by postal services or in free format text.
AddressLine	[ minItems: 0 maxItems: 2 `string` minLength: 1 maxLength: 70 Information that locates and identifies a specific address, as defined by postal services, that is presented in free format text. ]
BuildingNumber	BuildingNumber`string` Number that identifies the position of a building on a street.
PostCode	PostCode`string` 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`string` Name of a built-up area, with defined boundaries, and a local government.
CountrySubDivision	[ minItems: 0 maxItems: 2 `string` minLength: 1 maxLength: 35 Identifies a subdivision of a country, for instance state, region, county. ]
Country*	`string` pattern: ^[A-Z]{2,2}$ Nation with its own government, occupying a particular territory.

}

x-fapi-auth-date

string

(header)

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

x-fapi-customer-ip-address

string

(header)

The PSU's IP address if the PSU is currently logged in with the TPP.

x-fapi-interaction-id

string

(header)

An RFC4122 UID used as a correlation id.

Authorization *

string

(header)

An Authorisation Token as per https://tools.ietf.org/html/rfc6750 Link opens in a new window

x-idempotency-key *

string

(header)

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

x-jws-signature *

string

(header)

A detached JOSE signature of the body of the payload.

Responses

Response content type

Code Description

201

Created

Example Value Model

{
  "Data": {
    "ConsentId": "string",
    "CreationDateTime": "2024-06-19T12:10:09.634Z",
    "Status": "Authorised",
    "StatusUpdateDateTime": "2024-06-19T12:10:09.634Z",
    "Permission": "Create",
    "ExpectedExecutionDateTime": "2024-06-19T12:10:09.634Z",
    "ExpectedSettlementDateTime": "2024-06-19T12:10:09.634Z",
    "Charges": [
      {
        "ChargeBearer": "BorneByCreditor",
        "Type": "string",
        "Amount": {
          "Amount": "string",
          "Currency": "string"
        }
      }
    ],
    "ExchangeRateInformation": {
      "UnitCurrency": "string",
      "ExchangeRate": 0,
      "RateType": "Actual",
      "ContractIdentification": "string",
      "ExpirationDateTime": "2024-06-19T12:10:09.634Z"
    },
    "Initiation": {
      "InstructionIdentification": "string",
      "EndToEndIdentification": "string",
      "LocalInstrument": "string",
      "ChargeBearer": "BorneByCreditor",
      "RequestedExecutionDateTime": "2024-06-19T12:10:09.634Z",
      "CurrencyOfTransfer": "string",
      "InstructedAmount": {
        "Amount": "string",
        "Currency": "string"
      },
      "ExchangeRateInformation": {
        "UnitCurrency": "string",
        "ExchangeRate": 0,
        "RateType": "Actual",
        "ContractIdentification": "string"
      },
      "DebtorAccount": {
        "SchemeName": "string",
        "Identification": "string",
        "Name": "string"
      },
      "Creditor": {
        "Name": "string",
        "PostalAddress": {
          "AddressType": "Business",
          "PostCode": "string",
          "TownName": "string",
          "Country": "string",
          "AddressLine": [
            "string"
          ]
        }
      },
      "CreditorAgent": {
        "SchemeName": "string",
        "Identification": "string",
        "Name": "string",
        "PostalAddress": {
          "AddressType": "Business",
          "PostCode": "string",
          "TownName": "string",
          "Country": "string",
          "AddressLine": [
            "string"
          ]
        }
      },
      "CreditorAccount": {
        "SchemeName": "string",
        "Identification": "string",
        "Name": "string"
      },
      "RemittanceInformation": {
        "Unstructured": "string",
        "Reference": "string"
      }
    }
  },
  "Risk": {
    "PaymentContextCode": "BillPayment",
    "MerchantCategoryCode": "string",
    "MerchantCustomerIdentification": "string",
    "DeliveryAddress": {
      "AddressLine": [
        "string"
      ],
      "BuildingNumber": "string",
      "PostCode": "string",
      "TownName": "string",
      "CountrySubDivision": [
        "string"
      ],
      "Country": "string"
    }
  },
  "Links": {
    "Self": "string",
    "First": "string",
    "Prev": "string",
    "Next": "string",
    "Last": "string"
  },
  "Meta": {
    "TotalPages": 0,
    "FirstAvailableDateTime": "2024-06-19T12:10:09.634Z",
    "LastAvailableDateTime": "2024-06-19T12:10:09.634Z"
  }
}

#/definitions/OBWriteInternationalScheduledConsentResponse3OBWriteInternationalScheduledConsentResponse3{

Data*

{

ConsentId*

string
minLength: 1
maxLength: 128

OB: Unique identification as assigned by the ASPSP to uniquely identify the consent resource.

CreationDateTime*

string($date-time)

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

Specifies the status of consent resource in code form.

Enum:
[ Authorised, AwaitingAuthorisation, Consumed, Rejected ]

StatusUpdateDateTime*

string($date-time)

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

Specifies the Open Banking service request types.

Enum:
[ Create ]

ExpectedExecutionDateTime

string($date-time)

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)

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

[{

description:

Set of elements used to provide details of a charge for the payment initiation.

ChargeBearer*

OBChargeBearerType1Codestring

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

Enum:
[ BorneByCreditor, BorneByDebtor, FollowingServiceLevel, Shared ]

Type*

OBExternalPaymentChargeType1Codestring

Charge type, in a coded form.

Amount*

#/definitions/OBActiveOrHistoricCurrencyAndAmountOBActiveOrHistoricCurrencyAndAmount{

description:	Amount of money associated with the charge type.
Amount*	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.
Currency*	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".

}

}]

ExchangeRateInformation

{

description:	Further detailed information on the exchange rate that has been used in the payment transaction.
UnitCurrency*	`string` pattern: ^[A-Z]{3,3}$ 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 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` Specifies the type used to complete the currency exchange. Enum: [ Actual, Agreed, Indicative ]
ContractIdentification	`string` minLength: 1 maxLength: 256 Unique and unambiguous reference to the foreign exchange contract agreed between the initiating party/creditor and the debtor agent.
ExpirationDateTime	`string`($date-time) 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*

{

description:

The Initiation payload is sent by the initiating party to the ASPSP. It is used to request movement of funds from the debtor account to a creditor for a single scheduled international payment.

InstructionIdentification*

string
minLength: 1
maxLength: 35

EndToEndIdentification

string
minLength: 1
maxLength: 35

LocalInstrument

OBExternalLocalInstrument1Codestring

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.

ChargeBearer

OBChargeBearerType1Codestring

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

Enum:
[ BorneByCreditor, BorneByDebtor, FollowingServiceLevel, Shared ]

RequestedExecutionDateTime*

string($date-time)

CurrencyOfTransfer*

string
pattern: ^[A-Z]{3,3}$

Specifies the currency of the to be transferred amount, which is different from the currency of the debtor's account.

InstructedAmount*

{

description:	Amount of money to be moved between the debtor and creditor, before deduction of charges, expressed in the currency as ordered by the initiating party. Usage: This amount has to be transported unchanged through the transaction chain.
Amount*	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.
Currency*	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".

}

ExchangeRateInformation

{

description:	Provides details on the currency exchange rate and contract.
UnitCurrency*	`string` pattern: ^[A-Z]{3,3}$ 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 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` Specifies the type used to complete the currency exchange. Enum: [ Actual, Agreed, Indicative ]
ContractIdentification	`string` minLength: 1 maxLength: 256 Unique and unambiguous reference to the foreign exchange contract agreed between the initiating party/creditor and the debtor agent.

}

DebtorAccount

{

description:	Unambiguous identification of the account of the debtor to which a debit entry will be made as a result of the transaction.
SchemeName*	OBExternalAccountIdentification4Code`string` Name of the identification scheme, in a coded form as published in an external list.
Identification*	Identification`string` Identification assigned by an institution to identify an account. This identification is known by the account owner.
Name	`string` minLength: 1 maxLength: 70 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.

}

Creditor

{

description:

Party to which an amount of money is due.

Name

string
minLength: 1
maxLength: 140

Name by which a party is known and which is usually used to identify that party.

PostalAddress

#/definitions/OBPostalAddress6OBPostalAddress6{

description:	Information that locates and identifies a specific address, as defined by postal services.
AddressType	OBAddressTypeCode`string` Identifies the nature of the postal address. Enum: [ Business, Correspondence, DeliveryTo, MailTo, POBox, Postal, Residential, Statement ]
PostCode	PostCode`string` 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`string` Name of a built-up area, with defined boundaries, and a local government.
Country	`string` pattern: ^[A-Z]{2,2}$ Nation with its own government.
AddressLine	[ minItems: 0 maxItems: 2 `string` minLength: 1 maxLength: 70 Information that locates and identifies a specific address, as defined by postal services, presented in free format text. ]

}

CreditorAgent

{

description:

Financial institution servicing an account for the creditor.

SchemeName

string

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

Identification

string
minLength: 1
maxLength: 35

Unique and unambiguous identification of a financial institution or a branch of a financial institution.

Name

string
minLength: 1
maxLength: 140

Name by which an agent is known and which is usually used to identify that agent.

PostalAddress

#/definitions/OBPostalAddress6OBPostalAddress6{

description:	Information that locates and identifies a specific address, as defined by postal services.
AddressType	OBAddressTypeCode`string` Identifies the nature of the postal address. Enum: [ Business, Correspondence, DeliveryTo, MailTo, POBox, Postal, Residential, Statement ]
PostCode	PostCode`string` 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`string` Name of a built-up area, with defined boundaries, and a local government.
Country	`string` pattern: ^[A-Z]{2,2}$ Nation with its own government.
AddressLine	[ minItems: 0 maxItems: 2 `string` minLength: 1 maxLength: 70 Information that locates and identifies a specific address, as defined by postal services, presented in free format text. ]

}

CreditorAccount*

{

description:	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`string` Name of the identification scheme, in a coded form as published in an external list.
Identification*	Identification`string` Identification assigned by an institution to identify an account. This identification is known by the account owner.
Name*	`string` minLength: 1 maxLength: 70 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.

}

RemittanceInformation

{

description:	Information supplied to enable the matching of an entry with the items that the transfer is intended to settle, such as commercial invoices in an accounts' receivable system.
Unstructured	`string` minLength: 1 maxLength: 140 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` minLength: 1 maxLength: 35 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.

}

Risk*

#/definitions/OBRisk1OBRisk1{

description:

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

PaymentContextCode

string

Specifies the payment context

Enum:
[ BillPayment, EcommerceGoods, EcommerceServices, Other, PartyToParty ]

MerchantCategoryCode

string
minLength: 3
maxLength: 4

Category code conform to ISO 18245, related to the type of services or goods the merchant provides for the transaction.

MerchantCustomerIdentification

string
minLength: 1
maxLength: 70

The unique customer identifier of the PSU with the merchant.

DeliveryAddress

{

description:	Information that locates and identifies a specific address, as defined by postal services or in free format text.
AddressLine	[ minItems: 0 maxItems: 2 `string` minLength: 1 maxLength: 70 Information that locates and identifies a specific address, as defined by postal services, that is presented in free format text. ]
BuildingNumber	BuildingNumber`string` Number that identifies the position of a building on a street.
PostCode	PostCode`string` 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`string` Name of a built-up area, with defined boundaries, and a local government.
CountrySubDivision	[ minItems: 0 maxItems: 2 `string` minLength: 1 maxLength: 35 Identifies a subdivision of a country, for instance state, region, county. ]
Country*	`string` pattern: ^[A-Z]{2,2}$ Nation with its own government, occupying a particular territory.

}

Links

#/definitions/LinksLinks{

description:	Links relevant to the payload
Self*	`string`
First	`string`
Prev	`string`
Next	`string`
Last	`string`

}

Meta

#/definitions/MetaMeta{

description:	Meta Data relevant to the payload
TotalPages	integer($int32)
FirstAvailableDateTime	ISODateTime`string`($date-time) All dates in the JSON payloads are represented in ISO 8601 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`string`($date-time) All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00

}

Headers:

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

400

Bad request

Example Value Model

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

#/definitions/OBErrorResponse1OBErrorResponse1{

description:

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

Code*

string
minLength: 1
maxLength: 40

High level textual error code, to help categorize the errors.

string
minLength: 1
maxLength: 40

A unique reference for the error instance, for audit purposes, in case of unknown/unclassified errors.

Message*

string
minLength: 1
maxLength: 500

Brief Error message, e.g., 'There is something wrong with the request parameters provided'

Errors*

[
minItems: 1

#/definitions/OBError1OBError1{

ErrorCode*	`string` Low level textual error code, e.g., UK.OBIE.Field.Missing
Message*	`string` minLength: 1 maxLength: 500 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` minLength: 1 maxLength: 500 Recommended but optional reference to the JSON Path of the field with error, e.g., Data.Initiation.InstructedAmount.Currency
Url	`string` URL to help remediate the problem, or provide more information, or to API Reference, or help etc

}]

}

Headers:

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

401

Unauthorized

Headers:

Name	Description	Type
x-fapi-interaction-id	An RFC4122 UID used as a correlation id.	string

403

Forbidden

Example Value Model

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

#/definitions/OBErrorResponse1OBErrorResponse1{

description:

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

Code*

string
minLength: 1
maxLength: 40

High level textual error code, to help categorize the errors.

string
minLength: 1
maxLength: 40

A unique reference for the error instance, for audit purposes, in case of unknown/unclassified errors.

Message*

string
minLength: 1
maxLength: 500

Brief Error message, e.g., 'There is something wrong with the request parameters provided'

Errors*

[
minItems: 1

#/definitions/OBError1OBError1{

ErrorCode*	`string` Low level textual error code, e.g., UK.OBIE.Field.Missing
Message*	`string` minLength: 1 maxLength: 500 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` minLength: 1 maxLength: 500 Recommended but optional reference to the JSON Path of the field with error, e.g., Data.Initiation.InstructedAmount.Currency
Url	`string` URL to help remediate the problem, or provide more information, or to API Reference, or help etc

}]

}

Headers:

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

404

Not found

Headers:

Name	Description	Type
x-fapi-interaction-id	An RFC4122 UID used as a correlation id.	string

405

Method Not Allowed

Headers:

Name	Description	Type
x-fapi-interaction-id	An RFC4122 UID used as a correlation id.	string

406

Not Acceptable

Headers:

Name	Description	Type
x-fapi-interaction-id	An RFC4122 UID used as a correlation id.	string

429

Too Many Requests

Headers:

Name	Description	Type
Retry-After	Number in seconds to wait	integer
x-fapi-interaction-id	An RFC4122 UID used as a correlation id.	string

500

Internal Server Error

Example Value Model

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

#/definitions/OBErrorResponse1OBErrorResponse1{

description:

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

Code*

string
minLength: 1
maxLength: 40

High level textual error code, to help categorize the errors.

string
minLength: 1
maxLength: 40

A unique reference for the error instance, for audit purposes, in case of unknown/unclassified errors.

Message*

string
minLength: 1
maxLength: 500

Brief Error message, e.g., 'There is something wrong with the request parameters provided'

Errors*

[
minItems: 1

#/definitions/OBError1OBError1{

ErrorCode*	`string` Low level textual error code, e.g., UK.OBIE.Field.Missing
Message*	`string` minLength: 1 maxLength: 500 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` minLength: 1 maxLength: 500 Recommended but optional reference to the JSON Path of the field with error, e.g., Data.Initiation.InstructedAmount.Currency
Url	`string` URL to help remediate the problem, or provide more information, or to API Reference, or help etc

}]

}

Headers:

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

GET /open-banking/v3.1/pisp/international-payment-consents/{ConsentId} Get International Payment Consents

Name	Description
ConsentId * string (path)	ConsentId
x-fapi-auth-date string (header)	The time when the PSU last logged in with the TPP. All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: Sun, 10 Sep 2017 19:43:31 UTC
x-fapi-customer-ip-address string (header)	The PSU's IP address if the PSU is currently logged in with the TPP.
x-fapi-interaction-id string (header)	An RFC4122 UID used as a correlation id.
Authorization * string (header)	An Authorisation Token as per https://tools.ietf.org/html/rfc6750 Link opens in a new window

Responses

Response content type

Code Description

200

Example Value Model

{
  "Data": {
    "ConsentId": "string",
    "CreationDateTime": "2024-06-19T13:27:12.831Z",
    "Status": "Authorised",
    "StatusUpdateDateTime": "2024-06-19T13:27:12.831Z",
    "Permission": "Create",
    "ExpectedExecutionDateTime": "2024-06-19T13:27:12.831Z",
    "ExpectedSettlementDateTime": "2024-06-19T13:27:12.831Z",
    "Charges": [
      {
        "ChargeBearer": "BorneByCreditor",
        "Type": "string",
        "Amount": {
          "Amount": "string",
          "Currency": "string"
        }
      }
    ],
    "ExchangeRateInformation": {
      "UnitCurrency": "string",
      "ExchangeRate": 0,
      "RateType": "Actual",
      "ContractIdentification": "string",
      "ExpirationDateTime": "2024-06-19T13:27:12.832Z"
    },
    "Initiation": {
      "InstructionIdentification": "string",
      "EndToEndIdentification": "string",
      "LocalInstrument": "string",
      "ChargeBearer": "BorneByCreditor",
      "RequestedExecutionDateTime": "2024-06-19T13:27:12.832Z",
      "CurrencyOfTransfer": "string",
      "InstructedAmount": {
        "Amount": "string",
        "Currency": "string"
      },
      "ExchangeRateInformation": {
        "UnitCurrency": "string",
        "ExchangeRate": 0,
        "RateType": "Actual",
        "ContractIdentification": "string"
      },
      "DebtorAccount": {
        "SchemeName": "string",
        "Identification": "string",
        "Name": "string"
      },
      "Creditor": {
        "Name": "string",
        "PostalAddress": {
          "AddressType": "Business",
          "PostCode": "string",
          "TownName": "string",
          "Country": "string",
          "AddressLine": [
            "string"
          ]
        }
      },
      "CreditorAgent": {
        "SchemeName": "string",
        "Identification": "string",
        "Name": "string",
        "PostalAddress": {
          "AddressType": "Business",
          "PostCode": "string",
          "TownName": "string",
          "Country": "string",
          "AddressLine": [
            "string"
          ]
        }
      },
      "CreditorAccount": {
        "SchemeName": "string",
        "Identification": "string",
        "Name": "string"
      },
      "RemittanceInformation": {
        "Unstructured": "string",
        "Reference": "string"
      }
    }
  },
  "Risk": {
    "PaymentContextCode": "BillPayment",
    "MerchantCategoryCode": "string",
    "MerchantCustomerIdentification": "string",
    "DeliveryAddress": {
      "AddressLine": [
        "string"
      ],
      "BuildingNumber": "string",
      "PostCode": "string",
      "TownName": "string",
      "CountrySubDivision": [
        "string"
      ],
      "Country": "string"
    }
  },
  "Links": {
    "Self": "string",
    "First": "string",
    "Prev": "string",
    "Next": "string",
    "Last": "string"
  },
  "Meta": {
    "TotalPages": 0,
    "FirstAvailableDateTime": "2024-06-19T13:27:12.832Z",
    "LastAvailableDateTime": "2024-06-19T13:27:12.832Z"
  }
}

#/definitions/OBWriteInternationalScheduledConsentResponse3OBWriteInternationalScheduledConsentResponse3{

Data*

{

ConsentId*

string
minLength: 1
maxLength: 128

OB: Unique identification as assigned by the ASPSP to uniquely identify the consent resource.

CreationDateTime*

string($date-time)

Status*

string

Specifies the status of consent resource in code form.

Enum:
[ Authorised, AwaitingAuthorisation, Consumed, Rejected ]

StatusUpdateDateTime*

string($date-time)

Permission*

string

Specifies the Open Banking service request types.

Enum:
[ Create ]

ExpectedExecutionDateTime

string($date-time)

ExpectedSettlementDateTime

string($date-time)

Charges

[{

description:

Set of elements used to provide details of a charge for the payment initiation.

ChargeBearer*

OBChargeBearerType1Codestring

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

Enum:
[ BorneByCreditor, BorneByDebtor, FollowingServiceLevel, Shared ]

Type*

OBExternalPaymentChargeType1Codestring

Charge type, in a coded form.

Amount*

#/definitions/OBActiveOrHistoricCurrencyAndAmountOBActiveOrHistoricCurrencyAndAmount{

description:	Amount of money associated with the charge type.
Amount*	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.
Currency*	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".

}

}]

ExchangeRateInformation

{

description:	Further detailed information on the exchange rate that has been used in the payment transaction.
UnitCurrency*	`string` pattern: ^[A-Z]{3,3}$ 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 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` Specifies the type used to complete the currency exchange. Enum: [ Actual, Agreed, Indicative ]
ContractIdentification	`string` minLength: 1 maxLength: 256 Unique and unambiguous reference to the foreign exchange contract agreed between the initiating party/creditor and the debtor agent.
ExpirationDateTime	`string`($date-time) 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*

{

description:

The Initiation payload is sent by the initiating party to the ASPSP. It is used to request movement of funds from the debtor account to a creditor for a single scheduled international payment.

InstructionIdentification*

string
minLength: 1
maxLength: 35

EndToEndIdentification

string
minLength: 1
maxLength: 35

LocalInstrument

OBExternalLocalInstrument1Codestring

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.

ChargeBearer

OBChargeBearerType1Codestring

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

Enum:
[ BorneByCreditor, BorneByDebtor, FollowingServiceLevel, Shared ]

RequestedExecutionDateTime*

string($date-time)

CurrencyOfTransfer*

string
pattern: ^[A-Z]{3,3}$

Specifies the currency of the to be transferred amount, which is different from the currency of the debtor's account.

InstructedAmount*

{

description:	Amount of money to be moved between the debtor and creditor, before deduction of charges, expressed in the currency as ordered by the initiating party. Usage: This amount has to be transported unchanged through the transaction chain.
Amount*	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.
Currency*	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".

}

ExchangeRateInformation

{

description:	Provides details on the currency exchange rate and contract.
UnitCurrency*	`string` pattern: ^[A-Z]{3,3}$ 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 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` Specifies the type used to complete the currency exchange. Enum: [ Actual, Agreed, Indicative ]
ContractIdentification	`string` minLength: 1 maxLength: 256 Unique and unambiguous reference to the foreign exchange contract agreed between the initiating party/creditor and the debtor agent.

}

DebtorAccount

{

description:	Unambiguous identification of the account of the debtor to which a debit entry will be made as a result of the transaction.
SchemeName*	OBExternalAccountIdentification4Code`string` Name of the identification scheme, in a coded form as published in an external list.
Identification*	Identification`string` Identification assigned by an institution to identify an account. This identification is known by the account owner.
Name	`string` minLength: 1 maxLength: 70 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.

}

Creditor

{

description:

Party to which an amount of money is due.

Name

string
minLength: 1
maxLength: 140

Name by which a party is known and which is usually used to identify that party.

PostalAddress

#/definitions/OBPostalAddress6OBPostalAddress6{

description:	Information that locates and identifies a specific address, as defined by postal services.
AddressType	OBAddressTypeCode`string` Identifies the nature of the postal address. Enum: [ Business, Correspondence, DeliveryTo, MailTo, POBox, Postal, Residential, Statement ]
PostCode	PostCode`string` 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`string` Name of a built-up area, with defined boundaries, and a local government.
Country	`string` pattern: ^[A-Z]{2,2}$ Nation with its own government.
AddressLine	[ minItems: 0 maxItems: 2 `string` minLength: 1 maxLength: 70 Information that locates and identifies a specific address, as defined by postal services, presented in free format text. ]

}

CreditorAgent

{

description:

Financial institution servicing an account for the creditor.

SchemeName

string

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

Identification

string
minLength: 1
maxLength: 35

Unique and unambiguous identification of a financial institution or a branch of a financial institution.

Name

string
minLength: 1
maxLength: 140

Name by which an agent is known and which is usually used to identify that agent.

PostalAddress

#/definitions/OBPostalAddress6OBPostalAddress6{

description:	Information that locates and identifies a specific address, as defined by postal services.
AddressType	OBAddressTypeCode`string` Identifies the nature of the postal address. Enum: [ Business, Correspondence, DeliveryTo, MailTo, POBox, Postal, Residential, Statement ]
PostCode	PostCode`string` 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`string` Name of a built-up area, with defined boundaries, and a local government.
Country	`string` pattern: ^[A-Z]{2,2}$ Nation with its own government.
AddressLine	[ minItems: 0 maxItems: 2 `string` minLength: 1 maxLength: 70 Information that locates and identifies a specific address, as defined by postal services, presented in free format text. ]

}

CreditorAccount*

{

description:	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`string` Name of the identification scheme, in a coded form as published in an external list.
Identification*	Identification`string` Identification assigned by an institution to identify an account. This identification is known by the account owner.
Name*	`string` minLength: 1 maxLength: 70 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.

}

RemittanceInformation

{

description:	Information supplied to enable the matching of an entry with the items that the transfer is intended to settle, such as commercial invoices in an accounts' receivable system.
Unstructured	`string` minLength: 1 maxLength: 140 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` minLength: 1 maxLength: 35 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.

}

Risk*

#/definitions/OBRisk1OBRisk1{

description:

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

PaymentContextCode

string

Specifies the payment context

Enum:
[ BillPayment, EcommerceGoods, EcommerceServices, Other, PartyToParty ]

MerchantCategoryCode

string
minLength: 3
maxLength: 4

Category code conform to ISO 18245, related to the type of services or goods the merchant provides for the transaction.

MerchantCustomerIdentification

string
minLength: 1
maxLength: 70

The unique customer identifier of the PSU with the merchant.

DeliveryAddress

{

description:	Information that locates and identifies a specific address, as defined by postal services or in free format text.
AddressLine	[ minItems: 0 maxItems: 2 `string` minLength: 1 maxLength: 70 Information that locates and identifies a specific address, as defined by postal services, that is presented in free format text. ]
BuildingNumber	BuildingNumber`string` Number that identifies the position of a building on a street.
PostCode	PostCode`string` 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`string` Name of a built-up area, with defined boundaries, and a local government.
CountrySubDivision	[ minItems: 0 maxItems: 2 `string` minLength: 1 maxLength: 35 Identifies a subdivision of a country, for instance state, region, county. ]
Country*	`string` pattern: ^[A-Z]{2,2}$ Nation with its own government, occupying a particular territory.

}

Links

#/definitions/LinksLinks{

description:	Links relevant to the payload
Self*	`string`
First	`string`
Prev	`string`
Next	`string`
Last	`string`

}

Meta

#/definitions/MetaMeta{

description:	Meta Data relevant to the payload
TotalPages	integer($int32)
FirstAvailableDateTime	ISODateTime`string`($date-time) All dates in the JSON payloads are represented in ISO 8601 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`string`($date-time) All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00

}

Headers:

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

400

Bad request

Example Value Model

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

#/definitions/OBErrorResponse1OBErrorResponse1{

description:

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

Code*

string
minLength: 1
maxLength: 40

High level textual error code, to help categorize the errors.

string
minLength: 1
maxLength: 40

A unique reference for the error instance, for audit purposes, in case of unknown/unclassified errors.

Message*

string
minLength: 1
maxLength: 500

Brief Error message, e.g., 'There is something wrong with the request parameters provided'

Errors*

[
minItems: 1

#/definitions/OBError1OBError1{

ErrorCode*	`string` Low level textual error code, e.g., UK.OBIE.Field.Missing
Message*	`string` minLength: 1 maxLength: 500 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` minLength: 1 maxLength: 500 Recommended but optional reference to the JSON Path of the field with error, e.g., Data.Initiation.InstructedAmount.Currency
Url	`string` URL to help remediate the problem, or provide more information, or to API Reference, or help etc

}]

}

Headers:

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

401

Unauthorized

Headers:

Name	Description	Type
x-fapi-interaction-id	An RFC4122 UID used as a correlation id.	string

403

Forbidden

Example Value Model

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

#/definitions/OBErrorResponse1OBErrorResponse1{

description:

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

Code*

string
minLength: 1
maxLength: 40

High level textual error code, to help categorize the errors.

string
minLength: 1
maxLength: 40

A unique reference for the error instance, for audit purposes, in case of unknown/unclassified errors.

Message*

string
minLength: 1
maxLength: 500

Brief Error message, e.g., 'There is something wrong with the request parameters provided'

Errors*

[
minItems: 1

#/definitions/OBError1OBError1{

ErrorCode*	`string` Low level textual error code, e.g., UK.OBIE.Field.Missing
Message*	`string` minLength: 1 maxLength: 500 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` minLength: 1 maxLength: 500 Recommended but optional reference to the JSON Path of the field with error, e.g., Data.Initiation.InstructedAmount.Currency
Url	`string` URL to help remediate the problem, or provide more information, or to API Reference, or help etc

}]

}

Headers:

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

404

Not found

Headers:

Name	Description	Type
x-fapi-interaction-id	An RFC4122 UID used as a correlation id.	string

405

Method Not Allowed

Headers:

Name	Description	Type
x-fapi-interaction-id	An RFC4122 UID used as a correlation id.	string

406

Not Acceptable

Headers:

Name	Description	Type
x-fapi-interaction-id	An RFC4122 UID used as a correlation id.	string

429

Too Many Requests

Headers:

Name	Description	Type
Retry-After	Number in seconds to wait	integer
x-fapi-interaction-id	An RFC4122 UID used as a correlation id.	string

500

Internal Server Error

Example Value Model

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

#/definitions/OBErrorResponse1OBErrorResponse1{

description:

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

Code*

string
minLength: 1
maxLength: 40

High level textual error code, to help categorize the errors.

string
minLength: 1
maxLength: 40

A unique reference for the error instance, for audit purposes, in case of unknown/unclassified errors.

Message*

string
minLength: 1
maxLength: 500

Brief Error message, e.g., 'There is something wrong with the request parameters provided'

Errors*

[
minItems: 1

#/definitions/OBError1OBError1{

ErrorCode*	`string` Low level textual error code, e.g., UK.OBIE.Field.Missing
Message*	`string` minLength: 1 maxLength: 500 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` minLength: 1 maxLength: 500 Recommended but optional reference to the JSON Path of the field with error, e.g., Data.Initiation.InstructedAmount.Currency
Url	`string` URL to help remediate the problem, or provide more information, or to API Reference, or help etc

}]

}

Headers:

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

POST /open-banking/v3.1/pisp/international-scheduled-payments Create International Scheduled Payments

Name Description

OBWriteInternationalScheduled2Param *

(body)

Default

Example Value Model

{
  "Data": {
    "ConsentId": "string",
    "Initiation": {
      "InstructionIdentification": "string",
      "EndToEndIdentification": "string",
      "LocalInstrument": "string",
      "InstructionPriority": "Normal",
      "ChargeBearer": "BorneByCreditor",
      "RequestedExecutionDateTime": "2024-06-19T11:55:23.450Z",
      "CurrencyOfTransfer": "string",
      "InstructedAmount": {
        "Amount": "string",
        "Currency": "string"
      },
      "ExchangeRateInformation": {
        "UnitCurrency": "string",
        "ExchangeRate": 0,
        "RateType": "Actual",
        "ContractIdentification": "string"
      },
      "DebtorAccount": {
        "SchemeName": "string",
        "Identification": "string",
        "Name": "string"
      },
      "Creditor": {
        "Name": "string",
        "PostalAddress": {
          "AddressType": "Business",
          "PostCode": "string",
          "TownName": "string",
          "Country": "string",
          "AddressLine": [
            "string"
          ]
        }
      },
      "CreditorAgent": {
        "SchemeName": "string",
        "Identification": "string",
        "Name": "string",
        "PostalAddress": {
          "AddressType": "Business",
          "PostCode": "string",
          "TownName": "string",
          "Country": "string",
          "AddressLine": [
            "string"
          ]
        }
      },
      "CreditorAccount": {
        "SchemeName": "string",
        "Identification": "string",
        "Name": "string"
      },
      "RemittanceInformation": {
        "Unstructured": "string",
        "Reference": "string"
      }
    }
  },
  "Risk": {
    "PaymentContextCode": "BillPayment",
    "MerchantCategoryCode": "string",
    "MerchantCustomerIdentification": "string",
    "DeliveryAddress": {
      "AddressLine": [
        "string"
      ],
      "BuildingNumber": "string",
      "PostCode": "string",
      "TownName": "string",
      "CountrySubDivision": [
        "string"
      ],
      "Country": "string"
    }
  }
}

Parameter content type

#/definitions/OBWriteInternationalScheduled2OBWriteInternationalScheduled2{

Data*

{

ConsentId*

string
minLength: 1
maxLength: 128

OB: Unique identification as assigned by the ASPSP to uniquely identify the consent resource.

Initiation*

{

description:

The Initiation payload is sent by the initiating party to the ASPSP. It is used to request movement of funds from the debtor account to a creditor for a single scheduled international payment.

InstructionIdentification*

string
minLength: 1
maxLength: 35

EndToEndIdentification

string
minLength: 1
maxLength: 35

LocalInstrument

OBExternalLocalInstrument1Codestring

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

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.

Enum:
[ Normal, Urgent ]

ChargeBearer

OBChargeBearerType1Codestring

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

Enum:
[ BorneByCreditor, BorneByDebtor, FollowingServiceLevel, Shared ]

RequestedExecutionDateTime*

string($date-time)

CurrencyOfTransfer*

string
pattern: ^[A-Z]{3,3}$

Specifies the currency of the to be transferred amount, which is different from the currency of the debtor's account.

InstructedAmount*

{

description:	Amount of money to be moved between the debtor and creditor, before deduction of charges, expressed in the currency as ordered by the initiating party. Usage: This amount has to be transported unchanged through the transaction chain.
Amount*	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.
Currency*	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".

}

ExchangeRateInformation

{

description:	Provides details on the currency exchange rate and contract.
UnitCurrency*	`string` pattern: ^[A-Z]{3,3}$ 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 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` Specifies the type used to complete the currency exchange. Enum: [ Actual, Agreed, Indicative ]
ContractIdentification	`string` minLength: 1 maxLength: 256 Unique and unambiguous reference to the foreign exchange contract agreed between the initiating party/creditor and the debtor agent.

}

DebtorAccount

{

description:	Unambiguous identification of the account of the debtor to which a debit entry will be made as a result of the transaction.
SchemeName*	OBExternalAccountIdentification4Code`string` Name of the identification scheme, in a coded form as published in an external list.
Identification*	Identification`string` Identification assigned by an institution to identify an account. This identification is known by the account owner.
Name	`string` minLength: 1 maxLength: 70 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.

}

Creditor

{

description:

Party to which an amount of money is due.

Name

string
minLength: 1
maxLength: 140

Name by which a party is known and which is usually used to identify that party.

PostalAddress

#/definitions/OBPostalAddress6OBPostalAddress6{

description:	Information that locates and identifies a specific address, as defined by postal services.
AddressType	OBAddressTypeCode`string` Identifies the nature of the postal address. Enum: [ Business, Correspondence, DeliveryTo, MailTo, POBox, Postal, Residential, Statement ]
PostCode	PostCode`string` 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`string` Name of a built-up area, with defined boundaries, and a local government.
Country	`string` pattern: ^[A-Z]{2,2}$ Nation with its own government.
AddressLine	[ minItems: 0 maxItems: 2 `string` minLength: 1 maxLength: 70 Information that locates and identifies a specific address, as defined by postal services, presented in free format text. ]

}

CreditorAgent

{

description:

Financial institution servicing an account for the creditor.

SchemeName

string

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

Identification

string
minLength: 1
maxLength: 35

Unique and unambiguous identification of a financial institution or a branch of a financial institution.

Name

string
minLength: 1
maxLength: 140

Name by which an agent is known and which is usually used to identify that agent.

PostalAddress

#/definitions/OBPostalAddress6OBPostalAddress6{

description:	Information that locates and identifies a specific address, as defined by postal services.
AddressType	OBAddressTypeCode`string` Identifies the nature of the postal address. Enum: [ Business, Correspondence, DeliveryTo, MailTo, POBox, Postal, Residential, Statement ]
PostCode	PostCode`string` 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`string` Name of a built-up area, with defined boundaries, and a local government.
Country	`string` pattern: ^[A-Z]{2,2}$ Nation with its own government.
AddressLine	[ minItems: 0 maxItems: 2 `string` minLength: 1 maxLength: 70 Information that locates and identifies a specific address, as defined by postal services, presented in free format text. ]

}

CreditorAccount*

{

description:	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`string` Name of the identification scheme, in a coded form as published in an external list.
Identification*	Identification`string` Identification assigned by an institution to identify an account. This identification is known by the account owner.
Name*	`string` minLength: 1 maxLength: 70 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.

}

RemittanceInformation

{

description:	Information supplied to enable the matching of an entry with the items that the transfer is intended to settle, such as commercial invoices in an accounts' receivable system.
Unstructured	`string` minLength: 1 maxLength: 140 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` minLength: 1 maxLength: 35 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.

}

Risk*

#/definitions/OBRisk1OBRisk1{

description:

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

PaymentContextCode

string

Specifies the payment context

Enum:
[ BillPayment, EcommerceGoods, EcommerceServices, Other, PartyToParty ]

MerchantCategoryCode

string
minLength: 3
maxLength: 4

Category code conform to ISO 18245, related to the type of services or goods the merchant provides for the transaction.

MerchantCustomerIdentification

string
minLength: 1
maxLength: 70

The unique customer identifier of the PSU with the merchant.

DeliveryAddress

{

description:	Information that locates and identifies a specific address, as defined by postal services or in free format text.
AddressLine	[ minItems: 0 maxItems: 2 `string` minLength: 1 maxLength: 70 Information that locates and identifies a specific address, as defined by postal services, that is presented in free format text. ]
BuildingNumber	BuildingNumber`string` Number that identifies the position of a building on a street.
PostCode	PostCode`string` 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`string` Name of a built-up area, with defined boundaries, and a local government.
CountrySubDivision	[ minItems: 0 maxItems: 2 `string` minLength: 1 maxLength: 35 Identifies a subdivision of a country, for instance state, region, county. ]
Country*	`string` pattern: ^[A-Z]{2,2}$ Nation with its own government, occupying a particular territory.

}

x-fapi-auth-date

string

(header)

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

x-fapi-customer-ip-address

string

(header)

The PSU's IP address if the PSU is currently logged in with the TPP.

x-fapi-interaction-id

string

(header)

An RFC4122 UID used as a correlation id.

Authorization *

string

(header)

An Authorisation Token as per https://tools.ietf.org/html/rfc6750 Link opens in a new window

x-idempotency-key *

string

(header)

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

x-jws-signature *

string

(header)

A detached JOSE signature of the body of the payload.

Responses

Response content type

Code Description

201

Created

Example Value Model

{
  "Data": {
    "InternationalScheduledPaymentId": "string",
    "ConsentId": "string",
    "CreationDateTime": "2024-06-19T13:42:12.312Z",
    "Status": "Cancelled",
    "StatusUpdateDateTime": "2024-06-19T13:42:12.312Z",
    "ExpectedExecutionDateTime": "2024-06-19T13:42:12.312Z",
    "ExpectedSettlementDateTime": "2024-06-19T13:42:12.312Z",
    "ExchangeRateInformation": {
      "UnitCurrency": "string",
      "ExchangeRate": 0,
      "RateType": "Actual",
      "ContractIdentification": "string"
    },
    "Initiation": {
      "InstructionIdentification": "string",
      "EndToEndIdentification": "string",
      "LocalInstrument": "string",
      "InstructionPriority": "Normal",
      "Purpose": "string",
      "ChargeBearer": "BorneByCreditor",
      "RequestedExecutionDateTime": "2024-06-19T13:42:12.312Z",
      "CurrencyOfTransfer": "string",
      "InstructedAmount": {
        "Amount": "string",
        "Currency": "string"
      },
      "ExchangeRateInformation": {
        "UnitCurrency": "string",
        "ExchangeRate": 0,
        "RateType": "Actual",
        "ContractIdentification": "string"
      },
      "DebtorAccount": {
        "SchemeName": "string",
        "Identification": "string",
        "Name": "string"
      },
      "Creditor": {
        "Name": "string",
        "PostalAddress": {
          "AddressType": "Business",
          "PostCode": "string",
          "TownName": "string",
          "Country": "string",
          "AddressLine": [
            "string"
          ]
        }
      },
      "CreditorAgent": {
        "SchemeName": "string",
        "Identification": "string",
        "Name": "string",
        "PostalAddress": {
          "AddressType": "Business",
          "PostCode": "string",
          "TownName": "string",
          "Country": "string",
          "AddressLine": [
            "string"
          ]
        }
      },
      "CreditorAccount": {
        "SchemeName": "string",
        "Identification": "string",
        "Name": "string"
      },
      "RemittanceInformation": {
        "Unstructured": "string",
        "Reference": "string"
      }
    },
    "MultiAuthorisation": {
      "Status": "Authorised"
    }
  },
  "Links": {
    "Self": "string",
    "First": "string",
    "Prev": "string",
    "Next": "string",
    "Last": "string"
  },
  "Meta": {
    "TotalPages": 0,
    "FirstAvailableDateTime": "2024-06-19T13:42:12.312Z",
    "LastAvailableDateTime": "2024-06-19T13:42:12.312Z"
  }
}

#/definitions/OBWriteInternationalScheduledResponse3OBWriteInternationalScheduledResponse3{

Data*

{

InternationalScheduledPaymentId*

string
minLength: 1
maxLength: 40

OB: Unique identification as assigned by the ASPSP to uniquely identify the international scheduled payment resource.

ConsentId*

string
minLength: 1
maxLength: 128

OB: Unique identification as assigned by the ASPSP to uniquely identify the consent resource.

CreationDateTime*

string($date-time)

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

Specifies the status of the payment order resource.

Enum:
[ Cancelled, InitiationCompleted, InitiationFailed, InitiationPending ]

StatusUpdateDateTime*

string($date-time)

ExpectedExecutionDateTime

string($date-time)

ExpectedSettlementDateTime

string($date-time)

ExchangeRateInformation

{

description:	Further detailed information on the exchange rate that has been used in the payment transaction.
UnitCurrency*	`string` pattern: ^[A-Z]{3,3}$ 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 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` Specifies the type used to complete the currency exchange. Enum: [ Actual, Agreed, Indicative ]
ContractIdentification	`string` minLength: 1 maxLength: 256 Unique and unambiguous reference to the foreign exchange contract agreed between the initiating party/creditor and the debtor agent.

}

Initiation*

{

description:

The Initiation payload is sent by the initiating party to the ASPSP. It is used to request movement of funds from the debtor account to a creditor for a single scheduled international payment.

InstructionIdentification*

string
minLength: 1
maxLength: 35

EndToEndIdentification

string
minLength: 1
maxLength: 35

LocalInstrument

OBExternalLocalInstrument1Codestring

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

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.

Enum:
[ Normal, Urgent ]

Purpose

string

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

OBChargeBearerType1Codestring

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

Enum:
[ BorneByCreditor, BorneByDebtor, FollowingServiceLevel, Shared ]

RequestedExecutionDateTime*

string($date-time)

CurrencyOfTransfer*

string
pattern: ^[A-Z]{3,3}$

Specifies the currency of the to be transferred amount, which is different from the currency of the debtor's account.

InstructedAmount*

{

description:	Amount of money to be moved between the debtor and creditor, before deduction of charges, expressed in the currency as ordered by the initiating party. Usage: This amount has to be transported unchanged through the transaction chain.
Amount*	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.
Currency*	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".

}

ExchangeRateInformation

{

description:	Provides details on the currency exchange rate and contract.
UnitCurrency*	`string` pattern: ^[A-Z]{3,3}$ 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 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` Specifies the type used to complete the currency exchange. Enum: [ Actual, Agreed, Indicative ]
ContractIdentification	`string` minLength: 1 maxLength: 256 Unique and unambiguous reference to the foreign exchange contract agreed between the initiating party/creditor and the debtor agent.

}

DebtorAccount

{

description:	Unambiguous identification of the account of the debtor to which a debit entry will be made as a result of the transaction.
SchemeName*	OBExternalAccountIdentification4Code`string` Name of the identification scheme, in a coded form as published in an external list.
Identification*	Identification`string` Identification assigned by an institution to identify an account. This identification is known by the account owner.
Name	`string` minLength: 1 maxLength: 70 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.

}

Creditor

{

description:

Party to which an amount of money is due.

Name

string
minLength: 1
maxLength: 140

Name by which a party is known and which is usually used to identify that party.

PostalAddress

#/definitions/OBPostalAddress6OBPostalAddress6{

description:	Information that locates and identifies a specific address, as defined by postal services.
AddressType	OBAddressTypeCode`string` Identifies the nature of the postal address. Enum: [ Business, Correspondence, DeliveryTo, MailTo, POBox, Postal, Residential, Statement ]
PostCode	PostCode`string` 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`string` Name of a built-up area, with defined boundaries, and a local government.
Country	`string` pattern: ^[A-Z]{2,2}$ Nation with its own government.
AddressLine	[ minItems: 0 maxItems: 2 `string` minLength: 1 maxLength: 70 Information that locates and identifies a specific address, as defined by postal services, presented in free format text. ]

}

CreditorAgent

{

description:

Financial institution servicing an account for the creditor.

SchemeName

string

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

Identification

string
minLength: 1
maxLength: 35

Unique and unambiguous identification of a financial institution or a branch of a financial institution.

Name

string
minLength: 1
maxLength: 140

Name by which an agent is known and which is usually used to identify that agent.

PostalAddress

#/definitions/OBPostalAddress6OBPostalAddress6{

description:	Information that locates and identifies a specific address, as defined by postal services.
AddressType	OBAddressTypeCode`string` Identifies the nature of the postal address. Enum: [ Business, Correspondence, DeliveryTo, MailTo, POBox, Postal, Residential, Statement ]
PostCode	PostCode`string` 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`string` Name of a built-up area, with defined boundaries, and a local government.
Country	`string` pattern: ^[A-Z]{2,2}$ Nation with its own government.
AddressLine	[ minItems: 0 maxItems: 2 `string` minLength: 1 maxLength: 70 Information that locates and identifies a specific address, as defined by postal services, presented in free format text. ]

}

CreditorAccount*

{

description:	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`string` Name of the identification scheme, in a coded form as published in an external list.
Identification*	Identification`string` Identification assigned by an institution to identify an account. This identification is known by the account owner.
Name*	`string` minLength: 1 maxLength: 70 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.

}

RemittanceInformation

{

description:	Information supplied to enable the matching of an entry with the items that the transfer is intended to settle, such as commercial invoices in an accounts' receivable system.
Unstructured	`string` minLength: 1 maxLength: 140 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` minLength: 1 maxLength: 35 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.

}

MultiAuthorisation

{

description:	The multiple authorisation flow response from the ASPSP.
Status*	`string` Specifies the status of the authorisation flow in code form. Enum: [ Authorised, AwaitingFurtherAuthorisation, Rejected ]

}

Links

#/definitions/LinksLinks{

description:	Links relevant to the payload
Self*	`string`
First	`string`
Prev	`string`
Next	`string`
Last	`string`

}

Meta

#/definitions/MetaMeta{

description:	Meta Data relevant to the payload
TotalPages	integer($int32)
FirstAvailableDateTime	ISODateTime`string`($date-time) All dates in the JSON payloads are represented in ISO 8601 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`string`($date-time) All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00

}

Headers:

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

400

Bad request

Example Value Model

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

#/definitions/OBErrorResponse1OBErrorResponse1{

description:

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

Code*

string
minLength: 1
maxLength: 40

High level textual error code, to help categorize the errors.

string
minLength: 1
maxLength: 40

A unique reference for the error instance, for audit purposes, in case of unknown/unclassified errors.

Message*

string
minLength: 1
maxLength: 500

Brief Error message, e.g., 'There is something wrong with the request parameters provided'

Errors*

[
minItems: 1

#/definitions/OBError1OBError1{

ErrorCode*	`string` Low level textual error code, e.g., UK.OBIE.Field.Missing
Message*	`string` minLength: 1 maxLength: 500 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` minLength: 1 maxLength: 500 Recommended but optional reference to the JSON Path of the field with error, e.g., Data.Initiation.InstructedAmount.Currency
Url	`string` URL to help remediate the problem, or provide more information, or to API Reference, or help etc

}]

}

Headers:

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

401

Unauthorized

Headers:

Name	Description	Type
x-fapi-interaction-id	An RFC4122 UID used as a correlation id.	string

403

Forbidden

Example Value Model

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

#/definitions/OBErrorResponse1OBErrorResponse1{

description:

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

Code*

string
minLength: 1
maxLength: 40

High level textual error code, to help categorize the errors.

string
minLength: 1
maxLength: 40

A unique reference for the error instance, for audit purposes, in case of unknown/unclassified errors.

Message*

string
minLength: 1
maxLength: 500

Brief Error message, e.g., 'There is something wrong with the request parameters provided'

Errors*

[
minItems: 1

#/definitions/OBError1OBError1{

ErrorCode*	`string` Low level textual error code, e.g., UK.OBIE.Field.Missing
Message*	`string` minLength: 1 maxLength: 500 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` minLength: 1 maxLength: 500 Recommended but optional reference to the JSON Path of the field with error, e.g., Data.Initiation.InstructedAmount.Currency
Url	`string` URL to help remediate the problem, or provide more information, or to API Reference, or help etc

}]

}

Headers:

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

404

Not found

Headers:

Name	Description	Type
x-fapi-interaction-id	An RFC4122 UID used as a correlation id.	string

405

Method Not Allowed

Headers:

Name	Description	Type
x-fapi-interaction-id	An RFC4122 UID used as a correlation id.	string

406

Not Acceptable

Headers:

Name	Description	Type
x-fapi-interaction-id	An RFC4122 UID used as a correlation id.	string

429

Too Many Requests

Headers:

Name	Description	Type
Retry-After	Number in seconds to wait	integer
x-fapi-interaction-id	An RFC4122 UID used as a correlation id.	string

500

Internal Server Error

Example Value Model

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

#/definitions/OBErrorResponse1OBErrorResponse1{

description:

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

Code*

string
minLength: 1
maxLength: 40

High level textual error code, to help categorize the errors.

string
minLength: 1
maxLength: 40

A unique reference for the error instance, for audit purposes, in case of unknown/unclassified errors.

Message*

string
minLength: 1
maxLength: 500

Brief Error message, e.g., 'There is something wrong with the request parameters provided'

Errors*

[
minItems: 1

#/definitions/OBError1OBError1{

ErrorCode*	`string` Low level textual error code, e.g., UK.OBIE.Field.Missing
Message*	`string` minLength: 1 maxLength: 500 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` minLength: 1 maxLength: 500 Recommended but optional reference to the JSON Path of the field with error, e.g., Data.Initiation.InstructedAmount.Currency
Url	`string` URL to help remediate the problem, or provide more information, or to API Reference, or help etc

}]

}

Headers:

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

GET /open-banking/v3.1/pisp/international-scheduled-payments/{InternationalScheduledPaymentId} Get International Scheduled Payments

Name	Description
InternationalScheduledPaymentId * string (path)	InternationalScheduledPaymentId
x-fapi-auth-date string (header)	The time when the PSU last logged in with the TPP. All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: Sun, 10 Sep 2017 19:43:31 UTC
x-fapi-customer-ip-address string (header)	The PSU's IP address if the PSU is currently logged in with the TPP.
x-fapi-interaction-id string (header)	An RFC4122 UID used as a correlation id.
Authorization * string (header)	An Authorisation Token as per https://tools.ietf.org/html/rfc6750 Link opens in a new window

Responses

Response content type

Code Description

200

Example Value Model

{
  "Data": {
    "InternationalScheduledPaymentId": "string",
    "ConsentId": "string",
    "CreationDateTime": "2024-06-19T13:52:44.428Z",
    "Status": "Cancelled",
    "StatusUpdateDateTime": "2024-06-19T13:52:44.428Z",
    "ExpectedExecutionDateTime": "2024-06-19T13:52:44.428Z",
    "ExpectedSettlementDateTime": "2024-06-19T13:52:44.428Z",
    "ExchangeRateInformation": {
      "UnitCurrency": "string",
      "ExchangeRate": 0,
      "RateType": "Actual",
      "ContractIdentification": "string"
    },
    "Initiation": {
      "InstructionIdentification": "string",
      "EndToEndIdentification": "string",
      "LocalInstrument": "string",
      "InstructionPriority": "Normal",
      "Purpose": "string",
      "ChargeBearer": "BorneByCreditor",
      "RequestedExecutionDateTime": "2024-06-19T13:52:44.428Z",
      "CurrencyOfTransfer": "string",
      "InstructedAmount": {
        "Amount": "string",
        "Currency": "string"
      },
      "ExchangeRateInformation": {
        "UnitCurrency": "string",
        "ExchangeRate": 0,
        "RateType": "Actual",
        "ContractIdentification": "string"
      },
      "DebtorAccount": {
        "SchemeName": "string",
        "Identification": "string",
        "Name": "string"
      },
      "Creditor": {
        "Name": "string",
        "PostalAddress": {
          "AddressType": "Business",
          "PostCode": "string",
          "TownName": "string",
          "Country": "string",
          "AddressLine": [
            "string"
          ]
        }
      },
      "CreditorAgent": {
        "SchemeName": "string",
        "Identification": "string",
        "Name": "string",
        "PostalAddress": {
          "AddressType": "Business",
          "PostCode": "string",
          "TownName": "string",
          "Country": "string",
          "AddressLine": [
            "string"
          ]
        }
      },
      "CreditorAccount": {
        "SchemeName": "string",
        "Identification": "string",
        "Name": "string"
      },
      "RemittanceInformation": {
        "Unstructured": "string",
        "Reference": "string"
      }
    },
    "MultiAuthorisation": {
      "Status": "Authorised"
    }
  },
  "Links": {
    "Self": "string",
    "First": "string",
    "Prev": "string",
    "Next": "string",
    "Last": "string"
  },
  "Meta": {
    "TotalPages": 0,
    "FirstAvailableDateTime": "2024-06-19T13:52:44.428Z",
    "LastAvailableDateTime": "2024-06-19T13:52:44.428Z"
  }
}

#/definitions/OBWriteInternationalScheduledResponse3OBWriteInternationalScheduledResponse3{

Data*

{

InternationalScheduledPaymentId*

string
minLength: 1
maxLength: 40

OB: Unique identification as assigned by the ASPSP to uniquely identify the international scheduled payment resource.

ConsentId*

string
minLength: 1
maxLength: 128

OB: Unique identification as assigned by the ASPSP to uniquely identify the consent resource.

CreationDateTime*

string($date-time)

Status*

string

Specifies the status of the payment order resource.

Enum:
[ Cancelled, InitiationCompleted, InitiationFailed, InitiationPending ]

StatusUpdateDateTime*

string($date-time)

ExpectedExecutionDateTime

string($date-time)

ExpectedSettlementDateTime

string($date-time)

ExchangeRateInformation

{

description:	Further detailed information on the exchange rate that has been used in the payment transaction.
UnitCurrency*	`string` pattern: ^[A-Z]{3,3}$ 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 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` Specifies the type used to complete the currency exchange. Enum: [ Actual, Agreed, Indicative ]
ContractIdentification	`string` minLength: 1 maxLength: 256 Unique and unambiguous reference to the foreign exchange contract agreed between the initiating party/creditor and the debtor agent.

}

Initiation*

{

description:

The Initiation payload is sent by the initiating party to the ASPSP. It is used to request movement of funds from the debtor account to a creditor for a single scheduled international payment.

InstructionIdentification*

string
minLength: 1
maxLength: 35

EndToEndIdentification

string
minLength: 1
maxLength: 35

LocalInstrument

OBExternalLocalInstrument1Codestring

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

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.

Enum:
[ Normal, Urgent ]

Purpose

string

ChargeBearer

OBChargeBearerType1Codestring

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

Enum:
[ BorneByCreditor, BorneByDebtor, FollowingServiceLevel, Shared ]

RequestedExecutionDateTime*

string($date-time)

CurrencyOfTransfer*

string
pattern: ^[A-Z]{3,3}$

Specifies the currency of the to be transferred amount, which is different from the currency of the debtor's account.

InstructedAmount*

{

description:	Amount of money to be moved between the debtor and creditor, before deduction of charges, expressed in the currency as ordered by the initiating party. Usage: This amount has to be transported unchanged through the transaction chain.
Amount*	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.
Currency*	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".

}

ExchangeRateInformation

{

description:	Provides details on the currency exchange rate and contract.
UnitCurrency*	`string` pattern: ^[A-Z]{3,3}$ 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 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` Specifies the type used to complete the currency exchange. Enum: [ Actual, Agreed, Indicative ]
ContractIdentification	`string` minLength: 1 maxLength: 256 Unique and unambiguous reference to the foreign exchange contract agreed between the initiating party/creditor and the debtor agent.

}

DebtorAccount

{

description:	Unambiguous identification of the account of the debtor to which a debit entry will be made as a result of the transaction.
SchemeName*	OBExternalAccountIdentification4Code`string` Name of the identification scheme, in a coded form as published in an external list.
Identification*	Identification`string` Identification assigned by an institution to identify an account. This identification is known by the account owner.
Name	`string` minLength: 1 maxLength: 70 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.

}

Creditor

{

description:

Party to which an amount of money is due.

Name

string
minLength: 1
maxLength: 140

Name by which a party is known and which is usually used to identify that party.

PostalAddress

#/definitions/OBPostalAddress6OBPostalAddress6{

description:	Information that locates and identifies a specific address, as defined by postal services.
AddressType	OBAddressTypeCode`string` Identifies the nature of the postal address. Enum: [ Business, Correspondence, DeliveryTo, MailTo, POBox, Postal, Residential, Statement ]
PostCode	PostCode`string` 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`string` Name of a built-up area, with defined boundaries, and a local government.
Country	`string` pattern: ^[A-Z]{2,2}$ Nation with its own government.
AddressLine	[ minItems: 0 maxItems: 2 `string` minLength: 1 maxLength: 70 Information that locates and identifies a specific address, as defined by postal services, presented in free format text. ]

}

CreditorAgent

{

description:

Financial institution servicing an account for the creditor.

SchemeName

string

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

Identification

string
minLength: 1
maxLength: 35

Unique and unambiguous identification of a financial institution or a branch of a financial institution.

Name

string
minLength: 1
maxLength: 140

Name by which an agent is known and which is usually used to identify that agent.

PostalAddress

#/definitions/OBPostalAddress6OBPostalAddress6{

description:	Information that locates and identifies a specific address, as defined by postal services.
AddressType	OBAddressTypeCode`string` Identifies the nature of the postal address. Enum: [ Business, Correspondence, DeliveryTo, MailTo, POBox, Postal, Residential, Statement ]
PostCode	PostCode`string` 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`string` Name of a built-up area, with defined boundaries, and a local government.
Country	`string` pattern: ^[A-Z]{2,2}$ Nation with its own government.
AddressLine	[ minItems: 0 maxItems: 2 `string` minLength: 1 maxLength: 70 Information that locates and identifies a specific address, as defined by postal services, presented in free format text. ]

}

CreditorAccount*

{

description:	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`string` Name of the identification scheme, in a coded form as published in an external list.
Identification*	Identification`string` Identification assigned by an institution to identify an account. This identification is known by the account owner.
Name*	`string` minLength: 1 maxLength: 70 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.

}

RemittanceInformation

{

description:	Information supplied to enable the matching of an entry with the items that the transfer is intended to settle, such as commercial invoices in an accounts' receivable system.
Unstructured	`string` minLength: 1 maxLength: 140 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` minLength: 1 maxLength: 35 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.

}

MultiAuthorisation

{

description:	The multiple authorisation flow response from the ASPSP.
Status*	`string` Specifies the status of the authorisation flow in code form. Enum: [ Authorised, AwaitingFurtherAuthorisation, Rejected ]

}

Links

#/definitions/LinksLinks{

description:	Links relevant to the payload
Self*	`string`
First	`string`
Prev	`string`
Next	`string`
Last	`string`

}

Meta

#/definitions/MetaMeta{

description:	Meta Data relevant to the payload
TotalPages	integer($int32)
FirstAvailableDateTime	ISODateTime`string`($date-time) All dates in the JSON payloads are represented in ISO 8601 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`string`($date-time) All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00

}

Headers:

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

400

Bad request

Example Value Model

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

#/definitions/OBErrorResponse1OBErrorResponse1{

description:

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

Code*

string
minLength: 1
maxLength: 40

High level textual error code, to help categorize the errors.

string
minLength: 1
maxLength: 40

A unique reference for the error instance, for audit purposes, in case of unknown/unclassified errors.

Message*

string
minLength: 1
maxLength: 500

Brief Error message, e.g., 'There is something wrong with the request parameters provided'

Errors*

[
minItems: 1

#/definitions/OBError1OBError1{

ErrorCode*	`string` Low level textual error code, e.g., UK.OBIE.Field.Missing
Message*	`string` minLength: 1 maxLength: 500 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` minLength: 1 maxLength: 500 Recommended but optional reference to the JSON Path of the field with error, e.g., Data.Initiation.InstructedAmount.Currency
Url	`string` URL to help remediate the problem, or provide more information, or to API Reference, or help etc

}]

}

Headers:

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

401

Unauthorized

Headers:

Name	Description	Type
x-fapi-interaction-id	An RFC4122 UID used as a correlation id.	string

403

Forbidden

Example Value Model

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

#/definitions/OBErrorResponse1OBErrorResponse1{

description:

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

Code*

string
minLength: 1
maxLength: 40

High level textual error code, to help categorize the errors.

string
minLength: 1
maxLength: 40

A unique reference for the error instance, for audit purposes, in case of unknown/unclassified errors.

Message*

string
minLength: 1
maxLength: 500

Brief Error message, e.g., 'There is something wrong with the request parameters provided'

Errors*

[
minItems: 1

#/definitions/OBError1OBError1{

ErrorCode*	`string` Low level textual error code, e.g., UK.OBIE.Field.Missing
Message*	`string` minLength: 1 maxLength: 500 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` minLength: 1 maxLength: 500 Recommended but optional reference to the JSON Path of the field with error, e.g., Data.Initiation.InstructedAmount.Currency
Url	`string` URL to help remediate the problem, or provide more information, or to API Reference, or help etc

}]

}

Headers:

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

404

Not found

Headers:

Name	Description	Type
x-fapi-interaction-id	An RFC4122 UID used as a correlation id.	string

405

Method Not Allowed

Headers:

Name	Description	Type
x-fapi-interaction-id	An RFC4122 UID used as a correlation id.	string

406

Not Acceptable

Headers:

Name	Description	Type
x-fapi-interaction-id	An RFC4122 UID used as a correlation id.	string

429

Too Many Requests

Headers:

Name	Description	Type
Retry-After	Number in seconds to wait	integer
x-fapi-interaction-id	An RFC4122 UID used as a correlation id.	string

500

Internal Server Error

Example Value Model

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

#/definitions/OBErrorResponse1OBErrorResponse1{

description:

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

Code*

string
minLength: 1
maxLength: 40

High level textual error code, to help categorize the errors.

string
minLength: 1
maxLength: 40

A unique reference for the error instance, for audit purposes, in case of unknown/unclassified errors.

Message*

string
minLength: 1
maxLength: 500

Brief Error message, e.g., 'There is something wrong with the request parameters provided'

Errors*

[
minItems: 1

#/definitions/OBError1OBError1{

ErrorCode*	`string` Low level textual error code, e.g., UK.OBIE.Field.Missing
Message*	`string` minLength: 1 maxLength: 500 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` minLength: 1 maxLength: 500 Recommended but optional reference to the JSON Path of the field with error, e.g., Data.Initiation.InstructedAmount.Currency
Url	`string` URL to help remediate the problem, or provide more information, or to API Reference, or help etc

}]

}

Headers:

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

Models

ActiveOrHistoricCurrencyCode_0

ActiveOrHistoricCurrencyCode_0string

Identification of the currency in which the account is held.
Usage: Currency should only be used in case one and the same account number covers several currencies
and the initiating party needs to identify which currency needs to be used for settlement on the account.

ActiveOrHistoricCurrencyCode_1

ActiveOrHistoricCurrencyCode_1string

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

BuildingNumberstring

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

CountryCode

CountryCodestring

Nation with its own government, occupying a particular territory.

CountrySubDivision

CountrySubDivisionstring

Identifies a subdivision of a country eg, state, region, county.

CreationDateTime

CreationDateTimestring($date-time)

ISODateTime

ISODateTimestring($date-time)

All dates in the JSON payloads are represented in ISO 8601 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{

description:	Links relevant to the payload
Self*	string
First	string
Prev	string
Next	string
Last	string

}

Meta

Meta{

description:	Meta Data relevant to the payload
TotalPages	integer($int32)
FirstAvailableDateTime	ISODateTimestring($date-time) All dates in the JSON payloads are represented in ISO 8601 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	ISODateTimestring($date-time) All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00

}

OBEntryStatus1Code

OBEntryStatus1Codestring

Status of a transaction entry on the books of the account servicer.

Enum:
[ Booked, Pending ]

OBError1

OBError1{

ErrorCode*	string Low level textual error code, e.g., UK.OBIE.Field.Missing
Message*	string minLength: 1 maxLength: 500 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 minLength: 1 maxLength: 500 Recommended but optional reference to the JSON Path of the field with error, e.g., Data.Initiation.InstructedAmount.Currency
Url	string URL to help remediate the problem, or provide more information, or to API Reference, or help etc

}

OBErrorResponse1

OBErrorResponse1{

description:

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

Code*

string
minLength: 1
maxLength: 40

High level textual error code, to help categorize the errors.

string
minLength: 1
maxLength: 40

A unique reference for the error instance, for audit purposes, in case of unknown/unclassified errors.

Message*

string
minLength: 1
maxLength: 500

Brief Error message, e.g., 'There is something wrong with the request parameters provided'

Errors*

[
minItems: 1

#/definitions/OBError1OBError1{

ErrorCode*	string Low level textual error code, e.g., UK.OBIE.Field.Missing
Message*	string minLength: 1 maxLength: 500 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 minLength: 1 maxLength: 500 Recommended but optional reference to the JSON Path of the field with error, e.g., Data.Initiation.InstructedAmount.Currency
Url	string URL to help remediate the problem, or provide more information, or to API Reference, or help etc

}]

}

OBExternalAccountIdentification4Code

OBExternalAccountIdentification4Codestring

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

OBPostalAddress6

OBPostalAddress6{

description:	Information that locates and identifies a specific address, as defined by postal services.
AddressType	OBAddressTypeCodestring Identifies the nature of the postal address. Enum: [ Business, Correspondence, DeliveryTo, MailTo, POBox, Postal, Residential, Statement ]
PostCode	PostCodestring Identifier consisting of a group of letters and/or numbers that is added to a postal address to assist the sorting of mail.
TownName	TownNamestring Name of a built-up area, with defined boundaries, and a local government.
Country	string pattern: ^[A-Z]{2,2}$ Nation with its own government.
AddressLine	[ minItems: 0 maxItems: 2 string minLength: 1 maxLength: 70 Information that locates and identifies a specific address, as defined by postal services, presented in free format text. ]

}

PostCode

PostCodestring

Identifier consisting of a group of letters and/or numbers that is added to a postal address to assist the sorting of mail.

Department

Departmentstring

Identification of a division of a large organisation or building.

Identification

Identificationstring

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

OBActiveOrHistoricCurrencyAndAmount

OBActiveOrHistoricCurrencyAndAmount{

description:	Amount of money associated with the charge type.
Amount*	OBActiveCurrencyAndAmount_SimpleTypestring A number of monetary units specified in an active currency where the unit of currency is explicit and compliant with ISO 4217.
Currency*	ActiveOrHistoricCurrencyCodestring 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".

}

OBChargeBearerType1Code

OBChargeBearerType1Codestring

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

Enum:
[ BorneByCreditor, BorneByDebtor, FollowingServiceLevel, Shared ]

OBExternalLocalInstrument1Code

OBExternalLocalInstrument1Codestring

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

OBExternalPaymentChargeType1Codestring

Charge type, in a coded form.

OBRisk1

OBRisk1{

description:

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

PaymentContextCode

string

Specifies the payment context

Enum:
[ BillPayment, EcommerceGoods, EcommerceServices, Other, PartyToParty ]

MerchantCategoryCode

string
minLength: 3
maxLength: 4

Category code conform to ISO 18245, related to the type of services or goods the merchant provides for the transaction.

MerchantCustomerIdentification

string
minLength: 1
maxLength: 70

The unique customer identifier of the PSU with the merchant.

DeliveryAddress

{

description:	Information that locates and identifies a specific address, as defined by postal services or in free format text.
AddressLine	[ minItems: 0 maxItems: 2 string minLength: 1 maxLength: 70 Information that locates and identifies a specific address, as defined by postal services, that is presented in free format text. ]
BuildingNumber	BuildingNumberstring Number that identifies the position of a building on a street.
PostCode	PostCodestring Identifier consisting of a group of letters and/or numbers that is added to a postal address to assist the sorting of mail.
TownName*	TownNamestring Name of a built-up area, with defined boundaries, and a local government.
CountrySubDivision	[ minItems: 0 maxItems: 2 string minLength: 1 maxLength: 35 Identifies a subdivision of a country, for instance state, region, county. ]
Country*	string pattern: ^[A-Z]{2,2}$ Nation with its own government, occupying a particular territory.

}

OBWriteInternationalScheduled2

{

ConsentId*

string
minLength: 1
maxLength: 128

OB: Unique identification as assigned by the ASPSP to uniquely identify the consent resource.

Initiation*

{

description:

The Initiation payload is sent by the initiating party to the ASPSP. It is used to request movement of funds from the debtor account to a creditor for a single scheduled international payment.

InstructionIdentification*

string
minLength: 1
maxLength: 35

EndToEndIdentification

string
minLength: 1
maxLength: 35

LocalInstrument

OBExternalLocalInstrument1Codestring

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

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.

Enum:
[ Normal, Urgent ]

ChargeBearer

OBChargeBearerType1Codestring

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

Enum:
[ BorneByCreditor, BorneByDebtor, FollowingServiceLevel, Shared ]

RequestedExecutionDateTime*

string($date-time)

CurrencyOfTransfer*

string
pattern: ^[A-Z]{3,3}$

Specifies the currency of the to be transferred amount, which is different from the currency of the debtor's account.

InstructedAmount*

{

description:	Amount of money to be moved between the debtor and creditor, before deduction of charges, expressed in the currency as ordered by the initiating party. Usage: This amount has to be transported unchanged through the transaction chain.
Amount*	OBActiveCurrencyAndAmount_SimpleTypestring A number of monetary units specified in an active currency where the unit of currency is explicit and compliant with ISO 4217.
Currency*	ActiveOrHistoricCurrencyCodestring 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

{

description:	Provides details on the currency exchange rate and contract.
UnitCurrency*	string pattern: ^[A-Z]{3,3}$ 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 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 Specifies the type used to complete the currency exchange. Enum: [ Actual, Agreed, Indicative ]
ContractIdentification	string minLength: 1 maxLength: 256 Unique and unambiguous reference to the foreign exchange contract agreed between the initiating party/creditor and the debtor agent.

}

DebtorAccount

{

description:	Unambiguous identification of the account of the debtor to which a debit entry will be made as a result of the transaction.
SchemeName*	OBExternalAccountIdentification4Codestring Name of the identification scheme, in a coded form as published in an external list.
Identification*	Identificationstring Identification assigned by an institution to identify an account. This identification is known by the account owner.
Name	string minLength: 1 maxLength: 70 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.

}

Creditor

{

description:

Party to which an amount of money is due.

Name

string
minLength: 1
maxLength: 140

Name by which a party is known and which is usually used to identify that party.

PostalAddress

#/definitions/OBPostalAddress6OBPostalAddress6{

description:	Information that locates and identifies a specific address, as defined by postal services.
AddressType	OBAddressTypeCodestring Identifies the nature of the postal address. Enum: [ Business, Correspondence, DeliveryTo, MailTo, POBox, Postal, Residential, Statement ]
PostCode	PostCodestring Identifier consisting of a group of letters and/or numbers that is added to a postal address to assist the sorting of mail.
TownName	TownNamestring Name of a built-up area, with defined boundaries, and a local government.
Country	string pattern: ^[A-Z]{2,2}$ Nation with its own government.
AddressLine	[ minItems: 0 maxItems: 2 string minLength: 1 maxLength: 70 Information that locates and identifies a specific address, as defined by postal services, presented in free format text. ]

}

CreditorAgent

{

description:

Financial institution servicing an account for the creditor.

SchemeName

string

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

Identification

string
minLength: 1
maxLength: 35

Unique and unambiguous identification of a financial institution or a branch of a financial institution.

Name

string
minLength: 1
maxLength: 140

Name by which an agent is known and which is usually used to identify that agent.

PostalAddress

#/definitions/OBPostalAddress6OBPostalAddress6{

description:	Information that locates and identifies a specific address, as defined by postal services.
AddressType	OBAddressTypeCodestring Identifies the nature of the postal address. Enum: [ Business, Correspondence, DeliveryTo, MailTo, POBox, Postal, Residential, Statement ]
PostCode	PostCodestring Identifier consisting of a group of letters and/or numbers that is added to a postal address to assist the sorting of mail.
TownName	TownNamestring Name of a built-up area, with defined boundaries, and a local government.
Country	string pattern: ^[A-Z]{2,2}$ Nation with its own government.
AddressLine	[ minItems: 0 maxItems: 2 string minLength: 1 maxLength: 70 Information that locates and identifies a specific address, as defined by postal services, presented in free format text. ]

}

CreditorAccount*

{

description:	Unambiguous identification of the account of the creditor to which a credit entry will be posted as a result of the payment transaction.
SchemeName*	OBExternalAccountIdentification4Codestring Name of the identification scheme, in a coded form as published in an external list.
Identification*	Identificationstring Identification assigned by an institution to identify an account. This identification is known by the account owner.
Name*	string minLength: 1 maxLength: 70 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.

}

RemittanceInformation

{

description:	Information supplied to enable the matching of an entry with the items that the transfer is intended to settle, such as commercial invoices in an accounts' receivable system.
Unstructured	string minLength: 1 maxLength: 140 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 minLength: 1 maxLength: 35 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.

}

OBWriteInternationalScheduledConsent3

{

Permission*

string

Specifies the Open Banking service request types.

Enum:
[ Create ]

Initiation*

{

description:

The Initiation payload is sent by the initiating party to the ASPSP. It is used to request movement of funds from the debtor account to a creditor for a single scheduled international payment.

InstructionIdentification*

string
minLength: 1
maxLength: 35

EndToEndIdentification

string
minLength: 1
maxLength: 35

LocalInstrument

OBExternalLocalInstrument1Codestring

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.

ChargeBearer

OBChargeBearerType1Codestring

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

Enum:
[ BorneByCreditor, BorneByDebtor, FollowingServiceLevel, Shared ]

RequestedExecutionDateTime*

string($date-time)

CurrencyOfTransfer*

string
pattern: ^[A-Z]{3,3}$

Specifies the currency of the to be transferred amount, which is different from the currency of the debtor's account.

InstructedAmount*

{

description:	Amount of money to be moved between the debtor and creditor, before deduction of charges, expressed in the currency as ordered by the initiating party. Usage: This amount has to be transported unchanged through the transaction chain.
Amount*	OBActiveCurrencyAndAmount_SimpleTypestring A number of monetary units specified in an active currency where the unit of currency is explicit and compliant with ISO 4217.
Currency*	ActiveOrHistoricCurrencyCodestring 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

{

description:	Provides details on the currency exchange rate and contract.
UnitCurrency*	string pattern: ^[A-Z]{3,3}$ 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 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 Specifies the type used to complete the currency exchange. Enum: [ Actual, Agreed, Indicative ]
ContractIdentification	string minLength: 1 maxLength: 256 Unique and unambiguous reference to the foreign exchange contract agreed between the initiating party/creditor and the debtor agent.

}

DebtorAccount

{

description:	Unambiguous identification of the account of the debtor to which a debit entry will be made as a result of the transaction.
SchemeName*	OBExternalAccountIdentification4Codestring Name of the identification scheme, in a coded form as published in an external list.
Identification*	Identificationstring Identification assigned by an institution to identify an account. This identification is known by the account owner.
Name	string minLength: 1 maxLength: 70 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.

}

Creditor

{

description:

Party to which an amount of money is due.

Name

string
minLength: 1
maxLength: 140

Name by which a party is known and which is usually used to identify that party.

PostalAddress

#/definitions/OBPostalAddress6OBPostalAddress6{

description:	Information that locates and identifies a specific address, as defined by postal services.
AddressType	OBAddressTypeCodestring Identifies the nature of the postal address. Enum: [ Business, Correspondence, DeliveryTo, MailTo, POBox, Postal, Residential, Statement ]
PostCode	PostCodestring Identifier consisting of a group of letters and/or numbers that is added to a postal address to assist the sorting of mail.
TownName	TownNamestring Name of a built-up area, with defined boundaries, and a local government.
Country	string pattern: ^[A-Z]{2,2}$ Nation with its own government.
AddressLine	[ minItems: 0 maxItems: 2 string minLength: 1 maxLength: 70 Information that locates and identifies a specific address, as defined by postal services, presented in free format text. ]

}

CreditorAgent

{

description:

Financial institution servicing an account for the creditor.

SchemeName

string

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

Identification

string
minLength: 1
maxLength: 35

Unique and unambiguous identification of a financial institution or a branch of a financial institution.

Name

string
minLength: 1
maxLength: 140

Name by which an agent is known and which is usually used to identify that agent.

PostalAddress

#/definitions/OBPostalAddress6OBPostalAddress6{

description:	Information that locates and identifies a specific address, as defined by postal services.
AddressType	OBAddressTypeCodestring Identifies the nature of the postal address. Enum: [ Business, Correspondence, DeliveryTo, MailTo, POBox, Postal, Residential, Statement ]
PostCode	PostCodestring Identifier consisting of a group of letters and/or numbers that is added to a postal address to assist the sorting of mail.
TownName	TownNamestring Name of a built-up area, with defined boundaries, and a local government.
Country	string pattern: ^[A-Z]{2,2}$ Nation with its own government.
AddressLine	[ minItems: 0 maxItems: 2 string minLength: 1 maxLength: 70 Information that locates and identifies a specific address, as defined by postal services, presented in free format text. ]

}

CreditorAccount*

{

description:	Unambiguous identification of the account of the creditor to which a credit entry will be posted as a result of the payment transaction.
SchemeName*	OBExternalAccountIdentification4Codestring Name of the identification scheme, in a coded form as published in an external list.
Identification*	Identificationstring Identification assigned by an institution to identify an account. This identification is known by the account owner.
Name*	string minLength: 1 maxLength: 70 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.

}

RemittanceInformation

{

description:	Information supplied to enable the matching of an entry with the items that the transfer is intended to settle, such as commercial invoices in an accounts' receivable system.
Unstructured	string minLength: 1 maxLength: 140 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 minLength: 1 maxLength: 35 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.

}

OBWriteInternationalScheduledConsentResponse3

OBWriteInternationalScheduledConsentResponse3{

Data*

{

ConsentId*

string
minLength: 1
maxLength: 128

OB: Unique identification as assigned by the ASPSP to uniquely identify the consent resource.

CreationDateTime*

string($date-time)

Status*

string

Specifies the status of consent resource in code form.

Enum:
[ Authorised, AwaitingAuthorisation, Consumed, Rejected ]

StatusUpdateDateTime*

string($date-time)

Permission*

string

Specifies the Open Banking service request types.

Enum:
[ Create ]

ExpectedExecutionDateTime

string($date-time)

ExpectedSettlementDateTime

string($date-time)

Charges

[{

description:

Set of elements used to provide details of a charge for the payment initiation.

ChargeBearer*

OBChargeBearerType1Codestring

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

Enum:
[ BorneByCreditor, BorneByDebtor, FollowingServiceLevel, Shared ]

Type*

OBExternalPaymentChargeType1Codestring

Charge type, in a coded form.

Amount*

#/definitions/OBActiveOrHistoricCurrencyAndAmountOBActiveOrHistoricCurrencyAndAmount{

description:	Amount of money associated with the charge type.
Amount*	OBActiveCurrencyAndAmount_SimpleTypestring A number of monetary units specified in an active currency where the unit of currency is explicit and compliant with ISO 4217.
Currency*	ActiveOrHistoricCurrencyCodestring 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

{

description:	Further detailed information on the exchange rate that has been used in the payment transaction.
UnitCurrency*	string pattern: ^[A-Z]{3,3}$ 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 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 Specifies the type used to complete the currency exchange. Enum: [ Actual, Agreed, Indicative ]
ContractIdentification	string minLength: 1 maxLength: 256 Unique and unambiguous reference to the foreign exchange contract agreed between the initiating party/creditor and the debtor agent.
ExpirationDateTime	string($date-time) 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*

{

description:

The Initiation payload is sent by the initiating party to the ASPSP. It is used to request movement of funds from the debtor account to a creditor for a single scheduled international payment.

InstructionIdentification*

string
minLength: 1
maxLength: 35

EndToEndIdentification

string
minLength: 1
maxLength: 35

LocalInstrument

OBExternalLocalInstrument1Codestring

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.

ChargeBearer

OBChargeBearerType1Codestring

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

Enum:
[ BorneByCreditor, BorneByDebtor, FollowingServiceLevel, Shared ]

RequestedExecutionDateTime*

string($date-time)

CurrencyOfTransfer*

string
pattern: ^[A-Z]{3,3}$

Specifies the currency of the to be transferred amount, which is different from the currency of the debtor's account.

InstructedAmount*

{

description:	Amount of money to be moved between the debtor and creditor, before deduction of charges, expressed in the currency as ordered by the initiating party. Usage: This amount has to be transported unchanged through the transaction chain.
Amount*	OBActiveCurrencyAndAmount_SimpleTypestring A number of monetary units specified in an active currency where the unit of currency is explicit and compliant with ISO 4217.
Currency*	ActiveOrHistoricCurrencyCodestring 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

{

description:	Provides details on the currency exchange rate and contract.
UnitCurrency*	string pattern: ^[A-Z]{3,3}$ 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 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 Specifies the type used to complete the currency exchange. Enum: [ Actual, Agreed, Indicative ]
ContractIdentification	string minLength: 1 maxLength: 256 Unique and unambiguous reference to the foreign exchange contract agreed between the initiating party/creditor and the debtor agent.

}

DebtorAccount

{

description:	Unambiguous identification of the account of the debtor to which a debit entry will be made as a result of the transaction.
SchemeName*	OBExternalAccountIdentification4Codestring Name of the identification scheme, in a coded form as published in an external list.
Identification*	Identificationstring Identification assigned by an institution to identify an account. This identification is known by the account owner.
Name	string minLength: 1 maxLength: 70 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.

}

Creditor

{

description:

Party to which an amount of money is due.

Name

string
minLength: 1
maxLength: 140

Name by which a party is known and which is usually used to identify that party.

PostalAddress

#/definitions/OBPostalAddress6OBPostalAddress6{

description:	Information that locates and identifies a specific address, as defined by postal services.
AddressType	OBAddressTypeCodestring Identifies the nature of the postal address. Enum: [ Business, Correspondence, DeliveryTo, MailTo, POBox, Postal, Residential, Statement ]
PostCode	PostCodestring Identifier consisting of a group of letters and/or numbers that is added to a postal address to assist the sorting of mail.
TownName	TownNamestring Name of a built-up area, with defined boundaries, and a local government.
Country	string pattern: ^[A-Z]{2,2}$ Nation with its own government.
AddressLine	[ minItems: 0 maxItems: 2 string minLength: 1 maxLength: 70 Information that locates and identifies a specific address, as defined by postal services, presented in free format text. ]

}

CreditorAgent

{

description:

Financial institution servicing an account for the creditor.

SchemeName

string

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

Identification

string
minLength: 1
maxLength: 35

Unique and unambiguous identification of a financial institution or a branch of a financial institution.

Name

string
minLength: 1
maxLength: 140

Name by which an agent is known and which is usually used to identify that agent.

PostalAddress

#/definitions/OBPostalAddress6OBPostalAddress6{

description:	Information that locates and identifies a specific address, as defined by postal services.
AddressType	OBAddressTypeCodestring Identifies the nature of the postal address. Enum: [ Business, Correspondence, DeliveryTo, MailTo, POBox, Postal, Residential, Statement ]
PostCode	PostCodestring Identifier consisting of a group of letters and/or numbers that is added to a postal address to assist the sorting of mail.
TownName	TownNamestring Name of a built-up area, with defined boundaries, and a local government.
Country	string pattern: ^[A-Z]{2,2}$ Nation with its own government.
AddressLine	[ minItems: 0 maxItems: 2 string minLength: 1 maxLength: 70 Information that locates and identifies a specific address, as defined by postal services, presented in free format text. ]

}

CreditorAccount*

{

description:	Unambiguous identification of the account of the creditor to which a credit entry will be posted as a result of the payment transaction.
SchemeName*	OBExternalAccountIdentification4Codestring Name of the identification scheme, in a coded form as published in an external list.
Identification*	Identificationstring Identification assigned by an institution to identify an account. This identification is known by the account owner.
Name*	string minLength: 1 maxLength: 70 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.

}

RemittanceInformation

{

description:	Information supplied to enable the matching of an entry with the items that the transfer is intended to settle, such as commercial invoices in an accounts' receivable system.
Unstructured	string minLength: 1 maxLength: 140 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 minLength: 1 maxLength: 35 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.

}

Risk*

#/definitions/OBRisk1OBRisk1{

description:

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

PaymentContextCode

string

Specifies the payment context

Enum:
[ BillPayment, EcommerceGoods, EcommerceServices, Other, PartyToParty ]

MerchantCategoryCode

string
minLength: 3
maxLength: 4

Category code conform to ISO 18245, related to the type of services or goods the merchant provides for the transaction.

MerchantCustomerIdentification

string
minLength: 1
maxLength: 70

The unique customer identifier of the PSU with the merchant.

DeliveryAddress

{

description:	Information that locates and identifies a specific address, as defined by postal services or in free format text.
AddressLine	[ minItems: 0 maxItems: 2 string minLength: 1 maxLength: 70 Information that locates and identifies a specific address, as defined by postal services, that is presented in free format text. ]
BuildingNumber	BuildingNumberstring Number that identifies the position of a building on a street.
PostCode	PostCodestring Identifier consisting of a group of letters and/or numbers that is added to a postal address to assist the sorting of mail.
TownName*	TownNamestring Name of a built-up area, with defined boundaries, and a local government.
CountrySubDivision	[ minItems: 0 maxItems: 2 string minLength: 1 maxLength: 35 Identifies a subdivision of a country, for instance state, region, county. ]
Country*	string pattern: ^[A-Z]{2,2}$ Nation with its own government, occupying a particular territory.

}

Links

#/definitions/LinksLinks{

description:	Links relevant to the payload
Self*	string
First	string
Prev	string
Next	string
Last	string

}

Meta

#/definitions/MetaMeta{

description:	Meta Data relevant to the payload
TotalPages	integer($int32)
FirstAvailableDateTime	ISODateTimestring($date-time) All dates in the JSON payloads are represented in ISO 8601 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	ISODateTimestring($date-time) All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00

}

OBWriteInternationalScheduledResponse3

OBWriteInternationalScheduledResponse3{

Data*

{

InternationalScheduledPaymentId*

string
minLength: 1
maxLength: 40

OB: Unique identification as assigned by the ASPSP to uniquely identify the international scheduled payment resource.

ConsentId*

string
minLength: 1
maxLength: 128

OB: Unique identification as assigned by the ASPSP to uniquely identify the consent resource.

CreationDateTime*

string($date-time)

Status*

string

Specifies the status of the payment order resource.

Enum:
[ Cancelled, InitiationCompleted, InitiationFailed, InitiationPending ]

StatusUpdateDateTime*

string($date-time)

ExpectedExecutionDateTime

string($date-time)

ExpectedSettlementDateTime

string($date-time)

ExchangeRateInformation

{

description:	Further detailed information on the exchange rate that has been used in the payment transaction.
UnitCurrency*	string pattern: ^[A-Z]{3,3}$ 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 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 Specifies the type used to complete the currency exchange. Enum: [ Actual, Agreed, Indicative ]
ContractIdentification	string minLength: 1 maxLength: 256 Unique and unambiguous reference to the foreign exchange contract agreed between the initiating party/creditor and the debtor agent.

}

Initiation*

{

description:

The Initiation payload is sent by the initiating party to the ASPSP. It is used to request movement of funds from the debtor account to a creditor for a single scheduled international payment.

InstructionIdentification*

string
minLength: 1
maxLength: 35

EndToEndIdentification

string
minLength: 1
maxLength: 35

LocalInstrument

OBExternalLocalInstrument1Codestring

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

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.

Enum:
[ Normal, Urgent ]

Purpose

string

ChargeBearer

OBChargeBearerType1Codestring

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

Enum:
[ BorneByCreditor, BorneByDebtor, FollowingServiceLevel, Shared ]

RequestedExecutionDateTime*

string($date-time)

CurrencyOfTransfer*

string
pattern: ^[A-Z]{3,3}$

Specifies the currency of the to be transferred amount, which is different from the currency of the debtor's account.

InstructedAmount*

{

description:	Amount of money to be moved between the debtor and creditor, before deduction of charges, expressed in the currency as ordered by the initiating party. Usage: This amount has to be transported unchanged through the transaction chain.
Amount*	OBActiveCurrencyAndAmount_SimpleTypestring A number of monetary units specified in an active currency where the unit of currency is explicit and compliant with ISO 4217.
Currency*	ActiveOrHistoricCurrencyCodestring 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

{

description:	Provides details on the currency exchange rate and contract.
UnitCurrency*	string pattern: ^[A-Z]{3,3}$ 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 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 Specifies the type used to complete the currency exchange. Enum: [ Actual, Agreed, Indicative ]
ContractIdentification	string minLength: 1 maxLength: 256 Unique and unambiguous reference to the foreign exchange contract agreed between the initiating party/creditor and the debtor agent.

}

DebtorAccount

{

description:	Unambiguous identification of the account of the debtor to which a debit entry will be made as a result of the transaction.
SchemeName*	OBExternalAccountIdentification4Codestring Name of the identification scheme, in a coded form as published in an external list.
Identification*	Identificationstring Identification assigned by an institution to identify an account. This identification is known by the account owner.
Name	string minLength: 1 maxLength: 70 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.

}

Creditor

{

description:

Party to which an amount of money is due.

Name

string
minLength: 1
maxLength: 140

Name by which a party is known and which is usually used to identify that party.

PostalAddress

#/definitions/OBPostalAddress6OBPostalAddress6{

description:	Information that locates and identifies a specific address, as defined by postal services.
AddressType	OBAddressTypeCodestring Identifies the nature of the postal address. Enum: [ Business, Correspondence, DeliveryTo, MailTo, POBox, Postal, Residential, Statement ]
PostCode	PostCodestring Identifier consisting of a group of letters and/or numbers that is added to a postal address to assist the sorting of mail.
TownName	TownNamestring Name of a built-up area, with defined boundaries, and a local government.
Country	string pattern: ^[A-Z]{2,2}$ Nation with its own government.
AddressLine	[ minItems: 0 maxItems: 2 string minLength: 1 maxLength: 70 Information that locates and identifies a specific address, as defined by postal services, presented in free format text. ]

}

CreditorAgent

{

description:

Financial institution servicing an account for the creditor.

SchemeName

string

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

Identification

string
minLength: 1
maxLength: 35

Unique and unambiguous identification of a financial institution or a branch of a financial institution.

Name

string
minLength: 1
maxLength: 140

Name by which an agent is known and which is usually used to identify that agent.

PostalAddress

#/definitions/OBPostalAddress6OBPostalAddress6{

description:	Information that locates and identifies a specific address, as defined by postal services.
AddressType	OBAddressTypeCodestring Identifies the nature of the postal address. Enum: [ Business, Correspondence, DeliveryTo, MailTo, POBox, Postal, Residential, Statement ]
PostCode	PostCodestring Identifier consisting of a group of letters and/or numbers that is added to a postal address to assist the sorting of mail.
TownName	TownNamestring Name of a built-up area, with defined boundaries, and a local government.
Country	string pattern: ^[A-Z]{2,2}$ Nation with its own government.
AddressLine	[ minItems: 0 maxItems: 2 string minLength: 1 maxLength: 70 Information that locates and identifies a specific address, as defined by postal services, presented in free format text. ]

}

CreditorAccount*

{

description:	Unambiguous identification of the account of the creditor to which a credit entry will be posted as a result of the payment transaction.
SchemeName*	OBExternalAccountIdentification4Codestring Name of the identification scheme, in a coded form as published in an external list.
Identification*	Identificationstring Identification assigned by an institution to identify an account. This identification is known by the account owner.
Name*	string minLength: 1 maxLength: 70 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.

}

RemittanceInformation

{

description:	Information supplied to enable the matching of an entry with the items that the transfer is intended to settle, such as commercial invoices in an accounts' receivable system.
Unstructured	string minLength: 1 maxLength: 140 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 minLength: 1 maxLength: 35 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.

}

MultiAuthorisation

{

description:	The multiple authorisation flow response from the ASPSP.
Status*	string Specifies the status of the authorisation flow in code form. Enum: [ Authorised, AwaitingFurtherAuthorisation, Rejected ]

}

Links

#/definitions/LinksLinks{

description:	Links relevant to the payload
Self*	string
First	string
Prev	string
Next	string
Last	string

}

Meta

#/definitions/MetaMeta{

description:	Meta Data relevant to the payload
TotalPages	integer($int32)
FirstAvailableDateTime	ISODateTimestring($date-time) All dates in the JSON payloads are represented in ISO 8601 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	ISODateTimestring($date-time) All dates in the JSON payloads are represented in ISO 8601 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

OBActiveCurrencyAndAmount_SimpleTypestring

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

OBAddressTypeCode

OBAddressTypeCodestring

Identifies the nature of the postal address.

Enum:
[ Business, Correspondence, DeliveryTo, MailTo, POBox, Postal, Residential, Statement ]

TownName

TownNamestring

Name of a built-up area, with defined boundaries, and a local government.

ActiveOrHistoricCurrencyCode

ActiveOrHistoricCurrencyCodestring

Having trouble?

Contact our dedicated team members via our ticketing system or via our support mailbox

OpenBankingResponse@virginmoney.com