API Explorer

v3.1 (67 APIs)

Bank
Accounts
Views
Counterparties
Transactions

Create Domestic Payment Consents

NOTE: This endpoint currently only returns example data.

Authentication is Mandatory

JSON request body fields:

JSON response body fields:

Typical Successful Response:

								
									
{ "Meta":{ "FirstAvailableDateTime":{ }, "TotalPages":0 }, "Risk":{ "PaymentContextCode":{ }, "DeliveryAddress":{ "StreetName":"StreetName", "CountrySubDivision":["CountrySubDivision","CountrySubDivision"], "AddressLine":["AddressLine","AddressLine"], "BuildingNumber":"BuildingNumber", "TownName":"TownName", "Country":"Country", "PostCode":"PostCode" }, "MerchantCategoryCode":"MerchantCategoryCode", "MerchantCustomerIdentification":"MerchantCustomerIdentification" }, "Links":{ "Last":"http://example.com/aeiou", "Prev":"http://example.com/aeiou", "Next":"http://example.com/aeiou", "Self":"http://example.com/aeiou", "First":"http://example.com/aeiou" }, "Data":{ "Status":{ }, "StatusUpdateDateTime":"2000-01-23T04:56:07.000+00:00", "CreationDateTime":"2000-01-23T04:56:07.000+00:00", "ExpectedExecutionDateTime":"2000-01-23T04:56:07.000+00:00", "CutOffDateTime":"2000-01-23T04:56:07.000+00:00", "Authorisation":{ "CompletionDateTime":"2000-01-23T04:56:07.000+00:00", "AuthorisationType":{ } }, "Charges":[{ "Type":["UK.OBIE.CHAPSOut","UK.OBIE.BalanceTransferOut","UK.OBIE.MoneyTransferOut"], "Amount":{ "Amount":{ }, "Currency":"Currency" }, "ChargeBearer":{ } },{ "Type":["UK.OBIE.CHAPSOut","UK.OBIE.BalanceTransferOut","UK.OBIE.MoneyTransferOut"], "Amount":{ "Amount":{ }, "Currency":"Currency" }, "ChargeBearer":{ } }], "ConsentId":"ConsentId", "Initiation":{ "SupplementaryData":{ }, "LocalInstrument":["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"], "DebtorAccount":{ "SecondaryIdentification":"SecondaryIdentification", "SchemeName":["UK.OBIE.BBAN","UK.OBIE.IBAN","UK.OBIE.PAN","UK.OBIE.Paym","UK.OBIE.SortCodeAccountNumber"], "Identification":"Identification", "Name":"Name" }, "RemittanceInformation":{ "Unstructured":"Unstructured", "Reference":"Reference" }, "EndToEndIdentification":"EndToEndIdentification", "InstructionIdentification":"InstructionIdentification", "CreditorAccount":{ "SecondaryIdentification":"SecondaryIdentification", "SchemeName":["UK.OBIE.BBAN","UK.OBIE.IBAN","UK.OBIE.PAN","UK.OBIE.Paym","UK.OBIE.SortCodeAccountNumber"], "Identification":"Identification", "Name":"Name" }, "InstructedAmount":{ "Currency":"Currency" }, "CreditorPostalAddress":{ "StreetName":"StreetName", "CountrySubDivision":"CountrySubDivision", "Department":"Department", "AddressLine":["AddressLine","AddressLine","AddressLine","AddressLine","AddressLine","AddressLine","AddressLine"], "BuildingNumber":"BuildingNumber", "TownName":"TownName", "Country":"Country", "SubDepartment":"SubDepartment", "AddressType":{ }, "PostCode":"PostCode" } }, "ExpectedSettlementDateTime":"2000-01-23T04:56:07.000+00:00" } }
Validations:
  • Required JSON Validation: No
  • Allowed Authentication Types: Not set
Possible Errors:
  • OBP-20001: User not logged in. Authentication is required!
  • OBP-50000: Unknown Error.
Connector Methods:
Version: UKv3.1, function_name: by createDomesticPaymentConsents, operation_id: UKv3.1-createDomesticPaymentConsents Tags: Domestic Payments, Mocked-Data,

Create Domestic Payments

