The base URL for all PISP APIs is:
Our API currently only supports:
Our API does not support:
The following apply to all domestic payment consents:
InstructedAmount/Amountmandated by our API.
domestic-payment-consentsis authorised, but the payment initiation fails due to account limits.
RemittanceInformation/Reference is a mandatory field and must adhere to the following:
The PISP may also opt to populate reference field on behalf of the PSU
Domestic-payment-consents will only be authorised if the
CreditorAccountdetails are that of an already existing beneficiary i.e. one the PSU has previously created in their app. If a consent contains recipient info that does not meet this criteria then error will be returned to the front end, the consent will remain in status
AwaitingAuthorisationand the PSU will not be redirected.
The PISP can address this in one of two ways:
LocalInstrument supported is faster payment scheme. This field, if specified, must have the value
BH.OBF.NRT. If anything other than this is sent by PISP in consent payload then an error will be returned.
However, this field is not mandatory so we suggest PISP simply not include this field and Bank will stage consent as a faster payment.
The only supported
BH.OBF.IBAN for both
CreditorAccount. Any other enum provided will return error.
Payments can be made on all days including Saturdays, Sundays and Bank Holidays
Initiation/FirstPaymentDateTimemust be no more than 1 calendar year in advance, or PISP will be returned an error
Initiation/FinalPaymentDateTimemust be after Initiation/FirstPaymentDateTime by at least a calendar day, or PISP will be returned error
Initiation/Frequencysupported by Bank are:
The following rules apply:
The following rules apply.