API Explorer

UK

UK v3.1 (67 APIs)

Bank

Accounts

Views

Counterparties

Transactions

Create Account Access Consents

NOTE: This endpoint currently only returns example data.

Typical Successful Response:

								
									
{ "Meta":{ "FirstAvailableDateTime":{ }, "TotalPages":0 }, "Risk":{ }, "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", "TransactionToDateTime":"2000-01-23T04:56:07.000+00:00", "ExpirationDateTime":"2000-01-23T04:56:07.000+00:00", "Permissions":[{ },{ }], "ConsentId":"ConsentId", "TransactionFromDateTime":"2000-01-23T04:56:07.000+00:00" } }
Headers:

								
									
Possible Errors:
  • OBP-20001: User not logged in. Authentication is required!
  • OBP-50000: Unknown Error.
Implemented in UKv3.1 by createAccountAccessConsents

Delete Account Access Consents

NOTE: This endpoint currently only returns example data.

Typical Successful Response:

								
									
{ }
Headers:

								
									
Possible Errors:
  • OBP-20001: User not logged in. Authentication is required!
  • OBP-50000: Unknown Error.
Implemented in UKv3.1 by deleteAccountAccessConsentsConsentId

Get Account Access Consents

NOTE: This endpoint currently only returns example data.

Typical Successful Response:

								
									
{ "Meta":{ "FirstAvailableDateTime":{ }, "TotalPages":0 }, "Risk":{ }, "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", "TransactionToDateTime":"2000-01-23T04:56:07.000+00:00", "ExpirationDateTime":"2000-01-23T04:56:07.000+00:00", "Permissions":[{ },{ }], "ConsentId":"ConsentId", "TransactionFromDateTime":"2000-01-23T04:56:07.000+00:00" } }
Headers:

								
									
Possible Errors:
  • OBP-20001: User not logged in. Authentication is required!
  • OBP-50000: Unknown Error.
Implemented in UKv3.1 by getAccountAccessConsentsConsentId

Get Accounts

Typical Successful Response:

								
									
{ "Meta":{ "FirstAvailableDateTime":"2019-03-05T13:09:30.399Z", "LastAvailableDateTime":"2019-03-05T13:09:30.399Z", "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":{ "Account":[{ "Account":[{ "SecondaryIdentification":"SecondaryIdentification", "SchemeName":["UK.OBIE.BBAN","UK.OBIE.IBAN","UK.OBIE.PAN","UK.OBIE.Paym","UK.OBIE.SortCodeAccountNumber"], "Identification":"Identification", "Name":"Name" },{ "SecondaryIdentification":"SecondaryIdentification", "SchemeName":["UK.OBIE.BBAN","UK.OBIE.IBAN","UK.OBIE.PAN","UK.OBIE.Paym","UK.OBIE.SortCodeAccountNumber"], "Identification":"Identification", "Name":"Name" }], "Servicer":{ "SchemeName":["UK.OBIE.BICFI"], "Identification":"Identification" }, "AccountId":"String", "Description":"Description", "Currency":"Currency", "AccountType":"String", "AccountSubType":"String", "Nickname":"Nickname" },{ "Account":[{ "SecondaryIdentification":"SecondaryIdentification", "SchemeName":["UK.OBIE.BBAN","UK.OBIE.IBAN","UK.OBIE.PAN","UK.OBIE.Paym","UK.OBIE.SortCodeAccountNumber"], "Identification":"Identification", "Name":"Name" },{ "SecondaryIdentification":"SecondaryIdentification", "SchemeName":["UK.OBIE.BBAN","UK.OBIE.IBAN","UK.OBIE.PAN","UK.OBIE.Paym","UK.OBIE.SortCodeAccountNumber"], "Identification":"Identification", "Name":"Name" }], "Servicer":{ "SchemeName":["UK.OBIE.BICFI"], "Identification":"Identification" }, "AccountId":"String", "Description":"Description", "Currency":"Currency", "AccountType":"String", "AccountSubType":"String", "Nickname":"Nickname" }] } }
Headers:

								
									
Possible Errors:
  • OBP-20001: User not logged in. Authentication is required!
  • OBP-50000: Unknown Error.
Implemented in UKv3.1 by getAccountsAccountId

Get Accounts

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":{ "Account":[{ "Account":[{ "SecondaryIdentification":"SecondaryIdentification", "SchemeName":["UK.OBIE.BBAN","UK.OBIE.IBAN","UK.OBIE.PAN","UK.OBIE.Paym","UK.OBIE.SortCodeAccountNumber"], "Identification":"Identification", "Name":"Name" },{ "SecondaryIdentification":"SecondaryIdentification", "SchemeName":["UK.OBIE.BBAN","UK.OBIE.IBAN","UK.OBIE.PAN","UK.OBIE.Paym","UK.OBIE.SortCodeAccountNumber"], "Identification":"Identification", "Name":"Name" }], "Servicer":{ "SchemeName":["UK.OBIE.BICFI"], "Identification":"Identification" }, "AccountId":"String", "Description":"Description", "Currency":"Currency", "AccountType":"String", "AccountSubType":"String", "Nickname":"Nickname" },{ "Account":[{ "SecondaryIdentification":"SecondaryIdentification", "SchemeName":["UK.OBIE.BBAN","UK.OBIE.IBAN","UK.OBIE.PAN","UK.OBIE.Paym","UK.OBIE.SortCodeAccountNumber"], "Identification":"Identification", "Name":"Name" },{ "SecondaryIdentification":"SecondaryIdentification", "SchemeName":["UK.OBIE.BBAN","UK.OBIE.IBAN","UK.OBIE.PAN","UK.OBIE.Paym","UK.OBIE.SortCodeAccountNumber"], "Identification":"Identification", "Name":"Name" }], "Servicer":{ "SchemeName":["UK.OBIE.BICFI"], "Identification":"Identification" }, "AccountId":"String", "Description":"Description", "Currency":"Currency", "AccountType":"String", "AccountSubType":"String", "Nickname":"Nickname" }] } }
Headers:

								
									
Possible Errors:
  • OBP-20001: User not logged in. Authentication is required!
  • OBP-50000: Unknown Error.
Implemented in UKv3.1 by getAccounts

Get Balances

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":{ "Balance":[{ "Type":{ }, "AccountId":{ }, "CreditLine":[{ "Type":{ }, "Included":true, "Amount":{ "Amount":{ }, "Currency":"Currency" } },{ "Type":{ }, "Included":true, "Amount":{ "Amount":{ }, "Currency":"Currency" } }], "Amount":{ "Amount":{ }, "Currency":"Currency" }, "CreditDebitIndicator":"Credit", "DateTime":"2000-01-23T04:56:07.000+00:00" },{ "Type":{ }, "AccountId":{ }, "CreditLine":[{ "Type":{ }, "Included":true, "Amount":{ "Amount":{ }, "Currency":"Currency" } },{ "Type":{ }, "Included":true, "Amount":{ "Amount":{ }, "Currency":"Currency" } }], "Amount":{ "Amount":{ }, "Currency":"Currency" }, "CreditDebitIndicator":"Credit", "DateTime":"2000-01-23T04:56:07.000+00:00" }] } }
Headers:

								
									
Possible Errors:
  • OBP-20001: User not logged in. Authentication is required!
  • OBP-50000: Unknown Error.
Implemented in UKv3.1 by getAccountsAccountIdBalances

Get Balances

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":{ "Balance":[{ "Type":{ }, "AccountId":{ }, "CreditLine":[{ "Type":{ }, "Included":true, "Amount":{ "Amount":{ }, "Currency":"Currency" } },{ "Type":{ }, "Included":true, "Amount":{ "Amount":{ }, "Currency":"Currency" } }], "Amount":{ "Amount":{ }, "Currency":"Currency" }, "CreditDebitIndicator":"Credit", "DateTime":"2000-01-23T04:56:07.000+00:00" },{ "Type":{ }, "AccountId":{ }, "CreditLine":[{ "Type":{ }, "Included":true, "Amount":{ "Amount":{ }, "Currency":"Currency" } },{ "Type":{ }, "Included":true, "Amount":{ "Amount":{ }, "Currency":"Currency" } }], "Amount":{ "Amount":{ }, "Currency":"Currency" }, "CreditDebitIndicator":"Credit", "DateTime":"2000-01-23T04:56:07.000+00:00" }] } }
Headers:

								
									
Possible Errors:
  • OBP-20001: User not logged in. Authentication is required!
  • OBP-50000: Unknown Error.
Implemented in UKv3.1 by getBalances

Get Beneficiaries

NOTE: This endpoint currently only returns example data.

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":{ "Beneficiary":[{ "CreditorAgent":{ "PostalAddress":{ "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" }, "SchemeName":["UK.OBIE.BICFI"], "Identification":"Identification", "Name":"Name" }, "AccountId":{ }, "Reference":"Reference", "CreditorAccount":{ "SecondaryIdentification":"SecondaryIdentification", "SchemeName":["UK.OBIE.BBAN","UK.OBIE.IBAN","UK.OBIE.PAN","UK.OBIE.Paym","UK.OBIE.SortCodeAccountNumber"], "Identification":"Identification", "Name":"Name" }, "BeneficiaryId":"BeneficiaryId" },{ "CreditorAgent":{ "PostalAddress":{ "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" }, "SchemeName":["UK.OBIE.BICFI"], "Identification":"Identification", "Name":"Name" }, "AccountId":{ }, "Reference":"Reference", "CreditorAccount":{ "SecondaryIdentification":"SecondaryIdentification", "SchemeName":["UK.OBIE.BBAN","UK.OBIE.IBAN","UK.OBIE.PAN","UK.OBIE.Paym","UK.OBIE.SortCodeAccountNumber"], "Identification":"Identification", "Name":"Name" }, "BeneficiaryId":"BeneficiaryId" }] } }
Headers:

								
									
Possible Errors:
  • OBP-20001: User not logged in. Authentication is required!
  • OBP-50000: Unknown Error.
Implemented in UKv3.1 by getAccountsAccountIdBeneficiaries

Get Beneficiaries

NOTE: This endpoint currently only returns example data.

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":{ "Beneficiary":[{ "CreditorAgent":{ "PostalAddress":{ "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" }, "SchemeName":["UK.OBIE.BICFI"], "Identification":"Identification", "Name":"Name" }, "AccountId":{ }, "Reference":"Reference", "CreditorAccount":{ "SecondaryIdentification":"SecondaryIdentification", "SchemeName":["UK.OBIE.BBAN","UK.OBIE.IBAN","UK.OBIE.PAN","UK.OBIE.Paym","UK.OBIE.SortCodeAccountNumber"], "Identification":"Identification", "Name":"Name" }, "BeneficiaryId":"BeneficiaryId" },{ "CreditorAgent":{ "PostalAddress":{ "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" }, "SchemeName":["UK.OBIE.BICFI"], "Identification":"Identification", "Name":"Name" }, "AccountId":{ }, "Reference":"Reference", "CreditorAccount":{ "SecondaryIdentification":"SecondaryIdentification", "SchemeName":["UK.OBIE.BBAN","UK.OBIE.IBAN","UK.OBIE.PAN","UK.OBIE.Paym","UK.OBIE.SortCodeAccountNumber"], "Identification":"Identification", "Name":"Name" }, "BeneficiaryId":"BeneficiaryId" }] } }
Headers:

								
									
Possible Errors:
  • OBP-20001: User not logged in. Authentication is required!
  • OBP-50000: Unknown Error.
Implemented in UKv3.1 by getBeneficiaries

Get Direct Debits

NOTE: This endpoint currently only returns example data.

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":{ "DirectDebit":[{ "PreviousPaymentDateTime":"2000-01-23T04:56:07.000+00:00", "AccountId":{ }, "MandateIdentification":"MandateIdentification", "DirectDebitStatusCode":{ }, "DirectDebitId":"DirectDebitId", "PreviousPaymentAmount":{ "Amount":{ }, "Currency":"Currency" }, "Name":"Name" },{ "PreviousPaymentDateTime":"2000-01-23T04:56:07.000+00:00", "AccountId":{ }, "MandateIdentification":"MandateIdentification", "DirectDebitStatusCode":{ }, "DirectDebitId":"DirectDebitId", "PreviousPaymentAmount":{ "Amount":{ }, "Currency":"Currency" }, "Name":"Name" }] } }
Headers:

								
									
Possible Errors:
  • OBP-20001: User not logged in. Authentication is required!
  • OBP-50000: Unknown Error.
Implemented in UKv3.1 by getDirectDebits

Get Direct Debits

NOTE: This endpoint currently only returns example data.

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":{ "DirectDebit":[{ "PreviousPaymentDateTime":"2000-01-23T04:56:07.000+00:00", "AccountId":{ }, "MandateIdentification":"MandateIdentification", "DirectDebitStatusCode":{ }, "DirectDebitId":"DirectDebitId", "PreviousPaymentAmount":{ "Amount":{ }, "Currency":"Currency" }, "Name":"Name" },{ "PreviousPaymentDateTime":"2000-01-23T04:56:07.000+00:00", "AccountId":{ }, "MandateIdentification":"MandateIdentification", "DirectDebitStatusCode":{ }, "DirectDebitId":"DirectDebitId", "PreviousPaymentAmount":{ "Amount":{ }, "Currency":"Currency" }, "Name":"Name" }] } }
Headers:

								
									
Possible Errors:
  • OBP-20001: User not logged in. Authentication is required!
  • OBP-50000: Unknown Error.
Implemented in UKv3.1 by getAccountsAccountIdDirectDebits

Create Domestic Payment Consents

NOTE: This endpoint currently only returns example data.

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" } }
Headers:

								
									
Possible Errors:
  • OBP-20001: User not logged in. Authentication is required!
  • OBP-50000: Unknown Error.
Implemented in UKv3.1 by createDomesticPaymentConsents

Create Domestic Payments

NOTE: This endpoint currently only returns example data.

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 } } }
Headers:

								
									
Possible Errors:
  • OBP-20001: User not logged in. Authentication is required!
  • OBP-50000: Unknown Error.
Implemented in UKv3.1 by createDomesticPayments

Get Domestic Payment Consents

NOTE: This endpoint currently only returns example data.

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" } }
Headers:

								
									
Possible Errors:
  • OBP-20001: User not logged in. Authentication is required!
  • OBP-50000: Unknown Error.
Implemented in UKv3.1 by getDomesticPaymentConsentsConsentId

Get Domestic Payment Consents Funds Confirmation

NOTE: This endpoint currently only returns example data.

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 } } }
Headers:

								
									
Possible Errors:
  • OBP-20001: User not logged in. Authentication is required!
  • OBP-50000: Unknown Error.
Implemented in UKv3.1 by getDomesticPaymentConsentsConsentIdFundsConfirmation

Get Domestic Payments

NOTE: This endpoint currently only returns example data.

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 } } }
Headers:

								
									
Possible Errors:
  • OBP-20001: User not logged in. Authentication is required!
  • OBP-50000: Unknown Error.
Implemented in UKv3.1 by getDomesticPaymentsDomesticPaymentId

Create Domestic Scheduled Payment Consents

NOTE: This endpoint currently only returns example data.

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":{ } }, "Permission":{ }, "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" }, "RequestedExecutionDateTime":"2000-01-23T04:56:07.000+00:00", "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" } }
Headers:

								
									
Possible Errors:
  • OBP-20001: User not logged in. Authentication is required!
  • OBP-50000: Unknown Error.
Implemented in UKv3.1 by createDomesticScheduledPaymentConsents

Create Domestic Scheduled Payments

NOTE: This endpoint currently only returns example data.

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":{ "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", "DomesticScheduledPaymentId":"DomesticScheduledPaymentId", "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" }, "RequestedExecutionDateTime":"2000-01-23T04:56:07.000+00:00", "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 } } }
Headers:

								
									
Possible Errors:
  • OBP-20001: User not logged in. Authentication is required!
  • OBP-50000: Unknown Error.
Implemented in UKv3.1 by createDomesticScheduledPayments

Get Domestic Scheduled Payment Consents

NOTE: This endpoint currently only returns example data.

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":{ } }, "Permission":{ }, "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" }, "RequestedExecutionDateTime":"2000-01-23T04:56:07.000+00:00", "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" } }
Headers:

								
									
Possible Errors:
  • OBP-20001: User not logged in. Authentication is required!
  • OBP-50000: Unknown Error.
Implemented in UKv3.1 by getDomesticScheduledPaymentConsentsConsentId

Get Domestic Scheduled Payments

NOTE: This endpoint currently only returns example data.

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":{ "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", "DomesticScheduledPaymentId":"DomesticScheduledPaymentId", "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" }, "RequestedExecutionDateTime":"2000-01-23T04:56:07.000+00:00", "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 } } }
Headers:

								
									
Possible Errors:
  • OBP-20001: User not logged in. Authentication is required!
  • OBP-50000: Unknown Error.
Implemented in UKv3.1 by getDomesticScheduledPaymentsDomesticScheduledPaymentId

Create Domestic Standing Order Consents

NOTE: This endpoint currently only returns example data.

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", "CutOffDateTime":"2000-01-23T04:56:07.000+00:00", "Authorisation":{ "CompletionDateTime":"2000-01-23T04:56:07.000+00:00", "AuthorisationType":{ } }, "Permission":{ }, "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":{ }, "DebtorAccount":{ "SecondaryIdentification":"SecondaryIdentification", "SchemeName":["UK.OBIE.BBAN","UK.OBIE.IBAN","UK.OBIE.PAN","UK.OBIE.Paym","UK.OBIE.SortCodeAccountNumber"], "Identification":"Identification", "Name":"Name" }, "Reference":"Reference", "RecurringPaymentDateTime":"2000-01-23T04:56:07.000+00:00", "RecurringPaymentAmount":{ "Currency":"Currency" }, "CreditorAccount":{ "SecondaryIdentification":"SecondaryIdentification", "SchemeName":["UK.OBIE.BBAN","UK.OBIE.IBAN","UK.OBIE.PAN","UK.OBIE.Paym","UK.OBIE.SortCodeAccountNumber"], "Identification":"Identification", "Name":"Name" }, "Frequency":"Frequency", "FirstPaymentAmount":{ "Amount":{ }, "Currency":"Currency" }, "FirstPaymentDateTime":"2000-01-23T04:56:07.000+00:00", "FinalPaymentAmount":{ "Currency":"Currency" }, "NumberOfPayments":"NumberOfPayments", "FinalPaymentDateTime":"2000-01-23T04:56:07.000+00:00" } } }
Headers:

								
									
