Payment Initiation APIs

Download
(0 reviews)

Sandbox Mocking Information - Error Scenarios

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
ValidationsDescription/Response
AmountValidationIf Amount is of the form 100xx consent status is Rejected
CurrencyValidationAllowed Currencies are EUR, GBP else consent status is Rejected
POST API ValidationIf Amount is of the form 800xx, API will return 500, Internal Server Error
GET API ValidationIf Amount is of the form 700xx, Consent will be created but on fetching status user will get Internal Server Error
SecondaryIdentification ValidationIf 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
ValidationsDescription/Response
AmountValidationIf FirstPaymentAmount value is of the form 100xx consent status is Rejected
CurrencyValidationAllowed Currencies are EUR, GBP else consent status is Rejected
POST API ValidationIf FirstPaymentAmount value is of the form 800xx, API will return 500, Internal Server Error
GET API ValidationIf FirstPaymentAmount value is of the form 700xx, Consent will be created but on fetching status user will get Internal Server Error
SecondaryIdentification ValidationIf 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
ValidationsDescription/Response
AmountValidationIf Amount is of the form 200xx, payment status is Rejected
MultiAuthValidationIf 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 ValidationIf Amount is of the form 600xx, API will return 500, Internal Server Error
GET API ValidationIf Amount is of the form 700xx, payments resource will be created but on fetching status user will get Internal Server Error
AfterCutOffDateExceptionIf Amount is of the form 900xx, API will return 400 Bad Request with UK.OBIE.Rules.AfterCutOffDateTime error
1.4. Domestic Scheduled Payments API
ValidationsDescription/Response
AmountValidationIf Amount is of the form 200xx, payment status is InitiationFailed
MultiAuthValidationIf 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 ValidationIf Amount is of the form 600xx, API will return 500, Internal Server Error
GET API ValidationIf Amount is of the form 700xx, payments resource will be created but on fetching status user will get Internal Server Error
AfterCutOffDateExceptionIf Amount is of the form 900xx, API will return 400 Bad Request with UK.OBIE.Rules.AfterCutOffDateTime error
1.5. Domestic Standing Orders API
ValidationsDescription/Response
AmountValidationIf FirstPaymentAmount value is of the form 200xx, payment status is InitiationFailed
MultiAuthValidationIf 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 ValidationIf FirstPaymentAmount value is of the form 600xx, API will return 500, Internal Server Error
GET API ValidationIf FirstPaymentAmount value is of the form 700xx, payments resource will be created but on fetching status user will get Internal Server Error
AfterCutOffDateExceptionIf 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
ValidationsDescription/Response
AmountValidationIf Amount is of the form 100xx consent status is Rejected
CurrencyValidationUnsupported Currencies are AFN, IRR for which consent status is Rejected
ChargesUnless ChargeBearer is specified in request body,
if currency is USD then chargeType is BorneByCreditor,
ChargeListChargeAmount=1% or 5 GBP, whichever is lower.
ChargeCurrency=GBP
POST API ValidationIf Amount is of the form 800xx, API will return 500, Internal Server Error
GET API ValidationIf Amount is of the form 700xx, Consent will be created but on fetching status user will get Internal Server Error
SecondaryIdentification ValidationIf 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 ValidationsIf 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
ValidationsDescription/Response
AmountValidationIf Amount is of the form 200xx payments status is Rejected
MultiAuthValidationIf 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
ChargesUnless ChargeBearer is specified in request body,
if currency is USD then chargeType is BorneByCreditor,
ChargeListChargeAmount=1% or 5 GBP, whichever is lower.
ChargeCurrency=GBP
POST API ValidationIf Amount is of the form 600xx, API will return 500, Internal Server Error
GET API ValidationIf Amount is of the form 700xx, payments resource will be created but on fetching status user will get Internal Server Error
AfterCutOffDateExceptionIf Amount is of the form 900xx, API will return 400 Bad Request with UK.OBIE.Rules.AfterCutOffDateTime error
2.3. International Scheduled Payments API
ValidationsDescription/Response
AmountValidationIf Amount is of the form 200xx payments status is InitiationFailed
MultiAuthValidationIf 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
ChargesUnless ChargeBearer is specified in request body,
if currency is USD then chargeType is BorneByCreditor,
ChargeListChargeAmount=1% or 5 GBP, whichever is lower.
ChargeCurrency=GBP
POST API ValidationIf Amount is of the form 600xx, API will return 500, Internal Server Error
GET API ValidationIf Amount is of the form 700xx, payments resource will be created but on fetching status user will get Internal Server Error
AfterCutOffDateExceptionIf Amount is of the form 900xx, API will return 400 Bad Request with UK.OBIE.Rules.AfterCutOffDateTime error
3.1. File Payment Consents API
ValidationsDescription/Response
AmountValidationIf ControlSum is of the form 100xx consent status is Rejected
POST API ValidationIf ControlSum is of the form 800xx, API will return 500, Internal Server Error
GET API ValidationsIf ControlSum is of the form 700xx, Consent will be created but on fetching status user will get Internal Server Error
Uploaded file can only be fetched for a period of 90 days since upload
3.2. File Payments API
ValidationsDescription/Response
AmountValidationIf ControlSum is of the form 200xx payments status is InitiationFailed
MultiAuthValidationIf ControlSum is of the form 300xx, MultiAuth status is Authorised and Payment status is InitiationCompleted
If ControlSum is of the form 400xx, MultiAuth status is AwaitingFurtherAuthorisation and Payment status is InitiationPending
If ControlSum is of the form 500xx, MultiAuth status is Rejected and Payment status is InitiationFailed
POST API ValidationIf ControlSum is of the form 600xx, API will return 500, Internal Server Error
GET API ValidationIf ControlSum is of the form 700xx, file resource will be created but on fetching status user will get Internal Server Error
AfterCutOffDateExceptionIf ControlSum is of the form 900xx, API will return 400 Bad Request with UK.OBIE.Rules.AfterCutOffDateTime error

Reviews

Payment Initiation APIs doesn't have any reviews yet