Allica Bank's UK Open Banking Payment Initiation Service (PIS) API, conformant to the OBIE Read/Write Standard v4.0, exposing domestic payment, domestic scheduled payment, and domestic standing order consents and payments, plus payment-details and funds-confirmation resources for Allica Business Rewards accounts. FAPI-secured (OAuth2/OIDC, mTLS, PSD2 SCA); requires OBIE Directory onboarding and eIDAS/OB certificates.
openapi: 3.0.0
info:
title: Payment Initiation API Specification
description: |
# PISP API Overview
These APIs can be used to access PIS for Allica Business Rewards accounts.
## Base URL
The base URL for all PIS APIs is: `https://rs1.api.ob.allica.bank/open-banking/v4.0/pisp/**`
termsOfService: https://www.openbanking.org.uk/terms
contact:
name: Service Desk
email: ServiceDesk@openbanking.org.uk
license:
name: open-licence
url: https://www.openbanking.org.uk/open-licence
version: 4.0.0
paths:
/domestic-payment-consents:
post:
tags:
- Domestic Payments
summary: Create Domestic Payment Consents
operationId: CreateDomesticPaymentConsents
parameters:
- in: header
name: x-fapi-auth-date
required: false
description: |-
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
schema:
type: string
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)$
- in: header
name: x-fapi-customer-ip-address
required: false
description: The PSU's IP address if the PSU is currently logged in with the TPP.
schema:
type: string
- in: header
name: x-fapi-interaction-id
required: false
description: An RFC4122 UID used as a correlation id.
schema:
type: string
- in: header
name: Authorization
required: true
description: An Authorisation Token as per https://tools.ietf.org/html/rfc6750
schema:
type: string
- 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
schema:
type: string
maxLength: 40
pattern: ^(?!\s)(.*)(\S)$
- in: header
name: x-jws-signature
required: true
description: A detached JWS signature of the body of the payload.
schema:
type: string
- in: header
name: x-customer-user-agent
description: Indicates the user-agent that the PSU is using.
required: false
schema:
type: string
requestBody:
content:
application/json; charset=utf-8:
schema:
type: object
additionalProperties: false
required:
- Data
- Risk
properties:
Data:
type: object
additionalProperties: false
required:
- Initiation
properties:
ReadRefundAccount:
description: Specifies to share the refund account details with PISP
type: string
enum:
- 'No'
- 'Yes'
Initiation:
type: object
additionalProperties: false
required:
- InstructionIdentification
- EndToEndIdentification
- InstructedAmount
- CreditorAccount
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.
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:
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
x-namespaced-enum:
- 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
InstructedAmount:
type: object
additionalProperties: false
required:
- Amount
- Currency
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.
properties:
Amount:
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,13}\.\d{1,5}$
Currency:
description: 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".
type: string
pattern: ^[A-Z]{3,3}$
DebtorAccount:
type: object
additionalProperties: false
required:
- SchemeName
- Identification
description: Unambiguous identification of the account of the debtor to which a debit entry will be made as a result of the transaction.
properties:
SchemeName:
description: Name of the identification scheme, in a coded form as published in an external list.
type: string
x-namespaced-enum:
- UK.OBIE.BBAN
- UK.OBIE.IBAN
- UK.OBIE.PAN
- UK.OBIE.Paym
- UK.OBIE.SortCodeAccountNumber
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: |-
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.
type: string
minLength: 1
maxLength: 350
SecondaryIdentification:
description: |-
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).
type: string
minLength: 1
maxLength: 34
CreditorAccount:
type: object
additionalProperties: false
required:
- SchemeName
- Identification
- Name
description: Unambiguous identification of the account of the creditor to which a credit entry will be posted as a result of the payment transaction.
properties:
SchemeName:
description: Name of the identification scheme, in a coded form as published in an external list.
type: string
x-namespaced-enum:
- UK.OBIE.BBAN
- UK.OBIE.IBAN
- UK.OBIE.PAN
- UK.OBIE.Paym
- UK.OBIE.SortCodeAccountNumber
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: |-
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.
type: string
minLength: 1
maxLength: 350
SecondaryIdentification:
description: |-
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).
type: string
minLength: 1
maxLength: 34
CreditorPostalAddress:
type: object
additionalProperties: false
description: Information that locates and identifies a specific address, as defined by postal services.
properties:
AddressType:
description: Identifies the nature of the postal address.
type: string
enum:
- Business
- Correspondence
- DeliveryTo
- MailTo
- POBox
- Postal
- Residential
- Statement
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:
type: array
items:
description: Information that locates and identifies a specific address, as defined by postal services, presented in free format text.
type: string
minLength: 1
maxLength: 70
minItems: 0
maxItems: 7
RemittanceInformation:
type: object
additionalProperties: false
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.
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
SupplementaryData:
type: object
properties: {}
additionalProperties: true
description: Additional information that can not be captured in the structured fields and/or any other specific block.
Authorisation:
type: object
additionalProperties: false
required:
- AuthorisationType
description: The authorisation type request from the TPP.
properties:
AuthorisationType:
description: Type of authorisation flow requested.
type: string
enum:
- Any
- Single
CompletionDateTime:
description: |-
Date and time at which the requested authorisation flow must be completed.All dates in the JSON payloads are represented in ISO 8601 date-time format.
All date-time fields in responses must include the timezone. An example is below:
2017-04-05T10:43:07+00:00
type: string
format: date-time
SCASupportData:
type: object
properties:
RequestedSCAExemptionType:
type: string
description: This field allows a PISP to request specific SCA Exemption for a Payment Initiation
enum:
- BillPayment
- ContactlessTravel
- EcommerceGoods
- EcommerceServices
- Kiosk
- Parking
- PartyToParty
AppliedAuthenticationApproach:
type: string
maxLength: 40
description: |-
Specifies a character string with a maximum length of 40 characters.
Usage: This field indicates whether the PSU was subject to SCA performed by the TPP
enum:
- CA
- SCA
ReferencePaymentOrderId:
type: string
maxLength: 40
minLength: 1
description: 'If the payment is recurring, then this field is populated with the transaction identifier of the previous payment occurrence so that the ASPSP can verify that the PISP, amount and the payee are the same as the previous occurrence. The value here refers to the payment id e.g. DomesticPaymentId '
description: Supporting Data provided by TPP, when requesting SCA Exemption.
Risk:
type: object
additionalProperties: false
properties:
PaymentContextCode:
type: string
description: |
Specifies the payment context
* BillPayment - @deprecated
* EcommerceGoods - @deprecated
* EcommerceServices - @deprecated
* Other - @deprecated
* PartyToParty - @deprecated
enum:
- BillingGoodsAndServicesInAdvance
- BillingGoodsAndServicesInArrears
- PispPayee
- EcommerceMerchantInitiatedPayment
- FaceToFacePointOfSale
- TransferToSelf
- TransferToThirdParty
- BillPayment
- EcommerceGoods
- EcommerceServices
- Other
- PartyToParty
MerchantCategoryCode:
type: string
minLength: 3
maxLength: 4
description: Category code conform to ISO 18245, related to the type of services or goods the merchant provides for the transaction.
MerchantCustomerIdentification:
type: string
minLength: 1
maxLength: 70
description: The unique customer identifier of the PSU with the merchant.
ContractPresentInidicator:
type: boolean
description: Indicates if Payee has a contractual relationship with the PISP.
BeneficiaryPrepopulatedIndicator:
type: boolean
description: Indicates if PISP has immutably prepopulated payment details in for the PSU.
PaymentPurposeCode:
type: string
minLength: 3
maxLength: 4
description: Category code, related to the type of services or goods that corresponds to the underlying purpose of the payment that conforms to Recommended UK Purpose Code in ISO 20022 Payment Messaging List
BeneficiaryAccountType:
description: Specifies the extended type of account.
type: string
enum:
- Business
- BusinessSavingsAccount
- Charity
- Collection
- Corporate
- Ewallet
- Government
- Investment
- ISA
- JointPersonal
- Pension
- Personal
- PersonalSavingsAccount
- Premier
- Wealth
DeliveryAddress:
required:
- Country
- TownName
type: object
properties:
AddressLine:
maxItems: 2
minItems: 0
type: array
items:
type: string
minLength: 1
maxLength: 70
description: |-
Information that locates and identifies a specific address,
as defined by postal services, that is presented in free format
text.
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}$
description: |-
Information that locates and identifies a specific address,
as defined by postal services or in free format text.
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.
application/json:
schema:
type: object
additionalProperties: false
required:
- Data
- Risk
properties:
Data:
type: object
additionalProperties: false
required:
- Initiation
properties:
ReadRefundAccount:
description: Specifies to share the refund account details with PISP
type: string
enum:
- 'No'
- 'Yes'
Initiation:
type: object
additionalProperties: false
required:
- InstructionIdentification
- EndToEndIdentification
- InstructedAmount
- CreditorAccount
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.
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:
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
x-namespaced-enum:
- 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
InstructedAmount:
type: object
additionalProperties: false
required:
- Amount
- Currency
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.
properties:
Amount:
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,13}\.\d{1,5}$
Currency:
description: 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".
type: string
pattern: ^[A-Z]{3,3}$
DebtorAccount:
type: object
additionalProperties: false
required:
- SchemeName
- Identification
description: Unambiguous identification of the account of the debtor to which a debit entry will be made as a result of the transaction.
properties:
SchemeName:
description: Name of the identification scheme, in a coded form as published in an external list.
type: string
x-namespaced-enum:
- UK.OBIE.BBAN
- UK.OBIE.IBAN
- UK.OBIE.PAN
# --- truncated at 32 KB (6123 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/allica-bank/refs/heads/main/openapi/allica-bank-payment-initiation-openapi.yaml