Possible Errors:
  • OBP-20001: User not logged in. Authentication is required!
  • OBP-50000: Unknown Error.
Implemented in UKv3.1 by createDomesticStandingOrderConsents

Create Domestic Standing Orders

NOTE: This endpoint currently only returns example data.

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":{ "Status":{ }, "StatusUpdateDateTime":"2000-01-23T04:56:07.000+00:00", "CreationDateTime":"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":{ } }], "DomesticStandingOrderId":"DomesticStandingOrderId", "ConsentId":"ConsentId", "Initiation":{ "SupplementaryData":{ }, "DebtorAccount":{ "SecondaryIdentification":"SecondaryIdentification", "SchemeName":["UK.OBIE.BBAN","UK.OBIE.IBAN","UK.OBIE.PAN","UK.OBIE.Paym","UK.OBIE.SortCodeAccountNumber"], "Identification":"Identification", "Name":"Name" }, "Reference":"Reference", "RecurringPaymentDateTime":"2000-01-23T04:56:07.000+00:00", "RecurringPaymentAmount":{ "Currency":"Currency" }, "CreditorAccount":{ "SecondaryIdentification":"SecondaryIdentification", "SchemeName":["UK.OBIE.BBAN","UK.OBIE.IBAN","UK.OBIE.PAN","UK.OBIE.Paym","UK.OBIE.SortCodeAccountNumber"], "Identification":"Identification", "Name":"Name" }, "Frequency":"Frequency", "FirstPaymentAmount":{ "Amount":{ }, "Currency":"Currency" }, "FirstPaymentDateTime":"2000-01-23T04:56:07.000+00:00", "FinalPaymentAmount":{ "Currency":"Currency" }, "NumberOfPayments":"NumberOfPayments", "FinalPaymentDateTime":"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 } } }
Headers:

								
									
Possible Errors:
  • OBP-20001: User not logged in. Authentication is required!
  • OBP-50000: Unknown Error.
Implemented in UKv3.1 by createDomesticStandingOrders

Get Domestic Standing Order Consents

NOTE: This endpoint currently only returns example data.

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", "CutOffDateTime":"2000-01-23T04:56:07.000+00:00", "Authorisation":{ "CompletionDateTime":"2000-01-23T04:56:07.000+00:00", "AuthorisationType":{ } }, "Permission":{ }, "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":{ }, "DebtorAccount":{ "SecondaryIdentification":"SecondaryIdentification", "SchemeName":["UK.OBIE.BBAN","UK.OBIE.IBAN","UK.OBIE.PAN","UK.OBIE.Paym","UK.OBIE.SortCodeAccountNumber"], "Identification":"Identification", "Name":"Name" }, "Reference":"Reference", "RecurringPaymentDateTime":"2000-01-23T04:56:07.000+00:00", "RecurringPaymentAmount":{ "Currency":"Currency" }, "CreditorAccount":{ "SecondaryIdentification":"SecondaryIdentification", "SchemeName":["UK.OBIE.BBAN","UK.OBIE.IBAN","UK.OBIE.PAN","UK.OBIE.Paym","UK.OBIE.SortCodeAccountNumber"], "Identification":"Identification", "Name":"Name" }, "Frequency":"Frequency", "FirstPaymentAmount":{ "Amount":{ }, "Currency":"Currency" }, "FirstPaymentDateTime":"2000-01-23T04:56:07.000+00:00", "FinalPaymentAmount":{ "Currency":"Currency" }, "NumberOfPayments":"NumberOfPayments", "FinalPaymentDateTime":"2000-01-23T04:56:07.000+00:00" } } }
Headers:

								
									
Possible Errors:
  • OBP-20001: User not logged in. Authentication is required!
  • OBP-50000: Unknown Error.
Implemented in UKv3.1 by getDomesticStandingOrderConsentsConsentId

Get Domestic Standing Orders

NOTE: This endpoint currently only returns example data.

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":{ "Status":{ }, "StatusUpdateDateTime":"2000-01-23T04:56:07.000+00:00", "CreationDateTime":"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":{ } }], "DomesticStandingOrderId":"DomesticStandingOrderId", "ConsentId":"ConsentId", "Initiation":{ "SupplementaryData":{ }, "DebtorAccount":{ "SecondaryIdentification":"SecondaryIdentification", "SchemeName":["UK.OBIE.BBAN","UK.OBIE.IBAN","UK.OBIE.PAN","UK.OBIE.Paym","UK.OBIE.SortCodeAccountNumber"], "Identification":"Identification", "Name":"Name" }, "Reference":"Reference", "RecurringPaymentDateTime":"2000-01-23T04:56:07.000+00:00", "RecurringPaymentAmount":{ "Currency":"Currency" }, "CreditorAccount":{ "SecondaryIdentification":"SecondaryIdentification", "SchemeName":["UK.OBIE.BBAN","UK.OBIE.IBAN","UK.OBIE.PAN","UK.OBIE.Paym","UK.OBIE.SortCodeAccountNumber"], "Identification":"Identification", "Name":"Name" }, "Frequency":"Frequency", "FirstPaymentAmount":{ "Amount":{ }, "Currency":"Currency" }, "FirstPaymentDateTime":"2000-01-23T04:56:07.000+00:00", "FinalPaymentAmount":{ "Currency":"Currency" }, "NumberOfPayments":"NumberOfPayments", "FinalPaymentDateTime":"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 } } }
Headers:

								
									
Possible Errors:
  • OBP-20001: User not logged in. Authentication is required!
  • OBP-50000: Unknown Error.
Implemented in UKv3.1 by getDomesticStandingOrdersDomesticStandingOrderId

Create File Payment Consents

NOTE: This endpoint currently only returns example data.

Typical Successful Response:

								
									
{ }
Headers:

								
									
Possible Errors:
  • OBP-20001: User not logged in. Authentication is required!
  • OBP-50000: Unknown Error.
Implemented in UKv3.1 by createFilePaymentConsentsConsentIdFile

Create File Payment Consents

NOTE: This endpoint currently only returns example data.

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":{ "Status":{ }, "StatusUpdateDateTime":"2000-01-23T04:56:07.000+00:00", "CreationDateTime":"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":{ }, "ControlSum":0.8008281904610115, "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" }, "FileType":["UK.OBIE.PaymentInitiation.3.1","UK.OBIE.pain.001.001.08"], "FileHash":"FileHash", "NumberOfTransactions":"NumberOfTransactions", "FileReference":"FileReference", "RequestedExecutionDateTime":"2000-01-23T04:56:07.000+00:00" } } }
Headers:

								
									
Possible Errors:
  • OBP-20001: User not logged in. Authentication is required!
  • OBP-50000: Unknown Error.
Implemented in UKv3.1 by createFilePaymentConsents

Create File Payments

NOTE: This endpoint currently only returns example data.

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":{ "Status":{ }, "StatusUpdateDateTime":"2000-01-23T04:56:07.000+00:00", "CreationDateTime":"2000-01-23T04:56:07.000+00:00", "FilePaymentId":"FilePaymentId", "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":{ }, "ControlSum":0.8008281904610115, "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" }, "FileType":["UK.OBIE.PaymentInitiation.3.1","UK.OBIE.pain.001.001.08"], "FileHash":"FileHash", "NumberOfTransactions":"NumberOfTransactions", "FileReference":"FileReference", "RequestedExecutionDateTime":"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 } } }
Headers:

								
									
Possible Errors:
  • OBP-20001: User not logged in. Authentication is required!
  • OBP-50000: Unknown Error.
Implemented in UKv3.1 by createFilePayments

Get File Payment Consents

NOTE: This endpoint currently only returns example data.

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":{ "Status":{ }, "StatusUpdateDateTime":"2000-01-23T04:56:07.000+00:00", "CreationDateTime":"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":{ }, "ControlSum":0.8008281904610115, "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" }, "FileType":["UK.OBIE.PaymentInitiation.3.1","UK.OBIE.pain.001.001.08"], "FileHash":"FileHash", "NumberOfTransactions":"NumberOfTransactions", "FileReference":"FileReference", "RequestedExecutionDateTime":"2000-01-23T04:56:07.000+00:00" } } }
Headers:

								
									
Possible Errors:
  • OBP-20001: User not logged in. Authentication is required!
  • OBP-50000: Unknown Error.
Implemented in UKv3.1 by getFilePaymentConsentsConsentId

Get File Payment Consents

NOTE: This endpoint currently only returns example data.

Typical Successful Response:

								
									
{ }
Headers:

								
									
Possible Errors:
  • OBP-20001: User not logged in. Authentication is required!
  • OBP-50000: Unknown Error.
Implemented in UKv3.1 by getFilePaymentConsentsConsentIdFile

Get File Payments

NOTE: This endpoint currently only returns example data.

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":{ "Status":{ }, "StatusUpdateDateTime":"2000-01-23T04:56:07.000+00:00", "CreationDateTime":"2000-01-23T04:56:07.000+00:00", "FilePaymentId":"FilePaymentId", "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":{ }, "ControlSum":0.8008281904610115, "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" }, "FileType":["UK.OBIE.PaymentInitiation.3.1","UK.OBIE.pain.001.001.08"], "FileHash":"FileHash", "NumberOfTransactions":"NumberOfTransactions", "FileReference":"FileReference", "RequestedExecutionDateTime":"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 } } }
Headers:

								
									
Possible Errors:
  • OBP-20001: User not logged in. Authentication is required!
  • OBP-50000: Unknown Error.
Implemented in UKv3.1 by getFilePaymentsFilePaymentId

Get File Payments

NOTE: This endpoint currently only returns example data.

Typical Successful Response:

								
									
{ }
Headers:

								
									
Possible Errors:
  • OBP-20001: User not logged in. Authentication is required!
  • OBP-50000: Unknown Error.
Implemented in UKv3.1 by getFilePaymentsFilePaymentIdReportFile

Create Funds Confirmation

NOTE: This endpoint currently only returns example data.

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":{ "FundsConfirmationId":"FundsConfirmationId", "CreationDateTime":"2000-01-23T04:56:07.000+00:00", "Reference":"Reference", "FundsAvailable":true, "ConsentId":"ConsentId", "InstructedAmount":{ "Amount":{ }, "Currency":"Currency" } } }
Headers:

								
									
Possible Errors:
  • OBP-20001: User not logged in. Authentication is required!
  • OBP-50000: Unknown Error.
Implemented in UKv3.1 by createFundsConfirmations

Create Funds Confirmation Consent

NOTE: This endpoint currently only returns example data.

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":{ "Status":{ }, "StatusUpdateDateTime":"2000-01-23T04:56:07.000+00:00", "DebtorAccount":{ "SecondaryIdentification":"SecondaryIdentification", "SchemeName":["UK.OBIE.BBAN","UK.OBIE.IBAN","UK.OBIE.PAN","UK.OBIE.Paym","UK.OBIE.SortCodeAccountNumber"], "Identification":"Identification", "Name":"Name" }, "CreationDateTime":"2000-01-23T04:56:07.000+00:00", "ExpirationDateTime":"2000-01-23T04:56:07.000+00:00", "ConsentId":"ConsentId" } }
Headers:

								
									
Possible Errors:
  • OBP-20001: User not logged in. Authentication is required!
  • OBP-50000: Unknown Error.
Implemented in UKv3.1 by createFundsConfirmationConsents

Delete Funds Confirmation Consent

NOTE: This endpoint currently only returns example data.

Typical Successful Response:

								
									
{ }
Headers:

								
									
Possible Errors:
  • OBP-20001: User not logged in. Authentication is required!
  • OBP-50000: Unknown Error.
Implemented in UKv3.1 by deleteFundsConfirmationConsentsConsentId

Get Funds Confirmation Consent

NOTE: This endpoint currently only returns example data.

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":{ "Status":{ }, "StatusUpdateDateTime":"2000-01-23T04:56:07.000+00:00", "DebtorAccount":{ "SecondaryIdentification":"SecondaryIdentification", "SchemeName":["UK.OBIE.BBAN","UK.OBIE.IBAN","UK.OBIE.PAN","UK.OBIE.Paym","UK.OBIE.SortCodeAccountNumber"], "Identification":"Identification", "Name":"Name" }, "CreationDateTime":"2000-01-23T04:56:07.000+00:00", "ExpirationDateTime":"2000-01-23T04:56:07.000+00:00", "ConsentId":"ConsentId" } }
Headers:

								
									
Possible Errors:
  • OBP-20001: User not logged in. Authentication is required!
  • OBP-50000: Unknown Error.
Implemented in UKv3.1 by getFundsConfirmationConsentsConsentId

Create International Payment Consents

NOTE: This endpoint currently only returns example data.

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", "ExchangeRateInformation":{ "ExchangeRate":0.8008281904610115, "ExpirationDateTime":"2000-01-23T04:56:07.000+00:00", "RateType":{ }, "UnitCurrency":"UnitCurrency", "ContractIdentification":"ContractIdentification" }, "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":{ }, "DebtorAccount":{ "SecondaryIdentification":"SecondaryIdentification", "SchemeName":["UK.OBIE.BBAN","UK.OBIE.IBAN","UK.OBIE.PAN","UK.OBIE.Paym","UK.OBIE.SortCodeAccountNumber"], "Identification":"Identification", "Name":"Name" }, "CreditorAgent":{ "PostalAddress":{ "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" }, "SchemeName":["UK.OBIE.BICFI"], "Identification":"Identification", "Name":"Name" }, "EndToEndIdentification":"EndToEndIdentification", "InstructionIdentification":"InstructionIdentification", "CurrencyOfTransfer":"CurrencyOfTransfer", "CreditorAccount":{ "SecondaryIdentification":"SecondaryIdentification", "SchemeName":["UK.OBIE.BBAN","UK.OBIE.IBAN","UK.OBIE.PAN","UK.OBIE.Paym","UK.OBIE.SortCodeAccountNumber"], "Identification":"Identification", "Name":"Name" }, "Purpose":{ }, "ChargeBearer":{ }, "InstructionPriority":{ }, "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"], "RemittanceInformation":{ "Unstructured":"Unstructured", "Reference":"Reference" }, "ExchangeRateInformation":{ "ExchangeRate":6.027456183070403, "UnitCurrency":"UnitCurrency", "ContractIdentification":"ContractIdentification" }, "Creditor":{ "PostalAddress":{ "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" }, "Name":"Name" }, "InstructedAmount":{ "Currency":"Currency" } }, "ExpectedSettlementDateTime":"2000-01-23T04:56:07.000+00:00" } }
Headers:

								
									
Possible Errors:
  • OBP-20001: User not logged in. Authentication is required!
  • OBP-50000: Unknown Error.
Implemented in UKv3.1 by createInternationalPaymentConsents

Create International Payments

NOTE: This endpoint currently only returns example data.

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":{ "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", "ExchangeRateInformation":{ "ExchangeRate":0.8008281904610115, "ExpirationDateTime":"2000-01-23T04:56:07.000+00:00", "RateType":{ }, "UnitCurrency":"UnitCurrency", "ContractIdentification":"ContractIdentification" }, "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":{ } }], "InternationalPaymentId":"InternationalPaymentId", "ConsentId":"ConsentId", "Initiation":{ "SupplementaryData":{ }, "DebtorAccount":{ "SecondaryIdentification":"SecondaryIdentification", "SchemeName":["UK.OBIE.BBAN","UK.OBIE.IBAN","UK.OBIE.PAN","UK.OBIE.Paym","UK.OBIE.SortCodeAccountNumber"], "Identification":"Identification", "Name":"Name" }, "CreditorAgent":{ "PostalAddress":{ "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" }, "SchemeName":["UK.OBIE.BICFI"], "Identification":"Identification", "Name":"Name" }, "EndToEndIdentification":"EndToEndIdentification", "InstructionIdentification":"InstructionIdentification", "CurrencyOfTransfer":"CurrencyOfTransfer", "CreditorAccount":{ "SecondaryIdentification":"SecondaryIdentification", "SchemeName":["UK.OBIE.BBAN","UK.OBIE.IBAN","UK.OBIE.PAN","UK.OBIE.Paym","UK.OBIE.SortCodeAccountNumber"], "Identification":"Identification", "Name":"Name" }, "Purpose":{ }, "ChargeBearer":{ }, "InstructionPriority":{ }, "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"], "RemittanceInformation":{ "Unstructured":"Unstructured", "Reference":"Reference" }, "ExchangeRateInformation":{ "ExchangeRate":6.027456183070403, "UnitCurrency":"UnitCurrency", "ContractIdentification":"ContractIdentification" }, "Creditor":{ "PostalAddress":{ "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" }, "Name":"Name" }, "InstructedAmount":{ "Currency":"Currency" } }, "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 } } }
Headers:

								
									
Possible Errors:
  • OBP-20001: User not logged in. Authentication is required!
  • OBP-50000: Unknown Error.
Implemented in UKv3.1 by createInternationalPayments

Get International Payment Consents

NOTE: This endpoint currently only returns example data.

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", "ExchangeRateInformation":{ "ExchangeRate":0.8008281904610115, "ExpirationDateTime":"2000-01-23T04:56:07.000+00:00", "RateType":{ }, "UnitCurrency":"UnitCurrency", "ContractIdentification":"ContractIdentification" }, "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":{ }, "DebtorAccount":{ "SecondaryIdentification":"SecondaryIdentification", "SchemeName":["UK.OBIE.BBAN","UK.OBIE.IBAN","UK.OBIE.PAN","UK.OBIE.Paym","UK.OBIE.SortCodeAccountNumber"], "Identification":"Identification", "Name":"Name" }, "CreditorAgent":{ "PostalAddress":{ "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" }, "SchemeName":["UK.OBIE.BICFI"], "Identification":"Identification", "Name":"Name" }, "EndToEndIdentification":"EndToEndIdentification", "InstructionIdentification":"InstructionIdentification", "CurrencyOfTransfer":"CurrencyOfTransfer", "CreditorAccount":{ "SecondaryIdentification":"SecondaryIdentification", "SchemeName":["UK.OBIE.BBAN","UK.OBIE.IBAN","UK.OBIE.PAN","UK.OBIE.Paym","UK.OBIE.SortCodeAccountNumber"], "Identification":"Identification", "Name":"Name" }, "Purpose":{ }, "ChargeBearer":{ }, "InstructionPriority":{ }, "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"], "RemittanceInformation":{ "Unstructured":"Unstructured", "Reference":"Reference" }, "ExchangeRateInformation":{ "ExchangeRate":6.027456183070403, "UnitCurrency":"UnitCurrency", "ContractIdentification":"ContractIdentification" }, "Creditor":{ "PostalAddress":{ "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" }, "Name":"Name" }, "InstructedAmount":{ "Currency":"Currency" } }, "ExpectedSettlementDateTime":"2000-01-23T04:56:07.000+00:00" } }
Headers:

								
									
