To invoke the APIs, a developer needs to download Test Data by registering and logging into the BOI Developer Portal. This Test Data will provide the required PSU/Customer Account details required to invoke the APIs.
This sections provides Sandbox Mocking Information related to API requests and responses.
1.1. Domestic Payment Consents & Domestic Scheduled Payment Consents
Validations | Description/Response |
AmountValidation | If Amount is of the form 100xx consent status is Rejected |
CurrencyValidation | Allowed Currencies are EUR, GBP else consent status is Rejected |
POST API Validation | If Amount is of the form 800xx, API will return 500, Internal Server Error |
GET API Validation | If Amount is of the form 700xx, Consent will be created but on fetching status user will get Internal Server Error |
SecondaryIdentification Validation | If SecondaryIdentification of CreditorAccount provided in the request is of the form 333xx, API will return 400 Bad Request with UK.OBIE.Unsupported.AccountSecondaryIdentifier error |
1.2. Domestic Standing Order Consents API
Validations | Description/Response |
AmountValidation | If FirstPaymentAmount value is of the form 100xx consent status is Rejected |
CurrencyValidation | Allowed Currencies are EUR, GBP else consent status is Rejected |
POST API Validation | If FirstPaymentAmount value is of the form 800xx, API will return 500, Internal Server Error |
GET API Validation | If FirstPaymentAmount value is of the form 700xx, Consent will be created but on fetching status user will get Internal Server Error |
SecondaryIdentification Validation | If SecondaryIdentification of CreditorAccount provided in the request is of the form 333xx, API will return 400 Bad Request with UK.OBIE.Unsupported.AccountSecondaryIdentifier error |
1.3. Domestic Payments API
Validations | Description/Response |
AmountValidation | If Amount is of the form 200xx, payment status is Rejected |
MultiAuthValidation | If Amount is of the form 300xx, MultiAuth status is Authorised and Payment status is AcceptedSettlementInProcess |
If Amount is of the form 400xx, MultiAuth status is AwaitingFurtherAuthorisationand Payment Status is Pending |
If Amount is of the form 500xx, MultiAuth status is Rejected and Payment Status is Rejected |
POST API Validation | If Amount is of the form 600xx, API will return 500, Internal Server Error |
GET API Validation | If Amount is of the form 700xx, payments resource will be created but on fetching status user will get Internal Server Error |
AfterCutOffDateException | If Amount is of the form 900xx, API will return 400 Bad Request with UK.OBIE.Rules.AfterCutOffDateTime error |
1.4. Domestic Scheduled Payments API
Validations | Description/Response |
AmountValidation | If Amount is of the form 200xx, payment status is InitiationFailed |
MultiAuthValidation | If Amount is of the form 300xx, MultiAuth status is Authorised and Payment status is InitiationCompleted |
If Amount is of the form 400xx, MultiAuth status is AwaitingFurtherAuthorisation and Payment Status is InitiationPending |
if Amount is of the form 500xx, MultiAuth status is Rejected and Payment Status is InitiationFailed |
POST API Validation | If Amount is of the form 600xx, API will return 500, Internal Server Error |
GET API Validation | If Amount is of the form 700xx, payments resource will be created but on fetching status user will get Internal Server Error |
AfterCutOffDateException | If Amount is of the form 900xx, API will return 400 Bad Request with UK.OBIE.Rules.AfterCutOffDateTime error |
1.5. Domestic Standing Orders API
Validations | Description/Response |
AmountValidation | If FirstPaymentAmount value is of the form 200xx, payment status is InitiationFailed |
MultiAuthValidation | If FirstPaymentAmount value is of the form 300xx, MultiAuth status is Authorised and Payment status is InitiationCompleted |
If FirstPaymentAmount value is of the form 400xx, MultiAuth status is AwaitingFurtherAuthorisation and Payment Status is IntitiationPending |
if FirstPaymentAmount value is of the form 500xx, MultiAuth status is Rejected and Payment Status is InitiationFailed |
POST API Validation | If FirstPaymentAmount value is of the form 600xx, API will return 500, Internal Server Error |
GET API Validation | If FirstPaymentAmount value is of the form 700xx, payments resource will be created but on fetching status user will get Internal Server Error |
AfterCutOffDateException | If FirstPaymentAmount value is of the form 900xx, API will return 400 Bad Request with UK.OBIE.Rules.AfterCutOffDateTime error |
2.1. International Payment Consents & International Scheduled Payment Consents API
Validations | Description/Response |
AmountValidation | If Amount is of the form 100xx consent status is Rejected |
CurrencyValidation | Unsupported Currencies are AFN, IRR for which consent status is Rejected |
Charges | Unless ChargeBearer is specified in request body, |
if currency is USD then chargeType is BorneByCreditor, |
ChargeList | ChargeAmount=1% or 5 GBP, whichever is lower. |
ChargeCurrency=GBP |
POST API Validation | If Amount is of the form 800xx, API will return 500, Internal Server Error |
GET API Validation | If Amount is of the form 700xx, Consent will be created but on fetching status user will get Internal Server Error |
SecondaryIdentification Validation | If SecondaryIdentification of CreditorAccount provided in the request is of the form 333xx, API will return 400 Bad Request with UK.OBIE.Unsupported.AccountSecondaryIdentifier error |
ExchangeRateInformation Validations | If RateType specified and ExchangeRate not specified in the ExchangeRateInformation, in the request body, is Actual/Indicative, ExchangeRate in response is mocked to 1.5 ExpirationDateTime in the ExchangeRateInformation response block for RateType Agreed is mocked to 10 minutes after consent creation. If ContractIdentification is specified and its vale starts with Test, consent status in the response in rejected. |
2.2. International Payments API
Validations | Description/Response |
AmountValidation | If Amount is of the form 200xx payments status is Rejected |
MultiAuthValidation | If Amount is of the form 300xx, MultiAuth status is Authorised and Payment Status is AcceptedSettlementInProcess |
If Amount is of the form 400xx, MultiAuth status is AwaitingFurtherAuthorisation and Payment Status is Pending |
If Amount is of the form 500xx, MultiAuth status is Rejected and Payment Status is Rejected |
Charges | Unless ChargeBearer is specified in request body, |
if currency is USD then chargeType is BorneByCreditor, |
ChargeList | ChargeAmount=1% or 5 GBP, whichever is lower. |
ChargeCurrency=GBP |
POST API Validation | If Amount is of the form 600xx, API will return 500, Internal Server Error |
GET API Validation | If Amount is of the form 700xx, payments resource will be created but on fetching status user will get Internal Server Error |
AfterCutOffDateException | If Amount is of the form 900xx, API will return 400 Bad Request with UK.OBIE.Rules.AfterCutOffDateTime error |
2.3. International Scheduled Payments API
Validations | Description/Response |
AmountValidation | If Amount is of the form 200xx payments status is InitiationFailed |
MultiAuthValidation | If Amount is of the form 300xx MultiAuth status is Authorised and payment status is InitiationCompleted |
If Amount is of the form 400xx, MultiAuth status is AwaitingFurtherAuthorisation and Payment Status is IntitiationPending |
If Amount is of the form 500xx. MultiAuth status is Rejected and Payment Status is InitiationFailed |
Charges | Unless ChargeBearer is specified in request body, |
if currency is USD then chargeType is BorneByCreditor, |
ChargeList | ChargeAmount=1% or 5 GBP, whichever is lower. |
ChargeCurrency=GBP |
POST API Validation | If Amount is of the form 600xx, API will return 500, Internal Server Error |
GET API Validation | If Amount is of the form 700xx, payments resource will be created but on fetching status user will get Internal Server Error |
AfterCutOffDateException | If Amount is of the form 900xx, API will return 400 Bad Request with UK.OBIE.Rules.AfterCutOffDateTime error |