NOTE: This endpoint currently only returns example data.

Authentication is Mandatory

JSON request body fields:

JSON response body fields:

Typical Successful Response:

								
									
{ "Meta":{ "FirstAvailableDateTime":{ }, "TotalPages":0 }, "Links":{ "Last":"http://example.com/aeiou", "Prev":"http://example.com/aeiou", "Next":"http://example.com/aeiou", "Self":"http://example.com/aeiou", "First":"http://example.com/aeiou" }, "Data":{ "DomesticPaymentId":"DomesticPaymentId", "Status":{ }, "StatusUpdateDateTime":"2000-01-23T04:56:07.000+00:00", "CreationDateTime":"2000-01-23T04:56:07.000+00:00", "ExpectedExecutionDateTime":"2000-01-23T04:56:07.000+00:00", "Charges":[{ "Type":["UK.OBIE.CHAPSOut","UK.OBIE.BalanceTransferOut","UK.OBIE.MoneyTransferOut"], "Amount":{ "Amount":{ }, "Currency":"Currency" }, "ChargeBearer":{ } },{ "Type":["UK.OBIE.CHAPSOut","UK.OBIE.BalanceTransferOut","UK.OBIE.MoneyTransferOut"], "Amount":{ "Amount":{ }, "Currency":"Currency" }, "ChargeBearer":{ } }], "ConsentId":"ConsentId", "Initiation":{ "SupplementaryData":{ }, "LocalInstrument":["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"], "DebtorAccount":{ "SecondaryIdentification":"SecondaryIdentification", "SchemeName":["UK.OBIE.BBAN","UK.OBIE.IBAN","UK.OBIE.PAN","UK.OBIE.Paym","UK.OBIE.SortCodeAccountNumber"], "Identification":"Identification", "Name":"Name" }, "RemittanceInformation":{ "Unstructured":"Unstructured", "Reference":"Reference" }, "EndToEndIdentification":"EndToEndIdentification", "InstructionIdentification":"InstructionIdentification", "CreditorAccount":{ "SecondaryIdentification":"SecondaryIdentification", "SchemeName":["UK.OBIE.BBAN","UK.OBIE.IBAN","UK.OBIE.PAN","UK.OBIE.Paym","UK.OBIE.SortCodeAccountNumber"], "Identification":"Identification", "Name":"Name" }, "InstructedAmount":{ "Currency":"Currency" }, "CreditorPostalAddress":{ "StreetName":"StreetName", "CountrySubDivision":"CountrySubDivision", "Department":"Department", "AddressLine":["AddressLine","AddressLine","AddressLine","AddressLine","AddressLine","AddressLine","AddressLine"], "BuildingNumber":"BuildingNumber", "TownName":"TownName", "Country":"Country", "SubDepartment":"SubDepartment", "AddressType":{ }, "PostCode":"PostCode" } }, "ExpectedSettlementDateTime":"2000-01-23T04:56:07.000+00:00", "MultiAuthorisation":{ "Status":{ }, "NumberReceived":6, "LastUpdateDateTime":"2000-01-23T04:56:07.000+00:00", "ExpirationDateTime":"2000-01-23T04:56:07.000+00:00", "NumberRequired":0 } } }
Validations:
  • Required JSON Validation: No
  • Allowed Authentication Types: Not set
Possible Errors:
  • OBP-20001: User not logged in. Authentication is required!
  • OBP-50000: Unknown Error.
Connector Methods:
Version: UKv3.1, function_name: by createDomesticPayments, operation_id: UKv3.1-createDomesticPayments Tags: Domestic Payments, Mocked-Data,

Get Domestic Payment Consents

NOTE: This endpoint currently only returns example data.

Authentication is Mandatory

URL Parameters:

JSON response body fields:

Typical Successful Response:

								
									