Possible Errors:
  • OBP-20001: User not logged in. Authentication is required!
  • OBP-50000: Unknown Error.
Implemented in UKv3.1 by getInternationalPaymentConsentsConsentId

Get International Payment Consents Funds Confirmation

NOTE: This endpoint currently only returns example data.

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 } } }
Headers:

								
									
Possible Errors:
  • OBP-20001: User not logged in. Authentication is required!
  • OBP-50000: Unknown Error.
Implemented in UKv3.1 by getInternationalPaymentConsentsConsentIdFundsConfirmation

Get International Payments

NOTE: This endpoint currently only returns example data.

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":{ "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", "ExchangeRateInformation":{ "ExchangeRate":0.8008281904610115, "ExpirationDateTime":"2000-01-23T04:56:07.000+00:00", "RateType":{ }, "UnitCurrency":"UnitCurrency", "ContractIdentification":"ContractIdentification" }, "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":{ } }], "InternationalPaymentId":"InternationalPaymentId", "ConsentId":"ConsentId", "Initiation":{ "SupplementaryData":{ }, "DebtorAccount":{ "SecondaryIdentification":"SecondaryIdentification", "SchemeName":["UK.OBIE.BBAN","UK.OBIE.IBAN","UK.OBIE.PAN","UK.OBIE.Paym","UK.OBIE.SortCodeAccountNumber"], "Identification":"Identification", "Name":"Name" }, "CreditorAgent":{ "PostalAddress":{ "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" }, "SchemeName":["UK.OBIE.BICFI"], "Identification":"Identification", "Name":"Name" }, "EndToEndIdentification":"EndToEndIdentification", "InstructionIdentification":"InstructionIdentification", "CurrencyOfTransfer":"CurrencyOfTransfer", "CreditorAccount":{ "SecondaryIdentification":"SecondaryIdentification", "SchemeName":["UK.OBIE.BBAN","UK.OBIE.IBAN","UK.OBIE.PAN","UK.OBIE.Paym","UK.OBIE.SortCodeAccountNumber"], "Identification":"Identification", "Name":"Name" }, "Purpose":{ }, "ChargeBearer":{ }, "InstructionPriority":{ }, "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"], "RemittanceInformation":{ "Unstructured":"Unstructured", "Reference":"Reference" }, "ExchangeRateInformation":{ "ExchangeRate":6.027456183070403, "UnitCurrency":"UnitCurrency", "ContractIdentification":"ContractIdentification" }, "Creditor":{ "PostalAddress":{ "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" }, "Name":"Name" }, "InstructedAmount":{ "Currency":"Currency" } }, "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 } } }
Headers:

								
									
Possible Errors:
  • OBP-20001: User not logged in. Authentication is required!
  • OBP-50000: Unknown Error.
Implemented in UKv3.1 by getInternationalPaymentsInternationalPaymentId

Create International Scheduled Payment Consents

NOTE: This endpoint currently only returns example data.

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", "ExchangeRateInformation":{ "ExchangeRate":0.8008281904610115, "ExpirationDateTime":"2000-01-23T04:56:07.000+00:00", "RateType":{ }, "UnitCurrency":"UnitCurrency", "ContractIdentification":"ContractIdentification" }, "Authorisation":{ "CompletionDateTime":"2000-01-23T04:56:07.000+00:00", "AuthorisationType":{ } }, "Permission":{ }, "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":{ }, "DebtorAccount":{ "SecondaryIdentification":"SecondaryIdentification", "SchemeName":["UK.OBIE.BBAN","UK.OBIE.IBAN","UK.OBIE.PAN","UK.OBIE.Paym","UK.OBIE.SortCodeAccountNumber"], "Identification":"Identification", "Name":"Name" }, "CreditorAgent":{ "PostalAddress":{ "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" }, "SchemeName":["UK.OBIE.BICFI"], "Identification":"Identification", "Name":"Name" }, "EndToEndIdentification":"EndToEndIdentification", "InstructionIdentification":"InstructionIdentification", "CurrencyOfTransfer":"CurrencyOfTransfer", "CreditorAccount":{ "SecondaryIdentification":"SecondaryIdentification", "SchemeName":["UK.OBIE.BBAN","UK.OBIE.IBAN","UK.OBIE.PAN","UK.OBIE.Paym","UK.OBIE.SortCodeAccountNumber"], "Identification":"Identification", "Name":"Name" }, "Purpose":{ }, "ChargeBearer":{ }, "InstructionPriority":{ }, "RequestedExecutionDateTime":"2000-01-23T04:56:07.000+00:00", "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"], "RemittanceInformation":{ "Unstructured":"Unstructured", "Reference":"Reference" }, "ExchangeRateInformation":{ "ExchangeRate":6.027456183070403, "UnitCurrency":"UnitCurrency", "ContractIdentification":"ContractIdentification" }, "Creditor":{ "PostalAddress":{ "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" }, "Name":"Name" }, "InstructedAmount":{ "Currency":"Currency" } }, "ExpectedSettlementDateTime":"2000-01-23T04:56:07.000+00:00" } }
Headers:

								
									
Possible Errors:
  • OBP-20001: User not logged in. Authentication is required!
  • OBP-50000: Unknown Error.
Implemented in UKv3.1 by createInternationalScheduledPaymentConsents

Create International Scheduled Payments

NOTE: This endpoint currently only returns example data.

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":{ "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", "ExchangeRateInformation":{ "ExchangeRate":0.8008281904610115, "ExpirationDateTime":"2000-01-23T04:56:07.000+00:00", "RateType":{ }, "UnitCurrency":"UnitCurrency", "ContractIdentification":"ContractIdentification" }, "InternationalScheduledPaymentId":"InternationalScheduledPaymentId", "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":{ }, "DebtorAccount":{ "SecondaryIdentification":"SecondaryIdentification", "SchemeName":["UK.OBIE.BBAN","UK.OBIE.IBAN","UK.OBIE.PAN","UK.OBIE.Paym","UK.OBIE.SortCodeAccountNumber"], "Identification":"Identification", "Name":"Name" }, "CreditorAgent":{ "PostalAddress":{ "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" }, "SchemeName":["UK.OBIE.BICFI"], "Identification":"Identification", "Name":"Name" }, "EndToEndIdentification":"EndToEndIdentification", "InstructionIdentification":"InstructionIdentification", "CurrencyOfTransfer":"CurrencyOfTransfer", "CreditorAccount":{ "SecondaryIdentification":"SecondaryIdentification", "SchemeName":["UK.OBIE.BBAN","UK.OBIE.IBAN","UK.OBIE.PAN","UK.OBIE.Paym","UK.OBIE.SortCodeAccountNumber"], "Identification":"Identification", "Name":"Name" }, "Purpose":{ }, "ChargeBearer":{ }, "InstructionPriority":{ }, "RequestedExecutionDateTime":"2000-01-23T04:56:07.000+00:00", "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"], "RemittanceInformation":{ "Unstructured":"Unstructured", "Reference":"Reference" }, "ExchangeRateInformation":{ "ExchangeRate":6.027456183070403, "UnitCurrency":"UnitCurrency", "ContractIdentification":"ContractIdentification" }, "Creditor":{ "PostalAddress":{ "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" }, "Name":"Name" }, "InstructedAmount":{ "Currency":"Currency" } }, "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 } } }
Headers:

								
									
Possible Errors:
  • OBP-20001: User not logged in. Authentication is required!
  • OBP-50000: Unknown Error.
Implemented in UKv3.1 by createInternationalScheduledPayments

Get International Scheduled Payment Consents

NOTE: This endpoint currently only returns example data.

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", "ExchangeRateInformation":{ "ExchangeRate":0.8008281904610115, "ExpirationDateTime":"2000-01-23T04:56:07.000+00:00", "RateType":{ }, "UnitCurrency":"UnitCurrency", "ContractIdentification":"ContractIdentification" }, "Authorisation":{ "CompletionDateTime":"2000-01-23T04:56:07.000+00:00", "AuthorisationType":{ } }, "Permission":{ }, "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":{ }, "DebtorAccount":{ "SecondaryIdentification":"SecondaryIdentification", "SchemeName":["UK.OBIE.BBAN","UK.OBIE.IBAN","UK.OBIE.PAN","UK.OBIE.Paym","UK.OBIE.SortCodeAccountNumber"], "Identification":"Identification", "Name":"Name" }, "CreditorAgent":{ "PostalAddress":{ "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" }, "SchemeName":["UK.OBIE.BICFI"], "Identification":"Identification", "Name":"Name" }, "EndToEndIdentification":"EndToEndIdentification", "InstructionIdentification":"InstructionIdentification", "CurrencyOfTransfer":"CurrencyOfTransfer", "CreditorAccount":{ "SecondaryIdentification":"SecondaryIdentification", "SchemeName":["UK.OBIE.BBAN","UK.OBIE.IBAN","UK.OBIE.PAN","UK.OBIE.Paym","UK.OBIE.SortCodeAccountNumber"], "Identification":"Identification", "Name":"Name" }, "Purpose":{ }, "ChargeBearer":{ }, "InstructionPriority":{ }, "RequestedExecutionDateTime":"2000-01-23T04:56:07.000+00:00", "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"], "RemittanceInformation":{ "Unstructured":"Unstructured", "Reference":"Reference" }, "ExchangeRateInformation":{ "ExchangeRate":6.027456183070403, "UnitCurrency":"UnitCurrency", "ContractIdentification":"ContractIdentification" }, "Creditor":{ "PostalAddress":{ "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" }, "Name":"Name" }, "InstructedAmount":{ "Currency":"Currency" } }, "ExpectedSettlementDateTime":"2000-01-23T04:56:07.000+00:00" } }
Headers:

								
									
Possible Errors:
  • OBP-20001: User not logged in. Authentication is required!
  • OBP-50000: Unknown Error.
Implemented in UKv3.1 by getInternationalScheduledPaymentConsentsConsentId

Get International Scheduled Payment Consents Funds Confirmation

NOTE: This endpoint currently only returns example data.

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 } } }
Headers:

								
									
Possible Errors:
  • OBP-20001: User not logged in. Authentication is required!
  • OBP-50000: Unknown Error.
Implemented in UKv3.1 by getInternationalScheduledPaymentConsentsConsentIdFundsConfirmation

Get International Scheduled Payments

NOTE: This endpoint currently only returns example data.

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":{ "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", "ExchangeRateInformation":{ "ExchangeRate":0.8008281904610115, "ExpirationDateTime":"2000-01-23T04:56:07.000+00:00", "RateType":{ }, "UnitCurrency":"UnitCurrency", "ContractIdentification":"ContractIdentification" }, "InternationalScheduledPaymentId":"InternationalScheduledPaymentId", "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":{ }, "DebtorAccount":{ "SecondaryIdentification":"SecondaryIdentification", "SchemeName":["UK.OBIE.BBAN","UK.OBIE.IBAN","UK.OBIE.PAN","UK.OBIE.Paym","UK.OBIE.SortCodeAccountNumber"], "Identification":"Identification", "Name":"Name" }, "CreditorAgent":{ "PostalAddress":{ "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" }, "SchemeName":["UK.OBIE.BICFI"], "Identification":"Identification", "Name":"Name" }, "EndToEndIdentification":"EndToEndIdentification", "InstructionIdentification":"InstructionIdentification", "CurrencyOfTransfer":"CurrencyOfTransfer", "CreditorAccount":{ "SecondaryIdentification":"SecondaryIdentification", "SchemeName":["UK.OBIE.BBAN","UK.OBIE.IBAN","UK.OBIE.PAN","UK.OBIE.Paym","UK.OBIE.SortCodeAccountNumber"], "Identification":"Identification", "Name":"Name" }, "Purpose":{ }, "ChargeBearer":{ }, "InstructionPriority":{ }, "RequestedExecutionDateTime":"2000-01-23T04:56:07.000+00:00", "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"], "RemittanceInformation":{ "Unstructured":"Unstructured", "Reference":"Reference" }, "ExchangeRateInformation":{ "ExchangeRate":6.027456183070403, "UnitCurrency":"UnitCurrency", "ContractIdentification":"ContractIdentification" }, "Creditor":{ "PostalAddress":{ "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" }, "Name":"Name" }, "InstructedAmount":{ "Currency":"Currency" } }, "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 } } }
Headers:

								
									
Possible Errors:
  • OBP-20001: User not logged in. Authentication is required!
  • OBP-50000: Unknown Error.
Implemented in UKv3.1 by getInternationalScheduledPaymentsInternationalScheduledPaymentId

Create International Standing Order Consents

NOTE: This endpoint currently only returns example data.

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", "CutOffDateTime":"2000-01-23T04:56:07.000+00:00", "Authorisation":{ "CompletionDateTime":"2000-01-23T04:56:07.000+00:00", "AuthorisationType":{ } }, "Permission":{ }, "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":{ }, "DebtorAccount":{ "SecondaryIdentification":"SecondaryIdentification", "SchemeName":["UK.OBIE.BBAN","UK.OBIE.IBAN","UK.OBIE.PAN","UK.OBIE.Paym","UK.OBIE.SortCodeAccountNumber"], "Identification":"Identification", "Name":"Name" }, "CreditorAgent":{ "PostalAddress":{ "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" }, "SchemeName":["UK.OBIE.BICFI"], "Identification":"Identification", "Name":"Name" }, "Reference":"Reference", "CurrencyOfTransfer":"CurrencyOfTransfer", "CreditorAccount":{ "SecondaryIdentification":"SecondaryIdentification", "SchemeName":["UK.OBIE.BBAN","UK.OBIE.IBAN","UK.OBIE.PAN","UK.OBIE.Paym","UK.OBIE.SortCodeAccountNumber"], "Identification":"Identification", "Name":"Name" }, "Purpose":{ }, "ChargeBearer":{ }, "FinalPaymentDateTime":"2000-01-23T04:56:07.000+00:00", "Frequency":"Frequency", "FirstPaymentDateTime":"2000-01-23T04:56:07.000+00:00", "NumberOfPayments":"NumberOfPayments", "Creditor":{ "PostalAddress":{ "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" }, "Name":"Name" }, "InstructedAmount":{ "Currency":"Currency" } } } }
Headers:

								
									
Possible Errors:
  • OBP-20001: User not logged in. Authentication is required!
  • OBP-50000: Unknown Error.
Implemented in UKv3.1 by createInternationalStandingOrderConsents

Create International Standing Orders

NOTE: This endpoint currently only returns example data.

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":{ "Status":{ }, "StatusUpdateDateTime":"2000-01-23T04:56:07.000+00:00", "CreationDateTime":"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":{ } }], "InternationalStandingOrderId":"InternationalStandingOrderId", "ConsentId":"ConsentId", "Initiation":{ "SupplementaryData":{ }, "DebtorAccount":{ "SecondaryIdentification":"SecondaryIdentification", "SchemeName":["UK.OBIE.BBAN","UK.OBIE.IBAN","UK.OBIE.PAN","UK.OBIE.Paym","UK.OBIE.SortCodeAccountNumber"], "Identification":"Identification", "Name":"Name" }, "CreditorAgent":{ "PostalAddress":{ "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" }, "SchemeName":["UK.OBIE.BICFI"], "Identification":"Identification", "Name":"Name" }, "Reference":"Reference", "CurrencyOfTransfer":"CurrencyOfTransfer", "CreditorAccount":{ "SecondaryIdentification":"SecondaryIdentification", "SchemeName":["UK.OBIE.BBAN","UK.OBIE.IBAN","UK.OBIE.PAN","UK.OBIE.Paym","UK.OBIE.SortCodeAccountNumber"], "Identification":"Identification", "Name":"Name" }, "Purpose":{ }, "ChargeBearer":{ }, "FinalPaymentDateTime":"2000-01-23T04:56:07.000+00:00", "Frequency":"Frequency", "FirstPaymentDateTime":"2000-01-23T04:56:07.000+00:00", "NumberOfPayments":"NumberOfPayments", "Creditor":{ "PostalAddress":{ "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" }, "Name":"Name" }, "InstructedAmount":{ "Currency":"Currency" } }, "MultiAuthorisation":{ "Status":{ }, "NumberReceived":6, "LastUpdateDateTime":"2000-01-23T04:56:07.000+00:00", "ExpirationDateTime":"2000-01-23T04:56:07.000+00:00", "NumberRequired":0 } } }
Headers:

								
									
Possible Errors:
  • OBP-20001: User not logged in. Authentication is required!
  • OBP-50000: Unknown Error.
Implemented in UKv3.1 by createInternationalStandingOrders

Get International Standing Order Consents

NOTE: This endpoint currently only returns example data.

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", "CutOffDateTime":"2000-01-23T04:56:07.000+00:00", "Authorisation":{ "CompletionDateTime":"2000-01-23T04:56:07.000+00:00", "AuthorisationType":{ } }, "Permission":{ }, "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":{ }, "DebtorAccount":{ "SecondaryIdentification":"SecondaryIdentification", "SchemeName":["UK.OBIE.BBAN","UK.OBIE.IBAN","UK.OBIE.PAN","UK.OBIE.Paym","UK.OBIE.SortCodeAccountNumber"], "Identification":"Identification", "Name":"Name" }, "CreditorAgent":{ "PostalAddress":{ "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" }, "SchemeName":["UK.OBIE.BICFI"], "Identification":"Identification", "Name":"Name" }, "Reference":"Reference", "CurrencyOfTransfer":"CurrencyOfTransfer", "CreditorAccount":{ "SecondaryIdentification":"SecondaryIdentification", "SchemeName":["UK.OBIE.BBAN","UK.OBIE.IBAN","UK.OBIE.PAN","UK.OBIE.Paym","UK.OBIE.SortCodeAccountNumber"], "Identification":"Identification", "Name":"Name" }, "Purpose":{ }, "ChargeBearer":{ }, "FinalPaymentDateTime":"2000-01-23T04:56:07.000+00:00", "Frequency":"Frequency", "FirstPaymentDateTime":"2000-01-23T04:56:07.000+00:00", "NumberOfPayments":"NumberOfPayments", "Creditor":{ "PostalAddress":{ "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" }, "Name":"Name" }, "InstructedAmount":{ "Currency":"Currency" } } } }
Headers:

								
									
