Overview
All PISP APIs have been built in line with v3.1 of the Open Banking API Specification and are accessible by any regulated third party. It is advised that any third party wishing to utilise these APIs familiarizes themselves with the Open Banking specification.
You will receive a response with the relevant information requested, only if the following conditions pertaining to the user are met.
- The company to which the user belongs must be an active SVB client and must be eligible to initiate payments through a PISP
- The service will confirm that the client associated with the user has been configured for API services
- The user must be in an active status that allows the user to logon to Online Banking or Mobile Banking
- The service will confirm that the user is a valid user on online banking, and that they are not in frozen, disabled, locked, modified pending, deleted pending, pending or partially set up
- The user must be eligible to access account information through an PISP
- The service will confirm that the user associated with the client has been configured for API (PISP) services
- The user must be eligible to initiate payments from at least one account over the Online banking channel
- The service will confirm, specific to an account or all accounts, whether the user has entitlement to make payments and an appropriate limit within which to do so
- The consent provided by the user must be active
Please refer to the Payment & Foreign Exchange Processing guide for cut-off times. This can be found online through https://www.svb.com/uk
- FPS (UK time) : Start Time 4:00 AM and End Time 4:30 Pm
- BACS (UK time): Start Time 4:00 AM and End Time is 4:00 PM
- CHAPS (UK time) : Start Time 4:00 AM and End Time 4:30 Pm
- SEPA (UK time): Start Time 4:00 AM and End Time 11:00 AM
- SWIFT (UK time): Start Time 4:00 AM and End Time 5:00 PM
If final payment submission request is received by SVB after the cut-off time (note: small amount of tolerance allowed where user payments received within cut off times), weekends of bank holidays then payment initiation will be rejected
Note: SVB applies the following Cut-Off Times for payments (inc. File Payments):
You must digitally sign individual request and we will digitally sign individual response for each of the resources.
Payments Core Business Rules
Resource |
Field / Value |
Validation |
Notes |
---|---|---|---|
Domestic Payments |
Instructed Amount |
If the LocalInstrument is UK.OBIE.FPS or blank, then the Instructed Amount should be equal to or less than £250,000 or the consent will be rejected |
|
Domestic Payments |
Instructed Amount Currency |
If the LocalInstrument is UK.OBIE.FPS, UK.OBIE.BACS or blank and the selected payee account has a UK.OBIE.SortCodeAccountNumber then the ISO Currency Code provided should be GBP or the consent will be rejected |
|
Domestic Payments International Payments |
Instructed Amount |
If the payment request amount (instructed amount) is 0.00000, then the consent will be rejected |
|
Domestic Payments International Payments |
Remittance Information: Reference and Unstructured |
If the user provides both Unstructured and/or Reference, then API will use the information provided in unstructured as the client reference value |
|
Domestic Scheduled Payments International Scheduled Payments |
Requested Execution Date Time |
If the Requested Execution Date Time is past dated/current date/set beyond 5 years in future, then SVB will reject the consent |
|
Domestic Standing Orders International Standing Orders |
First Payment Date Time, Recurring Payment Date Time and Final Payment Date Time |
SVB only supports a single amount for Standing Orders. Therefore, if a TPP provides the Recurring Payment Amount, and Final Payment Amount then consent will be rejected |
|
Domestic Standing Orders International Standing Orders |
Local Instrument |
For Standing Order the Local Instrument must specified in Supplementary Data Section since Open Banking has not specified the local instrument in standing order endpoint and this is required for SVB to process any payment |
|
Domestic Standing Orders International Standing Orders |
Final Payment Date Time and Number of Payments |
If TPP provides both Final Payment Date Time and Number of Payments, then consent will be rejected |
|
Domestic Standing Orders International Standing Orders |
First Payment Date Time |
If the First Payment Date Time is past dated/current date/set 5 years in future or before First Payment Date, then SVB will reject the consent |
|
Domestic Standing Orders International Standing Orders |
Frequency Type |
If Frequency Type is provided other than IntrvlWkDay:01:(01 to 07), IntrvlWkDay:02:(01 to 07), IntrvlMnthDay:01:(01 to 31),IntrvlMnthDay:02:(01 to 31) ,IntrvlMnthDay:03:30 (01 to 31) ,IntrvlMnthDay:06:31 (01 to 31) and IntrvlMnthDay:12:01 (01 to 31) then consent will be rejected |
|
International Payments |
Instructed Amount Currency and Currency of Transfer |
If the Local Instrument is ‘UK.OBIE.SEPACreditTransfer' and payee account currency is not EUR, then consent will be rejected |
|
International Payments |
Creditor Account Identification |
If the Local Instrument is UK.OBIE.SEPACreditTransfer and the TPP provides Creditor Account Scheme Name as UK.OBIE.BBAN and Creditor Agent details is provided/not provided, then the consent will be rejected |
|
International Payments |
Creditor Account Identification |
If TPP provides Creditor Account Scheme Name as UK.OBIE.BBAN and Creditor Agent details is blank/null, then SVB will reject the consent |
|
International Payments |
Creditor Account Identification |
If the Local Instrument is UK.OBIE.SWIFT and the TPP provides Creditor Account Scheme Name as UK.OBIE.IBAN and Creditor Agent details is blank/null, then SVB will reject the consent |
|
International Payments |
Charge Bearer |
IF TPP provides ChargeBearer as FollowingServiceLevel, or XYZ (non-allowable value), then SVB will reject the consent |
|
International Payments |
Charge Bearer |
If the Local Instrument is UK.OBIE.SEPACreditTransfer and TPP provides ChargeBearer as BorneByCreditor, BorneByDebtor, then SVB will reject the consent |
|
International Payments |
Exchange Rate Information: Rate Type |
SVB only supports the Actual ExchangeRateInformation.RateType |
|
International Payments |
Creditor and Creditor Postal Address |
TPPs are required to provide Creditor and CreditorPostalAddress data objects when creating International Payment requests |
|
International Payments |
Exchange Rate |
Exchange Rates quotes are not generated until the user authorizes the consent and chooses which account they want to initiate the payment from |
|
International Scheduled Payments International Standing Orders |
Instructed Amount Currency and Currency of Transfer |
If the local instrument is SWIFT or Blank and TPP provides the different values in Currency of Transfer and Instructed Amount Currency, then SVB will reject the consent |
|
International Scheduled Payments International Standing Orders |
Exchange Rate |
SVB does not support requests containing ExchangeRateInformation for International Scheduled Payments or International Standing Orders |
|
Domestic Payments |
Creditor Account Scheme Name |
If the Local Instrument is either UK.OBIE.FPS (or blank), UK.OBIE.BACS, or UK.OBIE.CHAPS, and Creditor Account Scheme Name is other than 'UK.OBIE.SortCodeAccountNumber', then consent will be rejected |
Not Allowed values: UK.OBIE.BBAN, UK.OBIE.IBAN, UK.OBIE.PAN, and UK.OBIE.Paym |
International Payments |
Creditor Account Scheme Name |
If the If the Local Instrument is either UK.OBIE.SEPACreditTransfer, UK.OBIE.SWIFT, or blank, and Creditor Account Scheme Name is other than UK.OBIE.BBAN, or UK.OBIE.IBAN, then consent will be rejected |
Not Allowed values: UK.OBIE.SortCodeAccountNumber, UK.OBIE.PAN, and UK.OBIE.Paym |
Domestic Payments |
Local Instrument |
For Domestic Payment if the PISP has set Local Instrument value other than UK.OBIE.FPS, UK.OBIE.BACS, UK.OBIE.CHAPS, or blank (API will default to use UK.OBIE.FPS) , then consent will be rejected |
Not Allowed: UK.OBIE.BalanceTransfer, UK.OBIE.Euro1, UK.OBIE.Link, UK.OBIE.MoneyTransfer,UK.OBIE.Paym,UK.OBIE.SEPACreditTransfer, UK.OBIE.SWFIT, UK.OBIE.SEPAInstantCreditTransfer, UK.OBIE.Target2, and junk values (XYZ) |
International Payments |
Local Instrument |
For International Payment if the PISP has set Local Instrument value other than UK.OBIE.SEPACreditTransfer, UK.OBIE.SWIFT, or Blank (API will default to use UK.OBIE.SWIFT) then consent will be rejected with the following error message |
Not Allowed: UK.OBIE.BalanceTransfer, UK.OBIE.Euro1, UK.OBIE.Link, UK.OBIE.MoneyTransfer,UK.OBIE.Paym,UK.OBIE.FPS,UK.OBIE.BACS, UK.OBIE.CHAPS, UK.OBIE.SEPAInstantCreditTransfer, UK.OBIE.Target2, and junk values (XYZ) |
International Payments |
Charge Bearer |
If TPP provides Creditor Account Identification as UK.OBIE.IBAN and ChargeBearer as BorneByCreditor, BorneByDebtor or blank then SVB will derive the country from the IBAN and check if it is an EEA country from the EEA country list. If it is an EEA country, then consent will be rejected |
For non-EEA country user has an option to change the charge bearer on the consent authorization screen. SVB will use the value provided the user |
Domestic Payments International Payments |
Debtor Account |
If the TPP provides the debiting account, then consent will be rejected |
This validation is not applicable for file payments. Please refer to File Payment specific validations for debiting account validations |
International Scheduled Payments International Standing Orders |
Instructed Amount Currency and Currency of Transfer |
If Local Instrument is UK.OBIE.SWIFT, or Blank and Instructed Amount Currency and Currency of Transfer is not an SVB account currency, then consent will be rejected |
SVB Supported Account Currencies: USD, AUD, CAD, CHF, DKK, EUR, GBP, HKD, ILS, JPY, NOK, NZD, SEK, SGD, USD, ZAR, CNH |
International Payments |
Instructed Amount Currency and Currency of Transfer |
If Local Instrument is SWIFT or Blank and currency is not supported by SVB, then consent will be rejected |
SVB Supported Currency AED, ARS, AUD, BGN, BHD, BRL, CAD, CHF, CLP, CNH, COP, CZK, DKK, EGP, EUR, GBP, HKD, HUF, IDR, ILS, INR, JOD, JPY,KES, KRW, KWD, LKR, MXN, MYR, NOK, NZD, PEN, PHP, PLN, QAR, RJC, RON, RUB, SAR, SEK, SGD, THB, TRY, TWD, UAH, USD, VND, ZAR |
Domestic Payments |
Remittance Information Unstructured / Reference |
If the RemittanceInformation.Unstructured or RemittanceInformation.Reference data objects are more than 18 characters, then the consent will be rejected |
Where the Local Instrument is UK.OBIE.FPS or UK.OBIE.BACS
For Standing Order structure consists only Reference details and does not include Remittance Unstructured details. |
File Payments |
File Type |
If the user provides File Type other than 'UK.OBIE.PaymentInitiation.3.1', then SVB will reject the consent |
|
File Payments |
File Type |
If the TPP does not provide File Type, then SVB will reject the consent |
|
File Payments |
File Hash |
If the TPP does not provide File Hash, then SVB will reject the consent |
|
File Payments |
Number of Transaction |
If the TPP does not provide Number of Transaction, then SVB will reject the consent |
|
File Payments |
File Reference |
If the TPP does not provide File Reference, then SVB will reject the consent |
|
File Payments |
Control Sum |
If the TPP does not provide Control Sum, then SVB will reject the consent |
|
File Payments |
Local Instrument |
If the TPP does not provide Local Instrument, then SVB will reject the consent |
SVB only supports file payments with the same payment type across each payment within the file, and it is mandatory in consent and file upload. |
File Payments |
Local Instrument |
If the user provides Local Instrument as either UK.OBIE.FPS, UK.OBIE.CHAPS, UK.OBIE.SEPA, or UK.OBIE.SWIFT and provides the debtor account information, then SVB will reject the file payment |
|
File Payments |
Requested Execution Date Time |
If the TPP does not provide Requested Execution Date Time, then SVB will reject the consent |
Note: This field is mandatory by SVB in consent and upload endpoints, and it should be the same across each payment within the file. |
File Payments |
Requested Execution Date Time |
If TPP provides the ‘RequestedExecutionDateTime’ current date, then SVB will process the payment as immediate payment. If the Requested Execution Date Time is future date, then SVB will process the payment as Scheduled Payment |
|
File Payments |
Debtor Account Identification |
Faster Payments, CHAPS, BACS, SWIFT and SEPA (Batch Payments): Do not provide Debtor Accounts if you want to process Faster Payments, CHAPS, BACS, SWIFT, or SEPA. |
|
File Payments |
Debtor Account Identification |
Multi-BACS (Bulk Payments): Provide Debtor Accounts if you want to process bulk BACS payments. |
|
File Payments - Upload |
All Field Values |
All data noted in the consent metadata should be same in the file else file upload, otherwise the consent / file will be rejected |
|
File Payments - Upload |
Debtor Account Identification |
If Local Instrument is set as 'UK. OBIE.BACS' and Debtor Account is provided in the metadata, then Debtor Account must be same in the file else file upload will be rejected |
Provide the Debtor Accounts if you want to process bulk BACS payments. The debtor account details must be the same across each payment in the file. We do not support processing multiple debtor accounts within the same file for File Payments. |
File Payments - Upload |
Debtor Account Identification |
The debtor account details must be the same across each payment in the file. We do not support processing multiple debtor accounts within the same file for File Payments. |
Provide the Debtor Accounts if you want to process Faster Payments, CHAPS, BACS, SWIFT, or SEPA. |
File Payments – Upload |
Debtor Account Scheme Name |
If the If the Local Instrument is either UK. OBIE.BACS, UK.OBIE.FPS, UK.OBIE.CHAPS. UK. OBIE.SEPA. UK. OBIE.SWIFT and Debtor Account Scheme Name is other than 'UK. OBIE.SortCodeAccountNumber', then consent will be rejected |
Not Allowed values: UK. OBIE.BBAN, UK. OBIE.IBAN, UK.OBIE.PAN, and ‘UK. OBIE.Paym'
|
File Payments |
Requested Execution Date Time |
If the Requested Execution Date Time is past dated/set beyond 5 years in future, then SVB will reject the consent |
API will only go by the date and not the time to process the payment on the future date. |
File Payments |
Number of Transaction |
Number of Transaction must be maximum of 100. If user provides a value greater than 100, then SVB will reject the consent |
SVB limits current file imports to 100 records only |
File Payments – Upload |
General File Upload Error |
If the TPP is trying to upload the file again after file upload for the same consent when it is still in Awaiting Upload, then API must respond with an error |
SVB will respond with an error message - The file has already been received and validation is in progress. Use GET STATUS call to monitor for status of 201 to confirm completion |
File Payments – Upload |
General File Upload Error |
If the TPP is trying to upload file again after file upload for the same consent when it is in any other stage other than Awaiting Upload, then API respond with an error |
SVB will respond with an error message - The file has already been received for this consent. If this is a new file, please submit through a separate consent |
File Payments – Upload |
Header Details |
Domestic File Payments: For Faster Payments, CHAPS, BACS, or Multi-BACS the header must be ‘DomesticPayments’ for both immediate and scheduled payments in the file upload request. |
|
File Payments – Upload |
Header Details |
International File Payment: For SWIFT or SEPA the header must be ‘InternationalPayments’ for both immediate and scheduled payments in the file upload request. |
|
File Payments – Upload |
Debtor Account Identification |
If the Debtor Account is provided, then the sortcode (first 6 digit) must be 621000 else consent must be rejected |
The Debtor Account information must be an SVB account identified with the SVB sort code |
File Payments |
Debtor Account |
If the Debtor Account is provided, then the sort code (first 6 digit) must be 621000 else consent will be rejected |
The Debtor Account information must be an SVB account identified with the SVB sort code
If the TPP provides a Debtor Account in the file consent metadata, the payment will be assumed to be a Bulk (Multi-BACs) payment request |
File Payments - Upload |
Cut-off Time |
If Requested Execution Date is current date/blank and payment is received by SVB after the cut-off time, weekends or bank holidays, then payment initiation will be rejected |
SVB Cut-Off Times: FPS (UK time): Start Time 4:00 AM and End Time 4:30 Pm BACS (UK time): Start Time 4:00 AM and End Time is 4:00 PM CHAPS (UK time): Start Time 4:00 AM and End Time 4:30 Pm SEPA (UK time): Start Time 4:00 AM and End Time 11:00 AM SWIFT (UK time): Start Time 4:00 AM and End Time 5:00 PM |
Single Domestic Payments
The POST /domestic-payment-consents endpoint allows a PISP to create a payment request resource with SVB, by providing the requisite payment information.
Endpoints:
-
POST /domestic-payment-consents
-
GET /domestic-payment-consents/{ConsentId}
-
GET /domestic-payment-consents/{ConsentId}/funds-confirmation
-
POST /domestic-payments
-
GET /domestic-payments/{DomesticPaymentId}
Domestic Scheduled Payment
Endpoints:
-
POST /domestic-scheduled-payment-consents
-
GET /domestic-scheduled-payment-consents/{ConsentId}
- POST /domestic-scheduled-payments
-
GET /domestic-scheduled-payments/{DomesticScheduledPaymentId}
Domestic Standing Orders
Endpoints:
-
POST /domestic-standing-order-consents
-
GET /domestic-standing-order-consents/{ConsentId}
- POST /domestic-standing-orders
-
GET /domestic-standing-orders/{DomesticStandingOrderId}
Single International Payments
Endpoints:
-
POST /international-payment-consents
-
GET /international-payment-consents/{ConsentId}
-
GET /international-payment-consents/{ConsentId}/funds-confirmation
-
POST /international-payments
-
GET /international-payments/{InternationalPaymentId}
International Scheduled Payments
Endpoints:
-
POST /international-scheduled-payment-consents
-
GET /international-scheduled-payment-consents/{ConsentId}
- POST /international-scheduled-payments
-
GET /international-scheduled-payments/{InternationalScheduledPaymentId}
International Standing Orders
Endpoints:
-
POST /international-standing-order-consents
-
GET /international-standing-order-consents/{ConsentId}
- POST /international-standing-orders
-
GET /international-standing-orders/{InternationalStandingOrderPaymentId}
File Payments
Endpoints:
- POST /file-payment-consents
- GET /file-payment-consents/{ConsentId}
- POST /file-payment-consents/{ConsentId}/file
- GET /file-payment-consents/{ConsentId}/file
- POST /file-payments
- GET /file-payments/{FilePaymentId}