{ "Meta":{ "FirstAvailableDateTime":{ }, "TotalPages":0 }, "Risk":{ "PaymentContextCode":{ }, "DeliveryAddress":{ "StreetName":"StreetName", "CountrySubDivision":["CountrySubDivision","CountrySubDivision"], "AddressLine":["AddressLine","AddressLine"], "BuildingNumber":"BuildingNumber", "TownName":"TownName", "Country":"Country", "PostCode":"PostCode" }, "MerchantCategoryCode":"MerchantCategoryCode", "MerchantCustomerIdentification":"MerchantCustomerIdentification" }, "Links":{ "Last":"http://example.com/aeiou", "Prev":"http://example.com/aeiou", "Next":"http://example.com/aeiou", "Self":"http://example.com/aeiou", "First":"http://example.com/aeiou" }, "Data":{ "Status":{ }, "StatusUpdateDateTime":"2000-01-23T04:56:07.000+00:00", "CreationDateTime":"2000-01-23T04:56:07.000+00:00", "ExpectedExecutionDateTime":"2000-01-23T04:56:07.000+00:00", "CutOffDateTime":"2000-01-23T04:56:07.000+00:00", "Authorisation":{ "CompletionDateTime":"2000-01-23T04:56:07.000+00:00", "AuthorisationType":{ } }, "Charges":[{ "Type":["UK.OBIE.CHAPSOut","UK.OBIE.BalanceTransferOut","UK.OBIE.MoneyTransferOut"], "Amount":{ "Amount":{ }, "Currency":"Currency" }, "ChargeBearer":{ } },{ "Type":["UK.OBIE.CHAPSOut","UK.OBIE.BalanceTransferOut","UK.OBIE.MoneyTransferOut"], "Amount":{ "Amount":{ }, "Currency":"Currency" }, "ChargeBearer":{ } }], "ConsentId":"ConsentId", "Initiation":{ "SupplementaryData":{ }, "LocalInstrument":["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"], "DebtorAccount":{ "SecondaryIdentification":"SecondaryIdentification", "SchemeName":["UK.OBIE.BBAN","UK.OBIE.IBAN","UK.OBIE.PAN","UK.OBIE.Paym","UK.OBIE.SortCodeAccountNumber"], "Identification":"Identification", "Name":"Name" }, "RemittanceInformation":{ "Unstructured":"Unstructured", "Reference":"Reference" }, "EndToEndIdentification":"EndToEndIdentification", "InstructionIdentification":"InstructionIdentification", "CreditorAccount":{ "SecondaryIdentification":"SecondaryIdentification", "SchemeName":["UK.OBIE.BBAN","UK.OBIE.IBAN","UK.OBIE.PAN","UK.OBIE.Paym","UK.OBIE.SortCodeAccountNumber"], "Identification":"Identification", "Name":"Name" }, "InstructedAmount":{ "Currency":"Currency" }, "CreditorPostalAddress":{ "StreetName":"StreetName", "CountrySubDivision":"CountrySubDivision", "Department":"Department", "AddressLine":["AddressLine","AddressLine","AddressLine","AddressLine","AddressLine","AddressLine","AddressLine"], "BuildingNumber":"BuildingNumber", "TownName":"TownName", "Country":"Country", "SubDepartment":"SubDepartment", "AddressType":{ }, "PostCode":"PostCode" } }, "ExpectedSettlementDateTime":"2000-01-23T04:56:07.000+00:00" } }
Validations:
  • Required JSON Validation: No
  • Allowed Authentication Types: Not set
Possible Errors:
  • OBP-20001: User not logged in. Authentication is required!
  • OBP-50000: Unknown Error.
Connector Methods:
Version: UKv3.1, function_name: by getDomesticPaymentConsentsConsentId, operation_id: UKv3.1-getDomesticPaymentConsentsConsentId Tags: Domestic Payments, Mocked-Data,

Get Domestic Payment Consents Funds Confirmation

NOTE: This endpoint currently only returns example data.

Authentication is Mandatory

URL Parameters:

JSON response body fields:

Typical Successful Response:

								
									
{ "Meta":{ "FirstAvailableDateTime":{ }, "TotalPages":0 }, "Links":{ "Last":"http://example.com/aeiou", "Prev":"http://example.com/aeiou", "Next":"http://example.com/aeiou", "Self":"http://example.com/aeiou", "First":"http://example.com/aeiou" }, "Data":{ "SupplementaryData":{ }, "FundsAvailableResult":{ "FundsAvailableDateTime":"2000-01-23T04:56:07.000+00:00", "FundsAvailable":true } } }
Validations:
  • Required JSON Validation: No
  • Allowed Authentication Types: Not set