Possible Errors:
  • OBP-20001: User not logged in. Authentication is required!
  • OBP-50000: Unknown Error.
Implemented in UKv3.1 by getInternationalStandingOrderConsentsConsentId

Get International Standing Orders

NOTE: This endpoint currently only returns example data.

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":{ "Status":{ }, "StatusUpdateDateTime":"2000-01-23T04:56:07.000+00:00", "CreationDateTime":"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":{ } }], "InternationalStandingOrderId":"InternationalStandingOrderId", "ConsentId":"ConsentId", "Initiation":{ "SupplementaryData":{ }, "DebtorAccount":{ "SecondaryIdentification":"SecondaryIdentification", "SchemeName":["UK.OBIE.BBAN","UK.OBIE.IBAN","UK.OBIE.PAN","UK.OBIE.Paym","UK.OBIE.SortCodeAccountNumber"], "Identification":"Identification", "Name":"Name" }, "CreditorAgent":{ "PostalAddress":{ "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" }, "SchemeName":["UK.OBIE.BICFI"], "Identification":"Identification", "Name":"Name" }, "Reference":"Reference", "CurrencyOfTransfer":"CurrencyOfTransfer", "CreditorAccount":{ "SecondaryIdentification":"SecondaryIdentification", "SchemeName":["UK.OBIE.BBAN","UK.OBIE.IBAN","UK.OBIE.PAN","UK.OBIE.Paym","UK.OBIE.SortCodeAccountNumber"], "Identification":"Identification", "Name":"Name" }, "Purpose":{ }, "ChargeBearer":{ }, "FinalPaymentDateTime":"2000-01-23T04:56:07.000+00:00", "Frequency":"Frequency", "FirstPaymentDateTime":"2000-01-23T04:56:07.000+00:00", "NumberOfPayments":"NumberOfPayments", "Creditor":{ "PostalAddress":{ "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" }, "Name":"Name" }, "InstructedAmount":{ "Currency":"Currency" } }, "MultiAuthorisation":{ "Status":{ }, "NumberReceived":6, "LastUpdateDateTime":"2000-01-23T04:56:07.000+00:00", "ExpirationDateTime":"2000-01-23T04:56:07.000+00:00", "NumberRequired":0 } } }
Headers:

								
									
Possible Errors:
  • OBP-20001: User not logged in. Authentication is required!
  • OBP-50000: Unknown Error.
Implemented in UKv3.1 by getInternationalStandingOrdersInternationalStandingOrderPaymentId

Get Offers

NOTE: This endpoint currently only returns example data.

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":{ "Offer":[{ "OfferId":"OfferId", "AccountId":{ }, "Description":"Description", "StartDateTime":"2000-01-23T04:56:07.000+00:00", "EndDateTime":"2000-01-23T04:56:07.000+00:00", "Rate":"Rate", "Amount":{ "Amount":{ }, "Currency":"Currency" }, "Fee":{ "Amount":{ }, "Currency":"Currency" }, "Value":0, "Term":"Term", "URL":"URL", "OfferType":{ } },{ "OfferId":"OfferId", "AccountId":{ }, "Description":"Description", "StartDateTime":"2000-01-23T04:56:07.000+00:00", "EndDateTime":"2000-01-23T04:56:07.000+00:00", "Rate":"Rate", "Amount":{ "Amount":{ }, "Currency":"Currency" }, "Fee":{ "Amount":{ }, "Currency":"Currency" }, "Value":0, "Term":"Term", "URL":"URL", "OfferType":{ } }] } }
Headers:

								
									
Possible Errors:
  • OBP-20001: User not logged in. Authentication is required!
  • OBP-50000: Unknown Error.
Implemented in UKv3.1 by getAccountsAccountIdOffers

Get Offers

NOTE: This endpoint currently only returns example data.

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":{ "Offer":[{ "OfferId":"OfferId", "AccountId":{ }, "Description":"Description", "StartDateTime":"2000-01-23T04:56:07.000+00:00", "EndDateTime":"2000-01-23T04:56:07.000+00:00", "Rate":"Rate", "Amount":{ "Amount":{ }, "Currency":"Currency" }, "Fee":{ "Amount":{ }, "Currency":"Currency" }, "Value":0, "Term":"Term", "URL":"URL", "OfferType":{ } },{ "OfferId":"OfferId", "AccountId":{ }, "Description":"Description", "StartDateTime":"2000-01-23T04:56:07.000+00:00", "EndDateTime":"2000-01-23T04:56:07.000+00:00", "Rate":"Rate", "Amount":{ "Amount":{ }, "Currency":"Currency" }, "Fee":{ "Amount":{ }, "Currency":"Currency" }, "Value":0, "Term":"Term", "URL":"URL", "OfferType":{ } }] } }
Headers:

								
									
Possible Errors:
  • OBP-20001: User not logged in. Authentication is required!
  • OBP-50000: Unknown Error.
Implemented in UKv3.1 by getOffers

Get Party

NOTE: This endpoint currently only returns example data.

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":{ "Party":{ "PartyNumber":"PartyNumber", "PartyId":"PartyId", "Address":[{ "StreetName":"StreetName", "CountrySubDivision":"CountrySubDivision", "AddressLine":["AddressLine","AddressLine","AddressLine","AddressLine","AddressLine"], "BuildingNumber":"BuildingNumber", "TownName":"TownName", "Country":"Country", "AddressType":{ }, "PostCode":"PostCode" },{ "StreetName":"StreetName", "CountrySubDivision":"CountrySubDivision", "AddressLine":["AddressLine","AddressLine","AddressLine","AddressLine","AddressLine"], "BuildingNumber":"BuildingNumber", "TownName":"TownName", "Country":"Country", "AddressType":{ }, "PostCode":"PostCode" }], "Phone":"Phone", "Mobile":"Mobile", "PartyType":{ }, "EmailAddress":"EmailAddress", "Name":"Name" } } }
Headers:

								
									
Possible Errors:
  • OBP-20001: User not logged in. Authentication is required!
  • OBP-50000: Unknown Error.
Implemented in UKv3.1 by getAccountsAccountIdParty

Get Party

NOTE: This endpoint currently only returns example data.

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":{ "Party":{ "PartyNumber":"PartyNumber", "PartyId":"PartyId", "Address":[{ "StreetName":"StreetName", "CountrySubDivision":"CountrySubDivision", "AddressLine":["AddressLine","AddressLine","AddressLine","AddressLine","AddressLine"], "BuildingNumber":"BuildingNumber", "TownName":"TownName", "Country":"Country", "AddressType":{ }, "PostCode":"PostCode" },{ "StreetName":"StreetName", "CountrySubDivision":"CountrySubDivision", "AddressLine":["AddressLine","AddressLine","AddressLine","AddressLine","AddressLine"], "BuildingNumber":"BuildingNumber", "TownName":"TownName", "Country":"Country", "AddressType":{ }, "PostCode":"PostCode" }], "Phone":"Phone", "Mobile":"Mobile", "PartyType":{ }, "EmailAddress":"EmailAddress", "Name":"Name" } } }
Headers:

								
									
Possible Errors:
  • OBP-20001: User not logged in. Authentication is required!
  • OBP-50000: Unknown Error.
Implemented in UKv3.1 by getParty

Get Products

NOTE: This endpoint currently only returns example data.

Typical Successful Response:

								
									
{ }
Headers:

								
									
Possible Errors:
  • OBP-20001: User not logged in. Authentication is required!
  • OBP-50000: Unknown Error.
Implemented in UKv3.1 by getAccountsAccountIdProduct

Get Products

NOTE: This endpoint currently only returns example data.

Typical Successful Response:

								
									
{ }
Headers:

								
									
Possible Errors:
  • OBP-20001: User not logged in. Authentication is required!
  • OBP-50000: Unknown Error.
Implemented in UKv3.1 by getProducts

Get Scheduled Payments

NOTE: This endpoint currently only returns example data.

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":{ "ScheduledPayment":[{ "CreditorAgent":{ "SchemeName":["UK.OBIE.BICFI"], "Identification":"Identification" }, "AccountId":{ }, "Reference":"Reference", "CreditorAccount":{ "SecondaryIdentification":"SecondaryIdentification", "SchemeName":["UK.OBIE.BBAN","UK.OBIE.IBAN","UK.OBIE.PAN","UK.OBIE.Paym","UK.OBIE.SortCodeAccountNumber"], "Identification":"Identification", "Name":"Name" }, "ScheduledPaymentDateTime":"2000-01-23T04:56:07.000+00:00", "InstructedAmount":{ "Amount":{ }, "Currency":"Currency" }, "ScheduledPaymentId":"ScheduledPaymentId", "ScheduledType":{ } },{ "CreditorAgent":{ "SchemeName":["UK.OBIE.BICFI"], "Identification":"Identification" }, "AccountId":{ }, "Reference":"Reference", "CreditorAccount":{ "SecondaryIdentification":"SecondaryIdentification", "SchemeName":["UK.OBIE.BBAN","UK.OBIE.IBAN","UK.OBIE.PAN","UK.OBIE.Paym","UK.OBIE.SortCodeAccountNumber"], "Identification":"Identification", "Name":"Name" }, "ScheduledPaymentDateTime":"2000-01-23T04:56:07.000+00:00", "InstructedAmount":{ "Amount":{ }, "Currency":"Currency" }, "ScheduledPaymentId":"ScheduledPaymentId", "ScheduledType":{ } }] } }
Headers:

								
									
Possible Errors:
  • OBP-20001: User not logged in. Authentication is required!
  • OBP-50000: Unknown Error.
Implemented in UKv3.1 by getScheduledPayments

Get Scheduled Payments

NOTE: This endpoint currently only returns example data.

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":{ "ScheduledPayment":[{ "CreditorAgent":{ "SchemeName":["UK.OBIE.BICFI"], "Identification":"Identification" }, "AccountId":{ }, "Reference":"Reference", "CreditorAccount":{ "SecondaryIdentification":"SecondaryIdentification", "SchemeName":["UK.OBIE.BBAN","UK.OBIE.IBAN","UK.OBIE.PAN","UK.OBIE.Paym","UK.OBIE.SortCodeAccountNumber"], "Identification":"Identification", "Name":"Name" }, "ScheduledPaymentDateTime":"2000-01-23T04:56:07.000+00:00", "InstructedAmount":{ "Amount":{ }, "Currency":"Currency" }, "ScheduledPaymentId":"ScheduledPaymentId", "ScheduledType":{ } },{ "CreditorAgent":{ "SchemeName":["UK.OBIE.BICFI"], "Identification":"Identification" }, "AccountId":{ }, "Reference":"Reference", "CreditorAccount":{ "SecondaryIdentification":"SecondaryIdentification", "SchemeName":["UK.OBIE.BBAN","UK.OBIE.IBAN","UK.OBIE.PAN","UK.OBIE.Paym","UK.OBIE.SortCodeAccountNumber"], "Identification":"Identification", "Name":"Name" }, "ScheduledPaymentDateTime":"2000-01-23T04:56:07.000+00:00", "InstructedAmount":{ "Amount":{ }, "Currency":"Currency" }, "ScheduledPaymentId":"ScheduledPaymentId", "ScheduledType":{ } }] } }
Headers:

								
									
Possible Errors:
  • OBP-20001: User not logged in. Authentication is required!
  • OBP-50000: Unknown Error.
Implemented in UKv3.1 by getAccountsAccountIdScheduledPayments

Get Standing Orders

NOTE: This endpoint currently only returns example data.

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":{ "StandingOrder":[{ "SupplementaryData":{ }, "CreditorAgent":{ "SchemeName":["UK.OBIE.BICFI"], "Identification":"Identification" }, "AccountId":{ }, "StandingOrderId":"StandingOrderId", "Reference":"Reference", "StandingOrderStatusCode":{ }, "CreditorAccount":{ "SecondaryIdentification":"SecondaryIdentification", "SchemeName":["UK.OBIE.BBAN","UK.OBIE.IBAN","UK.OBIE.PAN","UK.OBIE.Paym","UK.OBIE.SortCodeAccountNumber"], "Identification":"Identification", "Name":"Name" }, "FirstPaymentAmount":{ "Amount":{ }, "Currency":"Currency" }, "FinalPaymentAmount":{ "Amount":{ }, "Currency":"Currency" }, "FinalPaymentDateTime":"2000-01-23T04:56:07.000+00:00", "NextPaymentAmount":{ "Amount":{ }, "Currency":"Currency" }, "NextPaymentDateTime":"2000-01-23T04:56:07.000+00:00", "Frequency":"Frequency", "FirstPaymentDateTime":"2000-01-23T04:56:07.000+00:00" },{ "SupplementaryData":{ }, "CreditorAgent":{ "SchemeName":["UK.OBIE.BICFI"], "Identification":"Identification" }, "AccountId":{ }, "StandingOrderId":"StandingOrderId", "Reference":"Reference", "StandingOrderStatusCode":{ }, "CreditorAccount":{ "SecondaryIdentification":"SecondaryIdentification", "SchemeName":["UK.OBIE.BBAN","UK.OBIE.IBAN","UK.OBIE.PAN","UK.OBIE.Paym","UK.OBIE.SortCodeAccountNumber"], "Identification":"Identification", "Name":"Name" }, "FirstPaymentAmount":{ "Amount":{ }, "Currency":"Currency" }, "FinalPaymentAmount":{ "Amount":{ }, "Currency":"Currency" }, "FinalPaymentDateTime":"2000-01-23T04:56:07.000+00:00", "NextPaymentAmount":{ "Amount":{ }, "Currency":"Currency" }, "NextPaymentDateTime":"2000-01-23T04:56:07.000+00:00", "Frequency":"Frequency", "FirstPaymentDateTime":"2000-01-23T04:56:07.000+00:00" }] } }
Headers:

								
									
Possible Errors:
  • OBP-20001: User not logged in. Authentication is required!
  • OBP-50000: Unknown Error.
Implemented in UKv3.1 by getStandingOrders

Get Standing Orders

NOTE: This endpoint currently only returns example data.

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":{ "StandingOrder":[{ "SupplementaryData":{ }, "CreditorAgent":{ "SchemeName":["UK.OBIE.BICFI"], "Identification":"Identification" }, "AccountId":{ }, "StandingOrderId":"StandingOrderId", "Reference":"Reference", "StandingOrderStatusCode":{ }, "CreditorAccount":{ "SecondaryIdentification":"SecondaryIdentification", "SchemeName":["UK.OBIE.BBAN","UK.OBIE.IBAN","UK.OBIE.PAN","UK.OBIE.Paym","UK.OBIE.SortCodeAccountNumber"], "Identification":"Identification", "Name":"Name" }, "FirstPaymentAmount":{ "Amount":{ }, "Currency":"Currency" }, "FinalPaymentAmount":{ "Amount":{ }, "Currency":"Currency" }, "FinalPaymentDateTime":"2000-01-23T04:56:07.000+00:00", "NextPaymentAmount":{ "Amount":{ }, "Currency":"Currency" }, "NextPaymentDateTime":"2000-01-23T04:56:07.000+00:00", "Frequency":"Frequency", "FirstPaymentDateTime":"2000-01-23T04:56:07.000+00:00" },{ "SupplementaryData":{ }, "CreditorAgent":{ "SchemeName":["UK.OBIE.BICFI"], "Identification":"Identification" }, "AccountId":{ }, "StandingOrderId":"StandingOrderId", "Reference":"Reference", "StandingOrderStatusCode":{ }, "CreditorAccount":{ "SecondaryIdentification":"SecondaryIdentification", "SchemeName":["UK.OBIE.BBAN","UK.OBIE.IBAN","UK.OBIE.PAN","UK.OBIE.Paym","UK.OBIE.SortCodeAccountNumber"], "Identification":"Identification", "Name":"Name" }, "FirstPaymentAmount":{ "Amount":{ }, "Currency":"Currency" }, "FinalPaymentAmount":{ "Amount":{ }, "Currency":"Currency" }, "FinalPaymentDateTime":"2000-01-23T04:56:07.000+00:00", "NextPaymentAmount":{ "Amount":{ }, "Currency":"Currency" }, "NextPaymentDateTime":"2000-01-23T04:56:07.000+00:00", "Frequency":"Frequency", "FirstPaymentDateTime":"2000-01-23T04:56:07.000+00:00" }] } }
Headers:

								
									
Possible Errors:
  • OBP-20001: User not logged in. Authentication is required!
  • OBP-50000: Unknown Error.
Implemented in UKv3.1 by getAccountsAccountIdStandingOrders

Get Statements

NOTE: This endpoint currently only returns example data.

Typical Successful Response:

								
									
{ }
Headers:

								
									
Possible Errors:
  • OBP-20001: User not logged in. Authentication is required!
  • OBP-50000: Unknown Error.
Implemented in UKv3.1 by getAccountsAccountIdStatementsStatementIdFile

Get Statements

