--- swagger: "2.0" info: x-ibm-name: ob-payment-initiation-sandbox-v3 title: Payment Initiation V3 Sandbox description: "This API provides the ability for authorised payment service providers (PISPs, TPPs – third party providers) to initiate domestic payments setup new domestic scheduled payments & domestic standing orders. The TPPs will be able to initiate requests directly from the customer’s (PSU- payment service user) current - personal or business - accounts, after being granted consent. This API is developed according to the Open Banking Read/Write API Specifications, see https://www.openbanking.org.uk\n\n\n
\n**API Information**\n\n| Title | Payment Initiation V3 Sandbox |\n|-----|-----|\n| Protocol | TLS-MA |\n| Open Banking Specification Version | 3.1 |\n| Access | Free to use but subscription is required |\n\n\n** Key Features:**\n-\tDomestic payments (in GBP)\n-\tDomestic scheduled payments (in GBP)\n-\tDomestic standing orders (in GBP)" termsOfService: https://www.openbanking.org.uk/terms contact: name: Santander Service Desk email: openbankingAPI@santander.co.uk license: name: open-licence url: "" version: 1.0.2 basePath: /open-banking/v3.1/pisp schemes: - https consumes: - application/json; charset=utf-8 produces: - application/json; charset=utf-8 paths: /domestic-payments: post: tags: - Domestic Payments summary: Create Domestic Payments operationId: CreateDomesticPayments parameters: - $ref: '#/parameters/OBWriteDomestic2Param' - $ref: '#/parameters/x-fapi-financial-id-Param' - $ref: '#/parameters/x-fapi-customer-last-logged-time-Param' - $ref: '#/parameters/x-fapi-customer-ip-address-Param' - $ref: '#/parameters/x-fapi-interaction-id-Param' - $ref: '#/parameters/Authorization' - $ref: '#/parameters/x-idempotency-key' - $ref: '#/parameters/x-jws-signature-Param' - $ref: '#/parameters/x-customer-user-agent-Param' responses: 201: $ref: '#/responses/201DomesticPaymentsCreated' 400: $ref: '#/responses/400ErrorResponse' 401: $ref: '#/responses/401ErrorResponse' 403: $ref: '#/responses/403ErrorResponse' 405: $ref: '#/responses/405ErrorResponse' 406: $ref: '#/responses/406ErrorResponse' 415: $ref: '#/responses/415ErrorResponse' 429: $ref: '#/responses/429ErrorResponse' 500: $ref: '#/responses/500ErrorResponse' /domestic-payments/{domestic_payment_id}: get: tags: - Domestic Payments summary: Get Domestic Payments operationId: GetDomesticPaymentsDomesticPaymentId parameters: - $ref: '#/parameters/DomesticPaymentId' - $ref: '#/parameters/x-fapi-financial-id-Param' - $ref: '#/parameters/x-fapi-customer-last-logged-time-Param' - $ref: '#/parameters/x-fapi-customer-ip-address-Param' - $ref: '#/parameters/x-fapi-interaction-id-Param' - $ref: '#/parameters/Authorization' - $ref: '#/parameters/x-customer-user-agent-Param' responses: 200: $ref: '#/responses/200DomesticPaymentsDomesticPaymentIdRead' 400: $ref: '#/responses/400ErrorResponse' 401: $ref: '#/responses/401ErrorResponse' 403: $ref: '#/responses/403ErrorResponse' 405: $ref: '#/responses/405ErrorResponse' 406: $ref: '#/responses/406ErrorResponse' 429: $ref: '#/responses/429ErrorResponse' 500: $ref: '#/responses/500ErrorResponse' /domestic-scheduled-payments: post: tags: - Domestic Scheduled Payments summary: Create Domestic Scheduled Payments operationId: CreateDomesticScheduledPayments parameters: - $ref: '#/parameters/OBWriteDomesticScheduled2Param' - $ref: '#/parameters/x-fapi-financial-id-Param' - $ref: '#/parameters/x-fapi-customer-last-logged-time-Param' - $ref: '#/parameters/x-fapi-customer-ip-address-Param' - $ref: '#/parameters/x-fapi-interaction-id-Param' - $ref: '#/parameters/Authorization' - $ref: '#/parameters/x-idempotency-key' - $ref: '#/parameters/x-jws-signature-Param' - $ref: '#/parameters/x-customer-user-agent-Param' responses: 201: $ref: '#/responses/201DomesticScheduledPaymentsCreated' 400: $ref: '#/responses/400ErrorResponse' 401: $ref: '#/responses/401ErrorResponse' 403: $ref: '#/responses/403ErrorResponse' 404: $ref: '#/responses/404ErrorResponse' 405: $ref: '#/responses/405ErrorResponse' 406: $ref: '#/responses/406ErrorResponse' 415: $ref: '#/responses/415ErrorResponse' 429: $ref: '#/responses/429ErrorResponse' 500: $ref: '#/responses/500ErrorResponse' /domestic-standing-orders: post: tags: - Domestic Standing Orders summary: Create Domestic Standing Orders operationId: CreateDomesticStandingOrders parameters: - $ref: '#/parameters/OBWriteDomesticStandingOrder2Param' - $ref: '#/parameters/x-fapi-financial-id-Param' - $ref: '#/parameters/x-fapi-customer-last-logged-time-Param' - $ref: '#/parameters/x-fapi-customer-ip-address-Param' - $ref: '#/parameters/x-fapi-interaction-id-Param' - $ref: '#/parameters/Authorization' - $ref: '#/parameters/x-idempotency-key' - $ref: '#/parameters/x-jws-signature-Param' - $ref: '#/parameters/x-customer-user-agent-Param' responses: 201: $ref: '#/responses/201DomesticStandingOrdersCreated' 400: $ref: '#/responses/400ErrorResponse' 401: $ref: '#/responses/401ErrorResponse' 403: $ref: '#/responses/403ErrorResponse' 404: $ref: '#/responses/404ErrorResponse' 405: $ref: '#/responses/405ErrorResponse' 406: $ref: '#/responses/406ErrorResponse' 415: $ref: '#/responses/415ErrorResponse' 429: $ref: '#/responses/429ErrorResponse' 500: $ref: '#/responses/500ErrorResponse' /domestic-scheduled-payments/{domestic_scheduled_payment_id}: get: tags: - Domestic Scheduled Payments summary: Get Domestic Scheduled Payments operationId: GetDomesticScheduledPaymentsDomesticScheduledPaymentId parameters: - $ref: '#/parameters/DomesticScheduledPaymentId' - $ref: '#/parameters/x-fapi-financial-id-Param' - $ref: '#/parameters/x-fapi-customer-last-logged-time-Param' - $ref: '#/parameters/x-fapi-customer-ip-address-Param' - $ref: '#/parameters/x-fapi-interaction-id-Param' - $ref: '#/parameters/Authorization' - $ref: '#/parameters/x-customer-user-agent-Param' responses: 200: $ref: '#/responses/200DomesticScheduledPaymentsDomesticScheduledPaymentIdRead' 400: $ref: '#/responses/400ErrorResponse' 401: $ref: '#/responses/401ErrorResponse' 403: $ref: '#/responses/403ErrorResponse' 404: $ref: '#/responses/404ErrorResponse' 405: $ref: '#/responses/405ErrorResponse' 406: $ref: '#/responses/406ErrorResponse' 429: $ref: '#/responses/429ErrorResponse' 500: $ref: '#/responses/500ErrorResponse' /domestic-standing-orders/{domestic_standing_order_id}: get: tags: - Domestic Standing Orders summary: Get Domestic Standing Orders operationId: GetDomesticStandingOrdersDomesticStandingOrderId parameters: - $ref: '#/parameters/DomesticStandingOrderId' - $ref: '#/parameters/x-fapi-financial-id-Param' - $ref: '#/parameters/x-fapi-customer-last-logged-time-Param' - $ref: '#/parameters/x-fapi-customer-ip-address-Param' - $ref: '#/parameters/x-fapi-interaction-id-Param' - $ref: '#/parameters/Authorization' - $ref: '#/parameters/x-customer-user-agent-Param' responses: 200: $ref: '#/responses/200DomesticStandingOrdersDomesticStandingOrderIdRead' 400: $ref: '#/responses/400ErrorResponse' 401: $ref: '#/responses/401ErrorResponse' 403: $ref: '#/responses/403ErrorResponse' 404: $ref: '#/responses/404ErrorResponse' 405: $ref: '#/responses/405ErrorResponse' 406: $ref: '#/responses/406ErrorResponse' 429: $ref: '#/responses/429ErrorResponse' 500: $ref: '#/responses/500ErrorResponse' parameters: x-idempotency-key: name: x-idempotency-key in: header description: Every request will be processed only once per x-idempotency-key. The Idempotency Key will be valid for 24 hours. required: true type: string pattern: ^(?!\s)(.*)(\S)$ maxLength: 40 x-fapi-financial-id-Param: in: header name: x-fapi-financial-id type: string required: true description: The unique id of the ASPSP to which the request is issued. The unique id will be issued by OB. x-fapi-customer-ip-address-Param: in: header name: x-fapi-customer-ip-address type: string required: false description: The PSU's IP address if the PSU is currently logged in with the TPP. x-fapi-interaction-id-Param: in: header name: x-fapi-interaction-id type: string required: false description: An RFC4122 UID used as a correlation id. x-fapi-customer-last-logged-time-Param: in: header name: x-fapi-customer-last-logged-time type: string required: false description: "The time when the PSU last logged in with the TPP. \nAll dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: \nSun, 10 Sep 2017 19:43:31 UTC" pattern: ^(Mon|Tue|Wed|Thu|Fri|Sat|Sun), \d{2} (Jan|Feb|Mar|Apr|May|Jun|Jul|Aug|Sep|Oct|Nov|Dec) \d{4} \d{2}:\d{2}:\d{2} (GMT|UTC)$ Authorization: in: header name: Authorization type: string required: true description: An Authorisation Token as per https://tools.ietf.org/html/rfc6750 x-jws-signature-Param: in: header name: x-jws-signature type: string required: true description: A detached JWS signature of the body of the payload. OBWriteDomesticStandingOrder2Param: name: OBWriteDomesticStandingOrder2Param in: body description: Default required: true schema: $ref: '#/definitions/OBWriteDomesticStandingOrder2' DomesticStandingOrderId: name: domestic_standing_order_id in: path description: DomesticStandingOrderId required: true type: string OBWriteDomestic2Param: name: OBWriteDomestic2Param in: body description: Default required: true schema: $ref: '#/definitions/OBWriteDomestic2' DomesticPaymentId: name: domestic_payment_id in: path description: DomesticPaymentId required: true type: string OBWriteDomesticScheduled2Param: name: OBWriteDomesticScheduled2Param in: body description: Default required: true schema: $ref: '#/definitions/OBWriteDomesticScheduled2' DomesticScheduledPaymentId: name: domestic_scheduled_payment_id in: path description: DomesticScheduledPaymentId required: true type: string x-customer-user-agent-Param: in: header name: x-customer-user-agent type: string description: Indicates the user-agent that the PSU is using. required: false responses: 201DomesticStandingOrdersCreated: description: Domestic Standing Orders Created headers: x-fapi-interaction-id: type: string description: An RFC4122 UID used as a correlation id. x-jws-signature: type: string description: Header containing a detached JWS signature of the body of the payload. schema: $ref: '#/definitions/OBWriteDomesticStandingOrderResponse2' 200DomesticStandingOrdersDomesticStandingOrderIdRead: description: Domestic Standing Orders Read headers: x-fapi-interaction-id: type: string description: An RFC4122 UID used as a correlation id. x-jws-signature: type: string description: Header containing a detached JWS signature of the body of the payload. schema: $ref: '#/definitions/OBWriteDomesticStandingOrderResponse2' 201DomesticPaymentsCreated: description: Domestic Payments Created headers: x-fapi-interaction-id: type: string description: An RFC4122 UID used as a correlation id. x-jws-signature: type: string description: Header containing a detached JWS signature of the body of the payload. schema: $ref: '#/definitions/OBWriteDomesticResponse2' 200DomesticPaymentsDomesticPaymentIdRead: description: Domestic Payments Read headers: x-fapi-interaction-id: type: string description: An RFC4122 UID used as a correlation id. x-jws-signature: type: string description: Header containing a detached JWS signature of the body of the payload. schema: $ref: '#/definitions/OBWriteDomesticResponse2' 201DomesticScheduledPaymentsCreated: description: Domestic Scheduled Payments Created headers: x-fapi-interaction-id: type: string description: An RFC4122 UID used as a correlation id. x-jws-signature: type: string description: Header containing a detached JWS signature of the body of the payload. schema: $ref: '#/definitions/OBWriteDomesticScheduledResponse2' 200DomesticScheduledPaymentsDomesticScheduledPaymentIdRead: description: Domestic Scheduled Payments Read headers: x-fapi-interaction-id: type: string description: An RFC4122 UID used as a correlation id. x-jws-signature: type: string description: Header containing a detached JWS signature of the body of the payload. schema: $ref: '#/definitions/OBWriteDomesticScheduledResponse2' 400ErrorResponse: description: Bad request schema: $ref: '#/definitions/OBErrorResponse1' 401ErrorResponse: description: Unauthorized 403ErrorResponse: description: Forbidden 404ErrorResponse: description: Not found 405ErrorResponse: description: Method Not Allowed 406ErrorResponse: description: Not Acceptable 415ErrorResponse: description: Unsupported Media Type 429ErrorResponse: description: Too Many Requests headers: Retry-After: description: Number in seconds to wait type: integer 500ErrorResponse: description: Internal Server Error schema: $ref: '#/definitions/OBErrorResponse1' definitions: OBActiveCurrencyAndAmount_SimpleType: description: A number of monetary units specified in an active currency where the unit of currency is explicit and compliant with ISO 4217. type: string pattern: ^\d{1,13}\.\d{1,5}$ OBAddressTypeCode: description: Identifies the nature of the postal address. type: string enum: - Business - Correspondence - DeliveryTo - MailTo - POBox - Postal - Residential - Statement OBChargeBearerType1Code: description: Specifies which party/parties will bear the charges associated with the processing of the payment transaction. type: string enum: - BorneByCreditor - BorneByDebtor - FollowingServiceLevel - Shared OBDomesticScheduled2: 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 domestic payment. type: object properties: InstructionIdentification: description: |- 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. type: string minLength: 1 maxLength: 35 EndToEndIdentification: description: |- Unique identification assigned by the initiating party to unambiguously identify the transaction. This identification is passed on, unchanged, throughout the entire end-to-end chain. 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. type: string minLength: 1 maxLength: 35 LocalInstrument: $ref: '#/definitions/OBExternalLocalInstrument1Code' RequestedExecutionDateTime: description: "Date at which the initiating party requests the clearing agent to process the payment. \nUsage: This is the date on which the debtor's account is to be debited.\nAll dates in the JSON payloads are represented in ISO 8601 date-time format. \nAll date-time fields in responses must include the timezone. An example is below:\n2017-04-05T10:43:07+00:00" type: string format: date-time InstructedAmount: type: object properties: Amount: $ref: '#/definitions/OBActiveCurrencyAndAmount_SimpleType' Currency: type: string pattern: ^[A-Z]{3,3}$ required: - Amount - Currency additionalProperties: false 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. DebtorAccount: $ref: '#/definitions/OBCashAccountDebtor4' CreditorAccount: $ref: '#/definitions/OBCashAccountCreditor3' CreditorPostalAddress: $ref: '#/definitions/OBPostalAddress6' RemittanceInformation: $ref: '#/definitions/OBRemittanceInformation1' SupplementaryData: $ref: '#/definitions/OBSupplementaryData1' required: - InstructionIdentification - RequestedExecutionDateTime - InstructedAmount - CreditorAccount additionalProperties: false OBDomesticStandingOrder2: 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 domestic standing order. type: object properties: Frequency: description: "Individual Definitions:\nEvryDay - Every day\nEvryWorkgDay - Every working day\nIntrvlWkDay - An interval specified in weeks (01 to 09), and the day within the week (01 to 07)\nWkInMnthDay - A monthly interval, specifying the week of the month (01 to 05) and day within the week (01 to 07)\nIntrvlMnthDay - An interval specified in months (between 01 to 06, 12, 24), specifying the day within the month (-5 to -1, 1 to 31)\nQtrDay - Quarterly (either ENGLISH, SCOTTISH, or RECEIVED). \nENGLISH = Paid on the 25th March, 24th June, 29th September and 25th December. \nSCOTTISH = Paid on the 2nd February, 15th May, 1st August and 11th November.\nRECEIVED = Paid on the 20th March, 19th June, 24th September and 20th December. \nIndividual Patterns:\nEvryDay (ScheduleCode)\nEvryWorkgDay (ScheduleCode)\nIntrvlWkDay:IntervalInWeeks:DayInWeek (ScheduleCode + IntervalInWeeks + DayInWeek)\nWkInMnthDay:WeekInMonth:DayInWeek (ScheduleCode + WeekInMonth + DayInWeek)\nIntrvlMnthDay:IntervalInMonths:DayInMonth (ScheduleCode + IntervalInMonths + DayInMonth)\nQtrDay: + either (ENGLISH, SCOTTISH or RECEIVED) ScheduleCode + QuarterDay\nThe regular expression for this element combines five smaller versions for each permitted pattern. To aid legibility - the components are presented individually here:\nEvryDay\nEvryWorkgDay\nIntrvlWkDay:0[1-9]:0[1-7]\nWkInMnthDay:0[1-5]:0[1-7]\nIntrvlMnthDay:(0[1-6]|12|24):(-0[1-5]|0[1-9]|[12][0-9]|3[01])\nQtrDay:(ENGLISH|SCOTTISH|RECEIVED)\nFull Regular Expression:\n^(EvryDay)$|^(EvryWorkgDay)$|^(IntrvlWkDay:0[1-9]:0[1-7])$|^(WkInMnthDay:0[1-5]:0[1-7])$|^(IntrvlMnthDay:(0[1-6]|12|24):(-0[1-5]|0[1-9]|[12][0-9]|3[01]))$|^(QtrDay:(ENGLISH|SCOTTISH|RECEIVED))$" type: string minLength: 1 maxLength: 35 pattern: ^(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: description: |- 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. type: string minLength: 1 maxLength: 35 NumberOfPayments: description: Number of the payments that will be made in completing this frequency sequence including any executed since the sequence start date. type: string minLength: 1 maxLength: 35 FirstPaymentDateTime: description: "The date on which the first payment for a Standing Order schedule will be made.\nAll dates in the JSON payloads are represented in ISO 8601 date-time format. \nAll date-time fields in responses must include the timezone. An example is below:\n2017-04-05T10:43:07+00:00" type: string format: date-time RecurringPaymentDateTime: description: "The date on which the first recurring payment for a Standing Order schedule will be made. \nUsage: This must be populated only if the first recurring date is different to the first payment date.\nAll dates in the JSON payloads are represented in ISO 8601 date-time format. \nAll date-time fields in responses must include the timezone. An example is below:\n2017-04-05T10:43:07+00:00" type: string format: date-time FinalPaymentDateTime: description: "The date on which the final payment for a Standing Order schedule will be made.\nAll dates in the JSON payloads are represented in ISO 8601 date-time format. \nAll date-time fields in responses must include the timezone. An example is below:\n2017-04-05T10:43:07+00:00" type: string format: date-time FirstPaymentAmount: type: object properties: Amount: $ref: '#/definitions/OBActiveCurrencyAndAmount_SimpleType' Currency: type: string pattern: ^[A-Z]{3,3}$ required: - Amount - Currency additionalProperties: false description: The amount of the first Standing Order RecurringPaymentAmount: type: object properties: Amount: $ref: '#/definitions/OBActiveCurrencyAndAmount_SimpleType' Currency: type: string pattern: ^[A-Z]{3,3}$ required: - Amount - Currency additionalProperties: false description: The amount of the recurring Standing Order FinalPaymentAmount: type: object properties: Amount: $ref: '#/definitions/OBActiveCurrencyAndAmount_SimpleType' Currency: type: string pattern: ^[A-Z]{3,3}$ required: - Amount - Currency additionalProperties: false description: The amount of the final Standing Order DebtorAccount: $ref: '#/definitions/OBCashAccountDebtor4' CreditorAccount: $ref: '#/definitions/OBCashAccountCreditor3' SupplementaryData: $ref: '#/definitions/OBSupplementaryData1' required: - Frequency - FirstPaymentDateTime - FirstPaymentAmount - CreditorAccount additionalProperties: false OBSupplementaryData1: description: Additional information that can not be captured in the structured fields and/or any other specific block. type: object properties: [] additionalProperties: false OBExternalAccountIdentification4Code: description: Name of the identification scheme, in a coded form as published in an external list. type: string example: - UK.OBIE.BBAN - UK.OBIE.IBAN - UK.OBIE.PAN - UK.OBIE.Paym - UK.OBIE.SortCodeAccountNumber minLength: 1 maxLength: 40 OBCashAccountDebtor4: description: Provides the details to identify the debtor account. type: object properties: SchemeName: $ref: '#/definitions/OBExternalAccountIdentification4Code' Identification: description: Identification assigned by an institution to identify an account. This identification is known by the account owner. type: string minLength: 1 maxLength: 256 Name: description: |- Name of the account, as assigned by the account servicing institution. Usage: The account name is the name or names of the account owner(s) represented at an account level. The account name is not the product name or the nickname of the account. type: string minLength: 1 maxLength: 70 SecondaryIdentification: description: "This is secondary identification of the account, as assigned by the account servicing institution. \nThis can be used by building societies to additionally identify accounts with a roll number (in addition to a sort code and account number combination)." type: string minLength: 1 maxLength: 34 required: - SchemeName - Identification additionalProperties: false OBCashAccountCreditor3: description: Provides the details to identify the beneficiary account. type: object properties: SchemeName: $ref: '#/definitions/OBExternalAccountIdentification4Code' Identification: description: Identification assigned by an institution to identify an account. This identification is known by the account owner. type: string minLength: 1 maxLength: 256 Name: description: |- Name of the account, as assigned by the account servicing institution. 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. type: string minLength: 1 maxLength: 70 SecondaryIdentification: description: "This is secondary identification of the account, as assigned by the account servicing institution. \nThis can be used by building societies to additionally identify accounts with a roll number (in addition to a sort code and account number combination)." type: string minLength: 1 maxLength: 34 required: - SchemeName - Identification - Name additionalProperties: false OBExternalPaymentContext1Code: description: Specifies the payment context type: string enum: - BillPayment - EcommerceGoods - EcommerceServices - Other - PartyToParty OBExternalStatus1Code: description: Specifies the status of resource in code form. type: string enum: - InitiationCompleted - InitiationFailed - InitiationPending OBExternalStatus2Code: description: Specifies the status of the authorisation flow in code form. type: string enum: - Authorised - AwaitingFurtherAuthorisation - Rejected OBMultiAuthorisation1: description: The multiple authorisation flow response from the ASPSP. type: object properties: Status: $ref: '#/definitions/OBExternalStatus2Code' NumberRequired: description: Number of authorisations required for payment order (total required at the start of the multi authorisation journey). type: integer format: int32 NumberReceived: description: Number of authorisations required for payment order (total required at the start of the multi authorisation journey). type: integer format: int32 LastUpdateDateTime: description: "Last date and time at the authorisation flow was updated.\nAll dates in the JSON payloads are represented in ISO 8601 date-time format. \nAll date-time fields in responses must include the timezone. An example is below:\n2017-04-05T10:43:07+00:00" type: string format: date-time ExpirationDateTime: description: "Date and time at which the requested authorisation flow must be completed.\nAll dates in the JSON payloads are represented in ISO 8601 date-time format. \nAll date-time fields in responses must include the timezone. An example is below:\n2017-04-05T10:43:07+00:00" type: string format: date-time required: - Status additionalProperties: false OBPostalAddress6: description: Information that locates and identifies a specific address, as defined by postal services. type: object properties: AddressType: $ref: '#/definitions/OBAddressTypeCode' Department: description: Identification of a division of a large organisation or building. type: string minLength: 1 maxLength: 70 SubDepartment: description: Identification of a sub-division of a large organisation or building. type: string minLength: 1 maxLength: 70 StreetName: description: Name of a street or thoroughfare. type: string minLength: 1 maxLength: 70 BuildingNumber: description: Number that identifies the position of a building on a street. type: string minLength: 1 maxLength: 16 PostCode: description: Identifier consisting of a group of letters and/or numbers that is added to a postal address to assist the sorting of mail. type: string minLength: 1 maxLength: 16 TownName: description: Name of a built-up area, with defined boundaries, and a local government. type: string minLength: 1 maxLength: 35 CountrySubDivision: description: Identifies a subdivision of a country such as state, region, county. type: string minLength: 1 maxLength: 35 Country: description: Nation with its own government. type: string pattern: ^[A-Z]{2,2}$ AddressLine: items: type: string minLength: 1 maxLength: 70 type: array description: Information that locates and identifies a specific address, as defined by postal services, presented in free format text. minItems: 0 maxItems: 7 additionalProperties: false OBRemittanceInformation1: 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. type: object properties: Unstructured: description: Information supplied to enable the matching/reconciliation of an entry with the items that the payment is intended to settle, such as commercial invoices in an accounts' receivable system, in an unstructured form. type: string minLength: 1 maxLength: 140 Reference: description: |- Unique reference, as assigned by the creditor, to unambiguously refer to the payment transaction. 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. type: string minLength: 1 maxLength: 35 additionalProperties: false 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. type: object properties: PaymentContextCode: $ref: '#/definitions/OBExternalPaymentContext1Code' MerchantCategoryCode: description: Category code conform to ISO 18245, related to the type of services or goods the merchant provides for the transaction. type: string minLength: 3 maxLength: 4 MerchantCustomerIdentification: description: The unique customer identifier of the PSU with the merchant. type: string minLength: 1 maxLength: 70 DeliveryAddress: description: Information that locates and identifies a specific address, as defined by postal services or in free format text. type: object properties: AddressLine: items: type: string minLength: 1 maxLength: 70 type: array description: Information that locates and identifies a specific address, as defined by postal services, that is presented in free format text. minItems: 0 maxItems: 2 StreetName: description: Name of a street or thoroughfare. type: string minLength: 1 maxLength: 70 BuildingNumber: description: Number that identifies the position of a building on a street. type: string minLength: 1 maxLength: 16 PostCode: description: Identifier consisting of a group of letters and/or numbers that is added to a postal address to assist the sorting of mail. type: string minLength: 1 maxLength: 16 TownName: description: Name of a built-up area, with defined boundaries, and a local government. type: string minLength: 1 maxLength: 35 CountrySubDivision: items: type: string minLength: 1 maxLength: 35 type: array description: Identifies a subdivision of a country, for instance state, region, county. minItems: 0 maxItems: 2 Country: description: Nation with its own government, occupying a particular territory. type: string pattern: ^[A-Z]{2,2}$ required: - TownName - Country additionalProperties: false additionalProperties: false OBTransactionIndividualStatus1Code: description: Specifies the status of the payment information group. type: string enum: - AcceptedSettlementCompleted - AcceptedSettlementInProcess - Pending - Rejected OBWriteDataDomestic2: type: object properties: ConsentId: description: 'OB: Unique identification as assigned by the ASPSP to uniquely identify the consent resource.' type: string minLength: 1 maxLength: 128 Initiation: $ref: '#/definitions/OBDomestic2' required: - ConsentId - Initiation additionalProperties: false OBDomestic2: 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 domestic payment. type: object properties: InstructionIdentification: description: |- 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. type: string minLength: 1 maxLength: 35 EndToEndIdentification: description: |- Unique identification assigned by the initiating party to unambiguously identify the transaction. This identification is passed on, unchanged, throughout the entire end-to-end chain. 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. type: string minLength: 1 maxLength: 35 LocalInstrument: $ref: '#/definitions/OBExternalLocalInstrument1Code' InstructedAmount: type: object properties: Amount: $ref: '#/definitions/OBActiveCurrencyAndAmount_SimpleType' Currency: type: string pattern: ^[A-Z]{3,3}$ required: - Amount - Currency additionalProperties: false 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. DebtorAccount: $ref: '#/definitions/OBCashAccountDebtor4' CreditorAccount: $ref: '#/definitions/OBCashAccountCreditor3' CreditorPostalAddress: $ref: '#/definitions/OBPostalAddress6' RemittanceInformation: $ref: '#/definitions/OBRemittanceInformation1' SupplementaryData: $ref: '#/definitions/OBSupplementaryData1' required: - InstructionIdentification - EndToEndIdentification - InstructedAmount - CreditorAccount additionalProperties: false OBWriteDataDomesticResponse2: type: object properties: DomesticPaymentId: description: 'OB: Unique identification as assigned by the ASPSP to uniquely identify the domestic payment resource.' type: string minLength: 1 maxLength: 40 ConsentId: description: 'OB: Unique identification as assigned by the ASPSP to uniquely identify the consent resource.' type: string minLength: 1 maxLength: 128 CreationDateTime: description: "Date and time at which the message was created.\nAll dates in the JSON payloads are represented in ISO 8601 date-time format. \nAll date-time fields in responses must include the timezone. An example is below:\n2017-04-05T10:43:07+00:00" type: string format: date-time Status: $ref: '#/definitions/OBTransactionIndividualStatus1Code' StatusUpdateDateTime: description: "Date and time at which the resource status was updated.\nAll dates in the JSON payloads are represented in ISO 8601 date-time format. \nAll date-time fields in responses must include the timezone. An example is below:\n2017-04-05T10:43:07+00:00" type: string format: date-time ExpectedExecutionDateTime: description: "Expected execution date and time for the payment resource.\nAll dates in the JSON payloads are represented in ISO 8601 date-time format. \nAll date-time fields in responses must include the timezone. An example is below:\n2017-04-05T10:43:07+00:00" type: string format: date-time ExpectedSettlementDateTime: description: "Expected settlement date and time for the payment resource.\nAll dates in the JSON payloads are represented in ISO 8601 date-time format. \nAll date-time fields in responses must include the timezone. An example is below:\n2017-04-05T10:43:07+00:00" type: string format: date-time Charges: items: $ref: '#/definitions/OBCharge2' type: array description: Set of elements used to provide details of a charge for the payment initiation. Initiation: $ref: '#/definitions/OBDomestic2' MultiAuthorisation: $ref: '#/definitions/OBMultiAuthorisation1' required: - DomesticPaymentId - ConsentId - CreationDateTime - Status - StatusUpdateDateTime - Initiation additionalProperties: false OBWriteDataDomesticScheduled2: type: object properties: ConsentId: description: 'OB: Unique identification as assigned by the ASPSP to uniquely identify the consent resource.' type: string minLength: 1 maxLength: 128 Initiation: $ref: '#/definitions/OBDomesticScheduled2' required: - ConsentId - Initiation additionalProperties: false OBWriteDataDomesticScheduledResponse2: type: object properties: DomesticScheduledPaymentId: description: 'OB: Unique identification as assigned by the ASPSP to uniquely identify the domestic schedule payment resource.' type: string minLength: 1 maxLength: 40 ConsentId: description: 'OB: Unique identification as assigned by the ASPSP to uniquely identify the consent resource.' type: string minLength: 1 maxLength: 128 CreationDateTime: description: "Date and time at which the message was created.\nAll dates in the JSON payloads are represented in ISO 8601 date-time format. \nAll date-time fields in responses must include the timezone. An example is below:\n2017-04-05T10:43:07+00:00" type: string format: date-time Status: $ref: '#/definitions/OBExternalStatus1Code' StatusUpdateDateTime: description: "Date and time at which the resource status was updated.\nAll dates in the JSON payloads are represented in ISO 8601 date-time format. \nAll date-time fields in responses must include the timezone. An example is below:\n2017-04-05T10:43:07+00:00" type: string format: date-time ExpectedExecutionDateTime: description: "Expected execution date and time for the payment resource.\nAll dates in the JSON payloads are represented in ISO 8601 date-time format. \nAll date-time fields in responses must include the timezone. An example is below:\n2017-04-05T10:43:07+00:00" type: string format: date-time ExpectedSettlementDateTime: description: "Expected settlement date and time for the payment resource.\nAll dates in the JSON payloads are represented in ISO 8601 date-time format. \nAll date-time fields in responses must include the timezone. An example is below:\n2017-04-05T10:43:07+00:00" type: string format: date-time Charges: items: $ref: '#/definitions/OBCharge2' type: array description: Set of elements used to provide details of a charge for the payment initiation. Initiation: $ref: '#/definitions/OBDomesticScheduled2' MultiAuthorisation: $ref: '#/definitions/OBMultiAuthorisation1' required: - DomesticScheduledPaymentId - ConsentId - CreationDateTime - Status - StatusUpdateDateTime - Initiation additionalProperties: false OBWriteDataDomesticStandingOrder2: type: object properties: ConsentId: description: 'OB: Unique identification as assigned by the ASPSP to uniquely identify the consent resource.' type: string minLength: 1 maxLength: 128 Initiation: $ref: '#/definitions/OBDomesticStandingOrder2' required: - ConsentId - Initiation additionalProperties: false OBWriteDataDomesticStandingOrderResponse2: type: object properties: DomesticStandingOrderId: description: 'OB: Unique identification as assigned by the ASPSP to uniquely identify the domestic standing order resource.' type: string minLength: 1 maxLength: 40 ConsentId: description: 'OB: Unique identification as assigned by the ASPSP to uniquely identify the consent resource.' type: string minLength: 1 maxLength: 128 CreationDateTime: description: "Date and time at which the resource was created.\nAll dates in the JSON payloads are represented in ISO 8601 date-time format. \nAll date-time fields in responses must include the timezone. An example is below:\n2017-04-05T10:43:07+00:00" type: string format: date-time Status: $ref: '#/definitions/OBExternalStatus1Code' StatusUpdateDateTime: description: "Date and time at which the resource status was updated.\nAll dates in the JSON payloads are represented in ISO 8601 date-time format. \nAll date-time fields in responses must include the timezone. An example is below:\n2017-04-05T10:43:07+00:00" type: string format: date-time Charges: items: $ref: '#/definitions/OBCharge2' type: array description: Set of elements used to provide details of a charge for the payment initiation. Initiation: $ref: '#/definitions/OBDomesticStandingOrder2' MultiAuthorisation: $ref: '#/definitions/OBMultiAuthorisation1' required: - DomesticStandingOrderId - ConsentId - CreationDateTime - Status - StatusUpdateDateTime - Initiation additionalProperties: false OBWriteDomestic2: type: object properties: Data: $ref: '#/definitions/OBWriteDataDomestic2' Risk: $ref: '#/definitions/OBRisk1' required: - Data - Risk additionalProperties: false OBWriteDomesticResponse2: type: object properties: Data: $ref: '#/definitions/OBWriteDataDomesticResponse2' Links: $ref: '#/definitions/Links' Meta: $ref: '#/definitions/Meta' required: - Data - Links - Meta additionalProperties: false OBWriteDomesticScheduled2: type: object properties: Data: $ref: '#/definitions/OBWriteDataDomesticScheduled2' Risk: $ref: '#/definitions/OBRisk1' required: - Data - Risk additionalProperties: false OBWriteDomesticScheduledResponse2: type: object properties: Data: $ref: '#/definitions/OBWriteDataDomesticScheduledResponse2' Links: $ref: '#/definitions/Links' Meta: $ref: '#/definitions/Meta' required: - Data - Links - Meta additionalProperties: false OBWriteDomesticStandingOrder2: type: object properties: Data: $ref: '#/definitions/OBWriteDataDomesticStandingOrder2' Risk: $ref: '#/definitions/OBRisk1' required: - Data - Risk additionalProperties: false OBWriteDomesticStandingOrderResponse2: type: object properties: Data: $ref: '#/definitions/OBWriteDataDomesticStandingOrderResponse2' Links: $ref: '#/definitions/Links' Meta: $ref: '#/definitions/Meta' required: - Data - Links - Meta additionalProperties: false OBExternalLocalInstrument1Code: description: |- 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. type: string example: - UK.OBIE.BACS - UK.OBIE.BalanceTransfer - UK.OBIE.CHAPS - UK.OBIE.Euro1 - UK.OBIE.FPS - UK.OBIE.Link - UK.OBIE.MoneyTransfer - UK.OBIE.Paym - UK.OBIE.SEPACreditTransfer - UK.OBIE.SEPAInstantCreditTransfer - UK.OBIE.SWIFT - UK.OBIE.Target2 minLength: 1 maxLength: 50 OBCharge2: description: Set of elements used to provide details of a charge for the payment initiation. type: object properties: ChargeBearer: $ref: '#/definitions/OBChargeBearerType1Code' Type: $ref: '#/definitions/OBExternalPaymentChargeType1Code' Amount: type: object properties: Amount: $ref: '#/definitions/OBActiveCurrencyAndAmount_SimpleType' Currency: type: string pattern: ^[A-Z]{3,3}$ required: - Amount - Currency additionalProperties: false description: Amount of money associated with the charge type. required: - ChargeBearer - Type - Amount additionalProperties: false OBExternalPaymentChargeType1Code: description: Charge type, in a coded form. type: string example: - UK.OBIE.CHAPSOut - UK.OBIE.BalanceTransferOut - UK.OBIE.MoneyTransferOut minLength: 1 maxLength: 40 OBError1: type: object properties: ErrorCode: description: Low level textual error code, e.g., UK.OBIE.Field.Missing type: string minLength: 1 maxLength: 128 Message: description: |- 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 type: string minLength: 1 maxLength: 500 Path: description: Recommended but optional reference to the JSON Path of the field with error, e.g., Data.Initiation.InstructedAmount.Currency type: string minLength: 1 maxLength: 500 Url: description: URL to help remediate the problem, or provide more information, or to API Reference, or help etc type: string required: - ErrorCode - Message additionalProperties: false minProperties: 1 OBErrorResponse1: description: An array of detail error codes, and messages, and URLs to documentation to help remediation. type: object properties: Code: description: High level textual error code, to help categorize the errors. type: string minLength: 1 maxLength: 40 Id: description: A unique reference for the error instance, for audit purposes, in case of unknown/unclassified errors. type: string minLength: 1 maxLength: 40 Message: description: Brief Error message, e.g., 'There is something wrong with the request parameters provided' type: string minLength: 1 maxLength: 500 Errors: items: $ref: '#/definitions/OBError1' type: array minItems: 1 required: - Code - Message - Errors additionalProperties: false ISODateTime: description: "All dates in the JSON payloads are represented in ISO 8601 date-time format. \nAll date-time fields in responses must include the timezone. An example is below:\n2017-04-05T10:43:07+00:00" type: string format: date-time Links: type: object description: Links relevant to the payload properties: Self: type: string format: uri First: type: string format: uri Prev: type: string format: uri Next: type: string format: uri Last: type: string format: uri additionalProperties: false required: - Self Meta: title: MetaData type: object description: Meta Data relevant to the payload properties: TotalPages: type: integer format: int32 FirstAvailableDateTime: $ref: '#/definitions/ISODateTime' LastAvailableDateTime: $ref: '#/definitions/ISODateTime' additionalProperties: false securityDefinitions: PSUOAuth2Security: type: oauth2 flow: accessCode tokenUrl: https://openbanking-ma-sandbox-dev-front.santanderuk.pre.corp/sanuk/external-sandbox/open-banking/openid-connect-provider/v1/oauth2/token authorizationUrl: https://openbanking-sandbox-dev-front.santanderuk.pre.corp/sanuk/external-sandbox/open-banking/openid-connect-provider/v1/oauth2/authorize scopes: payments: Generic payment scope description: OAuth flow, it is required when the PSU needs to perform SCA with the ASPSP when a TPP wants to access an ASPSP resource owned by the PSU x-tokenIntrospect: url: https://openbanking-sandbox-dev-front.santanderuk.pre.corp/sanuk/external-sandbox/open-banking/openid-connect-provider/v1/oauth2/introspect TPPOAuth2Security: type: oauth2 flow: application tokenUrl: https://openbanking-ma-sandbox-dev-front.santanderuk.pre.corp/sanuk/external-sandbox/open-banking/openid-connect-provider/v1/oauth2/token scopes: payments: "" description: TPP client credential authorisation flow with the ASPSP x-tokenIntrospect: url: https://openbanking-sandbox-dev-front.santanderuk.pre.corp/sanuk/external-sandbox/open-banking/openid-connect-provider/v1/oauth2/introspect tags: - name: Payments description: Payments endpoints x-ibm-configuration: enforced: true testable: true phase: specified categories: - Type / Experience - SanUK Business Domain / Common Services & Guidance / Payments - BIAN Business Area / NA - BIAN Business Domain / NA - BIAN Service Domain / NA security: - PSUOAuth2Security: - payments TPPOAuth2Security: - payments x-ibm-endpoints: - endpointUrl: https://openbanking-ma-sandbox.santander.co.uk/sanuk/external-sandbox type: - production ...