Possible Errors:
  • OBP-20001: User not logged in. Authentication is required!
  • OBP-50000: Unknown Error.
Connector Methods:
Version: UKv3.1, function_name: by getDomesticPaymentConsentsConsentIdFundsConfirmation, operation_id: UKv3.1-getDomesticPaymentConsentsConsentIdFundsConfirmation Tags: Domestic Payments, Mocked-Data,

Get Domestic Payments

NOTE: This endpoint currently only returns example data.

Authentication is Mandatory

URL Parameters:

JSON response body fields:

Typical Successful Response:

								
									
{ "Meta":{ "FirstAvailableDateTime":{ }, "TotalPages":0 }, "Links":{ "Last":"http://example.com/aeiou", "Prev":"http://example.com/aeiou", "Next":"http://example.com/aeiou", "Self":"http://example.com/aeiou", "First":"http://example.com/aeiou" }, "Data":{ "DomesticPaymentId":"DomesticPaymentId", "Status":{ }, "StatusUpdateDateTime":"2000-01-23T04:56:07.000+00:00", "CreationDateTime":"2000-01-23T04:56:07.000+00:00", "ExpectedExecutionDateTime":"2000-01-23T04:56:07.000+00:00", "Charges":[{ "Type":["UK.OBIE.CHAPSOut","UK.OBIE.BalanceTransferOut","UK.OBIE.MoneyTransferOut"], "Amount":{ "Amount":{ }, "Currency":"Currency" }, "ChargeBearer":{ } },{ "Type":["UK.OBIE.CHAPSOut","UK.OBIE.BalanceTransferOut","UK.OBIE.MoneyTransferOut"], "Amount":{ "Amount":{ }, "Currency":"Currency" }, "ChargeBearer":{ } }], "ConsentId":"ConsentId", "Initiation":{ "SupplementaryData":{ }, "LocalInstrument":["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"], "DebtorAccount":{ "SecondaryIdentification":"SecondaryIdentification", "SchemeName":["UK.OBIE.BBAN","UK.OBIE.IBAN","UK.OBIE.PAN","UK.OBIE.Paym","UK.OBIE.SortCodeAccountNumber"], "Identification":"Identification", "Name":"Name" }, "RemittanceInformation":{ "Unstructured":"Unstructured", "Reference":"Reference" }, "EndToEndIdentification":"EndToEndIdentification", "InstructionIdentification":"InstructionIdentification", "CreditorAccount":{ "SecondaryIdentification":"SecondaryIdentification", "SchemeName":["UK.OBIE.BBAN","UK.OBIE.IBAN","UK.OBIE.PAN","UK.OBIE.Paym","UK.OBIE.SortCodeAccountNumber"], "Identification":"Identification", "Name":"Name" }, "InstructedAmount":{ "Currency":"Currency" }, "CreditorPostalAddress":{ "StreetName":"StreetName", "CountrySubDivision":"CountrySubDivision", "Department":"Department", "AddressLine":["AddressLine","AddressLine","AddressLine","AddressLine","AddressLine","AddressLine","AddressLine"], "BuildingNumber":"BuildingNumber", "TownName":"TownName", "Country":"Country", "SubDepartment":"SubDepartment", "AddressType":{ }, "PostCode":"PostCode" } }, "ExpectedSettlementDateTime":"2000-01-23T04:56:07.000+00:00", "MultiAuthorisation":{ "Status":{ }, "NumberReceived":6, "LastUpdateDateTime":"2000-01-23T04:56:07.000+00:00", "ExpirationDateTime":"2000-01-23T04:56:07.000+00:00", "NumberRequired":0 } } }
Validations:
  • Required JSON Validation: No
  • Allowed Authentication Types: Not set
Possible Errors:
  • OBP-20001: User not logged in. Authentication is required!
  • OBP-50000: Unknown Error.
Connector Methods:
Version: UKv3.1, function_name: by getDomesticPaymentsDomesticPaymentId, operation_id: UKv3.1-getDomesticPaymentsDomesticPaymentId Tags: Domestic Payments, Mocked-Data,