NOTE: This endpoint currently only returns example data.

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":{ "Statement":[{ "AccountId":{ }, "StatementReference":"StatementReference", "StatementDateTime":[{ "Type":["UK.OBIE.BalanceTransferPromoEnd","UK.OBIE.DirectDebitDue","UK.OBIE.LastPayment","UK.OBIE.LastStatement","UK.OBIE.NextStatement","UK.OBIE.PaymentDue","UK.OBIE.PurchasePromoEnd","UK.OBIE.StatementAvailable"], "DateTime":"2000-01-23T04:56:07.000+00:00" },{ "Type":["UK.OBIE.BalanceTransferPromoEnd","UK.OBIE.DirectDebitDue","UK.OBIE.LastPayment","UK.OBIE.LastStatement","UK.OBIE.NextStatement","UK.OBIE.PaymentDue","UK.OBIE.PurchasePromoEnd","UK.OBIE.StatementAvailable"], "DateTime":"2000-01-23T04:56:07.000+00:00" }], "StatementInterest":[{ "Type":["UK.OBIE.BalanceTransfer","UK.OBIE.Cash","UK.OBIE.EstimatedNext","UK.OBIE.Purchase","UK.OBIE.Total"], "Amount":{ "Amount":{ }, "Currency":"Currency" }, "CreditDebitIndicator":"Credit" },{ "Type":["UK.OBIE.BalanceTransfer","UK.OBIE.Cash","UK.OBIE.EstimatedNext","UK.OBIE.Purchase","UK.OBIE.Total"], "Amount":{ "Amount":{ }, "Currency":"Currency" }, "CreditDebitIndicator":"Credit" }], "Type":{ }, "StartDateTime":"2000-01-23T04:56:07.000+00:00", "CreationDateTime":"2000-01-23T04:56:07.000+00:00", "StatementRate":[{ "Type":["UK.OBIE.AnnualBalanceTransfer","UK.OBIE.AnnualBalanceTransferAfterPromo","UK.OBIE.AnnualBalanceTransferPromo","UK.OBIE.AnnualCash","UK.OBIE.AnnualPurchase","UK.OBIE.AnnualPurchaseAfterPromo","UK.OBIE.AnnualPurchasePromo","UK.OBIE.MonthlyBalanceTransfer","UK.OBIE.MonthlyCash","UK.OBIE.MonthlyPurchase"], "Rate":"Rate" },{ "Type":["UK.OBIE.AnnualBalanceTransfer","UK.OBIE.AnnualBalanceTransferAfterPromo","UK.OBIE.AnnualBalanceTransferPromo","UK.OBIE.AnnualCash","UK.OBIE.AnnualPurchase","UK.OBIE.AnnualPurchaseAfterPromo","UK.OBIE.AnnualPurchasePromo","UK.OBIE.MonthlyBalanceTransfer","UK.OBIE.MonthlyCash","UK.OBIE.MonthlyPurchase"], "Rate":"Rate" }], "EndDateTime":"2000-01-23T04:56:07.000+00:00", "StatementId":"StatementId", "StatementValue":[{ "Type":["UK.OBIE.AirMilesPoints","UK.OBIE.AirMilesPointsBalance","UK.OBIE.Credits","UK.OBIE.Debits","UK.OBIE.HotelPoints","UK.OBIE.HotelPointsBalance","UK.OBIE.RetailShoppingPoints","UK.OBIE.RetailShoppingPointsBalance"], "Value":0 },{ "Type":["UK.OBIE.AirMilesPoints","UK.OBIE.AirMilesPointsBalance","UK.OBIE.Credits","UK.OBIE.Debits","UK.OBIE.HotelPoints","UK.OBIE.HotelPointsBalance","UK.OBIE.RetailShoppingPoints","UK.OBIE.RetailShoppingPointsBalance"], "Value":0 }], "StatementBenefit":[{ "Type":["UK.OBIE.Cashback","UK.OBIE.Insurance","UK.OBIE.TravelDiscount","UK.OBIE.TravelInsurance"], "Amount":{ "Amount":{ }, "Currency":"Currency" } },{ "Type":["UK.OBIE.Cashback","UK.OBIE.Insurance","UK.OBIE.TravelDiscount","UK.OBIE.TravelInsurance"], "Amount":{ "Amount":{ }, "Currency":"Currency" } }], "StatementFee":[{ "Type":["UK.OBIE.Annual","UK.OBIE.BalanceTransfer","UK.OBIE.CashAdvance","UK.OBIE.CashTransaction","UK.OBIE.ForeignCashTransaction","UK.OBIE.ForeignTransaction","UK.OBIE.Gambling","UK.OBIE.LatePayment","UK.OBIE.MoneyTransfer","UK.OBIE.Monthly","UK.OBIE.Overlimit","UK.OBIE.PostalOrder","UK.OBIE.PrizeEntry","UK.OBIE.StatementCopy","UK.OBIE.Total"], "Amount":{ "Amount":{ }, "Currency":"Currency" }, "CreditDebitIndicator":"Credit" },{ "Type":["UK.OBIE.Annual","UK.OBIE.BalanceTransfer","UK.OBIE.CashAdvance","UK.OBIE.CashTransaction","UK.OBIE.ForeignCashTransaction","UK.OBIE.ForeignTransaction","UK.OBIE.Gambling","UK.OBIE.LatePayment","UK.OBIE.MoneyTransfer","UK.OBIE.Monthly","UK.OBIE.Overlimit","UK.OBIE.PostalOrder","UK.OBIE.PrizeEntry","UK.OBIE.StatementCopy","UK.OBIE.Total"], "Amount":{ "Amount":{ }, "Currency":"Currency" }, "CreditDebitIndicator":"Credit" }], "StatementDescription":["StatementDescription","StatementDescription"], "StatementAmount":[{ "Type":["UK.OBIE.ArrearsClosingBalance","UK.OBIE.AvailableBalance","UK.OBIE.AverageBalanceWhenInCredit","UK.OBIE.AverageBalanceWhenInDebit","UK.OBIE.AverageDailyBalance","UK.OBIE.BalanceTransferClosingBalance","UK.OBIE.CashClosingBalance","UK.OBIE.ClosingBalance","UK.OBIE.CreditLimit","UK.OBIE.CurrentPayment","UK.OBIE.DirectDebitPaymentDue","UK.OBIE.FSCSInsurance","UK.OBIE.MinimumPaymentDue","UK.OBIE.PendingTransactionsBalance","UK.OBIE.PreviousClosingBalance","UK.OBIE.PreviousPayment","UK.OBIE.PurchaseClosingBalance","UK.OBIE.StartingBalance","UK.OBIE.TotalAdjustments","UK.OBIE.TotalCashAdvances","UK.OBIE.TotalCharges","UK.OBIE.TotalCredits","UK.OBIE.TotalDebits","UK.OBIE.TotalPurchases"], "Amount":{ "Amount":{ }, "Currency":"Currency" }, "CreditDebitIndicator":"Credit" },{ "Type":["UK.OBIE.ArrearsClosingBalance","UK.OBIE.AvailableBalance","UK.OBIE.AverageBalanceWhenInCredit","UK.OBIE.AverageBalanceWhenInDebit","UK.OBIE.AverageDailyBalance","UK.OBIE.BalanceTransferClosingBalance","UK.OBIE.CashClosingBalance","UK.OBIE.ClosingBalance","UK.OBIE.CreditLimit","UK.OBIE.CurrentPayment","UK.OBIE.DirectDebitPaymentDue","UK.OBIE.FSCSInsurance","UK.OBIE.MinimumPaymentDue","UK.OBIE.PendingTransactionsBalance","UK.OBIE.PreviousClosingBalance","UK.OBIE.PreviousPayment","UK.OBIE.PurchaseClosingBalance","UK.OBIE.StartingBalance","UK.OBIE.TotalAdjustments","UK.OBIE.TotalCashAdvances","UK.OBIE.TotalCharges","UK.OBIE.TotalCredits","UK.OBIE.TotalDebits","UK.OBIE.TotalPurchases"], "Amount":{ "Amount":{ }, "Currency":"Currency" }, "CreditDebitIndicator":"Credit" }] },{ "AccountId":{ }, "StatementReference":"StatementReference", "StatementDateTime":[{ "Type":["UK.OBIE.BalanceTransferPromoEnd","UK.OBIE.DirectDebitDue","UK.OBIE.LastPayment","UK.OBIE.LastStatement","UK.OBIE.NextStatement","UK.OBIE.PaymentDue","UK.OBIE.PurchasePromoEnd","UK.OBIE.StatementAvailable"], "DateTime":"2000-01-23T04:56:07.000+00:00" },{ "Type":["UK.OBIE.BalanceTransferPromoEnd","UK.OBIE.DirectDebitDue","UK.OBIE.LastPayment","UK.OBIE.LastStatement","UK.OBIE.NextStatement","UK.OBIE.PaymentDue","UK.OBIE.PurchasePromoEnd","UK.OBIE.StatementAvailable"], "DateTime":"2000-01-23T04:56:07.000+00:00" }], "StatementInterest":[{ "Type":["UK.OBIE.BalanceTransfer","UK.OBIE.Cash","UK.OBIE.EstimatedNext","UK.OBIE.Purchase","UK.OBIE.Total"], "Amount":{ "Amount":{ }, "Currency":"Currency" }, "CreditDebitIndicator":"Credit" },{ "Type":["UK.OBIE.BalanceTransfer","UK.OBIE.Cash","UK.OBIE.EstimatedNext","UK.OBIE.Purchase","UK.OBIE.Total"], "Amount":{ "Amount":{ }, "Currency":"Currency" }, "CreditDebitIndicator":"Credit" }], "Type":{ }, "StartDateTime":"2000-01-23T04:56:07.000+00:00", "CreationDateTime":"2000-01-23T04:56:07.000+00:00", "StatementRate":[{ "Type":["UK.OBIE.AnnualBalanceTransfer","UK.OBIE.AnnualBalanceTransferAfterPromo","UK.OBIE.AnnualBalanceTransferPromo","UK.OBIE.AnnualCash","UK.OBIE.AnnualPurchase","UK.OBIE.AnnualPurchaseAfterPromo","UK.OBIE.AnnualPurchasePromo","UK.OBIE.MonthlyBalanceTransfer","UK.OBIE.MonthlyCash","UK.OBIE.MonthlyPurchase"], "Rate":"Rate" },{ "Type":["UK.OBIE.AnnualBalanceTransfer","UK.OBIE.AnnualBalanceTransferAfterPromo","UK.OBIE.AnnualBalanceTransferPromo","UK.OBIE.AnnualCash","UK.OBIE.AnnualPurchase","UK.OBIE.AnnualPurchaseAfterPromo","UK.OBIE.AnnualPurchasePromo","UK.OBIE.MonthlyBalanceTransfer","UK.OBIE.MonthlyCash","UK.OBIE.MonthlyPurchase"], "Rate":"Rate" }], "EndDateTime":"2000-01-23T04:56:07.000+00:00", "StatementId":"StatementId", "StatementValue":[{ "Type":["UK.OBIE.AirMilesPoints","UK.OBIE.AirMilesPointsBalance","UK.OBIE.Credits","UK.OBIE.Debits","UK.OBIE.HotelPoints","UK.OBIE.HotelPointsBalance","UK.OBIE.RetailShoppingPoints","UK.OBIE.RetailShoppingPointsBalance"], "Value":0 },{ "Type":["UK.OBIE.AirMilesPoints","UK.OBIE.AirMilesPointsBalance","UK.OBIE.Credits","UK.OBIE.Debits","UK.OBIE.HotelPoints","UK.OBIE.HotelPointsBalance","UK.OBIE.RetailShoppingPoints","UK.OBIE.RetailShoppingPointsBalance"], "Value":0 }], "StatementBenefit":[{ "Type":["UK.OBIE.Cashback","UK.OBIE.Insurance","UK.OBIE.TravelDiscount","UK.OBIE.TravelInsurance"], "Amount":{ "Amount":{ }, "Currency":"Currency" } },{ "Type":["UK.OBIE.Cashback","UK.OBIE.Insurance","UK.OBIE.TravelDiscount","UK.OBIE.TravelInsurance"], "Amount":{ "Amount":{ }, "Currency":"Currency" } }], "StatementFee":[{ "Type":["UK.OBIE.Annual","UK.OBIE.BalanceTransfer","UK.OBIE.CashAdvance","UK.OBIE.CashTransaction","UK.OBIE.ForeignCashTransaction","UK.OBIE.ForeignTransaction","UK.OBIE.Gambling","UK.OBIE.LatePayment","UK.OBIE.MoneyTransfer","UK.OBIE.Monthly","UK.OBIE.Overlimit","UK.OBIE.PostalOrder","UK.OBIE.PrizeEntry","UK.OBIE.StatementCopy","UK.OBIE.Total"], "Amount":{ "Amount":{ }, "Currency":"Currency" }, "CreditDebitIndicator":"Credit" },{ "Type":["UK.OBIE.Annual","UK.OBIE.BalanceTransfer","UK.OBIE.CashAdvance","UK.OBIE.CashTransaction","UK.OBIE.ForeignCashTransaction","UK.OBIE.ForeignTransaction","UK.OBIE.Gambling","UK.OBIE.LatePayment","UK.OBIE.MoneyTransfer","UK.OBIE.Monthly","UK.OBIE.Overlimit","UK.OBIE.PostalOrder","UK.OBIE.PrizeEntry","UK.OBIE.StatementCopy","UK.OBIE.Total"], "Amount":{ "Amount":{ }, "Currency":"Currency" }, "CreditDebitIndicator":"Credit" }], "StatementDescription":["StatementDescription","StatementDescription"], "StatementAmount":[{ "Type":["UK.OBIE.ArrearsClosingBalance","UK.OBIE.AvailableBalance","UK.OBIE.AverageBalanceWhenInCredit","UK.OBIE.AverageBalanceWhenInDebit","UK.OBIE.AverageDailyBalance","UK.OBIE.BalanceTransferClosingBalance","UK.OBIE.CashClosingBalance","UK.OBIE.ClosingBalance","UK.OBIE.CreditLimit","UK.OBIE.CurrentPayment","UK.OBIE.DirectDebitPaymentDue","UK.OBIE.FSCSInsurance","UK.OBIE.MinimumPaymentDue","UK.OBIE.PendingTransactionsBalance","UK.OBIE.PreviousClosingBalance","UK.OBIE.PreviousPayment","UK.OBIE.PurchaseClosingBalance","UK.OBIE.StartingBalance","UK.OBIE.TotalAdjustments","UK.OBIE.TotalCashAdvances","UK.OBIE.TotalCharges","UK.OBIE.TotalCredits","UK.OBIE.TotalDebits","UK.OBIE.TotalPurchases"], "Amount":{ "Amount":{ }, "Currency":"Currency" }, "CreditDebitIndicator":"Credit" },{ "Type":["UK.OBIE.ArrearsClosingBalance","UK.OBIE.AvailableBalance","UK.OBIE.AverageBalanceWhenInCredit","UK.OBIE.AverageBalanceWhenInDebit","UK.OBIE.AverageDailyBalance","UK.OBIE.BalanceTransferClosingBalance","UK.OBIE.CashClosingBalance","UK.OBIE.ClosingBalance","UK.OBIE.CreditLimit","UK.OBIE.CurrentPayment","UK.OBIE.DirectDebitPaymentDue","UK.OBIE.FSCSInsurance","UK.OBIE.MinimumPaymentDue","UK.OBIE.PendingTransactionsBalance","UK.OBIE.PreviousClosingBalance","UK.OBIE.PreviousPayment","UK.OBIE.PurchaseClosingBalance","UK.OBIE.StartingBalance","UK.OBIE.TotalAdjustments","UK.OBIE.TotalCashAdvances","UK.OBIE.TotalCharges","UK.OBIE.TotalCredits","UK.OBIE.TotalDebits","UK.OBIE.TotalPurchases"], "Amount":{ "Amount":{ }, "Currency":"Currency" }, "CreditDebitIndicator":"Credit" }] }] } }
Headers:

								
									
Possible Errors:
  • OBP-20001: User not logged in. Authentication is required!
  • OBP-50000: Unknown Error.
Implemented in UKv3.1 by getAccountsAccountIdStatements

Get Statements

