|
Version | Date | Author | Comments |
---|---|---|---|
3.0-draft5 | OB R/W API Team | First draft of v3-draft5 | |
3.0-draft6/rc1 | OB R/W API Team | Draft6 changes:
| |
3.0-draft7 | OB R/W API Team | Draft7 Changes:
| |
3.0-RC2 | OB R/W API Team | RC2 Changes:
| |
3.0-RC3 | OB R/W API Team | No Change | |
3.0 | OB R/W API Team | This is the baseline version. No change from RC3. |
Resource | HTTP Operation | Endpoint | Mandatory ? | Scope | Grant Type | Message Signing | Idempotency Key | Request Object | Response Object |
---|---|---|---|---|---|---|---|---|---|
international-standing-order-consents | POST | POST /international-standing-order-consents | Conditional | payments | Client Credentials | Signed Request Signed Response | Yes | OBWriteInternationalStandingOrderConsent1 | OBWriteInternationalStandingOrderConsentResponse1 |
international-standing-order-consents | GET | GET /international-standing-order-consents/{ConsentId} | Mandatory (if resource POST implemented) | payments | Client Credentials | Signed Response | No | NA | OBWriteInternationalStandingOrderConsentResponse1 |
international-standing-orders | POST | POST /international-standing-orders | Conditional | payments | Authorization Code | Signed Request Signed Response | Yes | OBWriteInternationalStandingOrder1 | OBWriteInternationalStandingOrderResponse1 |
international-standing-orders | GET | GET /international-standing-orders/{InternationalStandingOrderPaymentId} | Mandatory (if resource POST implemented) | payments | Client Credentials | Signed Response | No | NA | OBWriteInternationalStandingOrderResponse1 |
POST /international-standing-order-consents |
The API endpoint allows the PISP to ask an ASPSP to create a new international-standing-order-consent resource.
The default Status is "AwaitingAuthorisation" immediately after the international-standing-order-consent has been created.
Status |
---|
AwaitingAuthorisation |
GET /international-standing-order-consents/{ConsentId} |
A PISP can optionally retrieve a payment consent resource that they have created to check its status.
Once the PSU authorises the payment-consent resource - the Status of the payment-consent resource will be updated with "Authorised".
If the PSU rejects the consent or the international-standing-order-consent has failed some other ASPSP validation, the Status will be set to "Rejected".
Once an international-standing-orders has been successfully created using the international-standing-order-consent, the Status of the international-standing-order-consent will be set to "Consumed".
The available Status codes for the international-standing-order-consent resource are:
Status |
---|
AwaitingAuthorisation |
Rejected |
Authorised |
Consumed |
POST /international-standing-orders |
Once the international-standing-order-consent has been authorised by the PSU, the PISP can proceed to submit the international-standing-orders for processing:
An international-standing-orders can only be created if its corresponding international-standing-order-consent resource has the status of "Authorised".
The international-standing-orders resource that is created successfully must have one of the following Status codes
Status |
---|
InitiationPending |
InitiationFailed |
InitiationCompleted |
GET /international-standing-orders/{InternationalStandingOrderPaymentId} |
A PISP can retrieve the international-standing-orders to check its status.
The international-standing-orders resource must have one of the following Status codes:
Status |
---|
InitiationPending |
InitiationFailed |
InitiationCompleted |
The state model for the international-standing-order-consent resource follows the generic consent state model. However, does not use the "Revoked" status, as the consent for an international-standing-order is not a long-lived consent.
The definitions for the Status:
Status | Status Description | |
---|---|---|
1 | AwaitingAuthorisation | The consent resource is awaiting PSU authorisation. |
2 | Rejected | The consent resource has been rejected. |
3 | Authorised | The consent resource has been successfully authorised. |
4 | Consumed | The consented action has been successfully completed. This does not reflect the status of the consented action. |
The state model for the international-standing-orders resource describes the initiation status only. I.e. not the subsequent execution of the international-standing-orders.
The definitions for the Status:
Status | Payment Status Description | |
---|---|---|
1 | InitiationPending | The initiation of the payment order is pending. |
2 | InitiationFailed | The initiation of the payment order has failed. |
3 | InitiationCompleted | The initiation of the payment order is complete. |
If the payment-order requires multiple authorisations - the Status of the multiple authorisations will be updated in the MultiAuthorisation object.
The definitions for the Status:
Status | Status Description | |
---|---|---|
1 | AwaitingFurtherAuthorisation | The payment-order resource is awaiting further authorisation. |
2 | Rejected | The payment-order resource has been rejected by an authoriser. |
3 | Authorised | The payment-order resource has been successfully authorised by all required authorisers. |
The data dictionary section gives the detail on the payload content for the International Standing Order API flows.
This section describes the OBInternationalStandingOrder1 class - which is reused as the Initiation object in the international-standing-order-consent and international-standing-orders resources.
For the OBInternationalStandingOrder1 Initiation object:
If the ASPSP is able to establish a problem with payload or any contextual error during the API call, the ASPSP must reject the international-standing-order-consent request immediately
If the ASPSP establishes a problem with the international-standing-order-consent after the API call, the ASPSP must set the Status of the international-standing-order-consent resource to Rejected
Name | Occurrence | XPath | EnhancedDefinition | Class | Codes | Pattern |
---|---|---|---|---|---|---|
OBInternationalStandingOrder1 | OBInternationalStandingOrder1 | The Initiation payload is sent by the initiating party to the ASPSP. It is used to request movement of funds from the debtor account to a creditor for an international standing order. | OBInternationalStandingOrder1 | |||
Frequency | 1..1 | OBInternationalStandingOrder1/Frequency | Individual Definitions: EvryDay - Every day EvryWorkgDay - Every working day IntrvlWkDay - An interval specified in weeks (01 to 09), and the day within the week (01 to 07) WkInMnthDay - A monthly interval, specifying the week of the month (01 to 05) and day within the week (01 to 07) IntrvlMnthDay - An interval specified in months (between 01 to 06, 12, 24), specifying the day within the month (-5 to -1, 1 to 31) QtrDay - Quarterly (either ENGLISH, SCOTTISH, or RECEIVED). ENGLISH = Paid on the 25th March, 24th June, 29th September and 25th December. SCOTTISH = Paid on the 2nd February, 15th May, 1st August and 11th November. RECEIVED = Paid on the 20th March, 19th June, 24th September and 20th December. Individual Patterns: EvryDay (ScheduleCode) EvryWorkgDay (ScheduleCode) IntrvlWkDay:IntervalInWeeks:DayInWeek (ScheduleCode + IntervalInWeeks + DayInWeek) WkInMnthDay:WeekInMonth:DayInWeek (ScheduleCode + WeekInMonth + DayInWeek) IntrvlMnthDay:IntervalInMonths:DayInMonth (ScheduleCode + IntervalInMonths + DayInMonth) QtrDay: + either (ENGLISH, SCOTTISH or RECEIVED) ScheduleCode + QuarterDay The regular expression for this element combines five smaller versions for each permitted pattern. To aid legibility - the components are presented individually here: EvryDay EvryWorkgDay IntrvlWkDay:0[1-9]:0[1-7] WkInMnthDay:0[1-5]:0[1-7] IntrvlMnthDay:(0[1-6]|12|24):(-0[1-5]|0[1-9]|[12][0-9]|3[01]) QtrDay:(ENGLISH|SCOTTISH|RECEIVED) Full Regular Expression: ^(EvryDay)$|^(EvryWorkgDay)$|^(IntrvlWkDay:0[1-9]:0[1-7])$|^(WkInMnthDay:0[1-5]:0[1-7])$|^(IntrvlMnthDay:(0[1-6]|12|24):(-0[1-5]|0[1-9]|[12][0-9]|3[01]))$|^(QtrDay:(ENGLISH|SCOTTISH|RECEIVED))$ | Max35Text | ^(EvryDay)$|^(EvryWorkgDay)$|^(IntrvlWkDay:0[1-9]:0[1-7])$|^(WkInMnthDay:0[1-5]:0[1-7])$|^(IntrvlMnthDay:(0[1-6]|12|24):(-0[1-5]|0[1-9]|[12][0-9]|3[01]))$|^(QtrDay:(ENGLISH|SCOTTISH|RECEIVED))$ | |
Reference | 0..1 | OBInternationalStandingOrder1/Reference | 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. | Max35Text | ||
NumberOfPayments | 0..1 | OBInternationalStandingOrder1/NumberOfPayments | Number of the payments that will be made in completing this frequency sequence including any executed since the sequence start date. | Max35Text | ||
FirstPaymentDateTime | 1..1 | OBInternationalStandingOrder1/FirstPaymentDateTime | The date on which the first payment for a Standing Order schedule will be made. | ISODateTime | ||
FinalPaymentDateTime | 0..1 | OBInternationalStandingOrder1/FinalPaymentDateTime | The date on which the final payment for a Standing Order schedule will be made. | ISODateTime | ||
Purpose | 0..1 | OBInternationalStandingOrder1/Purpose | Specifies the external purpose code in the format of character string with a maximum length of 35 characters. The list of valid codes is an external code list published separately. External code sets can be downloaded from www.iso20022.org. | ExternalPurposeCode | ||
ChargeBearer | 0..1 | OBInternationalStandingOrder1/ChargeBearer | Specifies which party/parties will bear the charges associated with the processing of the payment transaction. | OBChargeBearerType1Code | BorneByCreditor BorneByDebtor FollowingServiceLevel Shared | |
CurrencyOfTransfer | 1..1 | OBInternationalStandingOrder1/CurrencyOfTransfer | Specifies the currency of the to be transferred amount, which is different from the currency of the debtor's account. | ActiveOrHistoricCurrencyCode | ^[A-Z]{3,3}$ | |
InstructedAmount | 1..1 | OBInternationalStandingOrder1/InstructedAmount | 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. | OBActiveOrHistoricCurrencyAndAmount | ||
Amount | 1..1 | OBInternationalStandingOrder1/InstructedAmount/Amount | A number of monetary units specified in an active currency where the unit of currency is explicit and compliant with ISO 4217. | ActiveCurrencyAndAmount_SimpleType | ||
Currency | 1..1 | OBInternationalStandingOrder1/InstructedAmount/Currency | 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". | ActiveOrHistoricCurrencyCode | ^[A-Z]{3,3}$ | |
DebtorAccount | 0..1 | OBInternationalStandingOrder1/DebtorAccount | Provides the details to identify the debtor account. | OBCashAccountDebtor3 | ||
SchemeName | 1..1 | OBInternationalStandingOrder1/DebtorAccount/SchemeName | Name of the identification scheme, in a coded form as published in an external list. | Max40Text | ||
Identification | 1..1 | OBInternationalStandingOrder1/DebtorAccount/Identification | Identification assigned by an institution to identify an account. This identification is known by the account owner. | Max256Text | ||
Name | 0..1 | OBInternationalStandingOrder1/DebtorAccount/Name | Name of the account, as assigned by the account servicing institution. Usage: The account name is the name or names of the account owner(s) represented at an account level. The account name is not the product name or the nickname of the account. | Max70Text | ||
SecondaryIdentification | 0..1 | OBInternationalStandingOrder1/DebtorAccount/SecondaryIdentification | This is secondary identification of the account, as assigned by the account servicing institution. This can be used by building societies to additionally identify accounts with a roll number (in addition to a sort code and account number combination). | Max34Text | ||
Creditor | 0..1 | OBInternationalStandingOrder1/Creditor | Party to which an amount of money is due. | OBPartyIdentification43 | ||
Name | 0..1 | OBInternationalStandingOrder1/Creditor/Name | Name by which a party is known and which is usually used to identify that party. | Max140Text | ||
PostalAddress | 0..1 | OBInternationalStandingOrder1/Creditor/PostalAddress | Information that locates and identifies a specific address, as defined by postal services. | OBPostalAddress6 | ||
AddressType | 0..1 | OBInternationalStandingOrder1/Creditor/PostalAddress/AddressType | Identifies the nature of the postal address. | OBAddressTypeCode | Business Correspondence DeliveryTo MailTo POBox Postal Residential Statement | |
Department | 0..1 | OBInternationalStandingOrder1/Creditor/PostalAddress/Department | Identification of a division of a large organisation or building. | Max70Text | ||
SubDepartment | 0..1 | OBInternationalStandingOrder1/Creditor/PostalAddress/SubDepartment | Identification of a sub-division of a large organisation or building. | Max70Text | ||
StreetName | 0..1 | OBInternationalStandingOrder1/Creditor/PostalAddress/StreetName | Name of a street or thoroughfare. | Max70Text | ||
BuildingNumber | 0..1 | OBInternationalStandingOrder1/Creditor/PostalAddress/BuildingNumber | Number that identifies the position of a building on a street. | Max16Text | ||
PostCode | 0..1 | OBInternationalStandingOrder1/Creditor/PostalAddress/PostCode | Identifier consisting of a group of letters and/or numbers that is added to a postal address to assist the sorting of mail. | Max16Text | ||
TownName | 0..1 | OBInternationalStandingOrder1/Creditor/PostalAddress/TownName | Name of a built-up area, with defined boundaries, and a local government. | Max35Text | ||
CountrySubDivision | 0..1 | OBInternationalStandingOrder1/Creditor/PostalAddress/CountrySubDivision | Identifies a subdivision of a country such as state, region, county. | Max35Text | ||
Country | 0..1 | OBInternationalStandingOrder1/Creditor/PostalAddress/Country | Nation with its own government. | CountryCode | ^[A-Z]{2,2}$ | |
AddressLine | 0..7 | OBInternationalStandingOrder1/Creditor/PostalAddress/AddressLine | Information that locates and identifies a specific address, as defined by postal services, presented in free format text. | Max70Text | ||
CreditorAgent | 0..1 | OBInternationalStandingOrder1/CreditorAgent | Party that manages the account on behalf of the account owner, that is manages the registration and booking of entries on the account, calculates balances on the account and provides information about the account. This is the servicer of the beneficiary account. | OBBranchAndFinancialInstitutionIdentification3 | ||
SchemeName | 0..1 | OBInternationalStandingOrder1/CreditorAgent/SchemeName | Name of the identification scheme, in a coded form as published in an external list. | Max40Text | ||
Identification | 0..1 | OBInternationalStandingOrder1/CreditorAgent/Identification | Unique and unambiguous identification of the servicing institution. | Max35Text | ||
Name | 0..1 | OBInternationalStandingOrder1/CreditorAgent/Name | Name by which an agent is known and which is usually used to identify that agent. | Max140Text | ||
PostalAddress | 0..1 | OBInternationalStandingOrder1/CreditorAgent/PostalAddress | Information that locates and identifies a specific address, as defined by postal services. | OBPostalAddress6 | ||
AddressType | 0..1 | OBInternationalStandingOrder1/CreditorAgent/PostalAddress/AddressType | Identifies the nature of the postal address. | OBAddressTypeCode | Business Correspondence DeliveryTo MailTo POBox Postal Residential Statement | |
Department | 0..1 | OBInternationalStandingOrder1/CreditorAgent/PostalAddress/Department | Identification of a division of a large organisation or building. | Max70Text | ||
SubDepartment | 0..1 | OBInternationalStandingOrder1/CreditorAgent/PostalAddress/SubDepartment | Identification of a sub-division of a large organisation or building. | Max70Text | ||
StreetName | 0..1 | OBInternationalStandingOrder1/CreditorAgent/PostalAddress/StreetName | Name of a street or thoroughfare. | Max70Text | ||
BuildingNumber | 0..1 | OBInternationalStandingOrder1/CreditorAgent/PostalAddress/BuildingNumber | Number that identifies the position of a building on a street. | Max16Text | ||
PostCode | 0..1 | OBInternationalStandingOrder1/CreditorAgent/PostalAddress/PostCode | Identifier consisting of a group of letters and/or numbers that is added to a postal address to assist the sorting of mail. | Max16Text | ||
TownName | 0..1 | OBInternationalStandingOrder1/CreditorAgent/PostalAddress/TownName | Name of a built-up area, with defined boundaries, and a local government. | Max35Text | ||
CountrySubDivision | 0..1 | OBInternationalStandingOrder1/CreditorAgent/PostalAddress/CountrySubDivision | Identifies a subdivision of a country such as state, region, county. | Max35Text | ||
Country | 0..1 | OBInternationalStandingOrder1/CreditorAgent/PostalAddress/Country | Nation with its own government. | CountryCode | ^[A-Z]{2,2}$ | |
AddressLine | 0..7 | OBInternationalStandingOrder1/CreditorAgent/PostalAddress/AddressLine | Information that locates and identifies a specific address, as defined by postal services, presented in free format text. | Max70Text | ||
CreditorAccount | 1..1 | OBInternationalStandingOrder1/CreditorAccount | Provides the details to identify the beneficiary account. | OBCashAccountCreditor2 | ||
SchemeName | 1..1 | OBInternationalStandingOrder1/CreditorAccount/SchemeName | Name of the identification scheme, in a coded form as published in an external list. | Max40Text | ||
Identification | 1..1 | OBInternationalStandingOrder1/CreditorAccount/Identification | Identification assigned by an institution to identify an account. This identification is known by the account owner. | Max256Text | ||
Name | 1..1 | OBInternationalStandingOrder1/CreditorAccount/Name | Name of the account, as assigned by the account servicing institution. Usage: The account name is the name or names of the account owner(s) represented at an account level. The account name is not the product name or the nickname of the account. OB: ASPSPs may carry out name validation for Confirmation of Payee, but it is not mandatory. | Max70Text | ||
SecondaryIdentification | 0..1 | OBInternationalStandingOrder1/CreditorAccount/SecondaryIdentification | This is secondary identification of the account, as assigned by the account servicing institution. This can be used by building societies to additionally identify accounts with a roll number (in addition to a sort code and account number combination). | Max34Text |
The OBWriteInternationalStandingOrderConsent1 object will be used for the call to:
The international-standing-order-consent request contains these objects:
Name | Occurrence | XPath | EnhancedDefinition | Class | Codes | Pattern |
---|---|---|---|---|---|---|
OBWriteInternationalStandingOrderConsent1 | OBWriteInternationalStandingOrderConsent1 | OBWriteInternationalStandingOrderConsent1 | ||||
Data | 1..1 | OBWriteInternationalStandingOrderConsent1/Data | OBWriteDataInternationalStandingOrderConsent1 | |||
Permission | 1..1 | OBWriteInternationalStandingOrderConsent1/Data/Permission | Specifies the Open Banking service request types. | OBExternalPermissions2Code | Create | |
Initiation | 1..1 | OBWriteInternationalStandingOrderConsent1/Data/Initiation | The Initiation payload is sent by the initiating party to the ASPSP. It is used to request movement of funds from the debtor account to a creditor for an international standing order. | OBInternationalStandingOrder1 | ||
Authorisation | 0..1 | OBWriteInternationalStandingOrderConsent1/Data/Authorisation | OBAuthorisation1 | |||
Risk | 1..1 | OBWriteInternationalStandingOrderConsent1/Risk | The Risk section is sent by the initiating party to the ASPSP. It is used to specify additional details for risk scoring for Payments. | OBRisk1 |
The OBWriteInternationalStandingOrderConsentResponse1 object will be used for a response to a call to:
The international-standing-order-consent response contains the full original payload from the international-standing-order-consent request - with these additional elements:
Name | Occurrence | XPath | EnhancedDefinition | Class | Codes | Pattern |
---|---|---|---|---|---|---|
OBWriteInternationalStandingOrderConsentResponse1 | OBWriteInternationalStandingOrderConsentResponse1 | OBWriteInternationalStandingOrderConsentResponse1 | ||||
Data | 1..1 | OBWriteInternationalStandingOrderConsentResponse1/Data | OBWriteDataInternationalStandingOrderConsentResponse1 | |||
ConsentId | 1..1 | OBWriteInternationalStandingOrderConsentResponse1/Data/ConsentId | OB: Unique identification as assigned by the ASPSP to uniquely identify the consent resource. | Max128Text | ||
CreationDateTime | 1..1 | OBWriteInternationalStandingOrderConsentResponse1/Data/CreationDateTime | Date and time at which the resource was created. | ISODateTime | ||
Status | 1..1 | OBWriteInternationalStandingOrderConsentResponse1/Data/Status | Specifies the status of resource in code form. | OBExternalConsentStatus1Code | Authorised AwaitingAuthorisation Consumed Rejected | |
StatusUpdateDateTime | 1..1 | OBWriteInternationalStandingOrderConsentResponse1/Data/StatusUpdateDateTime | Date and time at which the resource status was updated. | ISODateTime | ||
Permission | 1..1 | OBWriteInternationalStandingOrderConsentResponse1/Data/Permission | Specifies the Open Banking service request types. | OBExternalPermissions2Code | Create | |
CutOffDateTime | 0..1 | OBWriteInternationalStandingOrderConsentResponse1/Data/CutOffDateTime | Specified cut-off date and time for the payment consent. | ISODateTime | ||
Charges | 0..n | OBWriteInternationalStandingOrderConsentResponse1/Data/Charges | Set of elements used to provide details of a charge for the payment initiation. | OBCharge1 | ||
Initiation | 1..1 | OBWriteInternationalStandingOrderConsentResponse1/Data/Initiation | The Initiation payload is sent by the initiating party to the ASPSP. It is used to request movement of funds from the debtor account to a creditor for an international standing order. | OBInternationalStandingOrder1 | ||
Authorisation | 0..1 | OBWriteInternationalStandingOrderConsentResponse1/Data/Authorisation | OBAuthorisation1 | |||
Risk | 1..1 | OBWriteInternationalStandingOrderConsentResponse1/Risk | The Risk section is sent by the initiating party to the ASPSP. It is used to specify additional details for risk scoring for Payments. | OBRisk1 |
The OBWriteInternationalStandingOrder1 object will be used for a call to:
The international-standing-orders request object contains the:
The Initiation and Risk sections of the international-standing-orders request must match the Initiation and Risk sections of the corresponding international-standing-order-consent request.
Name | Occurrence | XPath | EnhancedDefinition | Class | Codes | Pattern |
---|---|---|---|---|---|---|
OBWriteInternationalStandingOrder1 | OBWriteInternationalStandingOrder1 | OBWriteInternationalStandingOrder1 | ||||
Data | 1..1 | OBWriteInternationalStandingOrder1/Data | OBWriteDataInternationalStandingOrder1 | |||
ConsentId | 1..1 | OBWriteInternationalStandingOrder1/Data/ConsentId | OB: Unique identification as assigned by the ASPSP to uniquely identify the consent resource. | Max128Text | ||
Initiation | 1..1 | OBWriteInternationalStandingOrder1/Data/Initiation | The Initiation payload is sent by the initiating party to the ASPSP. It is used to request movement of funds from the debtor account to a creditor for an international standing order. | OBInternationalStandingOrder1 | ||
Risk | 1..1 | OBWriteInternationalStandingOrder1/Risk | The Risk section is sent by the initiating party to the ASPSP. It is used to specify additional details for risk scoring for Payments. | OBRisk1 |
The OBWriteInternationalStandingOrderResponse1 object will be used for a response to a call to:
The international-standing-orders response object contains the:
Name | Occurrence | XPath | EnhancedDefinition | Class | Codes | Pattern |
---|---|---|---|---|---|---|
OBWriteInternationalStandingOrderResponse1 | OBWriteInternationalStandingOrderResponse1 | OBWriteInternationalStandingOrderResponse1 | ||||
Data | 1..1 | OBWriteInternationalStandingOrderResponse1/Data | OBWriteDataInternationalStandingOrderResponse1 | |||
InternationalStandingOrderId | 1..1 | OBWriteInternationalStandingOrderResponse1/Data/InternationalStandingOrderId | OB: Unique identification as assigned by the ASPSP to uniquely identify the international standing order resource. | Max128Text | ||
ConsentId | 1..1 | OBWriteInternationalStandingOrderResponse1/Data/ConsentId | OB: Unique identification as assigned by the ASPSP to uniquely identify the consent resource. | Max128Text | ||
CreationDateTime | 1..1 | OBWriteInternationalStandingOrderResponse1/Data/CreationDateTime | Date and time at which the resource was created. | ISODateTime | ||
Status | 1..1 | OBWriteInternationalStandingOrderResponse1/Data/Status | Specifies the status of resource in code form. | OBExternalStatus1Code | InitiationCompleted InitiationFailed InitiationPending | |
StatusUpdateDateTime | 1..1 | OBWriteInternationalStandingOrderResponse1/Data/StatusUpdateDateTime | Date and time at which the resource status was updated. | ISODateTime | ||
Charges | 0..n | OBWriteInternationalStandingOrderResponse1/Data/Charges | Set of elements used to provide details of a charge for the payment initiation. | OBCharge1 | ||
Initiation | 1..1 | OBWriteInternationalStandingOrderResponse1/Data/Initiation | The Initiation payload is sent by the initiating party to the ASPSP. It is used to request movement of funds from the debtor account to a creditor for an international standing order. | OBInternationalStandingOrder1 | ||
MultiAuthorisation | 0..1 | OBWriteInternationalStandingOrderResponse1/Data/MultiAuthorisation | OBMultiAuthorisation1 |
POST /international-standing-order-consents
POST /international-standing-order-consents HTTP/1.1 Authorization: Bearer 2YotnFZFEjr1zCsicMWpAA x-jws-signature: TGlmZSdzIGEgam91cm5leSBub3QgYSBkZXN0aW5hdGlvbiA=..T2ggZ29vZCBldmVuaW5nIG1yIHR5bGVyIGdvaW5nIGRvd24gPw== x-fapi-financial-id: OB/2017/001 x-fapi-customer-last-logged-time: Mon, 01 Jan 2018 02:43:31 GMT x-fapi-customer-ip-address: 104.25.212.99 x-fapi-interaction-id: 93bac548-d2de-4546-b106-880a5018460d Content-Type: application/json Accept: application/json { "Data": { "Permission": "Create", "Initiation": { "Frequency": "EvryWorkgDay", "FirstPaymentDateTime": "2018-06-06T06:06:06+00:00", "FinalPaymentDateTime": "2020-03-20T06:06:06+00:00", "DebtorAccount": { "SchemeName": "UK.OBIE.SortCodeAccountNumber", "Identification": "11280001234567", "Name": "Andrea Frost" }, "CreditorAccount": { "SchemeName": "UK.OBIE.IBAN", "Identification": "DE89370400440532013000", "Name": "Tom Kirkman" }, "InstructedAmount": { "Amount": "20", "Currency": "EUR" }, "CurrencyOfTansfer":"EUR" } }, "Risk": { "PaymentContextCode": "PartyToParty" } } |
POST /international-standing-order-consents response
HTTP/1.1 201 Created x-jws-signature: V2hhdCB3ZSBnb3QgaGVyZQ0K..aXMgZmFpbHVyZSB0byBjb21tdW5pY2F0ZQ0K x-fapi-interaction-id: 93bac548-d2de-4546-b106-880a5018460d Content-Type: application/json { "Data": { "ConsentId": "ISOC-100", "CreationDateTime": "2018-01-01T06:06:06+00:00", "Status": "AwaitingAuthorisation", "StatusUpdateDateTime": "2018-01-01T06:06:06+00:00", "Permission": "Create", "Initiation": { "Frequency": "EvryWorkgDay", "FirstPaymentDateTime": "2018-06-06T06:06:06+00:00", "FinalPaymentDateTime": "2020-03-20T06:06:06+00:00", "DebtorAccount": { "SchemeName": "UK.OBIE.SortCodeAccountNumber", "Identification": "11280001234567", "Name": "Andrea Frost" }, "CreditorAccount": { "SchemeName": "UK.OBIE.IBAN", "Identification": "DE89370400440532013000", "Name": "Tom Kirkman" }, "InstructedAmount": { "Amount": "20", "Currency": "EUR" }, "CurrencyOfTansfer":"EUR" } }, "Risk": { "PaymentContextCode": "PartyToParty" }, "Links": { "Self": "https://api.alphabank.com/open-banking/v3.0/international-standing-order-consents/ISOC-100" }, "Meta": {} } |
POST /international-standing-orders request
POST /international-standing-orders HTTP/1.1 Authorization: Bearer eYJQLMQLMQLM x-jws-signature: TGlmZSdzIGEgam91cm5leSBub3QgYSBkZXN0aW5hdGlvbiA=..T2ggZ29vZCBldmVuaW5nIG1yIHR5bGVyIGdvaW5nIGRvd24gPw== x-fapi-financial-id: OB/2017/001 x-fapi-customer-last-logged-time: Mon, 01 Jan 2018 02:43:31 GMT x-fapi-customer-ip-address: 104.25.212.99 x-fapi-interaction-id: 93bac548-d2de-4546-b106-880a5018460d Content-Type: application/json Accept: application/json { "Data": { "ConsentId": "ISOC-100", "Initiation": { "Frequency": "EvryWorkgDay", "FirstPaymentDateTime": "2018-06-06T06:06:06+00:00", "FinalPaymentDateTime": "2020-03-20T06:06:06+00:00", "DebtorAccount": { "SchemeName": "UK.OBIE.SortCodeAccountNumber", "Identification": "11280001234567", "Name": "Andrea Frost" }, "CreditorAccount": { "SchemeName": "UK.OBIE.IBAN", "Identification": "DE89370400440532013000", "Name": "Tom Kirkman" }, "InstructedAmount": { "Amount": "20", "Currency": "EUR" }, "CurrencyOfTansfer":"EUR" } }, "Risk": { "PaymentContextCode": "PartyToParty" } } |
POST /international-standing-orders response
HTTP/1.1 201 Created x-jws-signature: V2hhdCB3ZSBnb3QgaGVyZQ0K..aXMgZmFpbHVyZSB0byBjb21tdW5pY2F0ZQ0K x-fapi-interaction-id: 93bac548-d2de-4546-b106-880a5018460d Content-Type: application/json { "Data": { "DomesticStandingOrderId": "SO-ISOC-100", "ConsentId": "ISOC-100", "CreationDateTime": "2018-01-01T06:06:36+00:00", "Status": "InitiationCompleted", "StatusUpdateDateTime": "2018-01-01T06:36:06+00:00", "Initiation": { "Frequency": "EvryWorkgDay", "FirstPaymentDateTime": "2018-06-06T06:06:06+00:00" "FinalPaymentDateTime": "2020-03-20T06:06:06+00:00", "DebtorAccount": { "SchemeName": "UK.OBIE.SortCodeAccountNumber", "Identification": "11280001234567", "Name": "Andrea Frost" }, "CreditorAccount": { "SchemeName": "UK.OBIE.IBAN", "Identification": "DE89370400440532013000", "Name": "Tom Kirkman" }, "InstructedAmount": { "Amount": "20", "Currency": "EUR" }, "CurrencyOfTansfer":"EUR" } }, "Risk": { "PaymentContextCode": "PartyToParty" }, "Links": { "Self": "https://api.alphabank.com/open-banking/v3.0/international-standing-orders/SO-ISOC-100" }, "Meta": {} } |