NOTE: This endpoint currently only returns example data.

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":{ "Statement":[{ "AccountId":{ }, "StatementReference":"StatementReference", "StatementDateTime":[{ "Type":["UK.OBIE.BalanceTransferPromoEnd","UK.OBIE.DirectDebitDue","UK.OBIE.LastPayment","UK.OBIE.LastStatement","UK.OBIE.NextStatement","UK.OBIE.PaymentDue","UK.OBIE.PurchasePromoEnd","UK.OBIE.StatementAvailable"], "DateTime":"2000-01-23T04:56:07.000+00:00" },{ "Type":["UK.OBIE.BalanceTransferPromoEnd","UK.OBIE.DirectDebitDue","UK.OBIE.LastPayment","UK.OBIE.LastStatement","UK.OBIE.NextStatement","UK.OBIE.PaymentDue","UK.OBIE.PurchasePromoEnd","UK.OBIE.StatementAvailable"], "DateTime":"2000-01-23T04:56:07.000+00:00" }], "StatementInterest":[{ "Type":["UK.OBIE.BalanceTransfer","UK.OBIE.Cash","UK.OBIE.EstimatedNext","UK.OBIE.Purchase","UK.OBIE.Total"], "Amount":{ "Amount":{ }, "Currency":"Currency" }, "CreditDebitIndicator":"Credit" },{ "Type":["UK.OBIE.BalanceTransfer","UK.OBIE.Cash","UK.OBIE.EstimatedNext","UK.OBIE.Purchase","UK.OBIE.Total"], "Amount":{ "Amount":{ }, "Currency":"Currency" }, "CreditDebitIndicator":"Credit" }], "Type":{ }, "StartDateTime":"2000-01-23T04:56:07.000+00:00", "CreationDateTime":"2000-01-23T04:56:07.000+00:00", "StatementRate":[{ "Type":["UK.OBIE.AnnualBalanceTransfer","UK.OBIE.AnnualBalanceTransferAfterPromo","UK.OBIE.AnnualBalanceTransferPromo","UK.OBIE.AnnualCash","UK.OBIE.AnnualPurchase","UK.OBIE.AnnualPurchaseAfterPromo","UK.OBIE.AnnualPurchasePromo","UK.OBIE.MonthlyBalanceTransfer","UK.OBIE.MonthlyCash","UK.OBIE.MonthlyPurchase"], "Rate":"Rate" },{ "Type":["UK.OBIE.AnnualBalanceTransfer","UK.OBIE.AnnualBalanceTransferAfterPromo","UK.OBIE.AnnualBalanceTransferPromo","UK.OBIE.AnnualCash","UK.OBIE.AnnualPurchase","UK.OBIE.AnnualPurchaseAfterPromo","UK.OBIE.AnnualPurchasePromo","UK.OBIE.MonthlyBalanceTransfer","UK.OBIE.MonthlyCash","UK.OBIE.MonthlyPurchase"], "Rate":"Rate" }], "EndDateTime":"2000-01-23T04:56:07.000+00:00", "StatementId":"StatementId", "StatementValue":[{ "Type":["UK.OBIE.AirMilesPoints","UK.OBIE.AirMilesPointsBalance","UK.OBIE.Credits","UK.OBIE.Debits","UK.OBIE.HotelPoints","UK.OBIE.HotelPointsBalance","UK.OBIE.RetailShoppingPoints","UK.OBIE.RetailShoppingPointsBalance"], "Value":0 },{ "Type":["UK.OBIE.AirMilesPoints","UK.OBIE.AirMilesPointsBalance","UK.OBIE.Credits","UK.OBIE.Debits","UK.OBIE.HotelPoints","UK.OBIE.HotelPointsBalance","UK.OBIE.RetailShoppingPoints","UK.OBIE.RetailShoppingPointsBalance"], "Value":0 }], "StatementBenefit":[{ "Type":["UK.OBIE.Cashback","UK.OBIE.Insurance","UK.OBIE.TravelDiscount","UK.OBIE.TravelInsurance"], "Amount":{ "Amount":{ }, "Currency":"Currency" } },{ "Type":["UK.OBIE.Cashback","UK.OBIE.Insurance","UK.OBIE.TravelDiscount","UK.OBIE.TravelInsurance"], "Amount":{ "Amount":{ }, "Currency":"Currency" } }], "StatementFee":[{ "Type":["UK.OBIE.Annual","UK.OBIE.BalanceTransfer","UK.OBIE.CashAdvance","UK.OBIE.CashTransaction","UK.OBIE.ForeignCashTransaction","UK.OBIE.ForeignTransaction","UK.OBIE.Gambling","UK.OBIE.LatePayment","UK.OBIE.MoneyTransfer","UK.OBIE.Monthly","UK.OBIE.Overlimit","UK.OBIE.PostalOrder","UK.OBIE.PrizeEntry","UK.OBIE.StatementCopy","UK.OBIE.Total"], "Amount":{ "Amount":{ }, "Currency":"Currency" }, "CreditDebitIndicator":"Credit" },{ "Type":["UK.OBIE.Annual","UK.OBIE.BalanceTransfer","UK.OBIE.CashAdvance","UK.OBIE.CashTransaction","UK.OBIE.ForeignCashTransaction","UK.OBIE.ForeignTransaction","UK.OBIE.Gambling","UK.OBIE.LatePayment","UK.OBIE.MoneyTransfer","UK.OBIE.Monthly","UK.OBIE.Overlimit","UK.OBIE.PostalOrder","UK.OBIE.PrizeEntry","UK.OBIE.StatementCopy","UK.OBIE.Total"], "Amount":{ "Amount":{ }, "Currency":"Currency" }, "CreditDebitIndicator":"Credit" }], "StatementDescription":["StatementDescription","StatementDescription"], "StatementAmount":[{ "Type":["UK.OBIE.ArrearsClosingBalance","UK.OBIE.AvailableBalance","UK.OBIE.AverageBalanceWhenInCredit","UK.OBIE.AverageBalanceWhenInDebit","UK.OBIE.AverageDailyBalance","UK.OBIE.BalanceTransferClosingBalance","UK.OBIE.CashClosingBalance","UK.OBIE.ClosingBalance","UK.OBIE.CreditLimit","UK.OBIE.CurrentPayment","UK.OBIE.DirectDebitPaymentDue","UK.OBIE.FSCSInsurance","UK.OBIE.MinimumPaymentDue","UK.OBIE.PendingTransactionsBalance","UK.OBIE.PreviousClosingBalance","UK.OBIE.PreviousPayment","UK.OBIE.PurchaseClosingBalance","UK.OBIE.StartingBalance","UK.OBIE.TotalAdjustments","UK.OBIE.TotalCashAdvances","UK.OBIE.TotalCharges","UK.OBIE.TotalCredits","UK.OBIE.TotalDebits","UK.OBIE.TotalPurchases"], "Amount":{ "Amount":{ }, "Currency":"Currency" }, "CreditDebitIndicator":"Credit" },{ "Type":["UK.OBIE.ArrearsClosingBalance","UK.OBIE.AvailableBalance","UK.OBIE.AverageBalanceWhenInCredit","UK.OBIE.AverageBalanceWhenInDebit","UK.OBIE.AverageDailyBalance","UK.OBIE.BalanceTransferClosingBalance","UK.OBIE.CashClosingBalance","UK.OBIE.ClosingBalance","UK.OBIE.CreditLimit","UK.OBIE.CurrentPayment","UK.OBIE.DirectDebitPaymentDue","UK.OBIE.FSCSInsurance","UK.OBIE.MinimumPaymentDue","UK.OBIE.PendingTransactionsBalance","UK.OBIE.PreviousClosingBalance","UK.OBIE.PreviousPayment","UK.OBIE.PurchaseClosingBalance","UK.OBIE.StartingBalance","UK.OBIE.TotalAdjustments","UK.OBIE.TotalCashAdvances","UK.OBIE.TotalCharges","UK.OBIE.TotalCredits","UK.OBIE.TotalDebits","UK.OBIE.TotalPurchases"], "Amount":{ "Amount":{ }, "Currency":"Currency" }, "CreditDebitIndicator":"Credit" }] },{ "AccountId":{ }, "StatementReference":"StatementReference", "StatementDateTime":[{ "Type":["UK.OBIE.BalanceTransferPromoEnd","UK.OBIE.DirectDebitDue","UK.OBIE.LastPayment","UK.OBIE.LastStatement","UK.OBIE.NextStatement","UK.OBIE.PaymentDue","UK.OBIE.PurchasePromoEnd","UK.OBIE.StatementAvailable"], "DateTime":"2000-01-23T04:56:07.000+00:00" },{ "Type":["UK.OBIE.BalanceTransferPromoEnd","UK.OBIE.DirectDebitDue","UK.OBIE.LastPayment","UK.OBIE.LastStatement","UK.OBIE.NextStatement","UK.OBIE.PaymentDue","UK.OBIE.PurchasePromoEnd","UK.OBIE.StatementAvailable"], "DateTime":"2000-01-23T04:56:07.000+00:00" }], "StatementInterest":[{ "Type":["UK.OBIE.BalanceTransfer","UK.OBIE.Cash","UK.OBIE.EstimatedNext","UK.OBIE.Purchase","UK.OBIE.Total"], "Amount":{ "Amount":{ }, "Currency":"Currency" }, "CreditDebitIndicator":"Credit" },{ "Type":["UK.OBIE.BalanceTransfer","UK.OBIE.Cash","UK.OBIE.EstimatedNext","UK.OBIE.Purchase","UK.OBIE.Total"], "Amount":{ "Amount":{ }, "Currency":"Currency" }, "CreditDebitIndicator":"Credit" }], "Type":{ }, "StartDateTime":"2000-01-23T04:56:07.000+00:00", "CreationDateTime":"2000-01-23T04:56:07.000+00:00", "StatementRate":[{ "Type":["UK.OBIE.AnnualBalanceTransfer","UK.OBIE.AnnualBalanceTransferAfterPromo","UK.OBIE.AnnualBalanceTransferPromo","UK.OBIE.AnnualCash","UK.OBIE.AnnualPurchase","UK.OBIE.AnnualPurchaseAfterPromo","UK.OBIE.AnnualPurchasePromo","UK.OBIE.MonthlyBalanceTransfer","UK.OBIE.MonthlyCash","UK.OBIE.MonthlyPurchase"], "Rate":"Rate" },{ "Type":["UK.OBIE.AnnualBalanceTransfer","UK.OBIE.AnnualBalanceTransferAfterPromo","UK.OBIE.AnnualBalanceTransferPromo","UK.OBIE.AnnualCash","UK.OBIE.AnnualPurchase","UK.OBIE.AnnualPurchaseAfterPromo","UK.OBIE.AnnualPurchasePromo","UK.OBIE.MonthlyBalanceTransfer","UK.OBIE.MonthlyCash","UK.OBIE.MonthlyPurchase"], "Rate":"Rate" }], "EndDateTime":"2000-01-23T04:56:07.000+00:00", "StatementId":"StatementId", "StatementValue":[{ "Type":["UK.OBIE.AirMilesPoints","UK.OBIE.AirMilesPointsBalance","UK.OBIE.Credits","UK.OBIE.Debits","UK.OBIE.HotelPoints","UK.OBIE.HotelPointsBalance","UK.OBIE.RetailShoppingPoints","UK.OBIE.RetailShoppingPointsBalance"], "Value":0 },{ "Type":["UK.OBIE.AirMilesPoints","UK.OBIE.AirMilesPointsBalance","UK.OBIE.Credits","UK.OBIE.Debits","UK.OBIE.HotelPoints","UK.OBIE.HotelPointsBalance","UK.OBIE.RetailShoppingPoints","UK.OBIE.RetailShoppingPointsBalance"], "Value":0 }], "StatementBenefit":[{ "Type":["UK.OBIE.Cashback","UK.OBIE.Insurance","UK.OBIE.TravelDiscount","UK.OBIE.TravelInsurance"], "Amount":{ "Amount":{ }, "Currency":"Currency" } },{ "Type":["UK.OBIE.Cashback","UK.OBIE.Insurance","UK.OBIE.TravelDiscount","UK.OBIE.TravelInsurance"], "Amount":{ "Amount":{ }, "Currency":"Currency" } }], "StatementFee":[{ "Type":["UK.OBIE.Annual","UK.OBIE.BalanceTransfer","UK.OBIE.CashAdvance","UK.OBIE.CashTransaction","UK.OBIE.ForeignCashTransaction","UK.OBIE.ForeignTransaction","UK.OBIE.Gambling","UK.OBIE.LatePayment","UK.OBIE.MoneyTransfer","UK.OBIE.Monthly","UK.OBIE.Overlimit","UK.OBIE.PostalOrder","UK.OBIE.PrizeEntry","UK.OBIE.StatementCopy","UK.OBIE.Total"], "Amount":{ "Amount":{ }, "Currency":"Currency" }, "CreditDebitIndicator":"Credit" },{ "Type":["UK.OBIE.Annual","UK.OBIE.BalanceTransfer","UK.OBIE.CashAdvance","UK.OBIE.CashTransaction","UK.OBIE.ForeignCashTransaction","UK.OBIE.ForeignTransaction","UK.OBIE.Gambling","UK.OBIE.LatePayment","UK.OBIE.MoneyTransfer","UK.OBIE.Monthly","UK.OBIE.Overlimit","UK.OBIE.PostalOrder","UK.OBIE.PrizeEntry","UK.OBIE.StatementCopy","UK.OBIE.Total"], "Amount":{ "Amount":{ }, "Currency":"Currency" }, "CreditDebitIndicator":"Credit" }], "StatementDescription":["StatementDescription","StatementDescription"], "StatementAmount":[{ "Type":["UK.OBIE.ArrearsClosingBalance","UK.OBIE.AvailableBalance","UK.OBIE.AverageBalanceWhenInCredit","UK.OBIE.AverageBalanceWhenInDebit","UK.OBIE.AverageDailyBalance","UK.OBIE.BalanceTransferClosingBalance","UK.OBIE.CashClosingBalance","UK.OBIE.ClosingBalance","UK.OBIE.CreditLimit","UK.OBIE.CurrentPayment","UK.OBIE.DirectDebitPaymentDue","UK.OBIE.FSCSInsurance","UK.OBIE.MinimumPaymentDue","UK.OBIE.PendingTransactionsBalance","UK.OBIE.PreviousClosingBalance","UK.OBIE.PreviousPayment","UK.OBIE.PurchaseClosingBalance","UK.OBIE.StartingBalance","UK.OBIE.TotalAdjustments","UK.OBIE.TotalCashAdvances","UK.OBIE.TotalCharges","UK.OBIE.TotalCredits","UK.OBIE.TotalDebits","UK.OBIE.TotalPurchases"], "Amount":{ "Amount":{ }, "Currency":"Currency" }, "CreditDebitIndicator":"Credit" },{ "Type":["UK.OBIE.ArrearsClosingBalance","UK.OBIE.AvailableBalance","UK.OBIE.AverageBalanceWhenInCredit","UK.OBIE.AverageBalanceWhenInDebit","UK.OBIE.AverageDailyBalance","UK.OBIE.BalanceTransferClosingBalance","UK.OBIE.CashClosingBalance","UK.OBIE.ClosingBalance","UK.OBIE.CreditLimit","UK.OBIE.CurrentPayment","UK.OBIE.DirectDebitPaymentDue","UK.OBIE.FSCSInsurance","UK.OBIE.MinimumPaymentDue","UK.OBIE.PendingTransactionsBalance","UK.OBIE.PreviousClosingBalance","UK.OBIE.PreviousPayment","UK.OBIE.PurchaseClosingBalance","UK.OBIE.StartingBalance","UK.OBIE.TotalAdjustments","UK.OBIE.TotalCashAdvances","UK.OBIE.TotalCharges","UK.OBIE.TotalCredits","UK.OBIE.TotalDebits","UK.OBIE.TotalPurchases"], "Amount":{ "Amount":{ }, "Currency":"Currency" }, "CreditDebitIndicator":"Credit" }] }] } }
Headers:

								
									
Possible Errors:
  • OBP-20001: User not logged in. Authentication is required!
  • OBP-50000: Unknown Error.
Implemented in UKv3.1 by getAccountsAccountIdStatementsStatementId

Get Statements

NOTE: This endpoint currently only returns example data.

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":{ "Statement":[{ "AccountId":{ }, "StatementReference":"StatementReference", "StatementDateTime":[{ "Type":["UK.OBIE.BalanceTransferPromoEnd","UK.OBIE.DirectDebitDue","UK.OBIE.LastPayment","UK.OBIE.LastStatement","UK.OBIE.NextStatement","UK.OBIE.PaymentDue","UK.OBIE.PurchasePromoEnd","UK.OBIE.StatementAvailable"], "DateTime":"2000-01-23T04:56:07.000+00:00" },{ "Type":["UK.OBIE.BalanceTransferPromoEnd","UK.OBIE.DirectDebitDue","UK.OBIE.LastPayment","UK.OBIE.LastStatement","UK.OBIE.NextStatement","UK.OBIE.PaymentDue","UK.OBIE.PurchasePromoEnd","UK.OBIE.StatementAvailable"], "DateTime":"2000-01-23T04:56:07.000+00:00" }], "StatementInterest":[{ "Type":["UK.OBIE.BalanceTransfer","UK.OBIE.Cash","UK.OBIE.EstimatedNext","UK.OBIE.Purchase","UK.OBIE.Total"], "Amount":{ "Amount":{ }, "Currency":"Currency" }, "CreditDebitIndicator":"Credit" },{ "Type":["UK.OBIE.BalanceTransfer","UK.OBIE.Cash","UK.OBIE.EstimatedNext","UK.OBIE.Purchase","UK.OBIE.Total"], "Amount":{ "Amount":{ }, "Currency":"Currency" }, "CreditDebitIndicator":"Credit" }], "Type":{ }, "StartDateTime":"2000-01-23T04:56:07.000+00:00", "CreationDateTime":"2000-01-23T04:56:07.000+00:00", "StatementRate":[{ "Type":["UK.OBIE.AnnualBalanceTransfer","UK.OBIE.AnnualBalanceTransferAfterPromo","UK.OBIE.AnnualBalanceTransferPromo","UK.OBIE.AnnualCash","UK.OBIE.AnnualPurchase","UK.OBIE.AnnualPurchaseAfterPromo","UK.OBIE.AnnualPurchasePromo","UK.OBIE.MonthlyBalanceTransfer","UK.OBIE.MonthlyCash","UK.OBIE.MonthlyPurchase"], "Rate":"Rate" },{ "Type":["UK.OBIE.AnnualBalanceTransfer","UK.OBIE.AnnualBalanceTransferAfterPromo","UK.OBIE.AnnualBalanceTransferPromo","UK.OBIE.AnnualCash","UK.OBIE.AnnualPurchase","UK.OBIE.AnnualPurchaseAfterPromo","UK.OBIE.AnnualPurchasePromo","UK.OBIE.MonthlyBalanceTransfer","UK.OBIE.MonthlyCash","UK.OBIE.MonthlyPurchase"], "Rate":"Rate" }], "EndDateTime":"2000-01-23T04:56:07.000+00:00", "StatementId":"StatementId", "StatementValue":[{ "Type":["UK.OBIE.AirMilesPoints","UK.OBIE.AirMilesPointsBalance","UK.OBIE.Credits","UK.OBIE.Debits","UK.OBIE.HotelPoints","UK.OBIE.HotelPointsBalance","UK.OBIE.RetailShoppingPoints","UK.OBIE.RetailShoppingPointsBalance"], "Value":0 },{ "Type":["UK.OBIE.AirMilesPoints","UK.OBIE.AirMilesPointsBalance","UK.OBIE.Credits","UK.OBIE.Debits","UK.OBIE.HotelPoints","UK.OBIE.HotelPointsBalance","UK.OBIE.RetailShoppingPoints","UK.OBIE.RetailShoppingPointsBalance"], "Value":0 }], "StatementBenefit":[{ "Type":["UK.OBIE.Cashback","UK.OBIE.Insurance","UK.OBIE.TravelDiscount","UK.OBIE.TravelInsurance"], "Amount":{ "Amount":{ }, "Currency":"Currency" } },{ "Type":["UK.OBIE.Cashback","UK.OBIE.Insurance","UK.OBIE.TravelDiscount","UK.OBIE.TravelInsurance"], "Amount":{ "Amount":{ }, "Currency":"Currency" } }], "StatementFee":[{ "Type":["UK.OBIE.Annual","UK.OBIE.BalanceTransfer","UK.OBIE.CashAdvance","UK.OBIE.CashTransaction","UK.OBIE.ForeignCashTransaction","UK.OBIE.ForeignTransaction","UK.OBIE.Gambling","UK.OBIE.LatePayment","UK.OBIE.MoneyTransfer","UK.OBIE.Monthly","UK.OBIE.Overlimit","UK.OBIE.PostalOrder","UK.OBIE.PrizeEntry","UK.OBIE.StatementCopy","UK.OBIE.Total"], "Amount":{ "Amount":{ }, "Currency":"Currency" }, "CreditDebitIndicator":"Credit" },{ "Type":["UK.OBIE.Annual","UK.OBIE.BalanceTransfer","UK.OBIE.CashAdvance","UK.OBIE.CashTransaction","UK.OBIE.ForeignCashTransaction","UK.OBIE.ForeignTransaction","UK.OBIE.Gambling","UK.OBIE.LatePayment","UK.OBIE.MoneyTransfer","UK.OBIE.Monthly","UK.OBIE.Overlimit","UK.OBIE.PostalOrder","UK.OBIE.PrizeEntry","UK.OBIE.StatementCopy","UK.OBIE.Total"], "Amount":{ "Amount":{ }, "Currency":"Currency" }, "CreditDebitIndicator":"Credit" }], "StatementDescription":["StatementDescription","StatementDescription"], "StatementAmount":[{ "Type":["UK.OBIE.ArrearsClosingBalance","UK.OBIE.AvailableBalance","UK.OBIE.AverageBalanceWhenInCredit","UK.OBIE.AverageBalanceWhenInDebit","UK.OBIE.AverageDailyBalance","UK.OBIE.BalanceTransferClosingBalance","UK.OBIE.CashClosingBalance","UK.OBIE.ClosingBalance","UK.OBIE.CreditLimit","UK.OBIE.CurrentPayment","UK.OBIE.DirectDebitPaymentDue","UK.OBIE.FSCSInsurance","UK.OBIE.MinimumPaymentDue","UK.OBIE.PendingTransactionsBalance","UK.OBIE.PreviousClosingBalance","UK.OBIE.PreviousPayment","UK.OBIE.PurchaseClosingBalance","UK.OBIE.StartingBalance","UK.OBIE.TotalAdjustments","UK.OBIE.TotalCashAdvances","UK.OBIE.TotalCharges","UK.OBIE.TotalCredits","UK.OBIE.TotalDebits","UK.OBIE.TotalPurchases"], "Amount":{ "Amount":{ }, "Currency":"Currency" }, "CreditDebitIndicator":"Credit" },{ "Type":["UK.OBIE.ArrearsClosingBalance","UK.OBIE.AvailableBalance","UK.OBIE.AverageBalanceWhenInCredit","UK.OBIE.AverageBalanceWhenInDebit","UK.OBIE.AverageDailyBalance","UK.OBIE.BalanceTransferClosingBalance","UK.OBIE.CashClosingBalance","UK.OBIE.ClosingBalance","UK.OBIE.CreditLimit","UK.OBIE.CurrentPayment","UK.OBIE.DirectDebitPaymentDue","UK.OBIE.FSCSInsurance","UK.OBIE.MinimumPaymentDue","UK.OBIE.PendingTransactionsBalance","UK.OBIE.PreviousClosingBalance","UK.OBIE.PreviousPayment","UK.OBIE.PurchaseClosingBalance","UK.OBIE.StartingBalance","UK.OBIE.TotalAdjustments","UK.OBIE.TotalCashAdvances","UK.OBIE.TotalCharges","UK.OBIE.TotalCredits","UK.OBIE.TotalDebits","UK.OBIE.TotalPurchases"], "Amount":{ "Amount":{ }, "Currency":"Currency" }, "CreditDebitIndicator":"Credit" }] },{ "AccountId":{ }, "StatementReference":"StatementReference", "StatementDateTime":[{ "Type":["UK.OBIE.BalanceTransferPromoEnd","UK.OBIE.DirectDebitDue","UK.OBIE.LastPayment","UK.OBIE.LastStatement","UK.OBIE.NextStatement","UK.OBIE.PaymentDue","UK.OBIE.PurchasePromoEnd","UK.OBIE.StatementAvailable"], "DateTime":"2000-01-23T04:56:07.000+00:00" },{ "Type":["UK.OBIE.BalanceTransferPromoEnd","UK.OBIE.DirectDebitDue","UK.OBIE.LastPayment","UK.OBIE.LastStatement","UK.OBIE.NextStatement","UK.OBIE.PaymentDue","UK.OBIE.PurchasePromoEnd","UK.OBIE.StatementAvailable"], "DateTime":"2000-01-23T04:56:07.000+00:00" }], "StatementInterest":[{ "Type":["UK.OBIE.BalanceTransfer","UK.OBIE.Cash","UK.OBIE.EstimatedNext","UK.OBIE.Purchase","UK.OBIE.Total"], "Amount":{ "Amount":{ }, "Currency":"Currency" }, "CreditDebitIndicator":"Credit" },{ "Type":["UK.OBIE.BalanceTransfer","UK.OBIE.Cash","UK.OBIE.EstimatedNext","UK.OBIE.Purchase","UK.OBIE.Total"], "Amount":{ "Amount":{ }, "Currency":"Currency" }, "CreditDebitIndicator":"Credit" }], "Type":{ }, "StartDateTime":"2000-01-23T04:56:07.000+00:00", "CreationDateTime":"2000-01-23T04:56:07.000+00:00", "StatementRate":[{ "Type":["UK.OBIE.AnnualBalanceTransfer","UK.OBIE.AnnualBalanceTransferAfterPromo","UK.OBIE.AnnualBalanceTransferPromo","UK.OBIE.AnnualCash","UK.OBIE.AnnualPurchase","UK.OBIE.AnnualPurchaseAfterPromo","UK.OBIE.AnnualPurchasePromo","UK.OBIE.MonthlyBalanceTransfer","UK.OBIE.MonthlyCash","UK.OBIE.MonthlyPurchase"], "Rate":"Rate" },{ "Type":["UK.OBIE.AnnualBalanceTransfer","UK.OBIE.AnnualBalanceTransferAfterPromo","UK.OBIE.AnnualBalanceTransferPromo","UK.OBIE.AnnualCash","UK.OBIE.AnnualPurchase","UK.OBIE.AnnualPurchaseAfterPromo","UK.OBIE.AnnualPurchasePromo","UK.OBIE.MonthlyBalanceTransfer","UK.OBIE.MonthlyCash","UK.OBIE.MonthlyPurchase"], "Rate":"Rate" }], "EndDateTime":"2000-01-23T04:56:07.000+00:00", "StatementId":"StatementId", "StatementValue":[{ "Type":["UK.OBIE.AirMilesPoints","UK.OBIE.AirMilesPointsBalance","UK.OBIE.Credits","UK.OBIE.Debits","UK.OBIE.HotelPoints","UK.OBIE.HotelPointsBalance","UK.OBIE.RetailShoppingPoints","UK.OBIE.RetailShoppingPointsBalance"], "Value":0 },{ "Type":["UK.OBIE.AirMilesPoints","UK.OBIE.AirMilesPointsBalance","UK.OBIE.Credits","UK.OBIE.Debits","UK.OBIE.HotelPoints","UK.OBIE.HotelPointsBalance","UK.OBIE.RetailShoppingPoints","UK.OBIE.RetailShoppingPointsBalance"], "Value":0 }], "StatementBenefit":[{ "Type":["UK.OBIE.Cashback","UK.OBIE.Insurance","UK.OBIE.TravelDiscount","UK.OBIE.TravelInsurance"], "Amount":{ "Amount":{ }, "Currency":"Currency" } },{ "Type":["UK.OBIE.Cashback","UK.OBIE.Insurance","UK.OBIE.TravelDiscount","UK.OBIE.TravelInsurance"], "Amount":{ "Amount":{ }, "Currency":"Currency" } }], "StatementFee":[{ "Type":["UK.OBIE.Annual","UK.OBIE.BalanceTransfer","UK.OBIE.CashAdvance","UK.OBIE.CashTransaction","UK.OBIE.ForeignCashTransaction","UK.OBIE.ForeignTransaction","UK.OBIE.Gambling","UK.OBIE.LatePayment","UK.OBIE.MoneyTransfer","UK.OBIE.Monthly","UK.OBIE.Overlimit","UK.OBIE.PostalOrder","UK.OBIE.PrizeEntry","UK.OBIE.StatementCopy","UK.OBIE.Total"], "Amount":{ "Amount":{ }, "Currency":"Currency" }, "CreditDebitIndicator":"Credit" },{ "Type":["UK.OBIE.Annual","UK.OBIE.BalanceTransfer","UK.OBIE.CashAdvance","UK.OBIE.CashTransaction","UK.OBIE.ForeignCashTransaction","UK.OBIE.ForeignTransaction","UK.OBIE.Gambling","UK.OBIE.LatePayment","UK.OBIE.MoneyTransfer","UK.OBIE.Monthly","UK.OBIE.Overlimit","UK.OBIE.PostalOrder","UK.OBIE.PrizeEntry","UK.OBIE.StatementCopy","UK.OBIE.Total"], "Amount":{ "Amount":{ }, "Currency":"Currency" }, "CreditDebitIndicator":"Credit" }], "StatementDescription":["StatementDescription","StatementDescription"], "StatementAmount":[{ "Type":["UK.OBIE.ArrearsClosingBalance","UK.OBIE.AvailableBalance","UK.OBIE.AverageBalanceWhenInCredit","UK.OBIE.AverageBalanceWhenInDebit","UK.OBIE.AverageDailyBalance","UK.OBIE.BalanceTransferClosingBalance","UK.OBIE.CashClosingBalance","UK.OBIE.ClosingBalance","UK.OBIE.CreditLimit","UK.OBIE.CurrentPayment","UK.OBIE.DirectDebitPaymentDue","UK.OBIE.FSCSInsurance","UK.OBIE.MinimumPaymentDue","UK.OBIE.PendingTransactionsBalance","UK.OBIE.PreviousClosingBalance","UK.OBIE.PreviousPayment","UK.OBIE.PurchaseClosingBalance","UK.OBIE.StartingBalance","UK.OBIE.TotalAdjustments","UK.OBIE.TotalCashAdvances","UK.OBIE.TotalCharges","UK.OBIE.TotalCredits","UK.OBIE.TotalDebits","UK.OBIE.TotalPurchases"], "Amount":{ "Amount":{ }, "Currency":"Currency" }, "CreditDebitIndicator":"Credit" },{ "Type":["UK.OBIE.ArrearsClosingBalance","UK.OBIE.AvailableBalance","UK.OBIE.AverageBalanceWhenInCredit","UK.OBIE.AverageBalanceWhenInDebit","UK.OBIE.AverageDailyBalance","UK.OBIE.BalanceTransferClosingBalance","UK.OBIE.CashClosingBalance","UK.OBIE.ClosingBalance","UK.OBIE.CreditLimit","UK.OBIE.CurrentPayment","UK.OBIE.DirectDebitPaymentDue","UK.OBIE.FSCSInsurance","UK.OBIE.MinimumPaymentDue","UK.OBIE.PendingTransactionsBalance","UK.OBIE.PreviousClosingBalance","UK.OBIE.PreviousPayment","UK.OBIE.PurchaseClosingBalance","UK.OBIE.StartingBalance","UK.OBIE.TotalAdjustments","UK.OBIE.TotalCashAdvances","UK.OBIE.TotalCharges","UK.OBIE.TotalCredits","UK.OBIE.TotalDebits","UK.OBIE.TotalPurchases"], "Amount":{ "Amount":{ }, "Currency":"Currency" }, "CreditDebitIndicator":"Credit" }] }] } }
Headers:

								
									
Possible Errors:
  • OBP-20001: User not logged in. Authentication is required!
  • OBP-50000: Unknown Error.
Implemented in UKv3.1 by getStatements

Get Transactions

NOTE: This endpoint currently only returns example data.

Typical Successful Response:

								
									
{ "Meta":{ "FirstAvailableDateTime":"2019-03-06T07:38:51.169Z", "LastAvailableDateTime":"2019-03-06T07:38:51.169Z", "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":{ "Transaction":[{ "Status":"string", "SupplementaryData":{ }, "CreditorAgent":{ "PostalAddress":{ "StreetName":"StreetName", "CountrySubDivision":"CountrySubDivision", "Department":"Department", "AddressLine":["AddressLine","AddressLine","AddressLine","AddressLine","AddressLine","AddressLine","AddressLine"], "BuildingNumber":"BuildingNumber", "TownName":"TownName", "Country":"Country", "SubDepartment":"SubDepartment", "AddressType":"string", "PostCode":"PostCode" }, "SchemeName":["UK.OBIE.BICFI"], "Identification":"Identification", "Name":"Name" }, "DebtorAccount":{ "SecondaryIdentification":"SecondaryIdentification", "SchemeName":["UK.OBIE.BBAN","UK.OBIE.IBAN","UK.OBIE.PAN","UK.OBIE.Paym","UK.OBIE.SortCodeAccountNumber"], "Identification":"Identification", "Name":"Name" }, "AccountId":"string", "TransactionReference":"TransactionReference", "ProprietaryBankTransactionCode":{ "Issuer":"Issuer", "Code":"Code" }, "AddressLine":"AddressLine", "Amount":{ "Amount":"string", "Currency":"Currency" }, "CreditorAccount":{ "SecondaryIdentification":"SecondaryIdentification", "SchemeName":["UK.OBIE.BBAN","UK.OBIE.IBAN","UK.OBIE.PAN","UK.OBIE.Paym","UK.OBIE.SortCodeAccountNumber"], "Identification":"Identification", "Name":"Name" }, "CreditDebitIndicator":"Credit", "CurrencyExchange":{ "SourceCurrency":"SourceCurrency", "ExchangeRate":0.8008281904610115, "QuotationDate":"2000-01-23T04:56:07.000+00:00", "UnitCurrency":"UnitCurrency", "ContractIdentification":"ContractIdentification", "InstructedAmount":{ "Amount":"string", "Currency":"Currency" }, "TargetCurrency":"TargetCurrency" }, "StatementReference":["StatementReference","StatementReference"], "ChargeAmount":{ "Amount":"string", "Currency":"Currency" }, "TransactionId":"TransactionId", "TransactionInformation":"string", "BookingDateTime":"2000-01-23T04:56:07.000+00:00", "BankTransactionCode":{ "SubCode":"SubCode", "Code":"Code" }, "MerchantDetails":{ "MerchantName":"MerchantName", "MerchantCategoryCode":"MerchantCategoryCode" }, "CardInstrument":{ "AuthorisationType":"string", "Identification":"Identification", "CardSchemeName":"string", "Name":"Name" }, "ValueDateTime":"2000-01-23T04:56:07.000+00:00", "DebtorAgent":{ "PostalAddress":{ "StreetName":"StreetName", "CountrySubDivision":"CountrySubDivision", "Department":"Department", "AddressLine":["AddressLine","AddressLine","AddressLine","AddressLine","AddressLine","AddressLine","AddressLine"], "BuildingNumber":"BuildingNumber", "TownName":"TownName", "Country":"Country", "SubDepartment":"SubDepartment", "AddressType":"string", "PostCode":"PostCode" }, "SchemeName":["UK.OBIE.BICFI"], "Identification":"Identification", "Name":"Name" }, "Balance":{ "Type":"string", "Amount":{ "Amount":"string", "Currency":"Currency" }, "CreditDebitIndicator":"Credit" } },{ "Status":"string", "SupplementaryData":{ }, "CreditorAgent":{ "PostalAddress":{ "StreetName":"StreetName", "CountrySubDivision":"CountrySubDivision", "Department":"Department", "AddressLine":["AddressLine","AddressLine","AddressLine","AddressLine","AddressLine","AddressLine","AddressLine"], "BuildingNumber":"BuildingNumber", "TownName":"TownName", "Country":"Country", "SubDepartment":"SubDepartment", "AddressType":"string", "PostCode":"PostCode" }, "SchemeName":["UK.OBIE.BICFI"], "Identification":"Identification", "Name":"Name" }, "DebtorAccount":{ "SecondaryIdentification":"SecondaryIdentification", "SchemeName":["UK.OBIE.BBAN","UK.OBIE.IBAN","UK.OBIE.PAN","UK.OBIE.Paym","UK.OBIE.SortCodeAccountNumber"], "Identification":"Identification", "Name":"Name" }, "AccountId":"string", "TransactionReference":"TransactionReference", "ProprietaryBankTransactionCode":{ "Issuer":"Issuer", "Code":"Code" }, "AddressLine":"AddressLine", "Amount":{ "Amount":"string", "Currency":"Currency" }, "CreditorAccount":{ "SecondaryIdentification":"SecondaryIdentification", "SchemeName":["UK.OBIE.BBAN","UK.OBIE.IBAN","UK.OBIE.PAN","UK.OBIE.Paym","UK.OBIE.SortCodeAccountNumber"], "Identification":"Identification", "Name":"Name" }, "CreditDebitIndicator":"Credit", "CurrencyExchange":{ "SourceCurrency":"SourceCurrency", "ExchangeRate":0.8008281904610115, "QuotationDate":"2000-01-23T04:56:07.000+00:00", "UnitCurrency":"UnitCurrency", "ContractIdentification":"ContractIdentification", "InstructedAmount":{ "Amount":"string", "Currency":"Currency" }, "TargetCurrency":"TargetCurrency" }, "StatementReference":["StatementReference","StatementReference"], "ChargeAmount":{ "Amount":"string", "Currency":"Currency" }, "TransactionId":"TransactionId", "TransactionInformation":"string", "BookingDateTime":"2000-01-23T04:56:07.000+00:00", "BankTransactionCode":{ "SubCode":"SubCode", "Code":"Code" }, "MerchantDetails":{ "MerchantName":"MerchantName", "MerchantCategoryCode":"MerchantCategoryCode" }, "CardInstrument":{ "AuthorisationType":"string", "Identification":"Identification", "CardSchemeName":"string", "Name":"Name" }, "ValueDateTime":"2000-01-23T04:56:07.000+00:00", "DebtorAgent":{ "PostalAddress":{ "StreetName":"StreetName", "CountrySubDivision":"CountrySubDivision", "Department":"Department", "AddressLine":["AddressLine","AddressLine","AddressLine","AddressLine","AddressLine","AddressLine","AddressLine"], "BuildingNumber":"BuildingNumber", "TownName":"TownName", "Country":"Country", "SubDepartment":"SubDepartment", "AddressType":"string", "PostCode":"PostCode" }, "SchemeName":["UK.OBIE.BICFI"], "Identification":"Identification", "Name":"Name" }, "Balance":{ "Type":"string", "Amount":{ "Amount":"string", "Currency":"Currency" }, "CreditDebitIndicator":"Credit" } }] } }
Headers:

								
									
Possible Errors:
  • OBP-20001: User not logged in. Authentication is required!
  • OBP-50000: Unknown Error.
Implemented in UKv3.1 by getAccountsAccountIdStatementsStatementIdTransactions

Get Transactions

NOTE: This endpoint currently only returns example data.

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":{ "Transaction":[{ "Status":{ }, "SupplementaryData":{ }, "CreditorAgent":{ "PostalAddress":{ "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" }, "SchemeName":["UK.OBIE.BICFI"], "Identification":"Identification", "Name":"Name" }, "DebtorAccount":{ "SecondaryIdentification":"SecondaryIdentification", "SchemeName":["UK.OBIE.BBAN","UK.OBIE.IBAN","UK.OBIE.PAN","UK.OBIE.Paym","UK.OBIE.SortCodeAccountNumber"], "Identification":"Identification", "Name":"Name" }, "AccountId":{ }, "TransactionReference":"TransactionReference", "ProprietaryBankTransactionCode":{ "Issuer":"Issuer", "Code":"Code" }, "AddressLine":"AddressLine", "Amount":{ "Amount":{ }, "Currency":"Currency" }, "CreditorAccount":{ "SecondaryIdentification":"SecondaryIdentification", "SchemeName":["UK.OBIE.BBAN","UK.OBIE.IBAN","UK.OBIE.PAN","UK.OBIE.Paym","UK.OBIE.SortCodeAccountNumber"], "Identification":"Identification", "Name":"Name" }, "CreditDebitIndicator":"Credit", "CurrencyExchange":{ "SourceCurrency":"SourceCurrency", "ExchangeRate":0.8008281904610115, "QuotationDate":"2000-01-23T04:56:07.000+00:00", "UnitCurrency":"UnitCurrency", "ContractIdentification":"ContractIdentification", "InstructedAmount":{ "Amount":{ }, "Currency":"Currency" }, "TargetCurrency":"TargetCurrency" }, "StatementReference":["StatementReference","StatementReference"], "ChargeAmount":{ "Amount":{ }, "Currency":"Currency" }, "TransactionId":"TransactionId", "TransactionInformation":{ }, "BookingDateTime":"2000-01-23T04:56:07.000+00:00", "BankTransactionCode":{ "SubCode":"SubCode", "Code":"Code" }, "MerchantDetails":{ "MerchantName":"MerchantName", "MerchantCategoryCode":"MerchantCategoryCode" }, "CardInstrument":{ "AuthorisationType":{ }, "Identification":"Identification", "CardSchemeName":{ }, "Name":"Name" }, "ValueDateTime":"2000-01-23T04:56:07.000+00:00", "DebtorAgent":{ "PostalAddress":{ "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" }, "SchemeName":["UK.OBIE.BICFI"], "Identification":"Identification", "Name":"Name" }, "Balance":{ "Type":{ }, "Amount":{ "Amount":{ }, "Currency":"Currency" }, "CreditDebitIndicator":"Credit" } },{ "Status":{ }, "SupplementaryData":{ }, "CreditorAgent":{ "PostalAddress":{ "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" }, "SchemeName":["UK.OBIE.BICFI"], "Identification":"Identification", "Name":"Name" }, "DebtorAccount":{ "SecondaryIdentification":"SecondaryIdentification", "SchemeName":["UK.OBIE.BBAN","UK.OBIE.IBAN","UK.OBIE.PAN","UK.OBIE.Paym","UK.OBIE.SortCodeAccountNumber"], "Identification":"Identification", "Name":"Name" }, "AccountId":{ }, "TransactionReference":"TransactionReference", "ProprietaryBankTransactionCode":{ "Issuer":"Issuer", "Code":"Code" }, "AddressLine":"AddressLine", "Amount":{ "Amount":{ }, "Currency":"Currency" }, "CreditorAccount":{ "SecondaryIdentification":"SecondaryIdentification", "SchemeName":["UK.OBIE.BBAN","UK.OBIE.IBAN","UK.OBIE.PAN","UK.OBIE.Paym","UK.OBIE.SortCodeAccountNumber"], "Identification":"Identification", "Name":"Name" }, "CreditDebitIndicator":"Credit", "CurrencyExchange":{ "SourceCurrency":"SourceCurrency", "ExchangeRate":0.8008281904610115, "QuotationDate":"2000-01-23T04:56:07.000+00:00", "UnitCurrency":"UnitCurrency", "ContractIdentification":"ContractIdentification", "InstructedAmount":{ "Amount":{ }, "Currency":"Currency" }, "TargetCurrency":"TargetCurrency" }, "StatementReference":["StatementReference","StatementReference"], "ChargeAmount":{ "Amount":{ }, "Currency":"Currency" }, "TransactionId":"TransactionId", "TransactionInformation":{ }, "BookingDateTime":"2000-01-23T04:56:07.000+00:00", "BankTransactionCode":{ "SubCode":"SubCode", "Code":"Code" }, "MerchantDetails":{ "MerchantName":"MerchantName", "MerchantCategoryCode":"MerchantCategoryCode" }, "CardInstrument":{ "AuthorisationType":{ }, "Identification":"Identification", "CardSchemeName":{ }, "Name":"Name" }, "ValueDateTime":"2000-01-23T04:56:07.000+00:00", "DebtorAgent":{ "PostalAddress":{ "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" }, "SchemeName":["UK.OBIE.BICFI"], "Identification":"Identification", "Name":"Name" }, "Balance":{ "Type":{ }, "Amount":{ "Amount":{ }, "Currency":"Currency" }, "CreditDebitIndicator":"Credit" } }] } }
Headers:

								
									
Possible Errors:
  • OBP-20001: User not logged in. Authentication is required!
  • OBP-50000: Unknown Error.
Implemented in UKv3.1 by getAccountsAccountIdStatementsStatementIdTransactions

Get Transactions

Typical Successful Response:

								
									
{ "Meta":{ "FirstAvailableDateTime":"2019-03-06T07:38:51.169Z", "LastAvailableDateTime":"2019-03-06T07:38:51.169Z", "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":{ "Transaction":[{ "Status":"string", "SupplementaryData":{ }, "CreditorAgent":{ "PostalAddress":{ "StreetName":"StreetName", "CountrySubDivision":"CountrySubDivision", "Department":"Department", "AddressLine":["AddressLine","AddressLine","AddressLine","AddressLine","AddressLine","AddressLine","AddressLine"], "BuildingNumber":"BuildingNumber", "TownName":"TownName", "Country":"Country", "SubDepartment":"SubDepartment", "AddressType":"string", "PostCode":"PostCode" }, "SchemeName":["UK.OBIE.BICFI"], "Identification":"Identification", "Name":"Name" }, "DebtorAccount":{ "SecondaryIdentification":"SecondaryIdentification", "SchemeName":["UK.OBIE.BBAN","UK.OBIE.IBAN","UK.OBIE.PAN","UK.OBIE.Paym","UK.OBIE.SortCodeAccountNumber"], "Identification":"Identification", "Name":"Name" }, "AccountId":"string", "TransactionReference":"TransactionReference", "ProprietaryBankTransactionCode":{ "Issuer":"Issuer", "Code":"Code" }, "AddressLine":"AddressLine", "Amount":{ "Amount":"string", "Currency":"Currency" }, "CreditorAccount":{ "SecondaryIdentification":"SecondaryIdentification", "SchemeName":["UK.OBIE.BBAN","UK.OBIE.IBAN","UK.OBIE.PAN","UK.OBIE.Paym","UK.OBIE.SortCodeAccountNumber"], "Identification":"Identification", "Name":"Name" }, "CreditDebitIndicator":"Credit", "CurrencyExchange":{ "SourceCurrency":"SourceCurrency", "ExchangeRate":0.8008281904610115, "QuotationDate":"2000-01-23T04:56:07.000+00:00", "UnitCurrency":"UnitCurrency", "ContractIdentification":"ContractIdentification", "InstructedAmount":{ "Amount":"string", "Currency":"Currency" }, "TargetCurrency":"TargetCurrency" }, "StatementReference":["StatementReference","StatementReference"], "ChargeAmount":{ "Amount":"string", "Currency":"Currency" }, "TransactionId":"TransactionId", "TransactionInformation":"string", "BookingDateTime":"2000-01-23T04:56:07.000+00:00", "BankTransactionCode":{ "SubCode":"SubCode", "Code":"Code" }, "MerchantDetails":{ "MerchantName":"MerchantName", "MerchantCategoryCode":"MerchantCategoryCode" }, "CardInstrument":{ "AuthorisationType":"string", "Identification":"Identification", "CardSchemeName":"string", "Name":"Name" }, "ValueDateTime":"2000-01-23T04:56:07.000+00:00", "DebtorAgent":{ "PostalAddress":{ "StreetName":"StreetName", "CountrySubDivision":"CountrySubDivision", "Department":"Department", "AddressLine":["AddressLine","AddressLine","AddressLine","AddressLine","AddressLine","AddressLine","AddressLine"], "BuildingNumber":"BuildingNumber", "TownName":"TownName", "Country":"Country", "SubDepartment":"SubDepartment", "AddressType":"string", "PostCode":"PostCode" }, "SchemeName":["UK.OBIE.BICFI"], "Identification":"Identification", "Name":"Name" }, "Balance":{ "Type":"string", "Amount":{ "Amount":"string", "Currency":"Currency" }, "CreditDebitIndicator":"Credit" } },{ "Status":"string", "SupplementaryData":{ }, "CreditorAgent":{ "PostalAddress":{ "StreetName":"StreetName", "CountrySubDivision":"CountrySubDivision", "Department":"Department", "AddressLine":["AddressLine","AddressLine","AddressLine","AddressLine","AddressLine","AddressLine","AddressLine"], "BuildingNumber":"BuildingNumber", "TownName":"TownName", "Country":"Country", "SubDepartment":"SubDepartment", "AddressType":"string", "PostCode":"PostCode" }, "SchemeName":["UK.OBIE.BICFI"], "Identification":"Identification", "Name":"Name" }, "DebtorAccount":{ "SecondaryIdentification":"SecondaryIdentification", "SchemeName":["UK.OBIE.BBAN","UK.OBIE.IBAN","UK.OBIE.PAN","UK.OBIE.Paym","UK.OBIE.SortCodeAccountNumber"], "Identification":"Identification", "Name":"Name" }, "AccountId":"string", "TransactionReference":"TransactionReference", "ProprietaryBankTransactionCode":{ "Issuer":"Issuer", "Code":"Code" }, "AddressLine":"AddressLine", "Amount":{ "Amount":"string", "Currency":"Currency" }, "CreditorAccount":{ "SecondaryIdentification":"SecondaryIdentification", "SchemeName":["UK.OBIE.BBAN","UK.OBIE.IBAN","UK.OBIE.PAN","UK.OBIE.Paym","UK.OBIE.SortCodeAccountNumber"], "Identification":"Identification", "Name":"Name" }, "CreditDebitIndicator":"Credit", "CurrencyExchange":{ "SourceCurrency":"SourceCurrency", "ExchangeRate":0.8008281904610115, "QuotationDate":"2000-01-23T04:56:07.000+00:00", "UnitCurrency":"UnitCurrency", "ContractIdentification":"ContractIdentification", "InstructedAmount":{ "Amount":"string", "Currency":"Currency" }, "TargetCurrency":"TargetCurrency" }, "StatementReference":["StatementReference","StatementReference"], "ChargeAmount":{ "Amount":"string", "Currency":"Currency" }, "TransactionId":"TransactionId", "TransactionInformation":"string", "BookingDateTime":"2000-01-23T04:56:07.000+00:00", "BankTransactionCode":{ "SubCode":"SubCode", "Code":"Code" }, "MerchantDetails":{ "MerchantName":"MerchantName", "MerchantCategoryCode":"MerchantCategoryCode" }, "CardInstrument":{ "AuthorisationType":"string", "Identification":"Identification", "CardSchemeName":"string", "Name":"Name" }, "ValueDateTime":"2000-01-23T04:56:07.000+00:00", "DebtorAgent":{ "PostalAddress":{ "StreetName":"StreetName", "CountrySubDivision":"CountrySubDivision", "Department":"Department", "AddressLine":["AddressLine","AddressLine","AddressLine","AddressLine","AddressLine","AddressLine","AddressLine"], "BuildingNumber":"BuildingNumber", "TownName":"TownName", "Country":"Country", "SubDepartment":"SubDepartment", "AddressType":"string", "PostCode":"PostCode" }, "SchemeName":["UK.OBIE.BICFI"], "Identification":"Identification", "Name":"Name" }, "Balance":{ "Type":"string", "Amount":{ "Amount":"string", "Currency":"Currency" }, "CreditDebitIndicator":"Credit" } }] } }
Headers:

								
									
Possible Errors:
  • OBP-20001: User not logged in. Authentication is required!
  • OBP-50000: Unknown Error.
Implemented in UKv3.1 by getAccountsAccountIdTransactions

Get Transactions

Typical Successful Response:

								
									
{ "Meta":{ "FirstAvailableDateTime":"2019-03-06T07:38:51.169Z", "LastAvailableDateTime":"2019-03-06T07:38:51.169Z", "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":{ "Transaction":[{ "Status":"string", "SupplementaryData":{ }, "CreditorAgent":{ "PostalAddress":{ "StreetName":"StreetName", "CountrySubDivision":"CountrySubDivision", "Department":"Department", "AddressLine":["AddressLine","AddressLine","AddressLine","AddressLine","AddressLine","AddressLine","AddressLine"], "BuildingNumber":"BuildingNumber", "TownName":"TownName", "Country":"Country", "SubDepartment":"SubDepartment", "AddressType":"string", "PostCode":"PostCode" }, "SchemeName":["UK.OBIE.BICFI"], "Identification":"Identification", "Name":"Name" }, "DebtorAccount":{ "SecondaryIdentification":"SecondaryIdentification", "SchemeName":["UK.OBIE.BBAN","UK.OBIE.IBAN","UK.OBIE.PAN","UK.OBIE.Paym","UK.OBIE.SortCodeAccountNumber"], "Identification":"Identification", "Name":"Name" }, "AccountId":"string", "TransactionReference":"TransactionReference", "ProprietaryBankTransactionCode":{ "Issuer":"Issuer", "Code":"Code" }, "AddressLine":"AddressLine", "Amount":{ "Amount":"string", "Currency":"Currency" }, "CreditorAccount":{ "SecondaryIdentification":"SecondaryIdentification", "SchemeName":["UK.OBIE.BBAN","UK.OBIE.IBAN","UK.OBIE.PAN","UK.OBIE.Paym","UK.OBIE.SortCodeAccountNumber"], "Identification":"Identification", "Name":"Name" }, "CreditDebitIndicator":"Credit", "CurrencyExchange":{ "SourceCurrency":"SourceCurrency", "ExchangeRate":0.8008281904610115, "QuotationDate":"2000-01-23T04:56:07.000+00:00", "UnitCurrency":"UnitCurrency", "ContractIdentification":"ContractIdentification", "InstructedAmount":{ "Amount":"string", "Currency":"Currency" }, "TargetCurrency":"TargetCurrency" }, "StatementReference":["StatementReference","StatementReference"], "ChargeAmount":{ "Amount":"string", "Currency":"Currency" }, "TransactionId":"TransactionId", "TransactionInformation":"string", "BookingDateTime":"2000-01-23T04:56:07.000+00:00", "BankTransactionCode":{ "SubCode":"SubCode", "Code":"Code" }, "MerchantDetails":{ "MerchantName":"MerchantName", "MerchantCategoryCode":"MerchantCategoryCode" }, "CardInstrument":{ "AuthorisationType":"string", "Identification":"Identification", "CardSchemeName":"string", "Name":"Name" }, "ValueDateTime":"2000-01-23T04:56:07.000+00:00", "DebtorAgent":{ "PostalAddress":{ "StreetName":"StreetName", "CountrySubDivision":"CountrySubDivision", "Department":"Department", "AddressLine":["AddressLine","AddressLine","AddressLine","AddressLine","AddressLine","AddressLine","AddressLine"], "BuildingNumber":"BuildingNumber", "TownName":"TownName", "Country":"Country", "SubDepartment":"SubDepartment", "AddressType":"string", "PostCode":"PostCode" }, "SchemeName":["UK.OBIE.BICFI"], "Identification":"Identification", "Name":"Name" }, "Balance":{ "Type":"string", "Amount":{ "Amount":"string", "Currency":"Currency" }, "CreditDebitIndicator":"Credit" } },{ "Status":"string", "SupplementaryData":{ }, "CreditorAgent":{ "PostalAddress":{ "StreetName":"StreetName", "CountrySubDivision":"CountrySubDivision", "Department":"Department", "AddressLine":["AddressLine","AddressLine","AddressLine","AddressLine","AddressLine","AddressLine","AddressLine"], "BuildingNumber":"BuildingNumber", "TownName":"TownName", "Country":"Country", "SubDepartment":"SubDepartment", "AddressType":"string", "PostCode":"PostCode" }, "SchemeName":["UK.OBIE.BICFI"], "Identification":"Identification", "Name":"Name" }, "DebtorAccount":{ "SecondaryIdentification":"SecondaryIdentification", "SchemeName":["UK.OBIE.BBAN","UK.OBIE.IBAN","UK.OBIE.PAN","UK.OBIE.Paym","UK.OBIE.SortCodeAccountNumber"], "Identification":"Identification", "Name":"Name" }, "AccountId":"string", "TransactionReference":"TransactionReference", "ProprietaryBankTransactionCode":{ "Issuer":"Issuer", "Code":"Code" }, "AddressLine":"AddressLine", "Amount":{ "Amount":"string", "Currency":"Currency" }, "CreditorAccount":{ "SecondaryIdentification":"SecondaryIdentification", "SchemeName":["UK.OBIE.BBAN","UK.OBIE.IBAN","UK.OBIE.PAN","UK.OBIE.Paym","UK.OBIE.SortCodeAccountNumber"], "Identification":"Identification", "Name":"Name" }, "CreditDebitIndicator":"Credit", "CurrencyExchange":{ "SourceCurrency":"SourceCurrency", "ExchangeRate":0.8008281904610115, "QuotationDate":"2000-01-23T04:56:07.000+00:00", "UnitCurrency":"UnitCurrency", "ContractIdentification":"ContractIdentification", "InstructedAmount":{ "Amount":"string", "Currency":"Currency" }, "TargetCurrency":"TargetCurrency" }, "StatementReference":["StatementReference","StatementReference"], "ChargeAmount":{ "Amount":"string", "Currency":"Currency" }, "TransactionId":"TransactionId", "TransactionInformation":"string", "BookingDateTime":"2000-01-23T04:56:07.000+00:00", "BankTransactionCode":{ "SubCode":"SubCode", "Code":"Code" }, "MerchantDetails":{ "MerchantName":"MerchantName", "MerchantCategoryCode":"MerchantCategoryCode" }, "CardInstrument":{ "AuthorisationType":"string", "Identification":"Identification", "CardSchemeName":"string", "Name":"Name" }, "ValueDateTime":"2000-01-23T04:56:07.000+00:00", "DebtorAgent":{ "PostalAddress":{ "StreetName":"StreetName", "CountrySubDivision":"CountrySubDivision", "Department":"Department", "AddressLine":["AddressLine","AddressLine","AddressLine","AddressLine","AddressLine","AddressLine","AddressLine"], "BuildingNumber":"BuildingNumber", "TownName":"TownName", "Country":"Country", "SubDepartment":"SubDepartment", "AddressType":"string", "PostCode":"PostCode" }, "SchemeName":["UK.OBIE.BICFI"], "Identification":"Identification", "Name":"Name" }, "Balance":{ "Type":"string", "Amount":{ "Amount":"string", "Currency":"Currency" }, "CreditDebitIndicator":"Credit" } }] } }
Headers:

								
									
Possible Errors:
  • OBP-20001: User not logged in. Authentication is required!
  • OBP-50000: Unknown Error.
Implemented in UKv3.1 by getTransactions