{"resource_docs":[{"operation_id":"UKv3.1-getAccountsAccountIdOffers","implemented_by":{"version":"UKv3.1","function":"getAccountsAccountIdOffers"},"request_verb":"GET","request_url":"/open-banking/v3.1/accounts/ACCOUNTID/offers","summary":"Get Offers","description":"
NOTE: This endpoint currently only returns example data.
\nAuthentication is Mandatory
\nURL Parameters:
\nACCOUNTID: ACCOUNTID
\nJSON response body fields:
\n","description_markdown":"**NOTE: This endpoint currently only returns example data.**\n\n \n\n\nAuthentication is Mandatory\n\n\n**URL Parameters:**\n\n[ACCOUNTID](/glossary#): ACCOUNTID\n\n\n\n\n\n**JSON response body fields:**\n\n\n","example_request_body":{"jsonString":"{}"},"success_response_body":{"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":{}}]}},"error_response_bodies":["OBP-20001: User not logged in. Authentication is required!","OBP-50000: Unknown Error."],"tags":["Offers","Mocked-Data"],"typed_request_body":{"type":"object","properties":{"jsonString":{"type":"string"}}},"typed_success_response_body":{"type":"object","properties":{"type":"object","properties":{"Meta":{"type":"object","properties":{"FirstAvailableDateTime":{"type":"object","properties":{}},"TotalPages":{"type":"integer"}}},"Links":{"type":"object","properties":{"First":{"type":"string"},"Self":{"type":"string"},"Next":{"type":"string"},"Last":{"type":"string"},"Prev":{"type":"string"}}},"Data":{"type":"object","properties":{"Offer":{"type":"array","items":{"type":"object","properties":{"Term":{"type":"string"},"Amount":{"type":"object","properties":{"Amount":{"type":"object","properties":{}},"Currency":{"type":"string"}}},"StartDateTime":{"type":"string"},"URL":{"type":"string"},"EndDateTime":{"type":"string"},"AccountId":{"type":"object","properties":{}},"OfferType":{"type":"object","properties":{}},"Value":{"type":"integer"},"Fee":{"type":"object","properties":{"Amount":{"type":"object","properties":{}},"Currency":{"type":"string"}}},"OfferId":{"type":"string"},"Description":{"type":"string"},"Rate":{"type":"string"}}}}}}}}},"is_featured":false,"special_instructions":"","specified_url":"/open-banking/v3.1/accounts/ACCOUNTID/offers","connector_methods":[]},{"operation_id":"UKv3.1-getAccountAccessConsentsConsentId","implemented_by":{"version":"UKv3.1","function":"getAccountAccessConsentsConsentId"},"request_verb":"GET","request_url":"/open-banking/v3.1/account-access-consents/CONSENT_ID","summary":"Get Account Access Consents","description":"Get Account Access Consents
\nAuthentication is Mandatory
\nURL Parameters:
\n\nJSON response body fields:
\n","description_markdown":"Get Account Access Consents\n\n\nAuthentication is Mandatory\n\n\n**URL Parameters:**\n\n[CONSENT_ID](/glossary#consent_id): \n\n\n\n\n\n**JSON response body fields:**\n\n\n","example_request_body":{"jsonString":"{}"},"success_response_body":{"Data":{"ConsentId":"string","CreationDateTime":"2020-10-20T10:28:39.801Z","Status":"Authorised","StatusUpdateDateTime":"2020-10-20T10:28:39.801Z","Permissions":["ReadAccountsBasic"],"ExpirationDateTime":"2020-10-20T10:28:39.801Z","TransactionFromDateTime":"2020-10-20T10:28:39.801Z","TransactionToDateTime":"2020-10-20T10:28:39.801Z"},"Risk":"","Links":{"Self":"https://apisandbox.openbankproject.com/open-banking/v3.1/account-access-consents/CONSENT_ID"},"Meta":{"TotalPages":0,"FirstAvailableDateTime":"2020-10-20T10:28:39.801Z","LastAvailableDateTime":"2020-10-20T10:28:39.801Z"}},"error_response_bodies":["OBP-20001: User not logged in. Authentication is required!","OBP-50000: Unknown Error."],"tags":["Account Access"],"typed_request_body":{"type":"object","properties":{"jsonString":{"type":"string"}}},"typed_success_response_body":{"type":"object","properties":{"type":"object","properties":{"Data":{"type":"object","properties":{"TransactionFromDateTime":{"type":"string"},"ConsentId":{"type":"string"},"ExpirationDateTime":{"type":"string"},"Status":{"type":"string"},"StatusUpdateDateTime":{"type":"string"},"Permissions":{"type":"array","items":{"type":"object","properties":{"s":{"type":"string"}}}},"CreationDateTime":{"type":"string"},"TransactionToDateTime":{"type":"string"}}},"Risk":{"type":"string"},"Links":{"type":"object","properties":{"Self":{"type":"string"}}},"Meta":{"type":"object","properties":{"TotalPages":{"type":"integer"},"FirstAvailableDateTime":{"type":"string"},"LastAvailableDateTime":{"type":"string"}}}}}},"is_featured":false,"special_instructions":"","specified_url":"/open-banking/v3.1/account-access-consents/CONSENT_ID","connector_methods":[]},{"operation_id":"UKv3.1-getInternationalPaymentConsentsConsentIdFundsConfirmation","implemented_by":{"version":"UKv3.1","function":"getInternationalPaymentConsentsConsentIdFundsConfirmation"},"request_verb":"GET","request_url":"/open-banking/v3.1/international-payment-consents/CONSENTID/funds-confirmation","summary":"Get International Payment Consents Funds Confirmation","description":"NOTE: This endpoint currently only returns example data.
\nAuthentication is Mandatory
\nURL Parameters:
\nCONSENTID: CONSENTID
\nJSON response body fields:
\n","description_markdown":"**NOTE: This endpoint currently only returns example data.**\n\n \n\n\nAuthentication is Mandatory\n\n\n**URL Parameters:**\n\n[CONSENTID](/glossary#): CONSENTID\n\n\n\n\n\n**JSON response body fields:**\n\n\n","example_request_body":{"jsonString":"{}"},"success_response_body":{"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}}},"error_response_bodies":["OBP-20001: User not logged in. Authentication is required!","OBP-50000: Unknown Error."],"tags":["International Payments","Mocked-Data"],"typed_request_body":{"type":"object","properties":{"jsonString":{"type":"string"}}},"typed_success_response_body":{"type":"object","properties":{"type":"object","properties":{"Meta":{"type":"object","properties":{"FirstAvailableDateTime":{"type":"object","properties":{}},"TotalPages":{"type":"integer"}}},"Links":{"type":"object","properties":{"First":{"type":"string"},"Self":{"type":"string"},"Next":{"type":"string"},"Last":{"type":"string"},"Prev":{"type":"string"}}},"Data":{"type":"object","properties":{"SupplementaryData":{"type":"object","properties":{}},"FundsAvailableResult":{"type":"object","properties":{"FundsAvailableDateTime":{"type":"string"},"FundsAvailable":{"type":"boolean"}}}}}}}},"is_featured":false,"special_instructions":"","specified_url":"/open-banking/v3.1/international-payment-consents/CONSENTID/funds-confirmation","connector_methods":[]},{"operation_id":"UKv3.1-getScheduledPayments","implemented_by":{"version":"UKv3.1","function":"getScheduledPayments"},"request_verb":"GET","request_url":"/open-banking/v3.1/scheduled-payments","summary":"Get Scheduled Payments","description":"NOTE: This endpoint currently only returns example data.
\nAuthentication is Mandatory
\nJSON response body fields:
\n","description_markdown":"**NOTE: This endpoint currently only returns example data.**\n\n \n\n\nAuthentication is Mandatory\n\n\n**JSON response body fields:**\n\n\n","example_request_body":{"jsonString":"{}"},"success_response_body":{"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":{}}]}},"error_response_bodies":["OBP-20001: User not logged in. Authentication is required!","OBP-50000: Unknown Error."],"tags":["Scheduled Payments","Mocked-Data"],"typed_request_body":{"type":"object","properties":{"jsonString":{"type":"string"}}},"typed_success_response_body":{"type":"object","properties":{"type":"object","properties":{"Meta":{"type":"object","properties":{"FirstAvailableDateTime":{"type":"object","properties":{}},"TotalPages":{"type":"integer"}}},"Links":{"type":"object","properties":{"First":{"type":"string"},"Self":{"type":"string"},"Next":{"type":"string"},"Last":{"type":"string"},"Prev":{"type":"string"}}},"Data":{"type":"object","properties":{"ScheduledPayment":{"type":"array","items":{"type":"object","properties":{"ScheduledType":{"type":"object","properties":{}},"CreditorAccount":{"type":"object","properties":{"SecondaryIdentification":{"type":"string"},"SchemeName":{"type":"array","items":{"type":"object","properties":{"s":{"type":"string"}}}},"Identification":{"type":"string"},"Name":{"type":"string"}}},"ScheduledPaymentId":{"type":"string"},"ScheduledPaymentDateTime":{"type":"string"},"AccountId":{"type":"object","properties":{}},"InstructedAmount":{"type":"object","properties":{"Amount":{"type":"object","properties":{}},"Currency":{"type":"string"}}},"CreditorAgent":{"type":"object","properties":{"SchemeName":{"type":"array","items":{"type":"object","properties":{"s":{"type":"string"}}}},"Identification":{"type":"string"}}},"Reference":{"type":"string"}}}}}}}}},"is_featured":false,"special_instructions":"","specified_url":"/open-banking/v3.1/scheduled-payments","connector_methods":[]},{"operation_id":"UKv3.1-createDomesticPaymentConsents","implemented_by":{"version":"UKv3.1","function":"createDomesticPaymentConsents"},"request_verb":"POST","request_url":"/open-banking/v3.1/domestic-payment-consents","summary":"Create Domestic Payment Consents","description":"NOTE: This endpoint currently only returns example data.
\nAuthentication is Mandatory
\nJSON request body fields:
\nJSON response body fields:
\n","description_markdown":"**NOTE: This endpoint currently only returns example data.**\n\n \n\n\nAuthentication is Mandatory\n\n\n**JSON request body fields:**\n\n\n\n\n\n**JSON response body fields:**\n\n\n","example_request_body":{"jsonString":"{}"},"success_response_body":{"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"}},"error_response_bodies":["OBP-20001: User not logged in. Authentication is required!","OBP-50000: Unknown Error."],"tags":["Domestic Payments","Mocked-Data"],"typed_request_body":{"type":"object","properties":{"jsonString":{"type":"string"}}},"typed_success_response_body":{"type":"object","properties":{"type":"object","properties":{"Meta":{"type":"object","properties":{"FirstAvailableDateTime":{"type":"object","properties":{}},"TotalPages":{"type":"integer"}}},"Risk":{"type":"object","properties":{"PaymentContextCode":{"type":"object","properties":{}},"DeliveryAddress":{"type":"object","properties":{"CountrySubDivision":{"type":"array","items":{"type":"object","properties":{"s":{"type":"string"}}}},"Country":{"type":"string"},"StreetName":{"type":"string"},"BuildingNumber":{"type":"string"},"AddressLine":{"type":"array","items":{"type":"object","properties":{"s":{"type":"string"}}}},"TownName":{"type":"string"},"PostCode":{"type":"string"}}},"MerchantCategoryCode":{"type":"string"},"MerchantCustomerIdentification":{"type":"string"}}},"Links":{"type":"object","properties":{"First":{"type":"string"},"Self":{"type":"string"},"Next":{"type":"string"},"Last":{"type":"string"},"Prev":{"type":"string"}}},"Data":{"type":"object","properties":{"ExpectedExecutionDateTime":{"type":"string"},"ExpectedSettlementDateTime":{"type":"string"},"StatusUpdateDateTime":{"type":"string"},"CreationDateTime":{"type":"string"},"ConsentId":{"type":"string"},"Initiation":{"type":"object","properties":{"InstructedAmount":{"type":"object","properties":{"Currency":{"type":"string"}}},"CreditorPostalAddress":{"type":"object","properties":{"CountrySubDivision":{"type":"string"},"Country":{"type":"string"},"Department":{"type":"string"},"StreetName":{"type":"string"},"AddressType":{"type":"object","properties":{}},"BuildingNumber":{"type":"string"},"TownName":{"type":"string"},"SubDepartment":{"type":"string"},"PostCode":{"type":"string"},"AddressLine":{"type":"array","items":{"type":"object","properties":{"s":{"type":"string"}}}}}},"CreditorAccount":{"type":"object","properties":{"SecondaryIdentification":{"type":"string"},"SchemeName":{"type":"array","items":{"type":"object","properties":{"s":{"type":"string"}}}},"Identification":{"type":"string"},"Name":{"type":"string"}}},"EndToEndIdentification":{"type":"string"},"DebtorAccount":{"type":"object","properties":{"SecondaryIdentification":{"type":"string"},"SchemeName":{"type":"array","items":{"type":"object","properties":{"s":{"type":"string"}}}},"Identification":{"type":"string"},"Name":{"type":"string"}}},"InstructionIdentification":{"type":"string"},"LocalInstrument":{"type":"array","items":{"type":"object","properties":{"s":{"type":"string"}}}},"SupplementaryData":{"type":"object","properties":{}},"RemittanceInformation":{"type":"object","properties":{"Unstructured":{"type":"string"},"Reference":{"type":"string"}}}}},"Status":{"type":"object","properties":{}},"Charges":{"type":"array","items":{"type":"object","properties":{"Type":{"type":"array","items":{"type":"object","properties":{"s":{"type":"string"}}}},"Amount":{"type":"object","properties":{"Amount":{"type":"object","properties":{}},"Currency":{"type":"string"}}},"ChargeBearer":{"type":"object","properties":{}}}}},"Authorisation":{"type":"object","properties":{"CompletionDateTime":{"type":"string"},"AuthorisationType":{"type":"object","properties":{}}}},"CutOffDateTime":{"type":"string"}}}}}},"is_featured":false,"special_instructions":"","specified_url":"/open-banking/v3.1/domestic-payment-consents","connector_methods":[]},{"operation_id":"UKv3.1-getInternationalStandingOrderConsentsConsentId","implemented_by":{"version":"UKv3.1","function":"getInternationalStandingOrderConsentsConsentId"},"request_verb":"GET","request_url":"/open-banking/v3.1/international-standing-order-consents/CONSENTID","summary":"Get International Standing Order Consents","description":"NOTE: This endpoint currently only returns example data.
\nAuthentication is Mandatory
\nURL Parameters:
\nCONSENTID: CONSENTID
\nJSON response body fields:
\n","description_markdown":"**NOTE: This endpoint currently only returns example data.**\n\n \n\n\nAuthentication is Mandatory\n\n\n**URL Parameters:**\n\n[CONSENTID](/glossary#): CONSENTID\n\n\n\n\n\n**JSON response body fields:**\n\n\n","example_request_body":{"jsonString":"{}"},"success_response_body":{"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"}}}},"error_response_bodies":["OBP-20001: User not logged in. Authentication is required!","OBP-50000: Unknown Error."],"tags":["International Standing Orders","Mocked-Data"],"typed_request_body":{"type":"object","properties":{"jsonString":{"type":"string"}}},"typed_success_response_body":{"type":"object","properties":{"type":"object","properties":{"Meta":{"type":"object","properties":{"FirstAvailableDateTime":{"type":"object","properties":{}},"TotalPages":{"type":"integer"}}},"Risk":{"type":"object","properties":{"PaymentContextCode":{"type":"object","properties":{}},"DeliveryAddress":{"type":"object","properties":{"CountrySubDivision":{"type":"array","items":{"type":"object","properties":{"s":{"type":"string"}}}},"Country":{"type":"string"},"StreetName":{"type":"string"},"BuildingNumber":{"type":"string"},"AddressLine":{"type":"array","items":{"type":"object","properties":{"s":{"type":"string"}}}},"TownName":{"type":"string"},"PostCode":{"type":"string"}}},"MerchantCategoryCode":{"type":"string"},"MerchantCustomerIdentification":{"type":"string"}}},"Links":{"type":"object","properties":{"First":{"type":"string"},"Self":{"type":"string"},"Next":{"type":"string"},"Last":{"type":"string"},"Prev":{"type":"string"}}},"Data":{"type":"object","properties":{"StatusUpdateDateTime":{"type":"string"},"CreationDateTime":{"type":"string"},"Permission":{"type":"object","properties":{}},"Initiation":{"type":"object","properties":{"CurrencyOfTransfer":{"type":"string"},"InstructedAmount":{"type":"object","properties":{"Currency":{"type":"string"}}},"CreditorAgent":{"type":"object","properties":{"PostalAddress":{"type":"object","properties":{"CountrySubDivision":{"type":"string"},"Country":{"type":"string"},"Department":{"type":"string"},"StreetName":{"type":"string"},"AddressType":{"type":"object","properties":{}},"BuildingNumber":{"type":"string"},"TownName":{"type":"string"},"SubDepartment":{"type":"string"},"PostCode":{"type":"string"},"AddressLine":{"type":"array","items":{"type":"object","properties":{"s":{"type":"string"}}}}}},"SchemeName":{"type":"array","items":{"type":"object","properties":{"s":{"type":"string"}}}},"Identification":{"type":"string"},"Name":{"type":"string"}}},"CreditorAccount":{"type":"object","properties":{"SecondaryIdentification":{"type":"string"},"SchemeName":{"type":"array","items":{"type":"object","properties":{"s":{"type":"string"}}}},"Identification":{"type":"string"},"Name":{"type":"string"}}},"NumberOfPayments":{"type":"string"},"FinalPaymentDateTime":{"type":"string"},"DebtorAccount":{"type":"object","properties":{"SecondaryIdentification":{"type":"string"},"SchemeName":{"type":"array","items":{"type":"object","properties":{"s":{"type":"string"}}}},"Identification":{"type":"string"},"Name":{"type":"string"}}},"ChargeBearer":{"type":"object","properties":{}},"FirstPaymentDateTime":{"type":"string"},"SupplementaryData":{"type":"object","properties":{}},"Purpose":{"type":"object","properties":{}},"Frequency":{"type":"string"},"Creditor":{"type":"object","properties":{"PostalAddress":{"type":"object","properties":{"CountrySubDivision":{"type":"string"},"Country":{"type":"string"},"Department":{"type":"string"},"StreetName":{"type":"string"},"AddressType":{"type":"object","properties":{}},"BuildingNumber":{"type":"string"},"TownName":{"type":"string"},"SubDepartment":{"type":"string"},"PostCode":{"type":"string"},"AddressLine":{"type":"array","items":{"type":"object","properties":{"s":{"type":"string"}}}}}},"Name":{"type":"string"}}},"Reference":{"type":"string"}}},"ConsentId":{"type":"string"},"Status":{"type":"object","properties":{}},"Charges":{"type":"array","items":{"type":"object","properties":{"Type":{"type":"array","items":{"type":"object","properties":{"s":{"type":"string"}}}},"Amount":{"type":"object","properties":{"Amount":{"type":"object","properties":{}},"Currency":{"type":"string"}}},"ChargeBearer":{"type":"object","properties":{}}}}},"Authorisation":{"type":"object","properties":{"CompletionDateTime":{"type":"string"},"AuthorisationType":{"type":"object","properties":{}}}},"CutOffDateTime":{"type":"string"}}}}}},"is_featured":false,"special_instructions":"","specified_url":"/open-banking/v3.1/international-standing-order-consents/CONSENTID","connector_methods":[]},{"operation_id":"UKv3.1-getFundsConfirmationConsentsConsentId","implemented_by":{"version":"UKv3.1","function":"getFundsConfirmationConsentsConsentId"},"request_verb":"GET","request_url":"/open-banking/v3.1/funds-confirmation-consents/CONSENTID","summary":"Get Funds Confirmation Consent","description":"NOTE: This endpoint currently only returns example data.
\nAuthentication is Mandatory
\nURL Parameters:
\nCONSENTID: CONSENTID
\nJSON response body fields:
\n","description_markdown":"**NOTE: This endpoint currently only returns example data.**\n\n \n\n\nAuthentication is Mandatory\n\n\n**URL Parameters:**\n\n[CONSENTID](/glossary#): CONSENTID\n\n\n\n\n\n**JSON response body fields:**\n\n\n","example_request_body":{"jsonString":"{}"},"success_response_body":{"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"}},"error_response_bodies":["OBP-20001: User not logged in. Authentication is required!","OBP-50000: Unknown Error."],"tags":["Funds Confirmations","Mocked-Data"],"typed_request_body":{"type":"object","properties":{"jsonString":{"type":"string"}}},"typed_success_response_body":{"type":"object","properties":{"type":"object","properties":{"Meta":{"type":"object","properties":{"FirstAvailableDateTime":{"type":"object","properties":{}},"TotalPages":{"type":"integer"}}},"Links":{"type":"object","properties":{"First":{"type":"string"},"Self":{"type":"string"},"Next":{"type":"string"},"Last":{"type":"string"},"Prev":{"type":"string"}}},"Data":{"type":"object","properties":{"ExpirationDateTime":{"type":"string"},"StatusUpdateDateTime":{"type":"string"},"DebtorAccount":{"type":"object","properties":{"SecondaryIdentification":{"type":"string"},"SchemeName":{"type":"array","items":{"type":"object","properties":{"s":{"type":"string"}}}},"Identification":{"type":"string"},"Name":{"type":"string"}}},"CreationDateTime":{"type":"string"},"ConsentId":{"type":"string"},"Status":{"type":"object","properties":{}}}}}}},"is_featured":false,"special_instructions":"","specified_url":"/open-banking/v3.1/funds-confirmation-consents/CONSENTID","connector_methods":[]},{"operation_id":"UKv3.1-createDomesticStandingOrders","implemented_by":{"version":"UKv3.1","function":"createDomesticStandingOrders"},"request_verb":"POST","request_url":"/open-banking/v3.1/domestic-standing-orders","summary":"Create Domestic Standing Orders","description":"NOTE: This endpoint currently only returns example data.
\nAuthentication is Mandatory
\nJSON request body fields:
\nJSON response body fields:
\n","description_markdown":"**NOTE: This endpoint currently only returns example data.**\n\n \n\n\nAuthentication is Mandatory\n\n\n**JSON request body fields:**\n\n\n\n\n\n**JSON response body fields:**\n\n\n","example_request_body":{"jsonString":"{}"},"success_response_body":{"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}}},"error_response_bodies":["OBP-20001: User not logged in. Authentication is required!","OBP-50000: Unknown Error."],"tags":["Domestic Standing Orders","Mocked-Data"],"typed_request_body":{"type":"object","properties":{"jsonString":{"type":"string"}}},"typed_success_response_body":{"type":"object","properties":{"type":"object","properties":{"Meta":{"type":"object","properties":{"FirstAvailableDateTime":{"type":"object","properties":{}},"TotalPages":{"type":"integer"}}},"Links":{"type":"object","properties":{"First":{"type":"string"},"Self":{"type":"string"},"Next":{"type":"string"},"Last":{"type":"string"},"Prev":{"type":"string"}}},"Data":{"type":"object","properties":{"StatusUpdateDateTime":{"type":"string"},"CreationDateTime":{"type":"string"},"ConsentId":{"type":"string"},"Initiation":{"type":"object","properties":{"RecurringPaymentDateTime":{"type":"string"},"CreditorAccount":{"type":"object","properties":{"SecondaryIdentification":{"type":"string"},"SchemeName":{"type":"array","items":{"type":"object","properties":{"s":{"type":"string"}}}},"Identification":{"type":"string"},"Name":{"type":"string"}}},"FirstPaymentAmount":{"type":"object","properties":{"Amount":{"type":"object","properties":{}},"Currency":{"type":"string"}}},"NumberOfPayments":{"type":"string"},"FinalPaymentDateTime":{"type":"string"},"DebtorAccount":{"type":"object","properties":{"SecondaryIdentification":{"type":"string"},"SchemeName":{"type":"array","items":{"type":"object","properties":{"s":{"type":"string"}}}},"Identification":{"type":"string"},"Name":{"type":"string"}}},"FirstPaymentDateTime":{"type":"string"},"SupplementaryData":{"type":"object","properties":{}},"Frequency":{"type":"string"},"RecurringPaymentAmount":{"type":"object","properties":{"Currency":{"type":"string"}}},"FinalPaymentAmount":{"type":"object","properties":{"Currency":{"type":"string"}}},"Reference":{"type":"string"}}},"DomesticStandingOrderId":{"type":"string"},"Status":{"type":"object","properties":{}},"Charges":{"type":"array","items":{"type":"object","properties":{"Type":{"type":"array","items":{"type":"object","properties":{"s":{"type":"string"}}}},"Amount":{"type":"object","properties":{"Amount":{"type":"object","properties":{}},"Currency":{"type":"string"}}},"ChargeBearer":{"type":"object","properties":{}}}}},"MultiAuthorisation":{"type":"object","properties":{"ExpirationDateTime":{"type":"string"},"NumberRequired":{"type":"integer"},"Status":{"type":"object","properties":{}},"NumberReceived":{"type":"integer"},"LastUpdateDateTime":{"type":"string"}}}}}}}},"is_featured":false,"special_instructions":"","specified_url":"/open-banking/v3.1/domestic-standing-orders","connector_methods":[]},{"operation_id":"UKv3.1-getInternationalStandingOrdersInternationalStandingOrderPaymentId","implemented_by":{"version":"UKv3.1","function":"getInternationalStandingOrdersInternationalStandingOrderPaymentId"},"request_verb":"GET","request_url":"/open-banking/v3.1/international-standing-orders/INTERNATIONALSTANDINGORDERPAYMENTID","summary":"Get International Standing Orders","description":"NOTE: This endpoint currently only returns example data.
\nAuthentication is Mandatory
\nURL Parameters:
\nINTERNATIONALSTANDINGORDERPAYMENTID: INTERNATIONALSTANDINGORDERPAYMENTID
\nJSON response body fields:
\n","description_markdown":"**NOTE: This endpoint currently only returns example data.**\n\n \n\n\nAuthentication is Mandatory\n\n\n**URL Parameters:**\n\n[INTERNATIONALSTANDINGORDERPAYMENTID](/glossary#): INTERNATIONALSTANDINGORDERPAYMENTID\n\n\n\n\n\n**JSON response body fields:**\n\n\n","example_request_body":{"jsonString":"{}"},"success_response_body":{"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}}},"error_response_bodies":["OBP-20001: User not logged in. Authentication is required!","OBP-50000: Unknown Error."],"tags":["International Standing Orders","Mocked-Data"],"typed_request_body":{"type":"object","properties":{"jsonString":{"type":"string"}}},"typed_success_response_body":{"type":"object","properties":{"type":"object","properties":{"Meta":{"type":"object","properties":{"FirstAvailableDateTime":{"type":"object","properties":{}},"TotalPages":{"type":"integer"}}},"Links":{"type":"object","properties":{"First":{"type":"string"},"Self":{"type":"string"},"Next":{"type":"string"},"Last":{"type":"string"},"Prev":{"type":"string"}}},"Data":{"type":"object","properties":{"InternationalStandingOrderId":{"type":"string"},"StatusUpdateDateTime":{"type":"string"},"CreationDateTime":{"type":"string"},"Initiation":{"type":"object","properties":{"CurrencyOfTransfer":{"type":"string"},"InstructedAmount":{"type":"object","properties":{"Currency":{"type":"string"}}},"CreditorAgent":{"type":"object","properties":{"PostalAddress":{"type":"object","properties":{"CountrySubDivision":{"type":"string"},"Country":{"type":"string"},"Department":{"type":"string"},"StreetName":{"type":"string"},"AddressType":{"type":"object","properties":{}},"BuildingNumber":{"type":"string"},"TownName":{"type":"string"},"SubDepartment":{"type":"string"},"PostCode":{"type":"string"},"AddressLine":{"type":"array","items":{"type":"object","properties":{"s":{"type":"string"}}}}}},"SchemeName":{"type":"array","items":{"type":"object","properties":{"s":{"type":"string"}}}},"Identification":{"type":"string"},"Name":{"type":"string"}}},"CreditorAccount":{"type":"object","properties":{"SecondaryIdentification":{"type":"string"},"SchemeName":{"type":"array","items":{"type":"object","properties":{"s":{"type":"string"}}}},"Identification":{"type":"string"},"Name":{"type":"string"}}},"NumberOfPayments":{"type":"string"},"FinalPaymentDateTime":{"type":"string"},"DebtorAccount":{"type":"object","properties":{"SecondaryIdentification":{"type":"string"},"SchemeName":{"type":"array","items":{"type":"object","properties":{"s":{"type":"string"}}}},"Identification":{"type":"string"},"Name":{"type":"string"}}},"ChargeBearer":{"type":"object","properties":{}},"FirstPaymentDateTime":{"type":"string"},"SupplementaryData":{"type":"object","properties":{}},"Purpose":{"type":"object","properties":{}},"Frequency":{"type":"string"},"Creditor":{"type":"object","properties":{"PostalAddress":{"type":"object","properties":{"CountrySubDivision":{"type":"string"},"Country":{"type":"string"},"Department":{"type":"string"},"StreetName":{"type":"string"},"AddressType":{"type":"object","properties":{}},"BuildingNumber":{"type":"string"},"TownName":{"type":"string"},"SubDepartment":{"type":"string"},"PostCode":{"type":"string"},"AddressLine":{"type":"array","items":{"type":"object","properties":{"s":{"type":"string"}}}}}},"Name":{"type":"string"}}},"Reference":{"type":"string"}}},"ConsentId":{"type":"string"},"Status":{"type":"object","properties":{}},"Charges":{"type":"array","items":{"type":"object","properties":{"Type":{"type":"array","items":{"type":"object","properties":{"s":{"type":"string"}}}},"Amount":{"type":"object","properties":{"Amount":{"type":"object","properties":{}},"Currency":{"type":"string"}}},"ChargeBearer":{"type":"object","properties":{}}}}},"MultiAuthorisation":{"type":"object","properties":{"ExpirationDateTime":{"type":"string"},"NumberRequired":{"type":"integer"},"Status":{"type":"object","properties":{}},"NumberReceived":{"type":"integer"},"LastUpdateDateTime":{"type":"string"}}}}}}}},"is_featured":false,"special_instructions":"","specified_url":"/open-banking/v3.1/international-standing-orders/INTERNATIONALSTANDINGORDERPAYMENTID","connector_methods":[]},{"operation_id":"UKv3.1-getDomesticScheduledPaymentConsentsConsentId","implemented_by":{"version":"UKv3.1","function":"getDomesticScheduledPaymentConsentsConsentId"},"request_verb":"GET","request_url":"/open-banking/v3.1/domestic-scheduled-payment-consents/CONSENTID","summary":"Get Domestic Scheduled Payment Consents","description":"NOTE: This endpoint currently only returns example data.
\nAuthentication is Mandatory
\nURL Parameters:
\nCONSENTID: CONSENTID
\nJSON response body fields:
\n","description_markdown":"**NOTE: This endpoint currently only returns example data.**\n\n \n\n\nAuthentication is Mandatory\n\n\n**URL Parameters:**\n\n[CONSENTID](/glossary#): CONSENTID\n\n\n\n\n\n**JSON response body fields:**\n\n\n","example_request_body":{"jsonString":"{}"},"success_response_body":{"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"}},"error_response_bodies":["OBP-20001: User not logged in. Authentication is required!","OBP-50000: Unknown Error."],"tags":["Domestic Scheduled Payments","Mocked-Data"],"typed_request_body":{"type":"object","properties":{"jsonString":{"type":"string"}}},"typed_success_response_body":{"type":"object","properties":{"type":"object","properties":{"Meta":{"type":"object","properties":{"FirstAvailableDateTime":{"type":"object","properties":{}},"TotalPages":{"type":"integer"}}},"Risk":{"type":"object","properties":{"PaymentContextCode":{"type":"object","properties":{}},"DeliveryAddress":{"type":"object","properties":{"CountrySubDivision":{"type":"array","items":{"type":"object","properties":{"s":{"type":"string"}}}},"Country":{"type":"string"},"StreetName":{"type":"string"},"BuildingNumber":{"type":"string"},"AddressLine":{"type":"array","items":{"type":"object","properties":{"s":{"type":"string"}}}},"TownName":{"type":"string"},"PostCode":{"type":"string"}}},"MerchantCategoryCode":{"type":"string"},"MerchantCustomerIdentification":{"type":"string"}}},"Links":{"type":"object","properties":{"First":{"type":"string"},"Self":{"type":"string"},"Next":{"type":"string"},"Last":{"type":"string"},"Prev":{"type":"string"}}},"Data":{"type":"object","properties":{"ExpectedExecutionDateTime":{"type":"string"},"ExpectedSettlementDateTime":{"type":"string"},"StatusUpdateDateTime":{"type":"string"},"CreationDateTime":{"type":"string"},"Permission":{"type":"object","properties":{}},"ConsentId":{"type":"string"},"Status":{"type":"object","properties":{}},"Charges":{"type":"array","items":{"type":"object","properties":{"Type":{"type":"array","items":{"type":"object","properties":{"s":{"type":"string"}}}},"Amount":{"type":"object","properties":{"Amount":{"type":"object","properties":{}},"Currency":{"type":"string"}}},"ChargeBearer":{"type":"object","properties":{}}}}},"Authorisation":{"type":"object","properties":{"CompletionDateTime":{"type":"string"},"AuthorisationType":{"type":"object","properties":{}}}},"Initiation":{"type":"object","properties":{"InstructedAmount":{"type":"object","properties":{"Currency":{"type":"string"}}},"RequestedExecutionDateTime":{"type":"string"},"CreditorPostalAddress":{"type":"object","properties":{"CountrySubDivision":{"type":"string"},"Country":{"type":"string"},"Department":{"type":"string"},"StreetName":{"type":"string"},"AddressType":{"type":"object","properties":{}},"BuildingNumber":{"type":"string"},"TownName":{"type":"string"},"SubDepartment":{"type":"string"},"PostCode":{"type":"string"},"AddressLine":{"type":"array","items":{"type":"object","properties":{"s":{"type":"string"}}}}}},"CreditorAccount":{"type":"object","properties":{"SecondaryIdentification":{"type":"string"},"SchemeName":{"type":"array","items":{"type":"object","properties":{"s":{"type":"string"}}}},"Identification":{"type":"string"},"Name":{"type":"string"}}},"EndToEndIdentification":{"type":"string"},"DebtorAccount":{"type":"object","properties":{"SecondaryIdentification":{"type":"string"},"SchemeName":{"type":"array","items":{"type":"object","properties":{"s":{"type":"string"}}}},"Identification":{"type":"string"},"Name":{"type":"string"}}},"InstructionIdentification":{"type":"string"},"LocalInstrument":{"type":"array","items":{"type":"object","properties":{"s":{"type":"string"}}}},"SupplementaryData":{"type":"object","properties":{}},"RemittanceInformation":{"type":"object","properties":{"Unstructured":{"type":"string"},"Reference":{"type":"string"}}}}},"CutOffDateTime":{"type":"string"}}}}}},"is_featured":false,"special_instructions":"","specified_url":"/open-banking/v3.1/domestic-scheduled-payment-consents/CONSENTID","connector_methods":[]},{"operation_id":"UKv3.1-getFilePaymentsFilePaymentId","implemented_by":{"version":"UKv3.1","function":"getFilePaymentsFilePaymentId"},"request_verb":"GET","request_url":"/open-banking/v3.1/file-payments/FILEPAYMENTID","summary":"Get File Payments","description":"NOTE: This endpoint currently only returns example data.
\nAuthentication is Mandatory
\nURL Parameters:
\nFILEPAYMENTID: FILEPAYMENTID
\nJSON response body fields:
\n","description_markdown":"**NOTE: This endpoint currently only returns example data.**\n\n \n\n\nAuthentication is Mandatory\n\n\n**URL Parameters:**\n\n[FILEPAYMENTID](/glossary#): FILEPAYMENTID\n\n\n\n\n\n**JSON response body fields:**\n\n\n","example_request_body":{"jsonString":"{}"},"success_response_body":{"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}}},"error_response_bodies":["OBP-20001: User not logged in. Authentication is required!","OBP-50000: Unknown Error."],"tags":["File Payments","Mocked-Data"],"typed_request_body":{"type":"object","properties":{"jsonString":{"type":"string"}}},"typed_success_response_body":{"type":"object","properties":{"type":"object","properties":{"Meta":{"type":"object","properties":{"FirstAvailableDateTime":{"type":"object","properties":{}},"TotalPages":{"type":"integer"}}},"Links":{"type":"object","properties":{"First":{"type":"string"},"Self":{"type":"string"},"Next":{"type":"string"},"Last":{"type":"string"},"Prev":{"type":"string"}}},"Data":{"type":"object","properties":{"StatusUpdateDateTime":{"type":"string"},"Initiation":{"type":"object","properties":{"RequestedExecutionDateTime":{"type":"string"},"DebtorAccount":{"type":"object","properties":{"SecondaryIdentification":{"type":"string"},"SchemeName":{"type":"array","items":{"type":"object","properties":{"s":{"type":"string"}}}},"Identification":{"type":"string"},"Name":{"type":"string"}}},"NumberOfTransactions":{"type":"string"},"ControlSum":{"type":"number"},"LocalInstrument":{"type":"array","items":{"type":"object","properties":{"s":{"type":"string"}}}},"SupplementaryData":{"type":"object","properties":{}},"RemittanceInformation":{"type":"object","properties":{"Unstructured":{"type":"string"},"Reference":{"type":"string"}}},"FileHash":{"type":"string"},"FileReference":{"type":"string"},"FileType":{"type":"array","items":{"type":"object","properties":{"s":{"type":"string"}}}}}},"FilePaymentId":{"type":"string"},"CreationDateTime":{"type":"string"},"ConsentId":{"type":"string"},"Status":{"type":"object","properties":{}},"Charges":{"type":"array","items":{"type":"object","properties":{"Type":{"type":"array","items":{"type":"object","properties":{"s":{"type":"string"}}}},"Amount":{"type":"object","properties":{"Amount":{"type":"object","properties":{}},"Currency":{"type":"string"}}},"ChargeBearer":{"type":"object","properties":{}}}}},"MultiAuthorisation":{"type":"object","properties":{"ExpirationDateTime":{"type":"string"},"NumberRequired":{"type":"integer"},"Status":{"type":"object","properties":{}},"NumberReceived":{"type":"integer"},"LastUpdateDateTime":{"type":"string"}}}}}}}},"is_featured":false,"special_instructions":"","specified_url":"/open-banking/v3.1/file-payments/FILEPAYMENTID","connector_methods":[]},{"operation_id":"UKv3.1-getTransactions","implemented_by":{"version":"UKv3.1","function":"getTransactions"},"request_verb":"GET","request_url":"/open-banking/v3.1/transactions","summary":"Get Transactions","description":"Authentication is Mandatory
\nJSON response body fields:
\n","description_markdown":"Authentication is Mandatory\n\n\n**JSON response body fields:**\n\n\n","example_request_body":{"jsonString":"{}"},"success_response_body":{"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"}}]}},"error_response_bodies":["OBP-20001: User not logged in. Authentication is required!","OBP-50000: Unknown Error."],"tags":["Transactions"],"typed_request_body":{"type":"object","properties":{"jsonString":{"type":"string"}}},"typed_success_response_body":{"type":"object","properties":{"type":"object","properties":{"Meta":{"type":"object","properties":{"FirstAvailableDateTime":{"type":"string"},"LastAvailableDateTime":{"type":"string"},"TotalPages":{"type":"integer"}}},"Links":{"type":"object","properties":{"First":{"type":"string"},"Self":{"type":"string"},"Next":{"type":"string"},"Last":{"type":"string"},"Prev":{"type":"string"}}},"Data":{"type":"object","properties":{"Transaction":{"type":"array","items":{"type":"object","properties":{"TransactionId":{"type":"string"},"StatementReference":{"type":"array","items":{"type":"object","properties":{"s":{"type":"string"}}}},"MerchantDetails":{"type":"object","properties":{"MerchantName":{"type":"string"},"MerchantCategoryCode":{"type":"string"}}},"CreditorAccount":{"type":"object","properties":{"SecondaryIdentification":{"type":"string"},"SchemeName":{"type":"array","items":{"type":"object","properties":{"s":{"type":"string"}}}},"Identification":{"type":"string"},"Name":{"type":"string"}}},"CurrencyExchange":{"type":"object","properties":{"QuotationDate":{"type":"string"},"SourceCurrency":{"type":"string"},"TargetCurrency":{"type":"string"},"ExchangeRate":{"type":"number"},"ContractIdentification":{"type":"string"},"InstructedAmount":{"type":"object","properties":{"Amount":{"type":"string"},"Currency":{"type":"string"}}},"UnitCurrency":{"type":"string"}}},"DebtorAccount":{"type":"object","properties":{"SecondaryIdentification":{"type":"string"},"SchemeName":{"type":"array","items":{"type":"object","properties":{"s":{"type":"string"}}}},"Identification":{"type":"string"},"Name":{"type":"string"}}},"BankTransactionCode":{"type":"object","properties":{"SubCode":{"type":"string"},"Code":{"type":"string"}}},"Balance":{"type":"object","properties":{"Type":{"type":"string"},"Amount":{"type":"object","properties":{"Amount":{"type":"string"},"Currency":{"type":"string"}}},"CreditDebitIndicator":{"type":"string"}}},"TransactionInformation":{"type":"string"},"DebtorAgent":{"type":"object","properties":{"PostalAddress":{"type":"object","properties":{"CountrySubDivision":{"type":"string"},"Country":{"type":"string"},"Department":{"type":"string"},"StreetName":{"type":"string"},"BuildingNumber":{"type":"string"},"AddressType":{"type":"string"},"TownName":{"type":"string"},"SubDepartment":{"type":"string"},"PostCode":{"type":"string"},"AddressLine":{"type":"array","items":{"type":"object","properties":{"s":{"type":"string"}}}}}},"SchemeName":{"type":"array","items":{"type":"object","properties":{"s":{"type":"string"}}}},"Identification":{"type":"string"},"Name":{"type":"string"}}},"ProprietaryBankTransactionCode":{"type":"object","properties":{"Issuer":{"type":"string"},"Code":{"type":"string"}}},"CreditorAgent":{"type":"object","properties":{"PostalAddress":{"type":"object","properties":{"CountrySubDivision":{"type":"string"},"Country":{"type":"string"},"Department":{"type":"string"},"StreetName":{"type":"string"},"BuildingNumber":{"type":"string"},"AddressType":{"type":"string"},"TownName":{"type":"string"},"SubDepartment":{"type":"string"},"PostCode":{"type":"string"},"AddressLine":{"type":"array","items":{"type":"object","properties":{"s":{"type":"string"}}}}}},"SchemeName":{"type":"array","items":{"type":"object","properties":{"s":{"type":"string"}}}},"Identification":{"type":"string"},"Name":{"type":"string"}}},"ValueDateTime":{"type":"string"},"ChargeAmount":{"type":"object","properties":{"Amount":{"type":"string"},"Currency":{"type":"string"}}},"TransactionReference":{"type":"string"},"SupplementaryData":{"type":"object","properties":{}},"AccountId":{"type":"string"},"BookingDateTime":{"type":"string"},"Amount":{"type":"object","properties":{"Amount":{"type":"string"},"Currency":{"type":"string"}}},"AddressLine":{"type":"string"},"CardInstrument":{"type":"object","properties":{"AuthorisationType":{"type":"string"},"Identification":{"type":"string"},"CardSchemeName":{"type":"string"},"Name":{"type":"string"}}},"Status":{"type":"string"},"CreditDebitIndicator":{"type":"string"}}}}}}}}},"is_featured":false,"special_instructions":"","specified_url":"/open-banking/v3.1/transactions","connector_methods":[]},{"operation_id":"UKv3.1-getAccountsAccountIdProduct","implemented_by":{"version":"UKv3.1","function":"getAccountsAccountIdProduct"},"request_verb":"GET","request_url":"/open-banking/v3.1/accounts/ACCOUNTID/product","summary":"Get Products","description":"NOTE: This endpoint currently only returns example data.
\nAuthentication is Mandatory
\nURL Parameters:
\nACCOUNTID: ACCOUNTID
\nJSON response body fields:
\n","description_markdown":"**NOTE: This endpoint currently only returns example data.**\n\n \n\nAuthentication is Mandatory\n\n\n**URL Parameters:**\n\n[ACCOUNTID](/glossary#): ACCOUNTID\n\n\n\n\n\n**JSON response body fields:**\n\n\n","example_request_body":{"jsonString":"{}"},"success_response_body":{"jsonString":"{}"},"error_response_bodies":["OBP-20001: User not logged in. Authentication is required!","OBP-50000: Unknown Error."],"tags":["Products","Mocked-Data"],"typed_request_body":{"type":"object","properties":{"jsonString":{"type":"string"}}},"typed_success_response_body":{"type":"object","properties":{"jsonString":{"type":"string"}}},"is_featured":false,"special_instructions":"","specified_url":"/open-banking/v3.1/accounts/ACCOUNTID/product","connector_methods":[]},{"operation_id":"UKv3.1-getAccountsAccountIdStatements","implemented_by":{"version":"UKv3.1","function":"getAccountsAccountIdStatements"},"request_verb":"GET","request_url":"/open-banking/v3.1/accounts/ACCOUNTID/statements","summary":"Get Statements","description":"NOTE: This endpoint currently only returns example data.
\nAuthentication is Mandatory
\nURL Parameters:
\nACCOUNTID: ACCOUNTID
\nJSON response body fields:
\n","description_markdown":"**NOTE: This endpoint currently only returns example data.**\n\n \n\n\nAuthentication is Mandatory\n\n\n**URL Parameters:**\n\n[ACCOUNTID](/glossary#): ACCOUNTID\n\n\n\n\n\n**JSON response body fields:**\n\n\n","example_request_body":{"jsonString":"{}"},"success_response_body":{"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"}]}]}},"error_response_bodies":["OBP-20001: User not logged in. Authentication is required!","OBP-50000: Unknown Error."],"tags":["Statements","Mocked-Data"],"typed_request_body":{"type":"object","properties":{"jsonString":{"type":"string"}}},"typed_success_response_body":{"type":"object","properties":{"type":"object","properties":{"Meta":{"type":"object","properties":{"FirstAvailableDateTime":{"type":"object","properties":{}},"TotalPages":{"type":"integer"}}},"Links":{"type":"object","properties":{"First":{"type":"string"},"Self":{"type":"string"},"Next":{"type":"string"},"Last":{"type":"string"},"Prev":{"type":"string"}}},"Data":{"type":"object","properties":{"Statement":{"type":"array","items":{"type":"object","properties":{"StatementReference":{"type":"string"},"StatementDateTime":{"type":"array","items":{"type":"object","properties":{"Type":{"type":"array","items":{"type":"object","properties":{"s":{"type":"string"}}}},"DateTime":{"type":"string"}}}},"StatementBenefit":{"type":"array","items":{"type":"object","properties":{"Type":{"type":"array","items":{"type":"object","properties":{"s":{"type":"string"}}}},"Amount":{"type":"object","properties":{"Amount":{"type":"object","properties":{}},"Currency":{"type":"string"}}}}}},"StatementFee":{"type":"array","items":{"type":"object","properties":{"Type":{"type":"array","items":{"type":"object","properties":{"s":{"type":"string"}}}},"Amount":{"type":"object","properties":{"Amount":{"type":"object","properties":{}},"Currency":{"type":"string"}}},"CreditDebitIndicator":{"type":"string"}}}},"StartDateTime":{"type":"string"},"StatementId":{"type":"string"},"CreationDateTime":{"type":"string"},"EndDateTime":{"type":"string"},"AccountId":{"type":"object","properties":{}},"Type":{"type":"object","properties":{}},"StatementValue":{"type":"array","items":{"type":"object","properties":{"Type":{"type":"array","items":{"type":"object","properties":{"s":{"type":"string"}}}},"Value":{"type":"integer"}}}},"StatementAmount":{"type":"array","items":{"type":"object","properties":{"Type":{"type":"array","items":{"type":"object","properties":{"s":{"type":"string"}}}},"Amount":{"type":"object","properties":{"Amount":{"type":"object","properties":{}},"Currency":{"type":"string"}}},"CreditDebitIndicator":{"type":"string"}}}},"StatementRate":{"type":"array","items":{"type":"object","properties":{"Type":{"type":"array","items":{"type":"object","properties":{"s":{"type":"string"}}}},"Rate":{"type":"string"}}}},"StatementDescription":{"type":"array","items":{"type":"object","properties":{"s":{"type":"string"}}}},"StatementInterest":{"type":"array","items":{"type":"object","properties":{"Type":{"type":"array","items":{"type":"object","properties":{"s":{"type":"string"}}}},"Amount":{"type":"object","properties":{"Amount":{"type":"object","properties":{}},"Currency":{"type":"string"}}},"CreditDebitIndicator":{"type":"string"}}}}}}}}}}}},"is_featured":false,"special_instructions":"","specified_url":"/open-banking/v3.1/accounts/ACCOUNTID/statements","connector_methods":[]},{"operation_id":"UKv3.1-createFilePayments","implemented_by":{"version":"UKv3.1","function":"createFilePayments"},"request_verb":"POST","request_url":"/open-banking/v3.1/file-payments","summary":"Create File Payments","description":"NOTE: This endpoint currently only returns example data.
\nAuthentication is Mandatory
\nJSON request body fields:
\nJSON response body fields:
\n","description_markdown":"**NOTE: This endpoint currently only returns example data.**\n\n \n\n\nAuthentication is Mandatory\n\n\n**JSON request body fields:**\n\n\n\n\n\n**JSON response body fields:**\n\n\n","example_request_body":{"jsonString":"{}"},"success_response_body":{"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}}},"error_response_bodies":["OBP-20001: User not logged in. Authentication is required!","OBP-50000: Unknown Error."],"tags":["File Payments","Mocked-Data"],"typed_request_body":{"type":"object","properties":{"jsonString":{"type":"string"}}},"typed_success_response_body":{"type":"object","properties":{"type":"object","properties":{"Meta":{"type":"object","properties":{"FirstAvailableDateTime":{"type":"object","properties":{}},"TotalPages":{"type":"integer"}}},"Links":{"type":"object","properties":{"First":{"type":"string"},"Self":{"type":"string"},"Next":{"type":"string"},"Last":{"type":"string"},"Prev":{"type":"string"}}},"Data":{"type":"object","properties":{"StatusUpdateDateTime":{"type":"string"},"Initiation":{"type":"object","properties":{"RequestedExecutionDateTime":{"type":"string"},"DebtorAccount":{"type":"object","properties":{"SecondaryIdentification":{"type":"string"},"SchemeName":{"type":"array","items":{"type":"object","properties":{"s":{"type":"string"}}}},"Identification":{"type":"string"},"Name":{"type":"string"}}},"NumberOfTransactions":{"type":"string"},"ControlSum":{"type":"number"},"LocalInstrument":{"type":"array","items":{"type":"object","properties":{"s":{"type":"string"}}}},"SupplementaryData":{"type":"object","properties":{}},"RemittanceInformation":{"type":"object","properties":{"Unstructured":{"type":"string"},"Reference":{"type":"string"}}},"FileHash":{"type":"string"},"FileReference":{"type":"string"},"FileType":{"type":"array","items":{"type":"object","properties":{"s":{"type":"string"}}}}}},"FilePaymentId":{"type":"string"},"CreationDateTime":{"type":"string"},"ConsentId":{"type":"string"},"Status":{"type":"object","properties":{}},"Charges":{"type":"array","items":{"type":"object","properties":{"Type":{"type":"array","items":{"type":"object","properties":{"s":{"type":"string"}}}},"Amount":{"type":"object","properties":{"Amount":{"type":"object","properties":{}},"Currency":{"type":"string"}}},"ChargeBearer":{"type":"object","properties":{}}}}},"MultiAuthorisation":{"type":"object","properties":{"ExpirationDateTime":{"type":"string"},"NumberRequired":{"type":"integer"},"Status":{"type":"object","properties":{}},"NumberReceived":{"type":"integer"},"LastUpdateDateTime":{"type":"string"}}}}}}}},"is_featured":false,"special_instructions":"","specified_url":"/open-banking/v3.1/file-payments","connector_methods":[]},{"operation_id":"UKv3.1-getAccountsAccountIdBalances","implemented_by":{"version":"UKv3.1","function":"getAccountsAccountIdBalances"},"request_verb":"GET","request_url":"/open-banking/v3.1/accounts/ACCOUNT_ID/balances","summary":"Get Balances","description":"Authentication is Mandatory
\nURL Parameters:
\nACCOUNT_ID: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
\nJSON response body fields:
\n","description_markdown":"Authentication is Mandatory\n\n\n**URL Parameters:**\n\n[ACCOUNT_ID](/glossary#Account.account_id): 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0\n\n\n\n\n\n**JSON response body fields:**\n\n\n","example_request_body":{"jsonString":"{}"},"success_response_body":{"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"}]}},"error_response_bodies":["OBP-20001: User not logged in. Authentication is required!","OBP-50000: Unknown Error."],"tags":["Balances"],"typed_request_body":{"type":"object","properties":{"jsonString":{"type":"string"}}},"typed_success_response_body":{"type":"object","properties":{"type":"object","properties":{"Meta":{"type":"object","properties":{"FirstAvailableDateTime":{"type":"object","properties":{}},"TotalPages":{"type":"integer"}}},"Links":{"type":"object","properties":{"First":{"type":"string"},"Self":{"type":"string"},"Next":{"type":"string"},"Last":{"type":"string"},"Prev":{"type":"string"}}},"Data":{"type":"object","properties":{"Balance":{"type":"array","items":{"type":"object","properties":{"CreditLine":{"type":"array","items":{"type":"object","properties":{"Type":{"type":"object","properties":{}},"Included":{"type":"boolean"},"Amount":{"type":"object","properties":{"Amount":{"type":"object","properties":{}},"Currency":{"type":"string"}}}}}},"Amount":{"type":"object","properties":{"Amount":{"type":"object","properties":{}},"Currency":{"type":"string"}}},"AccountId":{"type":"object","properties":{}},"Type":{"type":"object","properties":{}},"DateTime":{"type":"string"},"CreditDebitIndicator":{"type":"string"}}}}}}}}},"is_featured":false,"special_instructions":"","specified_url":"/open-banking/v3.1/accounts/ACCOUNT_ID/balances","connector_methods":[]},{"operation_id":"UKv3.1-getDomesticStandingOrderConsentsConsentId","implemented_by":{"version":"UKv3.1","function":"getDomesticStandingOrderConsentsConsentId"},"request_verb":"GET","request_url":"/open-banking/v3.1/domestic-standing-order-consents/CONSENTID","summary":"Get Domestic Standing Order Consents","description":"NOTE: This endpoint currently only returns example data.
\nAuthentication is Mandatory
\nURL Parameters:
\nCONSENTID: CONSENTID
\nJSON response body fields:
\n","description_markdown":"**NOTE: This endpoint currently only returns example data.**\n\n \n\n\nAuthentication is Mandatory\n\n\n**URL Parameters:**\n\n[CONSENTID](/glossary#): CONSENTID\n\n\n\n\n\n**JSON response body fields:**\n\n\n","example_request_body":{"jsonString":"{}"},"success_response_body":{"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"}}},"error_response_bodies":["OBP-20001: User not logged in. Authentication is required!","OBP-50000: Unknown Error."],"tags":["Domestic Standing Orders","Mocked-Data"],"typed_request_body":{"type":"object","properties":{"jsonString":{"type":"string"}}},"typed_success_response_body":{"type":"object","properties":{"type":"object","properties":{"Meta":{"type":"object","properties":{"FirstAvailableDateTime":{"type":"object","properties":{}},"TotalPages":{"type":"integer"}}},"Risk":{"type":"object","properties":{"PaymentContextCode":{"type":"object","properties":{}},"DeliveryAddress":{"type":"object","properties":{"CountrySubDivision":{"type":"array","items":{"type":"object","properties":{"s":{"type":"string"}}}},"Country":{"type":"string"},"StreetName":{"type":"string"},"BuildingNumber":{"type":"string"},"AddressLine":{"type":"array","items":{"type":"object","properties":{"s":{"type":"string"}}}},"TownName":{"type":"string"},"PostCode":{"type":"string"}}},"MerchantCategoryCode":{"type":"string"},"MerchantCustomerIdentification":{"type":"string"}}},"Links":{"type":"object","properties":{"First":{"type":"string"},"Self":{"type":"string"},"Next":{"type":"string"},"Last":{"type":"string"},"Prev":{"type":"string"}}},"Data":{"type":"object","properties":{"StatusUpdateDateTime":{"type":"string"},"CreationDateTime":{"type":"string"},"Permission":{"type":"object","properties":{}},"ConsentId":{"type":"string"},"Initiation":{"type":"object","properties":{"RecurringPaymentDateTime":{"type":"string"},"CreditorAccount":{"type":"object","properties":{"SecondaryIdentification":{"type":"string"},"SchemeName":{"type":"array","items":{"type":"object","properties":{"s":{"type":"string"}}}},"Identification":{"type":"string"},"Name":{"type":"string"}}},"FirstPaymentAmount":{"type":"object","properties":{"Amount":{"type":"object","properties":{}},"Currency":{"type":"string"}}},"NumberOfPayments":{"type":"string"},"FinalPaymentDateTime":{"type":"string"},"DebtorAccount":{"type":"object","properties":{"SecondaryIdentification":{"type":"string"},"SchemeName":{"type":"array","items":{"type":"object","properties":{"s":{"type":"string"}}}},"Identification":{"type":"string"},"Name":{"type":"string"}}},"FirstPaymentDateTime":{"type":"string"},"SupplementaryData":{"type":"object","properties":{}},"Frequency":{"type":"string"},"RecurringPaymentAmount":{"type":"object","properties":{"Currency":{"type":"string"}}},"FinalPaymentAmount":{"type":"object","properties":{"Currency":{"type":"string"}}},"Reference":{"type":"string"}}},"Status":{"type":"object","properties":{}},"Charges":{"type":"array","items":{"type":"object","properties":{"Type":{"type":"array","items":{"type":"object","properties":{"s":{"type":"string"}}}},"Amount":{"type":"object","properties":{"Amount":{"type":"object","properties":{}},"Currency":{"type":"string"}}},"ChargeBearer":{"type":"object","properties":{}}}}},"Authorisation":{"type":"object","properties":{"CompletionDateTime":{"type":"string"},"AuthorisationType":{"type":"object","properties":{}}}},"CutOffDateTime":{"type":"string"}}}}}},"is_featured":false,"special_instructions":"","specified_url":"/open-banking/v3.1/domestic-standing-order-consents/CONSENTID","connector_methods":[]},{"operation_id":"UKv3.1-getAccountsAccountIdStatementsStatementId","implemented_by":{"version":"UKv3.1","function":"getAccountsAccountIdStatementsStatementId"},"request_verb":"GET","request_url":"/open-banking/v3.1/accounts/ACCOUNTID/statements/STATEMENTID","summary":"Get Statements","description":"NOTE: This endpoint currently only returns example data.
\nAuthentication is Mandatory
\nURL Parameters:
\nACCOUNTID: ACCOUNTID
\nSTATEMENTID: STATEMENTID
\nJSON response body fields:
\n","description_markdown":"**NOTE: This endpoint currently only returns example data.**\n\n \n\n\nAuthentication is Mandatory\n\n\n**URL Parameters:**\n\n[ACCOUNTID](/glossary#): ACCOUNTID\n\n\n\n[STATEMENTID](/glossary#): STATEMENTID\n\n\n\n\n\n**JSON response body fields:**\n\n\n","example_request_body":{"jsonString":"{}"},"success_response_body":{"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"}]}]}},"error_response_bodies":["OBP-20001: User not logged in. Authentication is required!","OBP-50000: Unknown Error."],"tags":["Statements","Mocked-Data"],"typed_request_body":{"type":"object","properties":{"jsonString":{"type":"string"}}},"typed_success_response_body":{"type":"object","properties":{"type":"object","properties":{"Meta":{"type":"object","properties":{"FirstAvailableDateTime":{"type":"object","properties":{}},"TotalPages":{"type":"integer"}}},"Links":{"type":"object","properties":{"First":{"type":"string"},"Self":{"type":"string"},"Next":{"type":"string"},"Last":{"type":"string"},"Prev":{"type":"string"}}},"Data":{"type":"object","properties":{"Statement":{"type":"array","items":{"type":"object","properties":{"StatementReference":{"type":"string"},"StatementDateTime":{"type":"array","items":{"type":"object","properties":{"Type":{"type":"array","items":{"type":"object","properties":{"s":{"type":"string"}}}},"DateTime":{"type":"string"}}}},"StatementBenefit":{"type":"array","items":{"type":"object","properties":{"Type":{"type":"array","items":{"type":"object","properties":{"s":{"type":"string"}}}},"Amount":{"type":"object","properties":{"Amount":{"type":"object","properties":{}},"Currency":{"type":"string"}}}}}},"StatementFee":{"type":"array","items":{"type":"object","properties":{"Type":{"type":"array","items":{"type":"object","properties":{"s":{"type":"string"}}}},"Amount":{"type":"object","properties":{"Amount":{"type":"object","properties":{}},"Currency":{"type":"string"}}},"CreditDebitIndicator":{"type":"string"}}}},"StartDateTime":{"type":"string"},"StatementId":{"type":"string"},"CreationDateTime":{"type":"string"},"EndDateTime":{"type":"string"},"AccountId":{"type":"object","properties":{}},"Type":{"type":"object","properties":{}},"StatementValue":{"type":"array","items":{"type":"object","properties":{"Type":{"type":"array","items":{"type":"object","properties":{"s":{"type":"string"}}}},"Value":{"type":"integer"}}}},"StatementAmount":{"type":"array","items":{"type":"object","properties":{"Type":{"type":"array","items":{"type":"object","properties":{"s":{"type":"string"}}}},"Amount":{"type":"object","properties":{"Amount":{"type":"object","properties":{}},"Currency":{"type":"string"}}},"CreditDebitIndicator":{"type":"string"}}}},"StatementRate":{"type":"array","items":{"type":"object","properties":{"Type":{"type":"array","items":{"type":"object","properties":{"s":{"type":"string"}}}},"Rate":{"type":"string"}}}},"StatementDescription":{"type":"array","items":{"type":"object","properties":{"s":{"type":"string"}}}},"StatementInterest":{"type":"array","items":{"type":"object","properties":{"Type":{"type":"array","items":{"type":"object","properties":{"s":{"type":"string"}}}},"Amount":{"type":"object","properties":{"Amount":{"type":"object","properties":{}},"Currency":{"type":"string"}}},"CreditDebitIndicator":{"type":"string"}}}}}}}}}}}},"is_featured":false,"special_instructions":"","specified_url":"/open-banking/v3.1/accounts/ACCOUNTID/statements/STATEMENTID","connector_methods":[]},{"operation_id":"UKv3.1-createFilePaymentConsents","implemented_by":{"version":"UKv3.1","function":"createFilePaymentConsents"},"request_verb":"POST","request_url":"/open-banking/v3.1/file-payment-consents","summary":"Create File Payment Consents","description":"NOTE: This endpoint currently only returns example data.
\nAuthentication is Mandatory
\nJSON request body fields:
\nJSON response body fields:
\n","description_markdown":"**NOTE: This endpoint currently only returns example data.**\n\n \n\n\nAuthentication is Mandatory\n\n\n**JSON request body fields:**\n\n\n\n\n\n**JSON response body fields:**\n\n\n","example_request_body":{"jsonString":"{}"},"success_response_body":{"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"}}},"error_response_bodies":["OBP-20001: User not logged in. Authentication is required!","OBP-50000: Unknown Error."],"tags":["File Payments","Mocked-Data"],"typed_request_body":{"type":"object","properties":{"jsonString":{"type":"string"}}},"typed_success_response_body":{"type":"object","properties":{"type":"object","properties":{"Meta":{"type":"object","properties":{"FirstAvailableDateTime":{"type":"object","properties":{}},"TotalPages":{"type":"integer"}}},"Links":{"type":"object","properties":{"First":{"type":"string"},"Self":{"type":"string"},"Next":{"type":"string"},"Last":{"type":"string"},"Prev":{"type":"string"}}},"Data":{"type":"object","properties":{"StatusUpdateDateTime":{"type":"string"},"Initiation":{"type":"object","properties":{"RequestedExecutionDateTime":{"type":"string"},"DebtorAccount":{"type":"object","properties":{"SecondaryIdentification":{"type":"string"},"SchemeName":{"type":"array","items":{"type":"object","properties":{"s":{"type":"string"}}}},"Identification":{"type":"string"},"Name":{"type":"string"}}},"NumberOfTransactions":{"type":"string"},"ControlSum":{"type":"number"},"LocalInstrument":{"type":"array","items":{"type":"object","properties":{"s":{"type":"string"}}}},"SupplementaryData":{"type":"object","properties":{}},"RemittanceInformation":{"type":"object","properties":{"Unstructured":{"type":"string"},"Reference":{"type":"string"}}},"FileHash":{"type":"string"},"FileReference":{"type":"string"},"FileType":{"type":"array","items":{"type":"object","properties":{"s":{"type":"string"}}}}}},"CreationDateTime":{"type":"string"},"ConsentId":{"type":"string"},"Status":{"type":"object","properties":{}},"Charges":{"type":"array","items":{"type":"object","properties":{"Type":{"type":"array","items":{"type":"object","properties":{"s":{"type":"string"}}}},"Amount":{"type":"object","properties":{"Amount":{"type":"object","properties":{}},"Currency":{"type":"string"}}},"ChargeBearer":{"type":"object","properties":{}}}}},"Authorisation":{"type":"object","properties":{"CompletionDateTime":{"type":"string"},"AuthorisationType":{"type":"object","properties":{}}}},"CutOffDateTime":{"type":"string"}}}}}},"is_featured":false,"special_instructions":"","specified_url":"/open-banking/v3.1/file-payment-consents","connector_methods":[]},{"operation_id":"UKv3.1-getAccountsAccountIdStatementsStatementIdTransactions","implemented_by":{"version":"UKv3.1","function":"getAccountsAccountIdStatementsStatementIdTransactions"},"request_verb":"GET","request_url":"/open-banking/v3.1/accounts/ACCOUNTID/statements/STATEMENTID/transactions","summary":"Get Transactions","description":"NOTE: This endpoint currently only returns example data.
\nAuthentication is Mandatory
\nURL Parameters:
\nACCOUNTID: ACCOUNTID
\nSTATEMENTID: STATEMENTID
\nJSON response body fields:
\n","description_markdown":"**NOTE: This endpoint currently only returns example data.**\n\n \n\n\nAuthentication is Mandatory\n\n\n**URL Parameters:**\n\n[ACCOUNTID](/glossary#): ACCOUNTID\n\n\n\n[STATEMENTID](/glossary#): STATEMENTID\n\n\n\n\n\n**JSON response body fields:**\n\n\n","example_request_body":{"jsonString":"{}"},"success_response_body":{"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"}}]}},"error_response_bodies":["OBP-20001: User not logged in. Authentication is required!","OBP-50000: Unknown Error."],"tags":["Statements","Transactions","Mocked-Data"],"typed_request_body":{"type":"object","properties":{"jsonString":{"type":"string"}}},"typed_success_response_body":{"type":"object","properties":{"type":"object","properties":{"Meta":{"type":"object","properties":{"FirstAvailableDateTime":{"type":"object","properties":{}},"TotalPages":{"type":"integer"}}},"Links":{"type":"object","properties":{"First":{"type":"string"},"Self":{"type":"string"},"Next":{"type":"string"},"Last":{"type":"string"},"Prev":{"type":"string"}}},"Data":{"type":"object","properties":{"Transaction":{"type":"array","items":{"type":"object","properties":{"Balance":{"type":"object","properties":{"Type":{"type":"object","properties":{}},"Amount":{"type":"object","properties":{"Amount":{"type":"object","properties":{}},"Currency":{"type":"string"}}},"CreditDebitIndicator":{"type":"string"}}},"DebtorAgent":{"type":"object","properties":{"PostalAddress":{"type":"object","properties":{"CountrySubDivision":{"type":"string"},"Country":{"type":"string"},"Department":{"type":"string"},"StreetName":{"type":"string"},"AddressType":{"type":"object","properties":{}},"BuildingNumber":{"type":"string"},"TownName":{"type":"string"},"SubDepartment":{"type":"string"},"PostCode":{"type":"string"},"AddressLine":{"type":"array","items":{"type":"object","properties":{"s":{"type":"string"}}}}}},"SchemeName":{"type":"array","items":{"type":"object","properties":{"s":{"type":"string"}}}},"Identification":{"type":"string"},"Name":{"type":"string"}}},"TransactionId":{"type":"string"},"StatementReference":{"type":"array","items":{"type":"object","properties":{"s":{"type":"string"}}}},"CreditorAgent":{"type":"object","properties":{"PostalAddress":{"type":"object","properties":{"CountrySubDivision":{"type":"string"},"Country":{"type":"string"},"Department":{"type":"string"},"StreetName":{"type":"string"},"AddressType":{"type":"object","properties":{}},"BuildingNumber":{"type":"string"},"TownName":{"type":"string"},"SubDepartment":{"type":"string"},"PostCode":{"type":"string"},"AddressLine":{"type":"array","items":{"type":"object","properties":{"s":{"type":"string"}}}}}},"SchemeName":{"type":"array","items":{"type":"object","properties":{"s":{"type":"string"}}}},"Identification":{"type":"string"},"Name":{"type":"string"}}},"MerchantDetails":{"type":"object","properties":{"MerchantName":{"type":"string"},"MerchantCategoryCode":{"type":"string"}}},"TransactionInformation":{"type":"object","properties":{}},"CreditorAccount":{"type":"object","properties":{"SecondaryIdentification":{"type":"string"},"SchemeName":{"type":"array","items":{"type":"object","properties":{"s":{"type":"string"}}}},"Identification":{"type":"string"},"Name":{"type":"string"}}},"Amount":{"type":"object","properties":{"Amount":{"type":"object","properties":{}},"Currency":{"type":"string"}}},"DebtorAccount":{"type":"object","properties":{"SecondaryIdentification":{"type":"string"},"SchemeName":{"type":"array","items":{"type":"object","properties":{"s":{"type":"string"}}}},"Identification":{"type":"string"},"Name":{"type":"string"}}},"AccountId":{"type":"object","properties":{}},"BankTransactionCode":{"type":"object","properties":{"SubCode":{"type":"string"},"Code":{"type":"string"}}},"CurrencyExchange":{"type":"object","properties":{"QuotationDate":{"type":"string"},"SourceCurrency":{"type":"string"},"TargetCurrency":{"type":"string"},"ExchangeRate":{"type":"number"},"ContractIdentification":{"type":"string"},"InstructedAmount":{"type":"object","properties":{"Amount":{"type":"object","properties":{}},"Currency":{"type":"string"}}},"UnitCurrency":{"type":"string"}}},"ProprietaryBankTransactionCode":{"type":"object","properties":{"Issuer":{"type":"string"},"Code":{"type":"string"}}},"CardInstrument":{"type":"object","properties":{"AuthorisationType":{"type":"object","properties":{}},"Identification":{"type":"string"},"CardSchemeName":{"type":"object","properties":{}},"Name":{"type":"string"}}},"ChargeAmount":{"type":"object","properties":{"Amount":{"type":"object","properties":{}},"Currency":{"type":"string"}}},"Status":{"type":"object","properties":{}},"ValueDateTime":{"type":"string"},"TransactionReference":{"type":"string"},"SupplementaryData":{"type":"object","properties":{}},"BookingDateTime":{"type":"string"},"AddressLine":{"type":"string"},"CreditDebitIndicator":{"type":"string"}}}}}}}}},"is_featured":false,"special_instructions":"","specified_url":"/open-banking/v3.1/accounts/ACCOUNTID/statements/STATEMENTID/transactions","connector_methods":[]},{"operation_id":"UKv3.1-getDomesticStandingOrdersDomesticStandingOrderId","implemented_by":{"version":"UKv3.1","function":"getDomesticStandingOrdersDomesticStandingOrderId"},"request_verb":"GET","request_url":"/open-banking/v3.1/domestic-standing-orders/DOMESTICSTANDINGORDERID","summary":"Get Domestic Standing Orders","description":"NOTE: This endpoint currently only returns example data.
\nAuthentication is Mandatory
\nURL Parameters:
\nDOMESTICSTANDINGORDERID: DOMESTICSTANDINGORDERID
\nJSON response body fields:
\n","description_markdown":"**NOTE: This endpoint currently only returns example data.**\n\n \n\n\nAuthentication is Mandatory\n\n\n**URL Parameters:**\n\n[DOMESTICSTANDINGORDERID](/glossary#): DOMESTICSTANDINGORDERID\n\n\n\n\n\n**JSON response body fields:**\n\n\n","example_request_body":{"jsonString":"{}"},"success_response_body":{"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}}},"error_response_bodies":["OBP-20001: User not logged in. Authentication is required!","OBP-50000: Unknown Error."],"tags":["Domestic Standing Orders","Mocked-Data"],"typed_request_body":{"type":"object","properties":{"jsonString":{"type":"string"}}},"typed_success_response_body":{"type":"object","properties":{"type":"object","properties":{"Meta":{"type":"object","properties":{"FirstAvailableDateTime":{"type":"object","properties":{}},"TotalPages":{"type":"integer"}}},"Links":{"type":"object","properties":{"First":{"type":"string"},"Self":{"type":"string"},"Next":{"type":"string"},"Last":{"type":"string"},"Prev":{"type":"string"}}},"Data":{"type":"object","properties":{"StatusUpdateDateTime":{"type":"string"},"CreationDateTime":{"type":"string"},"ConsentId":{"type":"string"},"Initiation":{"type":"object","properties":{"RecurringPaymentDateTime":{"type":"string"},"CreditorAccount":{"type":"object","properties":{"SecondaryIdentification":{"type":"string"},"SchemeName":{"type":"array","items":{"type":"object","properties":{"s":{"type":"string"}}}},"Identification":{"type":"string"},"Name":{"type":"string"}}},"FirstPaymentAmount":{"type":"object","properties":{"Amount":{"type":"object","properties":{}},"Currency":{"type":"string"}}},"NumberOfPayments":{"type":"string"},"FinalPaymentDateTime":{"type":"string"},"DebtorAccount":{"type":"object","properties":{"SecondaryIdentification":{"type":"string"},"SchemeName":{"type":"array","items":{"type":"object","properties":{"s":{"type":"string"}}}},"Identification":{"type":"string"},"Name":{"type":"string"}}},"FirstPaymentDateTime":{"type":"string"},"SupplementaryData":{"type":"object","properties":{}},"Frequency":{"type":"string"},"RecurringPaymentAmount":{"type":"object","properties":{"Currency":{"type":"string"}}},"FinalPaymentAmount":{"type":"object","properties":{"Currency":{"type":"string"}}},"Reference":{"type":"string"}}},"DomesticStandingOrderId":{"type":"string"},"Status":{"type":"object","properties":{}},"Charges":{"type":"array","items":{"type":"object","properties":{"Type":{"type":"array","items":{"type":"object","properties":{"s":{"type":"string"}}}},"Amount":{"type":"object","properties":{"Amount":{"type":"object","properties":{}},"Currency":{"type":"string"}}},"ChargeBearer":{"type":"object","properties":{}}}}},"MultiAuthorisation":{"type":"object","properties":{"ExpirationDateTime":{"type":"string"},"NumberRequired":{"type":"integer"},"Status":{"type":"object","properties":{}},"NumberReceived":{"type":"integer"},"LastUpdateDateTime":{"type":"string"}}}}}}}},"is_featured":false,"special_instructions":"","specified_url":"/open-banking/v3.1/domestic-standing-orders/DOMESTICSTANDINGORDERID","connector_methods":[]},{"operation_id":"UKv3.1-createInternationalScheduledPayments","implemented_by":{"version":"UKv3.1","function":"createInternationalScheduledPayments"},"request_verb":"POST","request_url":"/open-banking/v3.1/international-scheduled-payments","summary":"Create International Scheduled Payments","description":"NOTE: This endpoint currently only returns example data.
\nAuthentication is Mandatory
\nJSON request body fields:
\nJSON response body fields:
\n","description_markdown":"**NOTE: This endpoint currently only returns example data.**\n\n \n\n\nAuthentication is Mandatory\n\n\n**JSON request body fields:**\n\n\n\n\n\n**JSON response body fields:**\n\n\n","example_request_body":{"jsonString":"{}"},"success_response_body":{"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}}},"error_response_bodies":["OBP-20001: User not logged in. Authentication is required!","OBP-50000: Unknown Error."],"tags":["International Scheduled Payments","Mocked-Data"],"typed_request_body":{"type":"object","properties":{"jsonString":{"type":"string"}}},"typed_success_response_body":{"type":"object","properties":{"type":"object","properties":{"Meta":{"type":"object","properties":{"FirstAvailableDateTime":{"type":"object","properties":{}},"TotalPages":{"type":"integer"}}},"Links":{"type":"object","properties":{"First":{"type":"string"},"Self":{"type":"string"},"Next":{"type":"string"},"Last":{"type":"string"},"Prev":{"type":"string"}}},"Data":{"type":"object","properties":{"ExpectedExecutionDateTime":{"type":"string"},"ExpectedSettlementDateTime":{"type":"string"},"StatusUpdateDateTime":{"type":"string"},"CreationDateTime":{"type":"string"},"Initiation":{"type":"object","properties":{"CurrencyOfTransfer":{"type":"string"},"InstructedAmount":{"type":"object","properties":{"Currency":{"type":"string"}}},"RequestedExecutionDateTime":{"type":"string"},"CreditorAgent":{"type":"object","properties":{"PostalAddress":{"type":"object","properties":{"CountrySubDivision":{"type":"string"},"Country":{"type":"string"},"Department":{"type":"string"},"StreetName":{"type":"string"},"AddressType":{"type":"object","properties":{}},"BuildingNumber":{"type":"string"},"TownName":{"type":"string"},"SubDepartment":{"type":"string"},"PostCode":{"type":"string"},"AddressLine":{"type":"array","items":{"type":"object","properties":{"s":{"type":"string"}}}}}},"SchemeName":{"type":"array","items":{"type":"object","properties":{"s":{"type":"string"}}}},"Identification":{"type":"string"},"Name":{"type":"string"}}},"InstructionPriority":{"type":"object","properties":{}},"CreditorAccount":{"type":"object","properties":{"SecondaryIdentification":{"type":"string"},"SchemeName":{"type":"array","items":{"type":"object","properties":{"s":{"type":"string"}}}},"Identification":{"type":"string"},"Name":{"type":"string"}}},"EndToEndIdentification":{"type":"string"},"DebtorAccount":{"type":"object","properties":{"SecondaryIdentification":{"type":"string"},"SchemeName":{"type":"array","items":{"type":"object","properties":{"s":{"type":"string"}}}},"Identification":{"type":"string"},"Name":{"type":"string"}}},"ChargeBearer":{"type":"object","properties":{}},"InstructionIdentification":{"type":"string"},"LocalInstrument":{"type":"array","items":{"type":"object","properties":{"s":{"type":"string"}}}},"SupplementaryData":{"type":"object","properties":{}},"Purpose":{"type":"object","properties":{}},"RemittanceInformation":{"type":"object","properties":{"Unstructured":{"type":"string"},"Reference":{"type":"string"}}},"Creditor":{"type":"object","properties":{"PostalAddress":{"type":"object","properties":{"CountrySubDivision":{"type":"string"},"Country":{"type":"string"},"Department":{"type":"string"},"StreetName":{"type":"string"},"AddressType":{"type":"object","properties":{}},"BuildingNumber":{"type":"string"},"TownName":{"type":"string"},"SubDepartment":{"type":"string"},"PostCode":{"type":"string"},"AddressLine":{"type":"array","items":{"type":"object","properties":{"s":{"type":"string"}}}}}},"Name":{"type":"string"}}},"ExchangeRateInformation":{"type":"object","properties":{"ExchangeRate":{"type":"number"},"UnitCurrency":{"type":"string"},"ContractIdentification":{"type":"string"}}}}},"ConsentId":{"type":"string"},"ExchangeRateInformation":{"type":"object","properties":{"ExpirationDateTime":{"type":"string"},"ExchangeRate":{"type":"number"},"RateType":{"type":"object","properties":{}},"ContractIdentification":{"type":"string"},"UnitCurrency":{"type":"string"}}},"Status":{"type":"object","properties":{}},"Charges":{"type":"array","items":{"type":"object","properties":{"Type":{"type":"array","items":{"type":"object","properties":{"s":{"type":"string"}}}},"Amount":{"type":"object","properties":{"Amount":{"type":"object","properties":{}},"Currency":{"type":"string"}}},"ChargeBearer":{"type":"object","properties":{}}}}},"MultiAuthorisation":{"type":"object","properties":{"ExpirationDateTime":{"type":"string"},"NumberRequired":{"type":"integer"},"Status":{"type":"object","properties":{}},"NumberReceived":{"type":"integer"},"LastUpdateDateTime":{"type":"string"}}},"InternationalScheduledPaymentId":{"type":"string"}}}}}},"is_featured":false,"special_instructions":"","specified_url":"/open-banking/v3.1/international-scheduled-payments","connector_methods":[]},{"operation_id":"UKv3.1-getParty","implemented_by":{"version":"UKv3.1","function":"getParty"},"request_verb":"GET","request_url":"/open-banking/v3.1/party","summary":"Get Party","description":"NOTE: This endpoint currently only returns example data.
\nAuthentication is Mandatory
\nJSON response body fields:
\n","description_markdown":"**NOTE: This endpoint currently only returns example data.**\n\n \n\n\nAuthentication is Mandatory\n\n\n**JSON response body fields:**\n\n\n","example_request_body":{"jsonString":"{}"},"success_response_body":{"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"}}},"error_response_bodies":["OBP-20001: User not logged in. Authentication is required!","OBP-50000: Unknown Error."],"tags":["Partys","Mocked-Data"],"typed_request_body":{"type":"object","properties":{"jsonString":{"type":"string"}}},"typed_success_response_body":{"type":"object","properties":{"type":"object","properties":{"Meta":{"type":"object","properties":{"FirstAvailableDateTime":{"type":"object","properties":{}},"TotalPages":{"type":"integer"}}},"Links":{"type":"object","properties":{"First":{"type":"string"},"Self":{"type":"string"},"Next":{"type":"string"},"Last":{"type":"string"},"Prev":{"type":"string"}}},"Data":{"type":"object","properties":{"Party":{"type":"object","properties":{"EmailAddress":{"type":"string"},"PartyType":{"type":"object","properties":{}},"Name":{"type":"string"},"Mobile":{"type":"string"},"Address":{"type":"array","items":{"type":"object","properties":{"CountrySubDivision":{"type":"string"},"AddressLine":{"type":"array","items":{"type":"object","properties":{"s":{"type":"string"}}}},"Country":{"type":"string"},"StreetName":{"type":"string"},"AddressType":{"type":"object","properties":{}},"BuildingNumber":{"type":"string"},"TownName":{"type":"string"},"PostCode":{"type":"string"}}}},"PartyId":{"type":"string"},"Phone":{"type":"string"},"PartyNumber":{"type":"string"}}}}}}}},"is_featured":false,"special_instructions":"","specified_url":"/open-banking/v3.1/party","connector_methods":[]},{"operation_id":"UKv3.1-createInternationalPaymentConsents","implemented_by":{"version":"UKv3.1","function":"createInternationalPaymentConsents"},"request_verb":"POST","request_url":"/open-banking/v3.1/international-payment-consents","summary":"Create International Payment Consents","description":"NOTE: This endpoint currently only returns example data.
\nAuthentication is Mandatory
\nJSON request body fields:
\nJSON response body fields:
\n","description_markdown":"**NOTE: This endpoint currently only returns example data.**\n\n \n\n\nAuthentication is Mandatory\n\n\n**JSON request body fields:**\n\n\n\n\n\n**JSON response body fields:**\n\n\n","example_request_body":{"jsonString":"{}"},"success_response_body":{"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"}},"error_response_bodies":["OBP-20001: User not logged in. Authentication is required!","OBP-50000: Unknown Error."],"tags":["International Payments","Mocked-Data"],"typed_request_body":{"type":"object","properties":{"jsonString":{"type":"string"}}},"typed_success_response_body":{"type":"object","properties":{"type":"object","properties":{"Meta":{"type":"object","properties":{"FirstAvailableDateTime":{"type":"object","properties":{}},"TotalPages":{"type":"integer"}}},"Risk":{"type":"object","properties":{"PaymentContextCode":{"type":"object","properties":{}},"DeliveryAddress":{"type":"object","properties":{"CountrySubDivision":{"type":"array","items":{"type":"object","properties":{"s":{"type":"string"}}}},"Country":{"type":"string"},"StreetName":{"type":"string"},"BuildingNumber":{"type":"string"},"AddressLine":{"type":"array","items":{"type":"object","properties":{"s":{"type":"string"}}}},"TownName":{"type":"string"},"PostCode":{"type":"string"}}},"MerchantCategoryCode":{"type":"string"},"MerchantCustomerIdentification":{"type":"string"}}},"Links":{"type":"object","properties":{"First":{"type":"string"},"Self":{"type":"string"},"Next":{"type":"string"},"Last":{"type":"string"},"Prev":{"type":"string"}}},"Data":{"type":"object","properties":{"ExpectedExecutionDateTime":{"type":"string"},"ExpectedSettlementDateTime":{"type":"string"},"StatusUpdateDateTime":{"type":"string"},"CreationDateTime":{"type":"string"},"Initiation":{"type":"object","properties":{"CurrencyOfTransfer":{"type":"string"},"InstructedAmount":{"type":"object","properties":{"Currency":{"type":"string"}}},"CreditorAgent":{"type":"object","properties":{"PostalAddress":{"type":"object","properties":{"CountrySubDivision":{"type":"string"},"Country":{"type":"string"},"Department":{"type":"string"},"StreetName":{"type":"string"},"AddressType":{"type":"object","properties":{}},"BuildingNumber":{"type":"string"},"TownName":{"type":"string"},"SubDepartment":{"type":"string"},"PostCode":{"type":"string"},"AddressLine":{"type":"array","items":{"type":"object","properties":{"s":{"type":"string"}}}}}},"SchemeName":{"type":"array","items":{"type":"object","properties":{"s":{"type":"string"}}}},"Identification":{"type":"string"},"Name":{"type":"string"}}},"InstructionPriority":{"type":"object","properties":{}},"CreditorAccount":{"type":"object","properties":{"SecondaryIdentification":{"type":"string"},"SchemeName":{"type":"array","items":{"type":"object","properties":{"s":{"type":"string"}}}},"Identification":{"type":"string"},"Name":{"type":"string"}}},"EndToEndIdentification":{"type":"string"},"DebtorAccount":{"type":"object","properties":{"SecondaryIdentification":{"type":"string"},"SchemeName":{"type":"array","items":{"type":"object","properties":{"s":{"type":"string"}}}},"Identification":{"type":"string"},"Name":{"type":"string"}}},"ChargeBearer":{"type":"object","properties":{}},"InstructionIdentification":{"type":"string"},"LocalInstrument":{"type":"array","items":{"type":"object","properties":{"s":{"type":"string"}}}},"SupplementaryData":{"type":"object","properties":{}},"Purpose":{"type":"object","properties":{}},"RemittanceInformation":{"type":"object","properties":{"Unstructured":{"type":"string"},"Reference":{"type":"string"}}},"Creditor":{"type":"object","properties":{"PostalAddress":{"type":"object","properties":{"CountrySubDivision":{"type":"string"},"Country":{"type":"string"},"Department":{"type":"string"},"StreetName":{"type":"string"},"AddressType":{"type":"object","properties":{}},"BuildingNumber":{"type":"string"},"TownName":{"type":"string"},"SubDepartment":{"type":"string"},"PostCode":{"type":"string"},"AddressLine":{"type":"array","items":{"type":"object","properties":{"s":{"type":"string"}}}}}},"Name":{"type":"string"}}},"ExchangeRateInformation":{"type":"object","properties":{"ExchangeRate":{"type":"number"},"UnitCurrency":{"type":"string"},"ContractIdentification":{"type":"string"}}}}},"ConsentId":{"type":"string"},"ExchangeRateInformation":{"type":"object","properties":{"ExpirationDateTime":{"type":"string"},"ExchangeRate":{"type":"number"},"RateType":{"type":"object","properties":{}},"ContractIdentification":{"type":"string"},"UnitCurrency":{"type":"string"}}},"Status":{"type":"object","properties":{}},"Charges":{"type":"array","items":{"type":"object","properties":{"Type":{"type":"array","items":{"type":"object","properties":{"s":{"type":"string"}}}},"Amount":{"type":"object","properties":{"Amount":{"type":"object","properties":{}},"Currency":{"type":"string"}}},"ChargeBearer":{"type":"object","properties":{}}}}},"Authorisation":{"type":"object","properties":{"CompletionDateTime":{"type":"string"},"AuthorisationType":{"type":"object","properties":{}}}},"CutOffDateTime":{"type":"string"}}}}}},"is_featured":false,"special_instructions":"","specified_url":"/open-banking/v3.1/international-payment-consents","connector_methods":[]},{"operation_id":"UKv3.1-getAccountsAccountIdDirectDebits","implemented_by":{"version":"UKv3.1","function":"getAccountsAccountIdDirectDebits"},"request_verb":"GET","request_url":"/open-banking/v3.1/accounts/ACCOUNTID/direct-debits","summary":"Get Direct Debits","description":"NOTE: This endpoint currently only returns example data.
\nAuthentication is Mandatory
\nURL Parameters:
\nACCOUNTID: ACCOUNTID
\nJSON response body fields:
\n","description_markdown":"**NOTE: This endpoint currently only returns example data.**\n\n \n\n\nAuthentication is Mandatory\n\n\n**URL Parameters:**\n\n[ACCOUNTID](/glossary#): ACCOUNTID\n\n\n\n\n\n**JSON response body fields:**\n\n\n","example_request_body":{"jsonString":"{}"},"success_response_body":{"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"}]}},"error_response_bodies":["OBP-20001: User not logged in. Authentication is required!","OBP-50000: Unknown Error."],"tags":["Direct Debits","Mocked-Data"],"typed_request_body":{"type":"object","properties":{"jsonString":{"type":"string"}}},"typed_success_response_body":{"type":"object","properties":{"type":"object","properties":{"Meta":{"type":"object","properties":{"FirstAvailableDateTime":{"type":"object","properties":{}},"TotalPages":{"type":"integer"}}},"Links":{"type":"object","properties":{"First":{"type":"string"},"Self":{"type":"string"},"Next":{"type":"string"},"Last":{"type":"string"},"Prev":{"type":"string"}}},"Data":{"type":"object","properties":{"DirectDebit":{"type":"array","items":{"type":"object","properties":{"PreviousPaymentAmount":{"type":"object","properties":{"Amount":{"type":"object","properties":{}},"Currency":{"type":"string"}}},"Name":{"type":"string"},"DirectDebitStatusCode":{"type":"object","properties":{}},"AccountId":{"type":"object","properties":{}},"MandateIdentification":{"type":"string"},"DirectDebitId":{"type":"string"},"PreviousPaymentDateTime":{"type":"string"}}}}}}}}},"is_featured":false,"special_instructions":"","specified_url":"/open-banking/v3.1/accounts/ACCOUNTID/direct-debits","connector_methods":[]},{"operation_id":"UKv3.1-getStandingOrders","implemented_by":{"version":"UKv3.1","function":"getStandingOrders"},"request_verb":"GET","request_url":"/open-banking/v3.1/standing-orders","summary":"Get Standing Orders","description":"NOTE: This endpoint currently only returns example data.
\nAuthentication is Mandatory
\nJSON response body fields:
\n","description_markdown":"**NOTE: This endpoint currently only returns example data.**\n\n \n\n\nAuthentication is Mandatory\n\n\n**JSON response body fields:**\n\n\n","example_request_body":{"jsonString":"{}"},"success_response_body":{"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"}]}},"error_response_bodies":["OBP-20001: User not logged in. Authentication is required!","OBP-50000: Unknown Error."],"tags":["Standing Orders","Mocked-Data"],"typed_request_body":{"type":"object","properties":{"jsonString":{"type":"string"}}},"typed_success_response_body":{"type":"object","properties":{"type":"object","properties":{"Meta":{"type":"object","properties":{"FirstAvailableDateTime":{"type":"object","properties":{}},"TotalPages":{"type":"integer"}}},"Links":{"type":"object","properties":{"First":{"type":"string"},"Self":{"type":"string"},"Next":{"type":"string"},"Last":{"type":"string"},"Prev":{"type":"string"}}},"Data":{"type":"object","properties":{"StandingOrder":{"type":"array","items":{"type":"object","properties":{"CreditorAccount":{"type":"object","properties":{"SecondaryIdentification":{"type":"string"},"SchemeName":{"type":"array","items":{"type":"object","properties":{"s":{"type":"string"}}}},"Identification":{"type":"string"},"Name":{"type":"string"}}},"FirstPaymentAmount":{"type":"object","properties":{"Amount":{"type":"object","properties":{}},"Currency":{"type":"string"}}},"FinalPaymentDateTime":{"type":"string"},"NextPaymentAmount":{"type":"object","properties":{"Amount":{"type":"object","properties":{}},"Currency":{"type":"string"}}},"AccountId":{"type":"object","properties":{}},"FirstPaymentDateTime":{"type":"string"},"StandingOrderStatusCode":{"type":"object","properties":{}},"SupplementaryData":{"type":"object","properties":{}},"Frequency":{"type":"string"},"CreditorAgent":{"type":"object","properties":{"SchemeName":{"type":"array","items":{"type":"object","properties":{"s":{"type":"string"}}}},"Identification":{"type":"string"}}},"FinalPaymentAmount":{"type":"object","properties":{"Amount":{"type":"object","properties":{}},"Currency":{"type":"string"}}},"Reference":{"type":"string"},"NextPaymentDateTime":{"type":"string"},"StandingOrderId":{"type":"string"}}}}}}}}},"is_featured":false,"special_instructions":"","specified_url":"/open-banking/v3.1/standing-orders","connector_methods":[]},{"operation_id":"UKv3.1-createDomesticScheduledPayments","implemented_by":{"version":"UKv3.1","function":"createDomesticScheduledPayments"},"request_verb":"POST","request_url":"/open-banking/v3.1/domestic-scheduled-payments","summary":"Create Domestic Scheduled Payments","description":"NOTE: This endpoint currently only returns example data.
\nAuthentication is Mandatory
\nJSON request body fields:
\nJSON response body fields:
\n","description_markdown":"**NOTE: This endpoint currently only returns example data.**\n\n \n\n\nAuthentication is Mandatory\n\n\n**JSON request body fields:**\n\n\n\n\n\n**JSON response body fields:**\n\n\n","example_request_body":{"jsonString":"{}"},"success_response_body":{"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}}},"error_response_bodies":["OBP-20001: User not logged in. Authentication is required!","OBP-50000: Unknown Error."],"tags":["Domestic Scheduled Payments","Mocked-Data"],"typed_request_body":{"type":"object","properties":{"jsonString":{"type":"string"}}},"typed_success_response_body":{"type":"object","properties":{"type":"object","properties":{"Meta":{"type":"object","properties":{"FirstAvailableDateTime":{"type":"object","properties":{}},"TotalPages":{"type":"integer"}}},"Links":{"type":"object","properties":{"First":{"type":"string"},"Self":{"type":"string"},"Next":{"type":"string"},"Last":{"type":"string"},"Prev":{"type":"string"}}},"Data":{"type":"object","properties":{"ExpectedExecutionDateTime":{"type":"string"},"ExpectedSettlementDateTime":{"type":"string"},"StatusUpdateDateTime":{"type":"string"},"CreationDateTime":{"type":"string"},"DomesticScheduledPaymentId":{"type":"string"},"ConsentId":{"type":"string"},"Status":{"type":"object","properties":{}},"Charges":{"type":"array","items":{"type":"object","properties":{"Type":{"type":"array","items":{"type":"object","properties":{"s":{"type":"string"}}}},"Amount":{"type":"object","properties":{"Amount":{"type":"object","properties":{}},"Currency":{"type":"string"}}},"ChargeBearer":{"type":"object","properties":{}}}}},"MultiAuthorisation":{"type":"object","properties":{"ExpirationDateTime":{"type":"string"},"NumberRequired":{"type":"integer"},"Status":{"type":"object","properties":{}},"NumberReceived":{"type":"integer"},"LastUpdateDateTime":{"type":"string"}}},"Initiation":{"type":"object","properties":{"InstructedAmount":{"type":"object","properties":{"Currency":{"type":"string"}}},"RequestedExecutionDateTime":{"type":"string"},"CreditorPostalAddress":{"type":"object","properties":{"CountrySubDivision":{"type":"string"},"Country":{"type":"string"},"Department":{"type":"string"},"StreetName":{"type":"string"},"AddressType":{"type":"object","properties":{}},"BuildingNumber":{"type":"string"},"TownName":{"type":"string"},"SubDepartment":{"type":"string"},"PostCode":{"type":"string"},"AddressLine":{"type":"array","items":{"type":"object","properties":{"s":{"type":"string"}}}}}},"CreditorAccount":{"type":"object","properties":{"SecondaryIdentification":{"type":"string"},"SchemeName":{"type":"array","items":{"type":"object","properties":{"s":{"type":"string"}}}},"Identification":{"type":"string"},"Name":{"type":"string"}}},"EndToEndIdentification":{"type":"string"},"DebtorAccount":{"type":"object","properties":{"SecondaryIdentification":{"type":"string"},"SchemeName":{"type":"array","items":{"type":"object","properties":{"s":{"type":"string"}}}},"Identification":{"type":"string"},"Name":{"type":"string"}}},"InstructionIdentification":{"type":"string"},"LocalInstrument":{"type":"array","items":{"type":"object","properties":{"s":{"type":"string"}}}},"SupplementaryData":{"type":"object","properties":{}},"RemittanceInformation":{"type":"object","properties":{"Unstructured":{"type":"string"},"Reference":{"type":"string"}}}}}}}}}},"is_featured":false,"special_instructions":"","specified_url":"/open-banking/v3.1/domestic-scheduled-payments","connector_methods":[]},{"operation_id":"UKv3.1-getAccountsAccountIdTransactions","implemented_by":{"version":"UKv3.1","function":"getAccountsAccountIdTransactions"},"request_verb":"GET","request_url":"/open-banking/v3.1/accounts/ACCOUNT_ID/transactions","summary":"Get Transactions","description":"Authentication is Mandatory
\nURL Parameters:
\nACCOUNT_ID: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
\nJSON response body fields:
\n","description_markdown":"Authentication is Mandatory\n\n\n**URL Parameters:**\n\n[ACCOUNT_ID](/glossary#Account.account_id): 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0\n\n\n\n\n\n**JSON response body fields:**\n\n\n","example_request_body":{"jsonString":"{}"},"success_response_body":{"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"}}]}},"error_response_bodies":["OBP-20001: User not logged in. Authentication is required!","OBP-50000: Unknown Error."],"tags":["Transactions"],"typed_request_body":{"type":"object","properties":{"jsonString":{"type":"string"}}},"typed_success_response_body":{"type":"object","properties":{"type":"object","properties":{"Meta":{"type":"object","properties":{"FirstAvailableDateTime":{"type":"string"},"LastAvailableDateTime":{"type":"string"},"TotalPages":{"type":"integer"}}},"Links":{"type":"object","properties":{"First":{"type":"string"},"Self":{"type":"string"},"Next":{"type":"string"},"Last":{"type":"string"},"Prev":{"type":"string"}}},"Data":{"type":"object","properties":{"Transaction":{"type":"array","items":{"type":"object","properties":{"TransactionId":{"type":"string"},"StatementReference":{"type":"array","items":{"type":"object","properties":{"s":{"type":"string"}}}},"MerchantDetails":{"type":"object","properties":{"MerchantName":{"type":"string"},"MerchantCategoryCode":{"type":"string"}}},"CreditorAccount":{"type":"object","properties":{"SecondaryIdentification":{"type":"string"},"SchemeName":{"type":"array","items":{"type":"object","properties":{"s":{"type":"string"}}}},"Identification":{"type":"string"},"Name":{"type":"string"}}},"CurrencyExchange":{"type":"object","properties":{"QuotationDate":{"type":"string"},"SourceCurrency":{"type":"string"},"TargetCurrency":{"type":"string"},"ExchangeRate":{"type":"number"},"ContractIdentification":{"type":"string"},"InstructedAmount":{"type":"object","properties":{"Amount":{"type":"string"},"Currency":{"type":"string"}}},"UnitCurrency":{"type":"string"}}},"DebtorAccount":{"type":"object","properties":{"SecondaryIdentification":{"type":"string"},"SchemeName":{"type":"array","items":{"type":"object","properties":{"s":{"type":"string"}}}},"Identification":{"type":"string"},"Name":{"type":"string"}}},"BankTransactionCode":{"type":"object","properties":{"SubCode":{"type":"string"},"Code":{"type":"string"}}},"Balance":{"type":"object","properties":{"Type":{"type":"string"},"Amount":{"type":"object","properties":{"Amount":{"type":"string"},"Currency":{"type":"string"}}},"CreditDebitIndicator":{"type":"string"}}},"TransactionInformation":{"type":"string"},"DebtorAgent":{"type":"object","properties":{"PostalAddress":{"type":"object","properties":{"CountrySubDivision":{"type":"string"},"Country":{"type":"string"},"Department":{"type":"string"},"StreetName":{"type":"string"},"BuildingNumber":{"type":"string"},"AddressType":{"type":"string"},"TownName":{"type":"string"},"SubDepartment":{"type":"string"},"PostCode":{"type":"string"},"AddressLine":{"type":"array","items":{"type":"object","properties":{"s":{"type":"string"}}}}}},"SchemeName":{"type":"array","items":{"type":"object","properties":{"s":{"type":"string"}}}},"Identification":{"type":"string"},"Name":{"type":"string"}}},"ProprietaryBankTransactionCode":{"type":"object","properties":{"Issuer":{"type":"string"},"Code":{"type":"string"}}},"CreditorAgent":{"type":"object","properties":{"PostalAddress":{"type":"object","properties":{"CountrySubDivision":{"type":"string"},"Country":{"type":"string"},"Department":{"type":"string"},"StreetName":{"type":"string"},"BuildingNumber":{"type":"string"},"AddressType":{"type":"string"},"TownName":{"type":"string"},"SubDepartment":{"type":"string"},"PostCode":{"type":"string"},"AddressLine":{"type":"array","items":{"type":"object","properties":{"s":{"type":"string"}}}}}},"SchemeName":{"type":"array","items":{"type":"object","properties":{"s":{"type":"string"}}}},"Identification":{"type":"string"},"Name":{"type":"string"}}},"ValueDateTime":{"type":"string"},"ChargeAmount":{"type":"object","properties":{"Amount":{"type":"string"},"Currency":{"type":"string"}}},"TransactionReference":{"type":"string"},"SupplementaryData":{"type":"object","properties":{}},"AccountId":{"type":"string"},"BookingDateTime":{"type":"string"},"Amount":{"type":"object","properties":{"Amount":{"type":"string"},"Currency":{"type":"string"}}},"AddressLine":{"type":"string"},"CardInstrument":{"type":"object","properties":{"AuthorisationType":{"type":"string"},"Identification":{"type":"string"},"CardSchemeName":{"type":"string"},"Name":{"type":"string"}}},"Status":{"type":"string"},"CreditDebitIndicator":{"type":"string"}}}}}}}}},"is_featured":false,"special_instructions":"","specified_url":"/open-banking/v3.1/accounts/ACCOUNT_ID/transactions","connector_methods":[]},{"operation_id":"UKv3.1-getDomesticPaymentConsentsConsentId","implemented_by":{"version":"UKv3.1","function":"getDomesticPaymentConsentsConsentId"},"request_verb":"GET","request_url":"/open-banking/v3.1/domestic-payment-consents/CONSENTID","summary":"Get Domestic Payment Consents","description":"NOTE: This endpoint currently only returns example data.
\nAuthentication is Mandatory
\nURL Parameters:
\nCONSENTID: CONSENTID
\nJSON response body fields:
\n","description_markdown":"**NOTE: This endpoint currently only returns example data.**\n\n \n\n\nAuthentication is Mandatory\n\n\n**URL Parameters:**\n\n[CONSENTID](/glossary#): CONSENTID\n\n\n\n\n\n**JSON response body fields:**\n\n\n","example_request_body":{"jsonString":"{}"},"success_response_body":{"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"}},"error_response_bodies":["OBP-20001: User not logged in. Authentication is required!","OBP-50000: Unknown Error."],"tags":["Domestic Payments","Mocked-Data"],"typed_request_body":{"type":"object","properties":{"jsonString":{"type":"string"}}},"typed_success_response_body":{"type":"object","properties":{"type":"object","properties":{"Meta":{"type":"object","properties":{"FirstAvailableDateTime":{"type":"object","properties":{}},"TotalPages":{"type":"integer"}}},"Risk":{"type":"object","properties":{"PaymentContextCode":{"type":"object","properties":{}},"DeliveryAddress":{"type":"object","properties":{"CountrySubDivision":{"type":"array","items":{"type":"object","properties":{"s":{"type":"string"}}}},"Country":{"type":"string"},"StreetName":{"type":"string"},"BuildingNumber":{"type":"string"},"AddressLine":{"type":"array","items":{"type":"object","properties":{"s":{"type":"string"}}}},"TownName":{"type":"string"},"PostCode":{"type":"string"}}},"MerchantCategoryCode":{"type":"string"},"MerchantCustomerIdentification":{"type":"string"}}},"Links":{"type":"object","properties":{"First":{"type":"string"},"Self":{"type":"string"},"Next":{"type":"string"},"Last":{"type":"string"},"Prev":{"type":"string"}}},"Data":{"type":"object","properties":{"ExpectedExecutionDateTime":{"type":"string"},"ExpectedSettlementDateTime":{"type":"string"},"StatusUpdateDateTime":{"type":"string"},"CreationDateTime":{"type":"string"},"ConsentId":{"type":"string"},"Initiation":{"type":"object","properties":{"InstructedAmount":{"type":"object","properties":{"Currency":{"type":"string"}}},"CreditorPostalAddress":{"type":"object","properties":{"CountrySubDivision":{"type":"string"},"Country":{"type":"string"},"Department":{"type":"string"},"StreetName":{"type":"string"},"AddressType":{"type":"object","properties":{}},"BuildingNumber":{"type":"string"},"TownName":{"type":"string"},"SubDepartment":{"type":"string"},"PostCode":{"type":"string"},"AddressLine":{"type":"array","items":{"type":"object","properties":{"s":{"type":"string"}}}}}},"CreditorAccount":{"type":"object","properties":{"SecondaryIdentification":{"type":"string"},"SchemeName":{"type":"array","items":{"type":"object","properties":{"s":{"type":"string"}}}},"Identification":{"type":"string"},"Name":{"type":"string"}}},"EndToEndIdentification":{"type":"string"},"DebtorAccount":{"type":"object","properties":{"SecondaryIdentification":{"type":"string"},"SchemeName":{"type":"array","items":{"type":"object","properties":{"s":{"type":"string"}}}},"Identification":{"type":"string"},"Name":{"type":"string"}}},"InstructionIdentification":{"type":"string"},"LocalInstrument":{"type":"array","items":{"type":"object","properties":{"s":{"type":"string"}}}},"SupplementaryData":{"type":"object","properties":{}},"RemittanceInformation":{"type":"object","properties":{"Unstructured":{"type":"string"},"Reference":{"type":"string"}}}}},"Status":{"type":"object","properties":{}},"Charges":{"type":"array","items":{"type":"object","properties":{"Type":{"type":"array","items":{"type":"object","properties":{"s":{"type":"string"}}}},"Amount":{"type":"object","properties":{"Amount":{"type":"object","properties":{}},"Currency":{"type":"string"}}},"ChargeBearer":{"type":"object","properties":{}}}}},"Authorisation":{"type":"object","properties":{"CompletionDateTime":{"type":"string"},"AuthorisationType":{"type":"object","properties":{}}}},"CutOffDateTime":{"type":"string"}}}}}},"is_featured":false,"special_instructions":"","specified_url":"/open-banking/v3.1/domestic-payment-consents/CONSENTID","connector_methods":[]},{"operation_id":"UKv3.1-getAccountsAccountIdScheduledPayments","implemented_by":{"version":"UKv3.1","function":"getAccountsAccountIdScheduledPayments"},"request_verb":"GET","request_url":"/open-banking/v3.1/accounts/ACCOUNTID/scheduled-payments","summary":"Get Scheduled Payments","description":"NOTE: This endpoint currently only returns example data.
\nAuthentication is Mandatory
\nURL Parameters:
\nACCOUNTID: ACCOUNTID
\nJSON response body fields:
\n","description_markdown":"**NOTE: This endpoint currently only returns example data.**\n\n \n\n\nAuthentication is Mandatory\n\n\n**URL Parameters:**\n\n[ACCOUNTID](/glossary#): ACCOUNTID\n\n\n\n\n\n**JSON response body fields:**\n\n\n","example_request_body":{"jsonString":"{}"},"success_response_body":{"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":{}}]}},"error_response_bodies":["OBP-20001: User not logged in. Authentication is required!","OBP-50000: Unknown Error."],"tags":["Scheduled Payments","Mocked-Data"],"typed_request_body":{"type":"object","properties":{"jsonString":{"type":"string"}}},"typed_success_response_body":{"type":"object","properties":{"type":"object","properties":{"Meta":{"type":"object","properties":{"FirstAvailableDateTime":{"type":"object","properties":{}},"TotalPages":{"type":"integer"}}},"Links":{"type":"object","properties":{"First":{"type":"string"},"Self":{"type":"string"},"Next":{"type":"string"},"Last":{"type":"string"},"Prev":{"type":"string"}}},"Data":{"type":"object","properties":{"ScheduledPayment":{"type":"array","items":{"type":"object","properties":{"ScheduledType":{"type":"object","properties":{}},"CreditorAccount":{"type":"object","properties":{"SecondaryIdentification":{"type":"string"},"SchemeName":{"type":"array","items":{"type":"object","properties":{"s":{"type":"string"}}}},"Identification":{"type":"string"},"Name":{"type":"string"}}},"ScheduledPaymentId":{"type":"string"},"ScheduledPaymentDateTime":{"type":"string"},"AccountId":{"type":"object","properties":{}},"InstructedAmount":{"type":"object","properties":{"Amount":{"type":"object","properties":{}},"Currency":{"type":"string"}}},"CreditorAgent":{"type":"object","properties":{"SchemeName":{"type":"array","items":{"type":"object","properties":{"s":{"type":"string"}}}},"Identification":{"type":"string"}}},"Reference":{"type":"string"}}}}}}}}},"is_featured":false,"special_instructions":"","specified_url":"/open-banking/v3.1/accounts/ACCOUNTID/scheduled-payments","connector_methods":[]},{"operation_id":"UKv3.1-createDomesticScheduledPaymentConsents","implemented_by":{"version":"UKv3.1","function":"createDomesticScheduledPaymentConsents"},"request_verb":"POST","request_url":"/open-banking/v3.1/domestic-scheduled-payment-consents","summary":"Create Domestic Scheduled Payment Consents","description":"NOTE: This endpoint currently only returns example data.
\nAuthentication is Mandatory
\nJSON request body fields:
\nJSON response body fields:
\n","description_markdown":"**NOTE: This endpoint currently only returns example data.**\n\n \n\n\nAuthentication is Mandatory\n\n\n**JSON request body fields:**\n\n\n\n\n\n**JSON response body fields:**\n\n\n","example_request_body":{"jsonString":"{}"},"success_response_body":{"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"}},"error_response_bodies":["OBP-20001: User not logged in. Authentication is required!","OBP-50000: Unknown Error."],"tags":["Domestic Scheduled Payments","Mocked-Data"],"typed_request_body":{"type":"object","properties":{"jsonString":{"type":"string"}}},"typed_success_response_body":{"type":"object","properties":{"type":"object","properties":{"Meta":{"type":"object","properties":{"FirstAvailableDateTime":{"type":"object","properties":{}},"TotalPages":{"type":"integer"}}},"Risk":{"type":"object","properties":{"PaymentContextCode":{"type":"object","properties":{}},"DeliveryAddress":{"type":"object","properties":{"CountrySubDivision":{"type":"array","items":{"type":"object","properties":{"s":{"type":"string"}}}},"Country":{"type":"string"},"StreetName":{"type":"string"},"BuildingNumber":{"type":"string"},"AddressLine":{"type":"array","items":{"type":"object","properties":{"s":{"type":"string"}}}},"TownName":{"type":"string"},"PostCode":{"type":"string"}}},"MerchantCategoryCode":{"type":"string"},"MerchantCustomerIdentification":{"type":"string"}}},"Links":{"type":"object","properties":{"First":{"type":"string"},"Self":{"type":"string"},"Next":{"type":"string"},"Last":{"type":"string"},"Prev":{"type":"string"}}},"Data":{"type":"object","properties":{"ExpectedExecutionDateTime":{"type":"string"},"ExpectedSettlementDateTime":{"type":"string"},"StatusUpdateDateTime":{"type":"string"},"CreationDateTime":{"type":"string"},"Permission":{"type":"object","properties":{}},"ConsentId":{"type":"string"},"Status":{"type":"object","properties":{}},"Charges":{"type":"array","items":{"type":"object","properties":{"Type":{"type":"array","items":{"type":"object","properties":{"s":{"type":"string"}}}},"Amount":{"type":"object","properties":{"Amount":{"type":"object","properties":{}},"Currency":{"type":"string"}}},"ChargeBearer":{"type":"object","properties":{}}}}},"Authorisation":{"type":"object","properties":{"CompletionDateTime":{"type":"string"},"AuthorisationType":{"type":"object","properties":{}}}},"Initiation":{"type":"object","properties":{"InstructedAmount":{"type":"object","properties":{"Currency":{"type":"string"}}},"RequestedExecutionDateTime":{"type":"string"},"CreditorPostalAddress":{"type":"object","properties":{"CountrySubDivision":{"type":"string"},"Country":{"type":"string"},"Department":{"type":"string"},"StreetName":{"type":"string"},"AddressType":{"type":"object","properties":{}},"BuildingNumber":{"type":"string"},"TownName":{"type":"string"},"SubDepartment":{"type":"string"},"PostCode":{"type":"string"},"AddressLine":{"type":"array","items":{"type":"object","properties":{"s":{"type":"string"}}}}}},"CreditorAccount":{"type":"object","properties":{"SecondaryIdentification":{"type":"string"},"SchemeName":{"type":"array","items":{"type":"object","properties":{"s":{"type":"string"}}}},"Identification":{"type":"string"},"Name":{"type":"string"}}},"EndToEndIdentification":{"type":"string"},"DebtorAccount":{"type":"object","properties":{"SecondaryIdentification":{"type":"string"},"SchemeName":{"type":"array","items":{"type":"object","properties":{"s":{"type":"string"}}}},"Identification":{"type":"string"},"Name":{"type":"string"}}},"InstructionIdentification":{"type":"string"},"LocalInstrument":{"type":"array","items":{"type":"object","properties":{"s":{"type":"string"}}}},"SupplementaryData":{"type":"object","properties":{}},"RemittanceInformation":{"type":"object","properties":{"Unstructured":{"type":"string"},"Reference":{"type":"string"}}}}},"CutOffDateTime":{"type":"string"}}}}}},"is_featured":false,"special_instructions":"","specified_url":"/open-banking/v3.1/domestic-scheduled-payment-consents","connector_methods":[]},{"operation_id":"UKv3.1-getBalances","implemented_by":{"version":"UKv3.1","function":"getBalances"},"request_verb":"GET","request_url":"/open-banking/v3.1/balances","summary":"Get Balances","description":"Authentication is Mandatory
\nJSON response body fields:
\n","description_markdown":"Authentication is Mandatory\n\n\n**JSON response body fields:**\n\n\n","example_request_body":{"jsonString":"{}"},"success_response_body":{"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"}]}},"error_response_bodies":["OBP-20001: User not logged in. Authentication is required!","OBP-50000: Unknown Error."],"tags":["Balances"],"typed_request_body":{"type":"object","properties":{"jsonString":{"type":"string"}}},"typed_success_response_body":{"type":"object","properties":{"type":"object","properties":{"Meta":{"type":"object","properties":{"FirstAvailableDateTime":{"type":"object","properties":{}},"TotalPages":{"type":"integer"}}},"Links":{"type":"object","properties":{"First":{"type":"string"},"Self":{"type":"string"},"Next":{"type":"string"},"Last":{"type":"string"},"Prev":{"type":"string"}}},"Data":{"type":"object","properties":{"Balance":{"type":"array","items":{"type":"object","properties":{"CreditLine":{"type":"array","items":{"type":"object","properties":{"Type":{"type":"object","properties":{}},"Included":{"type":"boolean"},"Amount":{"type":"object","properties":{"Amount":{"type":"object","properties":{}},"Currency":{"type":"string"}}}}}},"Amount":{"type":"object","properties":{"Amount":{"type":"object","properties":{}},"Currency":{"type":"string"}}},"AccountId":{"type":"object","properties":{}},"Type":{"type":"object","properties":{}},"DateTime":{"type":"string"},"CreditDebitIndicator":{"type":"string"}}}}}}}}},"is_featured":false,"special_instructions":"","specified_url":"/open-banking/v3.1/balances","connector_methods":[]},{"operation_id":"UKv3.1-createInternationalScheduledPaymentConsents","implemented_by":{"version":"UKv3.1","function":"createInternationalScheduledPaymentConsents"},"request_verb":"POST","request_url":"/open-banking/v3.1/international-scheduled-payment-consents","summary":"Create International Scheduled Payment Consents","description":"NOTE: This endpoint currently only returns example data.
\nAuthentication is Mandatory
\nJSON request body fields:
\nJSON response body fields:
\n","description_markdown":"**NOTE: This endpoint currently only returns example data.**\n\n \n\n\nAuthentication is Mandatory\n\n\n**JSON request body fields:**\n\n\n\n\n\n**JSON response body fields:**\n\n\n","example_request_body":{"jsonString":"{}"},"success_response_body":{"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"}},"error_response_bodies":["OBP-20001: User not logged in. Authentication is required!","OBP-50000: Unknown Error."],"tags":["International Scheduled Payments","Mocked-Data"],"typed_request_body":{"type":"object","properties":{"jsonString":{"type":"string"}}},"typed_success_response_body":{"type":"object","properties":{"type":"object","properties":{"Meta":{"type":"object","properties":{"FirstAvailableDateTime":{"type":"object","properties":{}},"TotalPages":{"type":"integer"}}},"Risk":{"type":"object","properties":{"PaymentContextCode":{"type":"object","properties":{}},"DeliveryAddress":{"type":"object","properties":{"CountrySubDivision":{"type":"array","items":{"type":"object","properties":{"s":{"type":"string"}}}},"Country":{"type":"string"},"StreetName":{"type":"string"},"BuildingNumber":{"type":"string"},"AddressLine":{"type":"array","items":{"type":"object","properties":{"s":{"type":"string"}}}},"TownName":{"type":"string"},"PostCode":{"type":"string"}}},"MerchantCategoryCode":{"type":"string"},"MerchantCustomerIdentification":{"type":"string"}}},"Links":{"type":"object","properties":{"First":{"type":"string"},"Self":{"type":"string"},"Next":{"type":"string"},"Last":{"type":"string"},"Prev":{"type":"string"}}},"Data":{"type":"object","properties":{"ExpectedExecutionDateTime":{"type":"string"},"ExpectedSettlementDateTime":{"type":"string"},"StatusUpdateDateTime":{"type":"string"},"CreationDateTime":{"type":"string"},"Initiation":{"type":"object","properties":{"CurrencyOfTransfer":{"type":"string"},"InstructedAmount":{"type":"object","properties":{"Currency":{"type":"string"}}},"RequestedExecutionDateTime":{"type":"string"},"CreditorAgent":{"type":"object","properties":{"PostalAddress":{"type":"object","properties":{"CountrySubDivision":{"type":"string"},"Country":{"type":"string"},"Department":{"type":"string"},"StreetName":{"type":"string"},"AddressType":{"type":"object","properties":{}},"BuildingNumber":{"type":"string"},"TownName":{"type":"string"},"SubDepartment":{"type":"string"},"PostCode":{"type":"string"},"AddressLine":{"type":"array","items":{"type":"object","properties":{"s":{"type":"string"}}}}}},"SchemeName":{"type":"array","items":{"type":"object","properties":{"s":{"type":"string"}}}},"Identification":{"type":"string"},"Name":{"type":"string"}}},"InstructionPriority":{"type":"object","properties":{}},"CreditorAccount":{"type":"object","properties":{"SecondaryIdentification":{"type":"string"},"SchemeName":{"type":"array","items":{"type":"object","properties":{"s":{"type":"string"}}}},"Identification":{"type":"string"},"Name":{"type":"string"}}},"EndToEndIdentification":{"type":"string"},"DebtorAccount":{"type":"object","properties":{"SecondaryIdentification":{"type":"string"},"SchemeName":{"type":"array","items":{"type":"object","properties":{"s":{"type":"string"}}}},"Identification":{"type":"string"},"Name":{"type":"string"}}},"ChargeBearer":{"type":"object","properties":{}},"InstructionIdentification":{"type":"string"},"LocalInstrument":{"type":"array","items":{"type":"object","properties":{"s":{"type":"string"}}}},"SupplementaryData":{"type":"object","properties":{}},"Purpose":{"type":"object","properties":{}},"RemittanceInformation":{"type":"object","properties":{"Unstructured":{"type":"string"},"Reference":{"type":"string"}}},"Creditor":{"type":"object","properties":{"PostalAddress":{"type":"object","properties":{"CountrySubDivision":{"type":"string"},"Country":{"type":"string"},"Department":{"type":"string"},"StreetName":{"type":"string"},"AddressType":{"type":"object","properties":{}},"BuildingNumber":{"type":"string"},"TownName":{"type":"string"},"SubDepartment":{"type":"string"},"PostCode":{"type":"string"},"AddressLine":{"type":"array","items":{"type":"object","properties":{"s":{"type":"string"}}}}}},"Name":{"type":"string"}}},"ExchangeRateInformation":{"type":"object","properties":{"ExchangeRate":{"type":"number"},"UnitCurrency":{"type":"string"},"ContractIdentification":{"type":"string"}}}}},"Permission":{"type":"object","properties":{}},"ConsentId":{"type":"string"},"ExchangeRateInformation":{"type":"object","properties":{"ExpirationDateTime":{"type":"string"},"ExchangeRate":{"type":"number"},"RateType":{"type":"object","properties":{}},"ContractIdentification":{"type":"string"},"UnitCurrency":{"type":"string"}}},"Status":{"type":"object","properties":{}},"Charges":{"type":"array","items":{"type":"object","properties":{"Type":{"type":"array","items":{"type":"object","properties":{"s":{"type":"string"}}}},"Amount":{"type":"object","properties":{"Amount":{"type":"object","properties":{}},"Currency":{"type":"string"}}},"ChargeBearer":{"type":"object","properties":{}}}}},"Authorisation":{"type":"object","properties":{"CompletionDateTime":{"type":"string"},"AuthorisationType":{"type":"object","properties":{}}}},"CutOffDateTime":{"type":"string"}}}}}},"is_featured":false,"special_instructions":"","specified_url":"/open-banking/v3.1/international-scheduled-payment-consents","connector_methods":[]},{"operation_id":"UKv3.1-getInternationalScheduledPaymentConsentsConsentId","implemented_by":{"version":"UKv3.1","function":"getInternationalScheduledPaymentConsentsConsentId"},"request_verb":"GET","request_url":"/open-banking/v3.1/international-scheduled-payment-consents/CONSENTID","summary":"Get International Scheduled Payment Consents","description":"NOTE: This endpoint currently only returns example data.
\nAuthentication is Mandatory
\nURL Parameters:
\nCONSENTID: CONSENTID
\nJSON response body fields:
\n","description_markdown":"**NOTE: This endpoint currently only returns example data.**\n\n \n\n\nAuthentication is Mandatory\n\n\n**URL Parameters:**\n\n[CONSENTID](/glossary#): CONSENTID\n\n\n\n\n\n**JSON response body fields:**\n\n\n","example_request_body":{"jsonString":"{}"},"success_response_body":{"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"}},"error_response_bodies":["OBP-20001: User not logged in. Authentication is required!","OBP-50000: Unknown Error."],"tags":["International Scheduled Payments","Mocked-Data"],"typed_request_body":{"type":"object","properties":{"jsonString":{"type":"string"}}},"typed_success_response_body":{"type":"object","properties":{"type":"object","properties":{"Meta":{"type":"object","properties":{"FirstAvailableDateTime":{"type":"object","properties":{}},"TotalPages":{"type":"integer"}}},"Risk":{"type":"object","properties":{"PaymentContextCode":{"type":"object","properties":{}},"DeliveryAddress":{"type":"object","properties":{"CountrySubDivision":{"type":"array","items":{"type":"object","properties":{"s":{"type":"string"}}}},"Country":{"type":"string"},"StreetName":{"type":"string"},"BuildingNumber":{"type":"string"},"AddressLine":{"type":"array","items":{"type":"object","properties":{"s":{"type":"string"}}}},"TownName":{"type":"string"},"PostCode":{"type":"string"}}},"MerchantCategoryCode":{"type":"string"},"MerchantCustomerIdentification":{"type":"string"}}},"Links":{"type":"object","properties":{"First":{"type":"string"},"Self":{"type":"string"},"Next":{"type":"string"},"Last":{"type":"string"},"Prev":{"type":"string"}}},"Data":{"type":"object","properties":{"ExpectedExecutionDateTime":{"type":"string"},"ExpectedSettlementDateTime":{"type":"string"},"StatusUpdateDateTime":{"type":"string"},"CreationDateTime":{"type":"string"},"Initiation":{"type":"object","properties":{"CurrencyOfTransfer":{"type":"string"},"InstructedAmount":{"type":"object","properties":{"Currency":{"type":"string"}}},"RequestedExecutionDateTime":{"type":"string"},"CreditorAgent":{"type":"object","properties":{"PostalAddress":{"type":"object","properties":{"CountrySubDivision":{"type":"string"},"Country":{"type":"string"},"Department":{"type":"string"},"StreetName":{"type":"string"},"AddressType":{"type":"object","properties":{}},"BuildingNumber":{"type":"string"},"TownName":{"type":"string"},"SubDepartment":{"type":"string"},"PostCode":{"type":"string"},"AddressLine":{"type":"array","items":{"type":"object","properties":{"s":{"type":"string"}}}}}},"SchemeName":{"type":"array","items":{"type":"object","properties":{"s":{"type":"string"}}}},"Identification":{"type":"string"},"Name":{"type":"string"}}},"InstructionPriority":{"type":"object","properties":{}},"CreditorAccount":{"type":"object","properties":{"SecondaryIdentification":{"type":"string"},"SchemeName":{"type":"array","items":{"type":"object","properties":{"s":{"type":"string"}}}},"Identification":{"type":"string"},"Name":{"type":"string"}}},"EndToEndIdentification":{"type":"string"},"DebtorAccount":{"type":"object","properties":{"SecondaryIdentification":{"type":"string"},"SchemeName":{"type":"array","items":{"type":"object","properties":{"s":{"type":"string"}}}},"Identification":{"type":"string"},"Name":{"type":"string"}}},"ChargeBearer":{"type":"object","properties":{}},"InstructionIdentification":{"type":"string"},"LocalInstrument":{"type":"array","items":{"type":"object","properties":{"s":{"type":"string"}}}},"SupplementaryData":{"type":"object","properties":{}},"Purpose":{"type":"object","properties":{}},"RemittanceInformation":{"type":"object","properties":{"Unstructured":{"type":"string"},"Reference":{"type":"string"}}},"Creditor":{"type":"object","properties":{"PostalAddress":{"type":"object","properties":{"CountrySubDivision":{"type":"string"},"Country":{"type":"string"},"Department":{"type":"string"},"StreetName":{"type":"string"},"AddressType":{"type":"object","properties":{}},"BuildingNumber":{"type":"string"},"TownName":{"type":"string"},"SubDepartment":{"type":"string"},"PostCode":{"type":"string"},"AddressLine":{"type":"array","items":{"type":"object","properties":{"s":{"type":"string"}}}}}},"Name":{"type":"string"}}},"ExchangeRateInformation":{"type":"object","properties":{"ExchangeRate":{"type":"number"},"UnitCurrency":{"type":"string"},"ContractIdentification":{"type":"string"}}}}},"Permission":{"type":"object","properties":{}},"ConsentId":{"type":"string"},"ExchangeRateInformation":{"type":"object","properties":{"ExpirationDateTime":{"type":"string"},"ExchangeRate":{"type":"number"},"RateType":{"type":"object","properties":{}},"ContractIdentification":{"type":"string"},"UnitCurrency":{"type":"string"}}},"Status":{"type":"object","properties":{}},"Charges":{"type":"array","items":{"type":"object","properties":{"Type":{"type":"array","items":{"type":"object","properties":{"s":{"type":"string"}}}},"Amount":{"type":"object","properties":{"Amount":{"type":"object","properties":{}},"Currency":{"type":"string"}}},"ChargeBearer":{"type":"object","properties":{}}}}},"Authorisation":{"type":"object","properties":{"CompletionDateTime":{"type":"string"},"AuthorisationType":{"type":"object","properties":{}}}},"CutOffDateTime":{"type":"string"}}}}}},"is_featured":false,"special_instructions":"","specified_url":"/open-banking/v3.1/international-scheduled-payment-consents/CONSENTID","connector_methods":[]},{"operation_id":"UKv3.1-getAccountsAccountIdParty","implemented_by":{"version":"UKv3.1","function":"getAccountsAccountIdParty"},"request_verb":"GET","request_url":"/open-banking/v3.1/accounts/ACCOUNTID/party","summary":"Get Party","description":"NOTE: This endpoint currently only returns example data.
\nAuthentication is Mandatory
\nURL Parameters:
\nACCOUNTID: ACCOUNTID
\nJSON response body fields:
\n","description_markdown":"**NOTE: This endpoint currently only returns example data.**\n\n \n\n\nAuthentication is Mandatory\n\n\n**URL Parameters:**\n\n[ACCOUNTID](/glossary#): ACCOUNTID\n\n\n\n\n\n**JSON response body fields:**\n\n\n","example_request_body":{"jsonString":"{}"},"success_response_body":{"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"}}},"error_response_bodies":["OBP-20001: User not logged in. Authentication is required!","OBP-50000: Unknown Error."],"tags":["Partys","Mocked-Data"],"typed_request_body":{"type":"object","properties":{"jsonString":{"type":"string"}}},"typed_success_response_body":{"type":"object","properties":{"type":"object","properties":{"Meta":{"type":"object","properties":{"FirstAvailableDateTime":{"type":"object","properties":{}},"TotalPages":{"type":"integer"}}},"Links":{"type":"object","properties":{"First":{"type":"string"},"Self":{"type":"string"},"Next":{"type":"string"},"Last":{"type":"string"},"Prev":{"type":"string"}}},"Data":{"type":"object","properties":{"Party":{"type":"object","properties":{"EmailAddress":{"type":"string"},"PartyType":{"type":"object","properties":{}},"Name":{"type":"string"},"Mobile":{"type":"string"},"Address":{"type":"array","items":{"type":"object","properties":{"CountrySubDivision":{"type":"string"},"AddressLine":{"type":"array","items":{"type":"object","properties":{"s":{"type":"string"}}}},"Country":{"type":"string"},"StreetName":{"type":"string"},"AddressType":{"type":"object","properties":{}},"BuildingNumber":{"type":"string"},"TownName":{"type":"string"},"PostCode":{"type":"string"}}}},"PartyId":{"type":"string"},"Phone":{"type":"string"},"PartyNumber":{"type":"string"}}}}}}}},"is_featured":false,"special_instructions":"","specified_url":"/open-banking/v3.1/accounts/ACCOUNTID/party","connector_methods":[]},{"operation_id":"UKv3.1-createDomesticPayments","implemented_by":{"version":"UKv3.1","function":"createDomesticPayments"},"request_verb":"POST","request_url":"/open-banking/v3.1/domestic-payments","summary":"Create Domestic Payments","description":"NOTE: This endpoint currently only returns example data.
\nAuthentication is Mandatory
\nJSON request body fields:
\nJSON response body fields:
\n","description_markdown":"**NOTE: This endpoint currently only returns example data.**\n\n \n\n\nAuthentication is Mandatory\n\n\n**JSON request body fields:**\n\n\n\n\n\n**JSON response body fields:**\n\n\n","example_request_body":{"jsonString":"{}"},"success_response_body":{"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}}},"error_response_bodies":["OBP-20001: User not logged in. Authentication is required!","OBP-50000: Unknown Error."],"tags":["Domestic Payments","Mocked-Data"],"typed_request_body":{"type":"object","properties":{"jsonString":{"type":"string"}}},"typed_success_response_body":{"type":"object","properties":{"type":"object","properties":{"Meta":{"type":"object","properties":{"FirstAvailableDateTime":{"type":"object","properties":{}},"TotalPages":{"type":"integer"}}},"Links":{"type":"object","properties":{"First":{"type":"string"},"Self":{"type":"string"},"Next":{"type":"string"},"Last":{"type":"string"},"Prev":{"type":"string"}}},"Data":{"type":"object","properties":{"ExpectedExecutionDateTime":{"type":"string"},"ExpectedSettlementDateTime":{"type":"string"},"StatusUpdateDateTime":{"type":"string"},"CreationDateTime":{"type":"string"},"ConsentId":{"type":"string"},"Initiation":{"type":"object","properties":{"InstructedAmount":{"type":"object","properties":{"Currency":{"type":"string"}}},"CreditorPostalAddress":{"type":"object","properties":{"CountrySubDivision":{"type":"string"},"Country":{"type":"string"},"Department":{"type":"string"},"StreetName":{"type":"string"},"AddressType":{"type":"object","properties":{}},"BuildingNumber":{"type":"string"},"TownName":{"type":"string"},"SubDepartment":{"type":"string"},"PostCode":{"type":"string"},"AddressLine":{"type":"array","items":{"type":"object","properties":{"s":{"type":"string"}}}}}},"CreditorAccount":{"type":"object","properties":{"SecondaryIdentification":{"type":"string"},"SchemeName":{"type":"array","items":{"type":"object","properties":{"s":{"type":"string"}}}},"Identification":{"type":"string"},"Name":{"type":"string"}}},"EndToEndIdentification":{"type":"string"},"DebtorAccount":{"type":"object","properties":{"SecondaryIdentification":{"type":"string"},"SchemeName":{"type":"array","items":{"type":"object","properties":{"s":{"type":"string"}}}},"Identification":{"type":"string"},"Name":{"type":"string"}}},"InstructionIdentification":{"type":"string"},"LocalInstrument":{"type":"array","items":{"type":"object","properties":{"s":{"type":"string"}}}},"SupplementaryData":{"type":"object","properties":{}},"RemittanceInformation":{"type":"object","properties":{"Unstructured":{"type":"string"},"Reference":{"type":"string"}}}}},"Status":{"type":"object","properties":{}},"DomesticPaymentId":{"type":"string"},"Charges":{"type":"array","items":{"type":"object","properties":{"Type":{"type":"array","items":{"type":"object","properties":{"s":{"type":"string"}}}},"Amount":{"type":"object","properties":{"Amount":{"type":"object","properties":{}},"Currency":{"type":"string"}}},"ChargeBearer":{"type":"object","properties":{}}}}},"MultiAuthorisation":{"type":"object","properties":{"ExpirationDateTime":{"type":"string"},"NumberRequired":{"type":"integer"},"Status":{"type":"object","properties":{}},"NumberReceived":{"type":"integer"},"LastUpdateDateTime":{"type":"string"}}}}}}}},"is_featured":false,"special_instructions":"","specified_url":"/open-banking/v3.1/domestic-payments","connector_methods":[]},{"operation_id":"UKv3.1-getProducts","implemented_by":{"version":"UKv3.1","function":"getProducts"},"request_verb":"GET","request_url":"/open-banking/v3.1/products","summary":"Get Products","description":"NOTE: This endpoint currently only returns example data.
\nAuthentication is Mandatory
\nJSON response body fields:
\n","description_markdown":"**NOTE: This endpoint currently only returns example data.**\n\n \n\n\nAuthentication is Mandatory\n\n\n**JSON response body fields:**\n\n\n","example_request_body":{"jsonString":"{}"},"success_response_body":{"jsonString":"{}"},"error_response_bodies":["OBP-20001: User not logged in. Authentication is required!","OBP-50000: Unknown Error."],"tags":["Products","Mocked-Data"],"typed_request_body":{"type":"object","properties":{"jsonString":{"type":"string"}}},"typed_success_response_body":{"type":"object","properties":{"jsonString":{"type":"string"}}},"is_featured":false,"special_instructions":"","specified_url":"/open-banking/v3.1/products","connector_methods":[]},{"operation_id":"UKv3.1-getInternationalPaymentConsentsConsentId","implemented_by":{"version":"UKv3.1","function":"getInternationalPaymentConsentsConsentId"},"request_verb":"GET","request_url":"/open-banking/v3.1/international-payment-consents/CONSENTID","summary":"Get International Payment Consents","description":"NOTE: This endpoint currently only returns example data.
\nAuthentication is Mandatory
\nURL Parameters:
\nCONSENTID: CONSENTID
\nJSON response body fields:
\n","description_markdown":"**NOTE: This endpoint currently only returns example data.**\n\n \n\n\nAuthentication is Mandatory\n\n\n**URL Parameters:**\n\n[CONSENTID](/glossary#): CONSENTID\n\n\n\n\n\n**JSON response body fields:**\n\n\n","example_request_body":{"jsonString":"{}"},"success_response_body":{"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"}},"error_response_bodies":["OBP-20001: User not logged in. Authentication is required!","OBP-50000: Unknown Error."],"tags":["International Payments","Mocked-Data"],"typed_request_body":{"type":"object","properties":{"jsonString":{"type":"string"}}},"typed_success_response_body":{"type":"object","properties":{"type":"object","properties":{"Meta":{"type":"object","properties":{"FirstAvailableDateTime":{"type":"object","properties":{}},"TotalPages":{"type":"integer"}}},"Risk":{"type":"object","properties":{"PaymentContextCode":{"type":"object","properties":{}},"DeliveryAddress":{"type":"object","properties":{"CountrySubDivision":{"type":"array","items":{"type":"object","properties":{"s":{"type":"string"}}}},"Country":{"type":"string"},"StreetName":{"type":"string"},"BuildingNumber":{"type":"string"},"AddressLine":{"type":"array","items":{"type":"object","properties":{"s":{"type":"string"}}}},"TownName":{"type":"string"},"PostCode":{"type":"string"}}},"MerchantCategoryCode":{"type":"string"},"MerchantCustomerIdentification":{"type":"string"}}},"Links":{"type":"object","properties":{"First":{"type":"string"},"Self":{"type":"string"},"Next":{"type":"string"},"Last":{"type":"string"},"Prev":{"type":"string"}}},"Data":{"type":"object","properties":{"ExpectedExecutionDateTime":{"type":"string"},"ExpectedSettlementDateTime":{"type":"string"},"StatusUpdateDateTime":{"type":"string"},"CreationDateTime":{"type":"string"},"Initiation":{"type":"object","properties":{"CurrencyOfTransfer":{"type":"string"},"InstructedAmount":{"type":"object","properties":{"Currency":{"type":"string"}}},"CreditorAgent":{"type":"object","properties":{"PostalAddress":{"type":"object","properties":{"CountrySubDivision":{"type":"string"},"Country":{"type":"string"},"Department":{"type":"string"},"StreetName":{"type":"string"},"AddressType":{"type":"object","properties":{}},"BuildingNumber":{"type":"string"},"TownName":{"type":"string"},"SubDepartment":{"type":"string"},"PostCode":{"type":"string"},"AddressLine":{"type":"array","items":{"type":"object","properties":{"s":{"type":"string"}}}}}},"SchemeName":{"type":"array","items":{"type":"object","properties":{"s":{"type":"string"}}}},"Identification":{"type":"string"},"Name":{"type":"string"}}},"InstructionPriority":{"type":"object","properties":{}},"CreditorAccount":{"type":"object","properties":{"SecondaryIdentification":{"type":"string"},"SchemeName":{"type":"array","items":{"type":"object","properties":{"s":{"type":"string"}}}},"Identification":{"type":"string"},"Name":{"type":"string"}}},"EndToEndIdentification":{"type":"string"},"DebtorAccount":{"type":"object","properties":{"SecondaryIdentification":{"type":"string"},"SchemeName":{"type":"array","items":{"type":"object","properties":{"s":{"type":"string"}}}},"Identification":{"type":"string"},"Name":{"type":"string"}}},"ChargeBearer":{"type":"object","properties":{}},"InstructionIdentification":{"type":"string"},"LocalInstrument":{"type":"array","items":{"type":"object","properties":{"s":{"type":"string"}}}},"SupplementaryData":{"type":"object","properties":{}},"Purpose":{"type":"object","properties":{}},"RemittanceInformation":{"type":"object","properties":{"Unstructured":{"type":"string"},"Reference":{"type":"string"}}},"Creditor":{"type":"object","properties":{"PostalAddress":{"type":"object","properties":{"CountrySubDivision":{"type":"string"},"Country":{"type":"string"},"Department":{"type":"string"},"StreetName":{"type":"string"},"AddressType":{"type":"object","properties":{}},"BuildingNumber":{"type":"string"},"TownName":{"type":"string"},"SubDepartment":{"type":"string"},"PostCode":{"type":"string"},"AddressLine":{"type":"array","items":{"type":"object","properties":{"s":{"type":"string"}}}}}},"Name":{"type":"string"}}},"ExchangeRateInformation":{"type":"object","properties":{"ExchangeRate":{"type":"number"},"UnitCurrency":{"type":"string"},"ContractIdentification":{"type":"string"}}}}},"ConsentId":{"type":"string"},"ExchangeRateInformation":{"type":"object","properties":{"ExpirationDateTime":{"type":"string"},"ExchangeRate":{"type":"number"},"RateType":{"type":"object","properties":{}},"ContractIdentification":{"type":"string"},"UnitCurrency":{"type":"string"}}},"Status":{"type":"object","properties":{}},"Charges":{"type":"array","items":{"type":"object","properties":{"Type":{"type":"array","items":{"type":"object","properties":{"s":{"type":"string"}}}},"Amount":{"type":"object","properties":{"Amount":{"type":"object","properties":{}},"Currency":{"type":"string"}}},"ChargeBearer":{"type":"object","properties":{}}}}},"Authorisation":{"type":"object","properties":{"CompletionDateTime":{"type":"string"},"AuthorisationType":{"type":"object","properties":{}}}},"CutOffDateTime":{"type":"string"}}}}}},"is_featured":false,"special_instructions":"","specified_url":"/open-banking/v3.1/international-payment-consents/CONSENTID","connector_methods":[]},{"operation_id":"UKv3.1-getFilePaymentConsentsConsentIdFile","implemented_by":{"version":"UKv3.1","function":"getFilePaymentConsentsConsentIdFile"},"request_verb":"GET","request_url":"/open-banking/v3.1/file-payment-consents/CONSENTID/file","summary":"Get File Payment Consents","description":"NOTE: This endpoint currently only returns example data.
\nAuthentication is Mandatory
\nURL Parameters:
\nCONSENTID: CONSENTID
\nJSON response body fields:
\n","description_markdown":"**NOTE: This endpoint currently only returns example data.**\n\n \n\n\nAuthentication is Mandatory\n\n\n**URL Parameters:**\n\n[CONSENTID](/glossary#): CONSENTID\n\n\n\n\n\n**JSON response body fields:**\n\n\n","example_request_body":{"jsonString":"{}"},"success_response_body":{"jsonString":"{}"},"error_response_bodies":["OBP-20001: User not logged in. Authentication is required!","OBP-50000: Unknown Error."],"tags":["File Payments","Mocked-Data"],"typed_request_body":{"type":"object","properties":{"jsonString":{"type":"string"}}},"typed_success_response_body":{"type":"object","properties":{"jsonString":{"type":"string"}}},"is_featured":false,"special_instructions":"","specified_url":"/open-banking/v3.1/file-payment-consents/CONSENTID/file","connector_methods":[]},{"operation_id":"UKv3.1-deleteFundsConfirmationConsentsConsentId","implemented_by":{"version":"UKv3.1","function":"deleteFundsConfirmationConsentsConsentId"},"request_verb":"DELETE","request_url":"/open-banking/v3.1/funds-confirmation-consents/CONSENTID","summary":"Delete Funds Confirmation Consent","description":"NOTE: This endpoint currently only returns example data.
\nAuthentication is Mandatory
\nURL Parameters:
\nCONSENTID: CONSENTID
\nJSON response body fields:
\n","description_markdown":"**NOTE: This endpoint currently only returns example data.**\n\n \n\n\nAuthentication is Mandatory\n\n\n**URL Parameters:**\n\n[CONSENTID](/glossary#): CONSENTID\n\n\n\n\n\n**JSON response body fields:**\n\n\n","example_request_body":{"jsonString":"{}"},"success_response_body":{"jsonString":"{}"},"error_response_bodies":["OBP-20001: User not logged in. Authentication is required!","OBP-50000: Unknown Error."],"tags":["Funds Confirmations","Mocked-Data"],"typed_request_body":{"type":"object","properties":{"jsonString":{"type":"string"}}},"typed_success_response_body":{"type":"object","properties":{"jsonString":{"type":"string"}}},"is_featured":false,"special_instructions":"","specified_url":"/open-banking/v3.1/funds-confirmation-consents/CONSENTID","connector_methods":[]},{"operation_id":"UKv3.1-createDomesticStandingOrderConsents","implemented_by":{"version":"UKv3.1","function":"createDomesticStandingOrderConsents"},"request_verb":"POST","request_url":"/open-banking/v3.1/domestic-standing-order-consents","summary":"Create Domestic Standing Order Consents","description":"NOTE: This endpoint currently only returns example data.
\nAuthentication is Mandatory
\nJSON request body fields:
\nJSON response body fields:
\n","description_markdown":"**NOTE: This endpoint currently only returns example data.**\n\n \n\n\nAuthentication is Mandatory\n\n\n**JSON request body fields:**\n\n\n\n\n\n**JSON response body fields:**\n\n\n","example_request_body":{"jsonString":"{}"},"success_response_body":{"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"}}},"error_response_bodies":["OBP-20001: User not logged in. Authentication is required!","OBP-50000: Unknown Error."],"tags":["Domestic Standing Orders","Mocked-Data"],"typed_request_body":{"type":"object","properties":{"jsonString":{"type":"string"}}},"typed_success_response_body":{"type":"object","properties":{"type":"object","properties":{"Meta":{"type":"object","properties":{"FirstAvailableDateTime":{"type":"object","properties":{}},"TotalPages":{"type":"integer"}}},"Risk":{"type":"object","properties":{"PaymentContextCode":{"type":"object","properties":{}},"DeliveryAddress":{"type":"object","properties":{"CountrySubDivision":{"type":"array","items":{"type":"object","properties":{"s":{"type":"string"}}}},"Country":{"type":"string"},"StreetName":{"type":"string"},"BuildingNumber":{"type":"string"},"AddressLine":{"type":"array","items":{"type":"object","properties":{"s":{"type":"string"}}}},"TownName":{"type":"string"},"PostCode":{"type":"string"}}},"MerchantCategoryCode":{"type":"string"},"MerchantCustomerIdentification":{"type":"string"}}},"Links":{"type":"object","properties":{"First":{"type":"string"},"Self":{"type":"string"},"Next":{"type":"string"},"Last":{"type":"string"},"Prev":{"type":"string"}}},"Data":{"type":"object","properties":{"StatusUpdateDateTime":{"type":"string"},"CreationDateTime":{"type":"string"},"Permission":{"type":"object","properties":{}},"ConsentId":{"type":"string"},"Initiation":{"type":"object","properties":{"RecurringPaymentDateTime":{"type":"string"},"CreditorAccount":{"type":"object","properties":{"SecondaryIdentification":{"type":"string"},"SchemeName":{"type":"array","items":{"type":"object","properties":{"s":{"type":"string"}}}},"Identification":{"type":"string"},"Name":{"type":"string"}}},"FirstPaymentAmount":{"type":"object","properties":{"Amount":{"type":"object","properties":{}},"Currency":{"type":"string"}}},"NumberOfPayments":{"type":"string"},"FinalPaymentDateTime":{"type":"string"},"DebtorAccount":{"type":"object","properties":{"SecondaryIdentification":{"type":"string"},"SchemeName":{"type":"array","items":{"type":"object","properties":{"s":{"type":"string"}}}},"Identification":{"type":"string"},"Name":{"type":"string"}}},"FirstPaymentDateTime":{"type":"string"},"SupplementaryData":{"type":"object","properties":{}},"Frequency":{"type":"string"},"RecurringPaymentAmount":{"type":"object","properties":{"Currency":{"type":"string"}}},"FinalPaymentAmount":{"type":"object","properties":{"Currency":{"type":"string"}}},"Reference":{"type":"string"}}},"Status":{"type":"object","properties":{}},"Charges":{"type":"array","items":{"type":"object","properties":{"Type":{"type":"array","items":{"type":"object","properties":{"s":{"type":"string"}}}},"Amount":{"type":"object","properties":{"Amount":{"type":"object","properties":{}},"Currency":{"type":"string"}}},"ChargeBearer":{"type":"object","properties":{}}}}},"Authorisation":{"type":"object","properties":{"CompletionDateTime":{"type":"string"},"AuthorisationType":{"type":"object","properties":{}}}},"CutOffDateTime":{"type":"string"}}}}}},"is_featured":false,"special_instructions":"","specified_url":"/open-banking/v3.1/domestic-standing-order-consents","connector_methods":[]},{"operation_id":"UKv3.1-deleteAccountAccessConsentsConsentId","implemented_by":{"version":"UKv3.1","function":"deleteAccountAccessConsentsConsentId"},"request_verb":"DELETE","request_url":"/open-banking/v3.1/account-access-consents/CONSENT_ID","summary":"Delete Account Access Consents","description":"Delete Account Access Consents
\nAuthentication is Mandatory
\nURL Parameters:
\n\nJSON response body fields:
\n","description_markdown":"Delete Account Access Consents\n\n\nAuthentication is Mandatory\n\n\n**URL Parameters:**\n\n[CONSENT_ID](/glossary#consent_id): \n\n\n\n\n\n**JSON response body fields:**\n\n\n","example_request_body":{"jsonString":"{}"},"success_response_body":{"jsonString":"{}"},"error_response_bodies":["OBP-20001: User not logged in. Authentication is required!","OBP-50000: Unknown Error."],"tags":["Account Access"],"typed_request_body":{"type":"object","properties":{"jsonString":{"type":"string"}}},"typed_success_response_body":{"type":"object","properties":{"jsonString":{"type":"string"}}},"is_featured":false,"special_instructions":"","specified_url":"/open-banking/v3.1/account-access-consents/CONSENT_ID","connector_methods":[]},{"operation_id":"UKv3.1-createInternationalPayments","implemented_by":{"version":"UKv3.1","function":"createInternationalPayments"},"request_verb":"POST","request_url":"/open-banking/v3.1/international-payments","summary":"Create International Payments","description":"NOTE: This endpoint currently only returns example data.
\nAuthentication is Mandatory
\nJSON request body fields:
\nJSON response body fields:
\n","description_markdown":"**NOTE: This endpoint currently only returns example data.**\n\n \n\n\nAuthentication is Mandatory\n\n\n**JSON request body fields:**\n\n\n\n\n\n**JSON response body fields:**\n\n\n","example_request_body":{"jsonString":"{}"},"success_response_body":{"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}}},"error_response_bodies":["OBP-20001: User not logged in. Authentication is required!","OBP-50000: Unknown Error."],"tags":["International Payments","Mocked-Data"],"typed_request_body":{"type":"object","properties":{"jsonString":{"type":"string"}}},"typed_success_response_body":{"type":"object","properties":{"type":"object","properties":{"Meta":{"type":"object","properties":{"FirstAvailableDateTime":{"type":"object","properties":{}},"TotalPages":{"type":"integer"}}},"Links":{"type":"object","properties":{"First":{"type":"string"},"Self":{"type":"string"},"Next":{"type":"string"},"Last":{"type":"string"},"Prev":{"type":"string"}}},"Data":{"type":"object","properties":{"ExpectedExecutionDateTime":{"type":"string"},"ExpectedSettlementDateTime":{"type":"string"},"StatusUpdateDateTime":{"type":"string"},"CreationDateTime":{"type":"string"},"Initiation":{"type":"object","properties":{"CurrencyOfTransfer":{"type":"string"},"InstructedAmount":{"type":"object","properties":{"Currency":{"type":"string"}}},"CreditorAgent":{"type":"object","properties":{"PostalAddress":{"type":"object","properties":{"CountrySubDivision":{"type":"string"},"Country":{"type":"string"},"Department":{"type":"string"},"StreetName":{"type":"string"},"AddressType":{"type":"object","properties":{}},"BuildingNumber":{"type":"string"},"TownName":{"type":"string"},"SubDepartment":{"type":"string"},"PostCode":{"type":"string"},"AddressLine":{"type":"array","items":{"type":"object","properties":{"s":{"type":"string"}}}}}},"SchemeName":{"type":"array","items":{"type":"object","properties":{"s":{"type":"string"}}}},"Identification":{"type":"string"},"Name":{"type":"string"}}},"InstructionPriority":{"type":"object","properties":{}},"CreditorAccount":{"type":"object","properties":{"SecondaryIdentification":{"type":"string"},"SchemeName":{"type":"array","items":{"type":"object","properties":{"s":{"type":"string"}}}},"Identification":{"type":"string"},"Name":{"type":"string"}}},"EndToEndIdentification":{"type":"string"},"DebtorAccount":{"type":"object","properties":{"SecondaryIdentification":{"type":"string"},"SchemeName":{"type":"array","items":{"type":"object","properties":{"s":{"type":"string"}}}},"Identification":{"type":"string"},"Name":{"type":"string"}}},"ChargeBearer":{"type":"object","properties":{}},"InstructionIdentification":{"type":"string"},"LocalInstrument":{"type":"array","items":{"type":"object","properties":{"s":{"type":"string"}}}},"SupplementaryData":{"type":"object","properties":{}},"Purpose":{"type":"object","properties":{}},"RemittanceInformation":{"type":"object","properties":{"Unstructured":{"type":"string"},"Reference":{"type":"string"}}},"Creditor":{"type":"object","properties":{"PostalAddress":{"type":"object","properties":{"CountrySubDivision":{"type":"string"},"Country":{"type":"string"},"Department":{"type":"string"},"StreetName":{"type":"string"},"AddressType":{"type":"object","properties":{}},"BuildingNumber":{"type":"string"},"TownName":{"type":"string"},"SubDepartment":{"type":"string"},"PostCode":{"type":"string"},"AddressLine":{"type":"array","items":{"type":"object","properties":{"s":{"type":"string"}}}}}},"Name":{"type":"string"}}},"ExchangeRateInformation":{"type":"object","properties":{"ExchangeRate":{"type":"number"},"UnitCurrency":{"type":"string"},"ContractIdentification":{"type":"string"}}}}},"ConsentId":{"type":"string"},"ExchangeRateInformation":{"type":"object","properties":{"ExpirationDateTime":{"type":"string"},"ExchangeRate":{"type":"number"},"RateType":{"type":"object","properties":{}},"ContractIdentification":{"type":"string"},"UnitCurrency":{"type":"string"}}},"Status":{"type":"object","properties":{}},"Charges":{"type":"array","items":{"type":"object","properties":{"Type":{"type":"array","items":{"type":"object","properties":{"s":{"type":"string"}}}},"Amount":{"type":"object","properties":{"Amount":{"type":"object","properties":{}},"Currency":{"type":"string"}}},"ChargeBearer":{"type":"object","properties":{}}}}},"InternationalPaymentId":{"type":"string"},"MultiAuthorisation":{"type":"object","properties":{"ExpirationDateTime":{"type":"string"},"NumberRequired":{"type":"integer"},"Status":{"type":"object","properties":{}},"NumberReceived":{"type":"integer"},"LastUpdateDateTime":{"type":"string"}}}}}}}},"is_featured":false,"special_instructions":"","specified_url":"/open-banking/v3.1/international-payments","connector_methods":[]},{"operation_id":"UKv3.1-getAccountsAccountIdStatementsStatementIdTransactions","implemented_by":{"version":"UKv3.1","function":"getAccountsAccountIdStatementsStatementIdTransactions"},"request_verb":"GET","request_url":"/open-banking/v3.1/accounts/ACCOUNTID/statements/STATEMENTID/transactions","summary":"Get Transactions","description":"NOTE: This endpoint currently only returns example data.
\nAuthentication is Mandatory
\nURL Parameters:
\nACCOUNTID: ACCOUNTID
\nSTATEMENTID: STATEMENTID
\nJSON response body fields:
\n","description_markdown":"**NOTE: This endpoint currently only returns example data.**\n\n \n\n\nAuthentication is Mandatory\n\n\n**URL Parameters:**\n\n[ACCOUNTID](/glossary#): ACCOUNTID\n\n\n\n[STATEMENTID](/glossary#): STATEMENTID\n\n\n\n\n\n**JSON response body fields:**\n\n\n","example_request_body":{"jsonString":"{}"},"success_response_body":{"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"}}]}},"error_response_bodies":["OBP-20001: User not logged in. Authentication is required!","OBP-50000: Unknown Error."],"tags":["Statements","Transactions","Mocked-Data"],"typed_request_body":{"type":"object","properties":{"jsonString":{"type":"string"}}},"typed_success_response_body":{"type":"object","properties":{"type":"object","properties":{"Meta":{"type":"object","properties":{"FirstAvailableDateTime":{"type":"object","properties":{}},"TotalPages":{"type":"integer"}}},"Links":{"type":"object","properties":{"First":{"type":"string"},"Self":{"type":"string"},"Next":{"type":"string"},"Last":{"type":"string"},"Prev":{"type":"string"}}},"Data":{"type":"object","properties":{"Transaction":{"type":"array","items":{"type":"object","properties":{"Balance":{"type":"object","properties":{"Type":{"type":"object","properties":{}},"Amount":{"type":"object","properties":{"Amount":{"type":"object","properties":{}},"Currency":{"type":"string"}}},"CreditDebitIndicator":{"type":"string"}}},"DebtorAgent":{"type":"object","properties":{"PostalAddress":{"type":"object","properties":{"CountrySubDivision":{"type":"string"},"Country":{"type":"string"},"Department":{"type":"string"},"StreetName":{"type":"string"},"AddressType":{"type":"object","properties":{}},"BuildingNumber":{"type":"string"},"TownName":{"type":"string"},"SubDepartment":{"type":"string"},"PostCode":{"type":"string"},"AddressLine":{"type":"array","items":{"type":"object","properties":{"s":{"type":"string"}}}}}},"SchemeName":{"type":"array","items":{"type":"object","properties":{"s":{"type":"string"}}}},"Identification":{"type":"string"},"Name":{"type":"string"}}},"TransactionId":{"type":"string"},"StatementReference":{"type":"array","items":{"type":"object","properties":{"s":{"type":"string"}}}},"CreditorAgent":{"type":"object","properties":{"PostalAddress":{"type":"object","properties":{"CountrySubDivision":{"type":"string"},"Country":{"type":"string"},"Department":{"type":"string"},"StreetName":{"type":"string"},"AddressType":{"type":"object","properties":{}},"BuildingNumber":{"type":"string"},"TownName":{"type":"string"},"SubDepartment":{"type":"string"},"PostCode":{"type":"string"},"AddressLine":{"type":"array","items":{"type":"object","properties":{"s":{"type":"string"}}}}}},"SchemeName":{"type":"array","items":{"type":"object","properties":{"s":{"type":"string"}}}},"Identification":{"type":"string"},"Name":{"type":"string"}}},"MerchantDetails":{"type":"object","properties":{"MerchantName":{"type":"string"},"MerchantCategoryCode":{"type":"string"}}},"TransactionInformation":{"type":"object","properties":{}},"CreditorAccount":{"type":"object","properties":{"SecondaryIdentification":{"type":"string"},"SchemeName":{"type":"array","items":{"type":"object","properties":{"s":{"type":"string"}}}},"Identification":{"type":"string"},"Name":{"type":"string"}}},"Amount":{"type":"object","properties":{"Amount":{"type":"object","properties":{}},"Currency":{"type":"string"}}},"DebtorAccount":{"type":"object","properties":{"SecondaryIdentification":{"type":"string"},"SchemeName":{"type":"array","items":{"type":"object","properties":{"s":{"type":"string"}}}},"Identification":{"type":"string"},"Name":{"type":"string"}}},"AccountId":{"type":"object","properties":{}},"BankTransactionCode":{"type":"object","properties":{"SubCode":{"type":"string"},"Code":{"type":"string"}}},"CurrencyExchange":{"type":"object","properties":{"QuotationDate":{"type":"string"},"SourceCurrency":{"type":"string"},"TargetCurrency":{"type":"string"},"ExchangeRate":{"type":"number"},"ContractIdentification":{"type":"string"},"InstructedAmount":{"type":"object","properties":{"Amount":{"type":"object","properties":{}},"Currency":{"type":"string"}}},"UnitCurrency":{"type":"string"}}},"ProprietaryBankTransactionCode":{"type":"object","properties":{"Issuer":{"type":"string"},"Code":{"type":"string"}}},"CardInstrument":{"type":"object","properties":{"AuthorisationType":{"type":"object","properties":{}},"Identification":{"type":"string"},"CardSchemeName":{"type":"object","properties":{}},"Name":{"type":"string"}}},"ChargeAmount":{"type":"object","properties":{"Amount":{"type":"object","properties":{}},"Currency":{"type":"string"}}},"Status":{"type":"object","properties":{}},"ValueDateTime":{"type":"string"},"TransactionReference":{"type":"string"},"SupplementaryData":{"type":"object","properties":{}},"BookingDateTime":{"type":"string"},"AddressLine":{"type":"string"},"CreditDebitIndicator":{"type":"string"}}}}}}}}},"is_featured":false,"special_instructions":"","specified_url":"/open-banking/v3.1/accounts/ACCOUNTID/statements/STATEMENTID/transactions","connector_methods":[]},{"operation_id":"UKv3.1-getBeneficiaries","implemented_by":{"version":"UKv3.1","function":"getBeneficiaries"},"request_verb":"GET","request_url":"/open-banking/v3.1/beneficiaries","summary":"Get Beneficiaries","description":"NOTE: This endpoint currently only returns example data.
\nAuthentication is Mandatory
\nJSON response body fields:
\n","description_markdown":"**NOTE: This endpoint currently only returns example data.**\n\n \n\n\nAuthentication is Mandatory\n\n\n**JSON response body fields:**\n\n\n","example_request_body":{"jsonString":"{}"},"success_response_body":{"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"}]}},"error_response_bodies":["OBP-20001: User not logged in. Authentication is required!","OBP-50000: Unknown Error."],"tags":["Beneficiaries","Mocked-Data"],"typed_request_body":{"type":"object","properties":{"jsonString":{"type":"string"}}},"typed_success_response_body":{"type":"object","properties":{"type":"object","properties":{"Meta":{"type":"object","properties":{"FirstAvailableDateTime":{"type":"object","properties":{}},"TotalPages":{"type":"integer"}}},"Links":{"type":"object","properties":{"First":{"type":"string"},"Self":{"type":"string"},"Next":{"type":"string"},"Last":{"type":"string"},"Prev":{"type":"string"}}},"Data":{"type":"object","properties":{"Beneficiary":{"type":"array","items":{"type":"object","properties":{"CreditorAgent":{"type":"object","properties":{"PostalAddress":{"type":"object","properties":{"CountrySubDivision":{"type":"string"},"Country":{"type":"string"},"Department":{"type":"string"},"StreetName":{"type":"string"},"AddressType":{"type":"object","properties":{}},"BuildingNumber":{"type":"string"},"TownName":{"type":"string"},"SubDepartment":{"type":"string"},"PostCode":{"type":"string"},"AddressLine":{"type":"array","items":{"type":"object","properties":{"s":{"type":"string"}}}}}},"SchemeName":{"type":"array","items":{"type":"object","properties":{"s":{"type":"string"}}}},"Identification":{"type":"string"},"Name":{"type":"string"}}},"CreditorAccount":{"type":"object","properties":{"SecondaryIdentification":{"type":"string"},"SchemeName":{"type":"array","items":{"type":"object","properties":{"s":{"type":"string"}}}},"Identification":{"type":"string"},"Name":{"type":"string"}}},"AccountId":{"type":"object","properties":{}},"BeneficiaryId":{"type":"string"},"Reference":{"type":"string"}}}}}}}}},"is_featured":false,"special_instructions":"","specified_url":"/open-banking/v3.1/beneficiaries","connector_methods":[]},{"operation_id":"UKv3.1-getDirectDebits","implemented_by":{"version":"UKv3.1","function":"getDirectDebits"},"request_verb":"GET","request_url":"/open-banking/v3.1/direct-debits","summary":"Get Direct Debits","description":"NOTE: This endpoint currently only returns example data.
\nAuthentication is Mandatory
\nJSON response body fields:
\n","description_markdown":"**NOTE: This endpoint currently only returns example data.**\n\n \n\n\nAuthentication is Mandatory\n\n\n**JSON response body fields:**\n\n\n","example_request_body":{"jsonString":"{}"},"success_response_body":{"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"}]}},"error_response_bodies":["OBP-20001: User not logged in. Authentication is required!","OBP-50000: Unknown Error."],"tags":["Direct Debits","Mocked-Data"],"typed_request_body":{"type":"object","properties":{"jsonString":{"type":"string"}}},"typed_success_response_body":{"type":"object","properties":{"type":"object","properties":{"Meta":{"type":"object","properties":{"FirstAvailableDateTime":{"type":"object","properties":{}},"TotalPages":{"type":"integer"}}},"Links":{"type":"object","properties":{"First":{"type":"string"},"Self":{"type":"string"},"Next":{"type":"string"},"Last":{"type":"string"},"Prev":{"type":"string"}}},"Data":{"type":"object","properties":{"DirectDebit":{"type":"array","items":{"type":"object","properties":{"PreviousPaymentAmount":{"type":"object","properties":{"Amount":{"type":"object","properties":{}},"Currency":{"type":"string"}}},"Name":{"type":"string"},"DirectDebitStatusCode":{"type":"object","properties":{}},"AccountId":{"type":"object","properties":{}},"MandateIdentification":{"type":"string"},"DirectDebitId":{"type":"string"},"PreviousPaymentDateTime":{"type":"string"}}}}}}}}},"is_featured":false,"special_instructions":"","specified_url":"/open-banking/v3.1/direct-debits","connector_methods":[]},{"operation_id":"UKv3.1-getDomesticPaymentConsentsConsentIdFundsConfirmation","implemented_by":{"version":"UKv3.1","function":"getDomesticPaymentConsentsConsentIdFundsConfirmation"},"request_verb":"GET","request_url":"/open-banking/v3.1/domestic-payment-consents/CONSENTID/funds-confirmation","summary":"Get Domestic Payment Consents Funds Confirmation","description":"NOTE: This endpoint currently only returns example data.
\nAuthentication is Mandatory
\nURL Parameters:
\nCONSENTID: CONSENTID
\nJSON response body fields:
\n","description_markdown":"**NOTE: This endpoint currently only returns example data.**\n\n \n\n\nAuthentication is Mandatory\n\n\n**URL Parameters:**\n\n[CONSENTID](/glossary#): CONSENTID\n\n\n\n\n\n**JSON response body fields:**\n\n\n","example_request_body":{"jsonString":"{}"},"success_response_body":{"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}}},"error_response_bodies":["OBP-20001: User not logged in. Authentication is required!","OBP-50000: Unknown Error."],"tags":["Domestic Payments","Mocked-Data"],"typed_request_body":{"type":"object","properties":{"jsonString":{"type":"string"}}},"typed_success_response_body":{"type":"object","properties":{"type":"object","properties":{"Meta":{"type":"object","properties":{"FirstAvailableDateTime":{"type":"object","properties":{}},"TotalPages":{"type":"integer"}}},"Links":{"type":"object","properties":{"First":{"type":"string"},"Self":{"type":"string"},"Next":{"type":"string"},"Last":{"type":"string"},"Prev":{"type":"string"}}},"Data":{"type":"object","properties":{"SupplementaryData":{"type":"object","properties":{}},"FundsAvailableResult":{"type":"object","properties":{"FundsAvailableDateTime":{"type":"string"},"FundsAvailable":{"type":"boolean"}}}}}}}},"is_featured":false,"special_instructions":"","specified_url":"/open-banking/v3.1/domestic-payment-consents/CONSENTID/funds-confirmation","connector_methods":[]},{"operation_id":"UKv3.1-getStatements","implemented_by":{"version":"UKv3.1","function":"getStatements"},"request_verb":"GET","request_url":"/open-banking/v3.1/statements","summary":"Get Statements","description":"NOTE: This endpoint currently only returns example data.
\nAuthentication is Mandatory
\nJSON response body fields:
\n","description_markdown":"**NOTE: This endpoint currently only returns example data.**\n\n \n\n\nAuthentication is Mandatory\n\n\n**JSON response body fields:**\n\n\n","example_request_body":{"jsonString":"{}"},"success_response_body":{"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"}]}]}},"error_response_bodies":["OBP-20001: User not logged in. Authentication is required!","OBP-50000: Unknown Error."],"tags":["Statements","Mocked-Data"],"typed_request_body":{"type":"object","properties":{"jsonString":{"type":"string"}}},"typed_success_response_body":{"type":"object","properties":{"type":"object","properties":{"Meta":{"type":"object","properties":{"FirstAvailableDateTime":{"type":"object","properties":{}},"TotalPages":{"type":"integer"}}},"Links":{"type":"object","properties":{"First":{"type":"string"},"Self":{"type":"string"},"Next":{"type":"string"},"Last":{"type":"string"},"Prev":{"type":"string"}}},"Data":{"type":"object","properties":{"Statement":{"type":"array","items":{"type":"object","properties":{"StatementReference":{"type":"string"},"StatementDateTime":{"type":"array","items":{"type":"object","properties":{"Type":{"type":"array","items":{"type":"object","properties":{"s":{"type":"string"}}}},"DateTime":{"type":"string"}}}},"StatementBenefit":{"type":"array","items":{"type":"object","properties":{"Type":{"type":"array","items":{"type":"object","properties":{"s":{"type":"string"}}}},"Amount":{"type":"object","properties":{"Amount":{"type":"object","properties":{}},"Currency":{"type":"string"}}}}}},"StatementFee":{"type":"array","items":{"type":"object","properties":{"Type":{"type":"array","items":{"type":"object","properties":{"s":{"type":"string"}}}},"Amount":{"type":"object","properties":{"Amount":{"type":"object","properties":{}},"Currency":{"type":"string"}}},"CreditDebitIndicator":{"type":"string"}}}},"StartDateTime":{"type":"string"},"StatementId":{"type":"string"},"CreationDateTime":{"type":"string"},"EndDateTime":{"type":"string"},"AccountId":{"type":"object","properties":{}},"Type":{"type":"object","properties":{}},"StatementValue":{"type":"array","items":{"type":"object","properties":{"Type":{"type":"array","items":{"type":"object","properties":{"s":{"type":"string"}}}},"Value":{"type":"integer"}}}},"StatementAmount":{"type":"array","items":{"type":"object","properties":{"Type":{"type":"array","items":{"type":"object","properties":{"s":{"type":"string"}}}},"Amount":{"type":"object","properties":{"Amount":{"type":"object","properties":{}},"Currency":{"type":"string"}}},"CreditDebitIndicator":{"type":"string"}}}},"StatementRate":{"type":"array","items":{"type":"object","properties":{"Type":{"type":"array","items":{"type":"object","properties":{"s":{"type":"string"}}}},"Rate":{"type":"string"}}}},"StatementDescription":{"type":"array","items":{"type":"object","properties":{"s":{"type":"string"}}}},"StatementInterest":{"type":"array","items":{"type":"object","properties":{"Type":{"type":"array","items":{"type":"object","properties":{"s":{"type":"string"}}}},"Amount":{"type":"object","properties":{"Amount":{"type":"object","properties":{}},"Currency":{"type":"string"}}},"CreditDebitIndicator":{"type":"string"}}}}}}}}}}}},"is_featured":false,"special_instructions":"","specified_url":"/open-banking/v3.1/statements","connector_methods":[]},{"operation_id":"UKv3.1-getAccountsAccountIdStatementsStatementIdFile","implemented_by":{"version":"UKv3.1","function":"getAccountsAccountIdStatementsStatementIdFile"},"request_verb":"GET","request_url":"/open-banking/v3.1/accounts/ACCOUNTID/statements/STATEMENTID/file","summary":"Get Statements","description":"NOTE: This endpoint currently only returns example data.
\nAuthentication is Mandatory
\nURL Parameters:
\nACCOUNTID: ACCOUNTID
\nSTATEMENTID: STATEMENTID
\nJSON response body fields:
\n","description_markdown":"**NOTE: This endpoint currently only returns example data.**\n\n \n\n\nAuthentication is Mandatory\n\n\n**URL Parameters:**\n\n[ACCOUNTID](/glossary#): ACCOUNTID\n\n\n\n[STATEMENTID](/glossary#): STATEMENTID\n\n\n\n\n\n**JSON response body fields:**\n\n\n","example_request_body":{"jsonString":"{}"},"success_response_body":{"jsonString":"{}"},"error_response_bodies":["OBP-20001: User not logged in. Authentication is required!","OBP-50000: Unknown Error."],"tags":["Statements","Mocked-Data"],"typed_request_body":{"type":"object","properties":{"jsonString":{"type":"string"}}},"typed_success_response_body":{"type":"object","properties":{"jsonString":{"type":"string"}}},"is_featured":false,"special_instructions":"","specified_url":"/open-banking/v3.1/accounts/ACCOUNTID/statements/STATEMENTID/file","connector_methods":[]},{"operation_id":"UKv3.1-getAccountsAccountIdStandingOrders","implemented_by":{"version":"UKv3.1","function":"getAccountsAccountIdStandingOrders"},"request_verb":"GET","request_url":"/open-banking/v3.1/accounts/ACCOUNTID/standing-orders","summary":"Get Standing Orders","description":"NOTE: This endpoint currently only returns example data.
\nAuthentication is Mandatory
\nURL Parameters:
\nACCOUNTID: ACCOUNTID
\nJSON response body fields:
\n","description_markdown":"**NOTE: This endpoint currently only returns example data.**\n\n \n\n\nAuthentication is Mandatory\n\n\n**URL Parameters:**\n\n[ACCOUNTID](/glossary#): ACCOUNTID\n\n\n\n\n\n**JSON response body fields:**\n\n\n","example_request_body":{"jsonString":"{}"},"success_response_body":{"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"}]}},"error_response_bodies":["OBP-20001: User not logged in. Authentication is required!","OBP-50000: Unknown Error."],"tags":["Standing Orders","Mocked-Data"],"typed_request_body":{"type":"object","properties":{"jsonString":{"type":"string"}}},"typed_success_response_body":{"type":"object","properties":{"type":"object","properties":{"Meta":{"type":"object","properties":{"FirstAvailableDateTime":{"type":"object","properties":{}},"TotalPages":{"type":"integer"}}},"Links":{"type":"object","properties":{"First":{"type":"string"},"Self":{"type":"string"},"Next":{"type":"string"},"Last":{"type":"string"},"Prev":{"type":"string"}}},"Data":{"type":"object","properties":{"StandingOrder":{"type":"array","items":{"type":"object","properties":{"CreditorAccount":{"type":"object","properties":{"SecondaryIdentification":{"type":"string"},"SchemeName":{"type":"array","items":{"type":"object","properties":{"s":{"type":"string"}}}},"Identification":{"type":"string"},"Name":{"type":"string"}}},"FirstPaymentAmount":{"type":"object","properties":{"Amount":{"type":"object","properties":{}},"Currency":{"type":"string"}}},"FinalPaymentDateTime":{"type":"string"},"NextPaymentAmount":{"type":"object","properties":{"Amount":{"type":"object","properties":{}},"Currency":{"type":"string"}}},"AccountId":{"type":"object","properties":{}},"FirstPaymentDateTime":{"type":"string"},"StandingOrderStatusCode":{"type":"object","properties":{}},"SupplementaryData":{"type":"object","properties":{}},"Frequency":{"type":"string"},"CreditorAgent":{"type":"object","properties":{"SchemeName":{"type":"array","items":{"type":"object","properties":{"s":{"type":"string"}}}},"Identification":{"type":"string"}}},"FinalPaymentAmount":{"type":"object","properties":{"Amount":{"type":"object","properties":{}},"Currency":{"type":"string"}}},"Reference":{"type":"string"},"NextPaymentDateTime":{"type":"string"},"StandingOrderId":{"type":"string"}}}}}}}}},"is_featured":false,"special_instructions":"","specified_url":"/open-banking/v3.1/accounts/ACCOUNTID/standing-orders","connector_methods":[]},{"operation_id":"UKv3.1-getDomesticScheduledPaymentsDomesticScheduledPaymentId","implemented_by":{"version":"UKv3.1","function":"getDomesticScheduledPaymentsDomesticScheduledPaymentId"},"request_verb":"GET","request_url":"/open-banking/v3.1/domestic-scheduled-payments/DOMESTICSCHEDULEDPAYMENTID","summary":"Get Domestic Scheduled Payments","description":"NOTE: This endpoint currently only returns example data.
\nAuthentication is Mandatory
\nURL Parameters:
\nDOMESTICSCHEDULEDPAYMENTID: DOMESTICSCHEDULEDPAYMENTID
\nJSON response body fields:
\n","description_markdown":"**NOTE: This endpoint currently only returns example data.**\n\n \n\n\nAuthentication is Mandatory\n\n\n**URL Parameters:**\n\n[DOMESTICSCHEDULEDPAYMENTID](/glossary#): DOMESTICSCHEDULEDPAYMENTID\n\n\n\n\n\n**JSON response body fields:**\n\n\n","example_request_body":{"jsonString":"{}"},"success_response_body":{"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}}},"error_response_bodies":["OBP-20001: User not logged in. Authentication is required!","OBP-50000: Unknown Error."],"tags":["Domestic Scheduled Payments","Mocked-Data"],"typed_request_body":{"type":"object","properties":{"jsonString":{"type":"string"}}},"typed_success_response_body":{"type":"object","properties":{"type":"object","properties":{"Meta":{"type":"object","properties":{"FirstAvailableDateTime":{"type":"object","properties":{}},"TotalPages":{"type":"integer"}}},"Links":{"type":"object","properties":{"First":{"type":"string"},"Self":{"type":"string"},"Next":{"type":"string"},"Last":{"type":"string"},"Prev":{"type":"string"}}},"Data":{"type":"object","properties":{"ExpectedExecutionDateTime":{"type":"string"},"ExpectedSettlementDateTime":{"type":"string"},"StatusUpdateDateTime":{"type":"string"},"CreationDateTime":{"type":"string"},"DomesticScheduledPaymentId":{"type":"string"},"ConsentId":{"type":"string"},"Status":{"type":"object","properties":{}},"Charges":{"type":"array","items":{"type":"object","properties":{"Type":{"type":"array","items":{"type":"object","properties":{"s":{"type":"string"}}}},"Amount":{"type":"object","properties":{"Amount":{"type":"object","properties":{}},"Currency":{"type":"string"}}},"ChargeBearer":{"type":"object","properties":{}}}}},"MultiAuthorisation":{"type":"object","properties":{"ExpirationDateTime":{"type":"string"},"NumberRequired":{"type":"integer"},"Status":{"type":"object","properties":{}},"NumberReceived":{"type":"integer"},"LastUpdateDateTime":{"type":"string"}}},"Initiation":{"type":"object","properties":{"InstructedAmount":{"type":"object","properties":{"Currency":{"type":"string"}}},"RequestedExecutionDateTime":{"type":"string"},"CreditorPostalAddress":{"type":"object","properties":{"CountrySubDivision":{"type":"string"},"Country":{"type":"string"},"Department":{"type":"string"},"StreetName":{"type":"string"},"AddressType":{"type":"object","properties":{}},"BuildingNumber":{"type":"string"},"TownName":{"type":"string"},"SubDepartment":{"type":"string"},"PostCode":{"type":"string"},"AddressLine":{"type":"array","items":{"type":"object","properties":{"s":{"type":"string"}}}}}},"CreditorAccount":{"type":"object","properties":{"SecondaryIdentification":{"type":"string"},"SchemeName":{"type":"array","items":{"type":"object","properties":{"s":{"type":"string"}}}},"Identification":{"type":"string"},"Name":{"type":"string"}}},"EndToEndIdentification":{"type":"string"},"DebtorAccount":{"type":"object","properties":{"SecondaryIdentification":{"type":"string"},"SchemeName":{"type":"array","items":{"type":"object","properties":{"s":{"type":"string"}}}},"Identification":{"type":"string"},"Name":{"type":"string"}}},"InstructionIdentification":{"type":"string"},"LocalInstrument":{"type":"array","items":{"type":"object","properties":{"s":{"type":"string"}}}},"SupplementaryData":{"type":"object","properties":{}},"RemittanceInformation":{"type":"object","properties":{"Unstructured":{"type":"string"},"Reference":{"type":"string"}}}}}}}}}},"is_featured":false,"special_instructions":"","specified_url":"/open-banking/v3.1/domestic-scheduled-payments/DOMESTICSCHEDULEDPAYMENTID","connector_methods":[]},{"operation_id":"UKv3.1-getAccountsAccountId","implemented_by":{"version":"UKv3.1","function":"getAccountsAccountId"},"request_verb":"GET","request_url":"/open-banking/v3.1/accounts/ACCOUNT_ID","summary":"Get Accounts","description":"Authentication is Mandatory
\nURL Parameters:
\nACCOUNT_ID: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
\nJSON response body fields:
\n","description_markdown":"Authentication is Mandatory\n\n\n**URL Parameters:**\n\n[ACCOUNT_ID](/glossary#Account.account_id): 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0\n\n\n\n\n\n**JSON response body fields:**\n\n\n","example_request_body":{"jsonString":"{}"},"success_response_body":{"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"}]}},"error_response_bodies":["OBP-20001: User not logged in. Authentication is required!","OBP-50000: Unknown Error."],"tags":["Accounts"],"typed_request_body":{"type":"object","properties":{"jsonString":{"type":"string"}}},"typed_success_response_body":{"type":"object","properties":{"type":"object","properties":{"Meta":{"type":"object","properties":{"FirstAvailableDateTime":{"type":"string"},"LastAvailableDateTime":{"type":"string"},"TotalPages":{"type":"integer"}}},"Links":{"type":"object","properties":{"First":{"type":"string"},"Self":{"type":"string"},"Next":{"type":"string"},"Last":{"type":"string"},"Prev":{"type":"string"}}},"Data":{"type":"object","properties":{"Account":{"type":"array","items":{"type":"object","properties":{"AccountType":{"type":"string"},"Nickname":{"type":"string"},"AccountSubType":{"type":"string"},"Servicer":{"type":"object","properties":{"SchemeName":{"type":"array","items":{"type":"object","properties":{"s":{"type":"string"}}}},"Identification":{"type":"string"}}},"Currency":{"type":"string"},"Account":{"type":"array","items":{"type":"object","properties":{"SecondaryIdentification":{"type":"string"},"SchemeName":{"type":"array","items":{"type":"object","properties":{"s":{"type":"string"}}}},"Identification":{"type":"string"},"Name":{"type":"string"}}}},"Description":{"type":"string"},"AccountId":{"type":"string"}}}}}}}}},"is_featured":false,"special_instructions":"","specified_url":"/open-banking/v3.1/accounts/ACCOUNT_ID","connector_methods":[]},{"operation_id":"UKv3.1-getDomesticPaymentsDomesticPaymentId","implemented_by":{"version":"UKv3.1","function":"getDomesticPaymentsDomesticPaymentId"},"request_verb":"GET","request_url":"/open-banking/v3.1/domestic-payments/DOMESTICPAYMENTID","summary":"Get Domestic Payments","description":"NOTE: This endpoint currently only returns example data.
\nAuthentication is Mandatory
\nURL Parameters:
\nDOMESTICPAYMENTID: DOMESTICPAYMENTID
\nJSON response body fields:
\n","description_markdown":"**NOTE: This endpoint currently only returns example data.**\n\n \n\n\nAuthentication is Mandatory\n\n\n**URL Parameters:**\n\n[DOMESTICPAYMENTID](/glossary#): DOMESTICPAYMENTID\n\n\n\n\n\n**JSON response body fields:**\n\n\n","example_request_body":{"jsonString":"{}"},"success_response_body":{"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}}},"error_response_bodies":["OBP-20001: User not logged in. Authentication is required!","OBP-50000: Unknown Error."],"tags":["Domestic Payments","Mocked-Data"],"typed_request_body":{"type":"object","properties":{"jsonString":{"type":"string"}}},"typed_success_response_body":{"type":"object","properties":{"type":"object","properties":{"Meta":{"type":"object","properties":{"FirstAvailableDateTime":{"type":"object","properties":{}},"TotalPages":{"type":"integer"}}},"Links":{"type":"object","properties":{"First":{"type":"string"},"Self":{"type":"string"},"Next":{"type":"string"},"Last":{"type":"string"},"Prev":{"type":"string"}}},"Data":{"type":"object","properties":{"ExpectedExecutionDateTime":{"type":"string"},"ExpectedSettlementDateTime":{"type":"string"},"StatusUpdateDateTime":{"type":"string"},"CreationDateTime":{"type":"string"},"ConsentId":{"type":"string"},"Initiation":{"type":"object","properties":{"InstructedAmount":{"type":"object","properties":{"Currency":{"type":"string"}}},"CreditorPostalAddress":{"type":"object","properties":{"CountrySubDivision":{"type":"string"},"Country":{"type":"string"},"Department":{"type":"string"},"StreetName":{"type":"string"},"AddressType":{"type":"object","properties":{}},"BuildingNumber":{"type":"string"},"TownName":{"type":"string"},"SubDepartment":{"type":"string"},"PostCode":{"type":"string"},"AddressLine":{"type":"array","items":{"type":"object","properties":{"s":{"type":"string"}}}}}},"CreditorAccount":{"type":"object","properties":{"SecondaryIdentification":{"type":"string"},"SchemeName":{"type":"array","items":{"type":"object","properties":{"s":{"type":"string"}}}},"Identification":{"type":"string"},"Name":{"type":"string"}}},"EndToEndIdentification":{"type":"string"},"DebtorAccount":{"type":"object","properties":{"SecondaryIdentification":{"type":"string"},"SchemeName":{"type":"array","items":{"type":"object","properties":{"s":{"type":"string"}}}},"Identification":{"type":"string"},"Name":{"type":"string"}}},"InstructionIdentification":{"type":"string"},"LocalInstrument":{"type":"array","items":{"type":"object","properties":{"s":{"type":"string"}}}},"SupplementaryData":{"type":"object","properties":{}},"RemittanceInformation":{"type":"object","properties":{"Unstructured":{"type":"string"},"Reference":{"type":"string"}}}}},"Status":{"type":"object","properties":{}},"DomesticPaymentId":{"type":"string"},"Charges":{"type":"array","items":{"type":"object","properties":{"Type":{"type":"array","items":{"type":"object","properties":{"s":{"type":"string"}}}},"Amount":{"type":"object","properties":{"Amount":{"type":"object","properties":{}},"Currency":{"type":"string"}}},"ChargeBearer":{"type":"object","properties":{}}}}},"MultiAuthorisation":{"type":"object","properties":{"ExpirationDateTime":{"type":"string"},"NumberRequired":{"type":"integer"},"Status":{"type":"object","properties":{}},"NumberReceived":{"type":"integer"},"LastUpdateDateTime":{"type":"string"}}}}}}}},"is_featured":false,"special_instructions":"","specified_url":"/open-banking/v3.1/domestic-payments/DOMESTICPAYMENTID","connector_methods":[]},{"operation_id":"UKv3.1-createFundsConfirmationConsents","implemented_by":{"version":"UKv3.1","function":"createFundsConfirmationConsents"},"request_verb":"POST","request_url":"/open-banking/v3.1/funds-confirmation-consents","summary":"Create Funds Confirmation Consent","description":"NOTE: This endpoint currently only returns example data.
\nAuthentication is Mandatory
\nJSON request body fields:
\nJSON response body fields:
\n","description_markdown":"**NOTE: This endpoint currently only returns example data.**\n\n \n\n\nAuthentication is Mandatory\n\n\n**JSON request body fields:**\n\n\n\n\n\n**JSON response body fields:**\n\n\n","example_request_body":{"jsonString":"{}"},"success_response_body":{"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"}},"error_response_bodies":["OBP-20001: User not logged in. Authentication is required!","OBP-50000: Unknown Error."],"tags":["Funds Confirmations","Mocked-Data"],"typed_request_body":{"type":"object","properties":{"jsonString":{"type":"string"}}},"typed_success_response_body":{"type":"object","properties":{"type":"object","properties":{"Meta":{"type":"object","properties":{"FirstAvailableDateTime":{"type":"object","properties":{}},"TotalPages":{"type":"integer"}}},"Links":{"type":"object","properties":{"First":{"type":"string"},"Self":{"type":"string"},"Next":{"type":"string"},"Last":{"type":"string"},"Prev":{"type":"string"}}},"Data":{"type":"object","properties":{"ExpirationDateTime":{"type":"string"},"StatusUpdateDateTime":{"type":"string"},"DebtorAccount":{"type":"object","properties":{"SecondaryIdentification":{"type":"string"},"SchemeName":{"type":"array","items":{"type":"object","properties":{"s":{"type":"string"}}}},"Identification":{"type":"string"},"Name":{"type":"string"}}},"CreationDateTime":{"type":"string"},"ConsentId":{"type":"string"},"Status":{"type":"object","properties":{}}}}}}},"is_featured":false,"special_instructions":"","specified_url":"/open-banking/v3.1/funds-confirmation-consents","connector_methods":[]},{"operation_id":"UKv3.1-getInternationalPaymentsInternationalPaymentId","implemented_by":{"version":"UKv3.1","function":"getInternationalPaymentsInternationalPaymentId"},"request_verb":"GET","request_url":"/open-banking/v3.1/international-payments/INTERNATIONALPAYMENTID","summary":"Get International Payments","description":"NOTE: This endpoint currently only returns example data.
\nAuthentication is Mandatory
\nURL Parameters:
\nINTERNATIONALPAYMENTID: INTERNATIONALPAYMENTID
\nJSON response body fields:
\n","description_markdown":"**NOTE: This endpoint currently only returns example data.**\n\n \n\n\nAuthentication is Mandatory\n\n\n**URL Parameters:**\n\n[INTERNATIONALPAYMENTID](/glossary#): INTERNATIONALPAYMENTID\n\n\n\n\n\n**JSON response body fields:**\n\n\n","example_request_body":{"jsonString":"{}"},"success_response_body":{"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}}},"error_response_bodies":["OBP-20001: User not logged in. Authentication is required!","OBP-50000: Unknown Error."],"tags":["International Payments","Mocked-Data"],"typed_request_body":{"type":"object","properties":{"jsonString":{"type":"string"}}},"typed_success_response_body":{"type":"object","properties":{"type":"object","properties":{"Meta":{"type":"object","properties":{"FirstAvailableDateTime":{"type":"object","properties":{}},"TotalPages":{"type":"integer"}}},"Links":{"type":"object","properties":{"First":{"type":"string"},"Self":{"type":"string"},"Next":{"type":"string"},"Last":{"type":"string"},"Prev":{"type":"string"}}},"Data":{"type":"object","properties":{"ExpectedExecutionDateTime":{"type":"string"},"ExpectedSettlementDateTime":{"type":"string"},"StatusUpdateDateTime":{"type":"string"},"CreationDateTime":{"type":"string"},"Initiation":{"type":"object","properties":{"CurrencyOfTransfer":{"type":"string"},"InstructedAmount":{"type":"object","properties":{"Currency":{"type":"string"}}},"CreditorAgent":{"type":"object","properties":{"PostalAddress":{"type":"object","properties":{"CountrySubDivision":{"type":"string"},"Country":{"type":"string"},"Department":{"type":"string"},"StreetName":{"type":"string"},"AddressType":{"type":"object","properties":{}},"BuildingNumber":{"type":"string"},"TownName":{"type":"string"},"SubDepartment":{"type":"string"},"PostCode":{"type":"string"},"AddressLine":{"type":"array","items":{"type":"object","properties":{"s":{"type":"string"}}}}}},"SchemeName":{"type":"array","items":{"type":"object","properties":{"s":{"type":"string"}}}},"Identification":{"type":"string"},"Name":{"type":"string"}}},"InstructionPriority":{"type":"object","properties":{}},"CreditorAccount":{"type":"object","properties":{"SecondaryIdentification":{"type":"string"},"SchemeName":{"type":"array","items":{"type":"object","properties":{"s":{"type":"string"}}}},"Identification":{"type":"string"},"Name":{"type":"string"}}},"EndToEndIdentification":{"type":"string"},"DebtorAccount":{"type":"object","properties":{"SecondaryIdentification":{"type":"string"},"SchemeName":{"type":"array","items":{"type":"object","properties":{"s":{"type":"string"}}}},"Identification":{"type":"string"},"Name":{"type":"string"}}},"ChargeBearer":{"type":"object","properties":{}},"InstructionIdentification":{"type":"string"},"LocalInstrument":{"type":"array","items":{"type":"object","properties":{"s":{"type":"string"}}}},"SupplementaryData":{"type":"object","properties":{}},"Purpose":{"type":"object","properties":{}},"RemittanceInformation":{"type":"object","properties":{"Unstructured":{"type":"string"},"Reference":{"type":"string"}}},"Creditor":{"type":"object","properties":{"PostalAddress":{"type":"object","properties":{"CountrySubDivision":{"type":"string"},"Country":{"type":"string"},"Department":{"type":"string"},"StreetName":{"type":"string"},"AddressType":{"type":"object","properties":{}},"BuildingNumber":{"type":"string"},"TownName":{"type":"string"},"SubDepartment":{"type":"string"},"PostCode":{"type":"string"},"AddressLine":{"type":"array","items":{"type":"object","properties":{"s":{"type":"string"}}}}}},"Name":{"type":"string"}}},"ExchangeRateInformation":{"type":"object","properties":{"ExchangeRate":{"type":"number"},"UnitCurrency":{"type":"string"},"ContractIdentification":{"type":"string"}}}}},"ConsentId":{"type":"string"},"ExchangeRateInformation":{"type":"object","properties":{"ExpirationDateTime":{"type":"string"},"ExchangeRate":{"type":"number"},"RateType":{"type":"object","properties":{}},"ContractIdentification":{"type":"string"},"UnitCurrency":{"type":"string"}}},"Status":{"type":"object","properties":{}},"Charges":{"type":"array","items":{"type":"object","properties":{"Type":{"type":"array","items":{"type":"object","properties":{"s":{"type":"string"}}}},"Amount":{"type":"object","properties":{"Amount":{"type":"object","properties":{}},"Currency":{"type":"string"}}},"ChargeBearer":{"type":"object","properties":{}}}}},"InternationalPaymentId":{"type":"string"},"MultiAuthorisation":{"type":"object","properties":{"ExpirationDateTime":{"type":"string"},"NumberRequired":{"type":"integer"},"Status":{"type":"object","properties":{}},"NumberReceived":{"type":"integer"},"LastUpdateDateTime":{"type":"string"}}}}}}}},"is_featured":false,"special_instructions":"","specified_url":"/open-banking/v3.1/international-payments/INTERNATIONALPAYMENTID","connector_methods":[]},{"operation_id":"UKv3.1-createFundsConfirmations","implemented_by":{"version":"UKv3.1","function":"createFundsConfirmations"},"request_verb":"POST","request_url":"/open-banking/v3.1/funds-confirmations","summary":"Create Funds Confirmation","description":"NOTE: This endpoint currently only returns example data.
\nAuthentication is Mandatory
\nJSON request body fields:
\nJSON response body fields:
\n","description_markdown":"**NOTE: This endpoint currently only returns example data.**\n\n \n\n\nAuthentication is Mandatory\n\n\n**JSON request body fields:**\n\n\n\n\n\n**JSON response body fields:**\n\n\n","example_request_body":{"jsonString":"{}"},"success_response_body":{"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"}}},"error_response_bodies":["OBP-20001: User not logged in. Authentication is required!","OBP-50000: Unknown Error."],"tags":["Funds Confirmations","Mocked-Data"],"typed_request_body":{"type":"object","properties":{"jsonString":{"type":"string"}}},"typed_success_response_body":{"type":"object","properties":{"type":"object","properties":{"Meta":{"type":"object","properties":{"FirstAvailableDateTime":{"type":"object","properties":{}},"TotalPages":{"type":"integer"}}},"Links":{"type":"object","properties":{"First":{"type":"string"},"Self":{"type":"string"},"Next":{"type":"string"},"Last":{"type":"string"},"Prev":{"type":"string"}}},"Data":{"type":"object","properties":{"FundsAvailable":{"type":"boolean"},"FundsConfirmationId":{"type":"string"},"CreationDateTime":{"type":"string"},"ConsentId":{"type":"string"},"InstructedAmount":{"type":"object","properties":{"Amount":{"type":"object","properties":{}},"Currency":{"type":"string"}}},"Reference":{"type":"string"}}}}}},"is_featured":false,"special_instructions":"","specified_url":"/open-banking/v3.1/funds-confirmations","connector_methods":[]},{"operation_id":"UKv3.1-getAccountsAccountIdBeneficiaries","implemented_by":{"version":"UKv3.1","function":"getAccountsAccountIdBeneficiaries"},"request_verb":"GET","request_url":"/open-banking/v3.1/accounts/ACCOUNTID/beneficiaries","summary":"Get Beneficiaries","description":"NOTE: This endpoint currently only returns example data.
\nAuthentication is Mandatory
\nURL Parameters:
\nACCOUNTID: ACCOUNTID
\nJSON response body fields:
\n","description_markdown":"**NOTE: This endpoint currently only returns example data.**\n\n \n\n\nAuthentication is Mandatory\n\n\n**URL Parameters:**\n\n[ACCOUNTID](/glossary#): ACCOUNTID\n\n\n\n\n\n**JSON response body fields:**\n\n\n","example_request_body":{"jsonString":"{}"},"success_response_body":{"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"}]}},"error_response_bodies":["OBP-20001: User not logged in. Authentication is required!","OBP-50000: Unknown Error."],"tags":["Beneficiaries","Mocked-Data"],"typed_request_body":{"type":"object","properties":{"jsonString":{"type":"string"}}},"typed_success_response_body":{"type":"object","properties":{"type":"object","properties":{"Meta":{"type":"object","properties":{"FirstAvailableDateTime":{"type":"object","properties":{}},"TotalPages":{"type":"integer"}}},"Links":{"type":"object","properties":{"First":{"type":"string"},"Self":{"type":"string"},"Next":{"type":"string"},"Last":{"type":"string"},"Prev":{"type":"string"}}},"Data":{"type":"object","properties":{"Beneficiary":{"type":"array","items":{"type":"object","properties":{"CreditorAgent":{"type":"object","properties":{"PostalAddress":{"type":"object","properties":{"CountrySubDivision":{"type":"string"},"Country":{"type":"string"},"Department":{"type":"string"},"StreetName":{"type":"string"},"AddressType":{"type":"object","properties":{}},"BuildingNumber":{"type":"string"},"TownName":{"type":"string"},"SubDepartment":{"type":"string"},"PostCode":{"type":"string"},"AddressLine":{"type":"array","items":{"type":"object","properties":{"s":{"type":"string"}}}}}},"SchemeName":{"type":"array","items":{"type":"object","properties":{"s":{"type":"string"}}}},"Identification":{"type":"string"},"Name":{"type":"string"}}},"CreditorAccount":{"type":"object","properties":{"SecondaryIdentification":{"type":"string"},"SchemeName":{"type":"array","items":{"type":"object","properties":{"s":{"type":"string"}}}},"Identification":{"type":"string"},"Name":{"type":"string"}}},"AccountId":{"type":"object","properties":{}},"BeneficiaryId":{"type":"string"},"Reference":{"type":"string"}}}}}}}}},"is_featured":false,"special_instructions":"","specified_url":"/open-banking/v3.1/accounts/ACCOUNTID/beneficiaries","connector_methods":[]},{"operation_id":"UKv3.1-getOffers","implemented_by":{"version":"UKv3.1","function":"getOffers"},"request_verb":"GET","request_url":"/open-banking/v3.1/offers","summary":"Get Offers","description":"NOTE: This endpoint currently only returns example data.
\nAuthentication is Mandatory
\nJSON response body fields:
\n","description_markdown":"**NOTE: This endpoint currently only returns example data.**\n\n \n\n\nAuthentication is Mandatory\n\n\n**JSON response body fields:**\n\n\n","example_request_body":{"jsonString":"{}"},"success_response_body":{"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":{}}]}},"error_response_bodies":["OBP-20001: User not logged in. Authentication is required!","OBP-50000: Unknown Error."],"tags":["Offers","Mocked-Data"],"typed_request_body":{"type":"object","properties":{"jsonString":{"type":"string"}}},"typed_success_response_body":{"type":"object","properties":{"type":"object","properties":{"Meta":{"type":"object","properties":{"FirstAvailableDateTime":{"type":"object","properties":{}},"TotalPages":{"type":"integer"}}},"Links":{"type":"object","properties":{"First":{"type":"string"},"Self":{"type":"string"},"Next":{"type":"string"},"Last":{"type":"string"},"Prev":{"type":"string"}}},"Data":{"type":"object","properties":{"Offer":{"type":"array","items":{"type":"object","properties":{"Term":{"type":"string"},"Amount":{"type":"object","properties":{"Amount":{"type":"object","properties":{}},"Currency":{"type":"string"}}},"StartDateTime":{"type":"string"},"URL":{"type":"string"},"EndDateTime":{"type":"string"},"AccountId":{"type":"object","properties":{}},"OfferType":{"type":"object","properties":{}},"Value":{"type":"integer"},"Fee":{"type":"object","properties":{"Amount":{"type":"object","properties":{}},"Currency":{"type":"string"}}},"OfferId":{"type":"string"},"Description":{"type":"string"},"Rate":{"type":"string"}}}}}}}}},"is_featured":false,"special_instructions":"","specified_url":"/open-banking/v3.1/offers","connector_methods":[]},{"operation_id":"UKv3.1-getInternationalScheduledPaymentsInternationalScheduledPaymentId","implemented_by":{"version":"UKv3.1","function":"getInternationalScheduledPaymentsInternationalScheduledPaymentId"},"request_verb":"GET","request_url":"/open-banking/v3.1/international-scheduled-payments/INTERNATIONALSCHEDULEDPAYMENTID","summary":"Get International Scheduled Payments","description":"NOTE: This endpoint currently only returns example data.
\nAuthentication is Mandatory
\nURL Parameters:
\nINTERNATIONALSCHEDULEDPAYMENTID: INTERNATIONALSCHEDULEDPAYMENTID
\nJSON response body fields:
\n","description_markdown":"**NOTE: This endpoint currently only returns example data.**\n\n \n\n\nAuthentication is Mandatory\n\n\n**URL Parameters:**\n\n[INTERNATIONALSCHEDULEDPAYMENTID](/glossary#): INTERNATIONALSCHEDULEDPAYMENTID\n\n\n\n\n\n**JSON response body fields:**\n\n\n","example_request_body":{"jsonString":"{}"},"success_response_body":{"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}}},"error_response_bodies":["OBP-20001: User not logged in. Authentication is required!","OBP-50000: Unknown Error."],"tags":["International Scheduled Payments","Mocked-Data"],"typed_request_body":{"type":"object","properties":{"jsonString":{"type":"string"}}},"typed_success_response_body":{"type":"object","properties":{"type":"object","properties":{"Meta":{"type":"object","properties":{"FirstAvailableDateTime":{"type":"object","properties":{}},"TotalPages":{"type":"integer"}}},"Links":{"type":"object","properties":{"First":{"type":"string"},"Self":{"type":"string"},"Next":{"type":"string"},"Last":{"type":"string"},"Prev":{"type":"string"}}},"Data":{"type":"object","properties":{"ExpectedExecutionDateTime":{"type":"string"},"ExpectedSettlementDateTime":{"type":"string"},"StatusUpdateDateTime":{"type":"string"},"CreationDateTime":{"type":"string"},"Initiation":{"type":"object","properties":{"CurrencyOfTransfer":{"type":"string"},"InstructedAmount":{"type":"object","properties":{"Currency":{"type":"string"}}},"RequestedExecutionDateTime":{"type":"string"},"CreditorAgent":{"type":"object","properties":{"PostalAddress":{"type":"object","properties":{"CountrySubDivision":{"type":"string"},"Country":{"type":"string"},"Department":{"type":"string"},"StreetName":{"type":"string"},"AddressType":{"type":"object","properties":{}},"BuildingNumber":{"type":"string"},"TownName":{"type":"string"},"SubDepartment":{"type":"string"},"PostCode":{"type":"string"},"AddressLine":{"type":"array","items":{"type":"object","properties":{"s":{"type":"string"}}}}}},"SchemeName":{"type":"array","items":{"type":"object","properties":{"s":{"type":"string"}}}},"Identification":{"type":"string"},"Name":{"type":"string"}}},"InstructionPriority":{"type":"object","properties":{}},"CreditorAccount":{"type":"object","properties":{"SecondaryIdentification":{"type":"string"},"SchemeName":{"type":"array","items":{"type":"object","properties":{"s":{"type":"string"}}}},"Identification":{"type":"string"},"Name":{"type":"string"}}},"EndToEndIdentification":{"type":"string"},"DebtorAccount":{"type":"object","properties":{"SecondaryIdentification":{"type":"string"},"SchemeName":{"type":"array","items":{"type":"object","properties":{"s":{"type":"string"}}}},"Identification":{"type":"string"},"Name":{"type":"string"}}},"ChargeBearer":{"type":"object","properties":{}},"InstructionIdentification":{"type":"string"},"LocalInstrument":{"type":"array","items":{"type":"object","properties":{"s":{"type":"string"}}}},"SupplementaryData":{"type":"object","properties":{}},"Purpose":{"type":"object","properties":{}},"RemittanceInformation":{"type":"object","properties":{"Unstructured":{"type":"string"},"Reference":{"type":"string"}}},"Creditor":{"type":"object","properties":{"PostalAddress":{"type":"object","properties":{"CountrySubDivision":{"type":"string"},"Country":{"type":"string"},"Department":{"type":"string"},"StreetName":{"type":"string"},"AddressType":{"type":"object","properties":{}},"BuildingNumber":{"type":"string"},"TownName":{"type":"string"},"SubDepartment":{"type":"string"},"PostCode":{"type":"string"},"AddressLine":{"type":"array","items":{"type":"object","properties":{"s":{"type":"string"}}}}}},"Name":{"type":"string"}}},"ExchangeRateInformation":{"type":"object","properties":{"ExchangeRate":{"type":"number"},"UnitCurrency":{"type":"string"},"ContractIdentification":{"type":"string"}}}}},"ConsentId":{"type":"string"},"ExchangeRateInformation":{"type":"object","properties":{"ExpirationDateTime":{"type":"string"},"ExchangeRate":{"type":"number"},"RateType":{"type":"object","properties":{}},"ContractIdentification":{"type":"string"},"UnitCurrency":{"type":"string"}}},"Status":{"type":"object","properties":{}},"Charges":{"type":"array","items":{"type":"object","properties":{"Type":{"type":"array","items":{"type":"object","properties":{"s":{"type":"string"}}}},"Amount":{"type":"object","properties":{"Amount":{"type":"object","properties":{}},"Currency":{"type":"string"}}},"ChargeBearer":{"type":"object","properties":{}}}}},"MultiAuthorisation":{"type":"object","properties":{"ExpirationDateTime":{"type":"string"},"NumberRequired":{"type":"integer"},"Status":{"type":"object","properties":{}},"NumberReceived":{"type":"integer"},"LastUpdateDateTime":{"type":"string"}}},"InternationalScheduledPaymentId":{"type":"string"}}}}}},"is_featured":false,"special_instructions":"","specified_url":"/open-banking/v3.1/international-scheduled-payments/INTERNATIONALSCHEDULEDPAYMENTID","connector_methods":[]},{"operation_id":"UKv3.1-createFilePaymentConsentsConsentIdFile","implemented_by":{"version":"UKv3.1","function":"createFilePaymentConsentsConsentIdFile"},"request_verb":"POST","request_url":"/open-banking/v3.1/file-payment-consents/CONSENTID/file","summary":"Create File Payment Consents","description":"NOTE: This endpoint currently only returns example data.
\nAuthentication is Mandatory
\nURL Parameters:
\nCONSENTID: CONSENTID
\nJSON request body fields:
\nJSON response body fields:
\n","description_markdown":"**NOTE: This endpoint currently only returns example data.**\n\n \n\n\nAuthentication is Mandatory\n\n\n**URL Parameters:**\n\n[CONSENTID](/glossary#): CONSENTID\n\n\n\n\n\n**JSON request body fields:**\n\n\n\n\n\n**JSON response body fields:**\n\n\n","example_request_body":{"jsonString":"{}"},"success_response_body":{"jsonString":"{}"},"error_response_bodies":["OBP-20001: User not logged in. Authentication is required!","OBP-50000: Unknown Error."],"tags":["File Payments","Mocked-Data"],"typed_request_body":{"type":"object","properties":{"jsonString":{"type":"string"}}},"typed_success_response_body":{"type":"object","properties":{"jsonString":{"type":"string"}}},"is_featured":false,"special_instructions":"","specified_url":"/open-banking/v3.1/file-payment-consents/CONSENTID/file","connector_methods":[]},{"operation_id":"UKv3.1-createAccountAccessConsents","implemented_by":{"version":"UKv3.1","function":"createAccountAccessConsents"},"request_verb":"POST","request_url":"/open-banking/v3.1/account-access-consents","summary":"Create Account Access Consents","description":"Create Account Access Consents
\nAuthentication is Mandatory
\nJSON request body fields:
\nJSON response body fields:
\n","description_markdown":"Create Account Access Consents\n\n\nAuthentication is Mandatory\n\n\n**JSON request body fields:**\n\n\n\n\n\n**JSON response body fields:**\n\n\n","example_request_body":{"Data":{"Permissions":["ReadAccountsBasic"],"ExpirationDateTime":"2020-10-20T08:40:47.285Z","TransactionFromDateTime":"2020-10-20T08:40:47.285Z","TransactionToDateTime":"2020-10-20T08:40:47.285Z"},"Risk":""},"success_response_body":{"Data":{"ConsentId":"string","CreationDateTime":"2020-10-20T08:40:47.375Z","Status":"Authorised","StatusUpdateDateTime":"2020-10-20T08:40:47.375Z","Permissions":["ReadAccountsBasic"],"ExpirationDateTime":"2020-10-20T08:40:47.375Z","TransactionFromDateTime":"2020-10-20T08:40:47.375Z","TransactionToDateTime":"2020-10-20T08:40:47.375Z"},"Risk":{},"Links":{"Self":"https://apisandbox.openbankproject.com/open-banking/v3.1/account-access-consents/CONSENT_ID"},"Meta":{"TotalPages":0,"FirstAvailableDateTime":"2020-10-20T08:40:47.375Z","LastAvailableDateTime":"2020-10-20T08:40:47.375Z"}},"error_response_bodies":["OBP-20001: User not logged in. Authentication is required!","OBP-50000: Unknown Error."],"tags":["Account Access"],"typed_request_body":{"type":"object","properties":{"type":"object","properties":{"Data":{"type":"object","properties":{"Permissions":{"type":"array","items":{"type":"object","properties":{"s":{"type":"string"}}}},"ExpirationDateTime":{"type":"string"},"TransactionFromDateTime":{"type":"string"},"TransactionToDateTime":{"type":"string"}}},"Risk":{"type":"string"}}}},"typed_success_response_body":{"type":"object","properties":{"type":"object","properties":{"Data":{"type":"object","properties":{"ConsentId":{"type":"string"},"Status":{"type":"string"},"CreationDateTime":{"type":"string"},"TransactionToDateTime":{"type":"string"},"StatusUpdateDateTime":{"type":"string"},"Permissions":{"type":"array","items":{"type":"object","properties":{"s":{"type":"string"}}}},"TransactionFromDateTime":{"type":"string"},"ExpirationDateTime":{"type":"string"}}},"Risk":{"type":"object","properties":{}},"Links":{"type":"object","properties":{"Self":{"type":"string"}}},"Meta":{"type":"object","properties":{"TotalPages":{"type":"integer"},"FirstAvailableDateTime":{"type":"string"},"LastAvailableDateTime":{"type":"string"}}}}}},"is_featured":false,"special_instructions":"","specified_url":"/open-banking/v3.1/account-access-consents","connector_methods":[]},{"operation_id":"UKv3.1-createInternationalStandingOrders","implemented_by":{"version":"UKv3.1","function":"createInternationalStandingOrders"},"request_verb":"POST","request_url":"/open-banking/v3.1/international-standing-orders","summary":"Create International Standing Orders","description":"NOTE: This endpoint currently only returns example data.
\nAuthentication is Mandatory
\nJSON request body fields:
\nJSON response body fields:
\n","description_markdown":"**NOTE: This endpoint currently only returns example data.**\n\n \n\n\nAuthentication is Mandatory\n\n\n**JSON request body fields:**\n\n\n\n\n\n**JSON response body fields:**\n\n\n","example_request_body":{"jsonString":"{}"},"success_response_body":{"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}}},"error_response_bodies":["OBP-20001: User not logged in. Authentication is required!","OBP-50000: Unknown Error."],"tags":["International Standing Orders","Mocked-Data"],"typed_request_body":{"type":"object","properties":{"jsonString":{"type":"string"}}},"typed_success_response_body":{"type":"object","properties":{"type":"object","properties":{"Meta":{"type":"object","properties":{"FirstAvailableDateTime":{"type":"object","properties":{}},"TotalPages":{"type":"integer"}}},"Links":{"type":"object","properties":{"First":{"type":"string"},"Self":{"type":"string"},"Next":{"type":"string"},"Last":{"type":"string"},"Prev":{"type":"string"}}},"Data":{"type":"object","properties":{"InternationalStandingOrderId":{"type":"string"},"StatusUpdateDateTime":{"type":"string"},"CreationDateTime":{"type":"string"},"Initiation":{"type":"object","properties":{"CurrencyOfTransfer":{"type":"string"},"InstructedAmount":{"type":"object","properties":{"Currency":{"type":"string"}}},"CreditorAgent":{"type":"object","properties":{"PostalAddress":{"type":"object","properties":{"CountrySubDivision":{"type":"string"},"Country":{"type":"string"},"Department":{"type":"string"},"StreetName":{"type":"string"},"AddressType":{"type":"object","properties":{}},"BuildingNumber":{"type":"string"},"TownName":{"type":"string"},"SubDepartment":{"type":"string"},"PostCode":{"type":"string"},"AddressLine":{"type":"array","items":{"type":"object","properties":{"s":{"type":"string"}}}}}},"SchemeName":{"type":"array","items":{"type":"object","properties":{"s":{"type":"string"}}}},"Identification":{"type":"string"},"Name":{"type":"string"}}},"CreditorAccount":{"type":"object","properties":{"SecondaryIdentification":{"type":"string"},"SchemeName":{"type":"array","items":{"type":"object","properties":{"s":{"type":"string"}}}},"Identification":{"type":"string"},"Name":{"type":"string"}}},"NumberOfPayments":{"type":"string"},"FinalPaymentDateTime":{"type":"string"},"DebtorAccount":{"type":"object","properties":{"SecondaryIdentification":{"type":"string"},"SchemeName":{"type":"array","items":{"type":"object","properties":{"s":{"type":"string"}}}},"Identification":{"type":"string"},"Name":{"type":"string"}}},"ChargeBearer":{"type":"object","properties":{}},"FirstPaymentDateTime":{"type":"string"},"SupplementaryData":{"type":"object","properties":{}},"Purpose":{"type":"object","properties":{}},"Frequency":{"type":"string"},"Creditor":{"type":"object","properties":{"PostalAddress":{"type":"object","properties":{"CountrySubDivision":{"type":"string"},"Country":{"type":"string"},"Department":{"type":"string"},"StreetName":{"type":"string"},"AddressType":{"type":"object","properties":{}},"BuildingNumber":{"type":"string"},"TownName":{"type":"string"},"SubDepartment":{"type":"string"},"PostCode":{"type":"string"},"AddressLine":{"type":"array","items":{"type":"object","properties":{"s":{"type":"string"}}}}}},"Name":{"type":"string"}}},"Reference":{"type":"string"}}},"ConsentId":{"type":"string"},"Status":{"type":"object","properties":{}},"Charges":{"type":"array","items":{"type":"object","properties":{"Type":{"type":"array","items":{"type":"object","properties":{"s":{"type":"string"}}}},"Amount":{"type":"object","properties":{"Amount":{"type":"object","properties":{}},"Currency":{"type":"string"}}},"ChargeBearer":{"type":"object","properties":{}}}}},"MultiAuthorisation":{"type":"object","properties":{"ExpirationDateTime":{"type":"string"},"NumberRequired":{"type":"integer"},"Status":{"type":"object","properties":{}},"NumberReceived":{"type":"integer"},"LastUpdateDateTime":{"type":"string"}}}}}}}},"is_featured":false,"special_instructions":"","specified_url":"/open-banking/v3.1/international-standing-orders","connector_methods":[]},{"operation_id":"UKv3.1-getFilePaymentConsentsConsentId","implemented_by":{"version":"UKv3.1","function":"getFilePaymentConsentsConsentId"},"request_verb":"GET","request_url":"/open-banking/v3.1/file-payment-consents/CONSENTID","summary":"Get File Payment Consents","description":"NOTE: This endpoint currently only returns example data.
\nAuthentication is Mandatory
\nURL Parameters:
\nCONSENTID: CONSENTID
\nJSON response body fields:
\n","description_markdown":"**NOTE: This endpoint currently only returns example data.**\n\n \n\n\nAuthentication is Mandatory\n\n\n**URL Parameters:**\n\n[CONSENTID](/glossary#): CONSENTID\n\n\n\n\n\n**JSON response body fields:**\n\n\n","example_request_body":{"jsonString":"{}"},"success_response_body":{"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"}}},"error_response_bodies":["OBP-20001: User not logged in. Authentication is required!","OBP-50000: Unknown Error."],"tags":["File Payments","Mocked-Data"],"typed_request_body":{"type":"object","properties":{"jsonString":{"type":"string"}}},"typed_success_response_body":{"type":"object","properties":{"type":"object","properties":{"Meta":{"type":"object","properties":{"FirstAvailableDateTime":{"type":"object","properties":{}},"TotalPages":{"type":"integer"}}},"Links":{"type":"object","properties":{"First":{"type":"string"},"Self":{"type":"string"},"Next":{"type":"string"},"Last":{"type":"string"},"Prev":{"type":"string"}}},"Data":{"type":"object","properties":{"StatusUpdateDateTime":{"type":"string"},"Initiation":{"type":"object","properties":{"RequestedExecutionDateTime":{"type":"string"},"DebtorAccount":{"type":"object","properties":{"SecondaryIdentification":{"type":"string"},"SchemeName":{"type":"array","items":{"type":"object","properties":{"s":{"type":"string"}}}},"Identification":{"type":"string"},"Name":{"type":"string"}}},"NumberOfTransactions":{"type":"string"},"ControlSum":{"type":"number"},"LocalInstrument":{"type":"array","items":{"type":"object","properties":{"s":{"type":"string"}}}},"SupplementaryData":{"type":"object","properties":{}},"RemittanceInformation":{"type":"object","properties":{"Unstructured":{"type":"string"},"Reference":{"type":"string"}}},"FileHash":{"type":"string"},"FileReference":{"type":"string"},"FileType":{"type":"array","items":{"type":"object","properties":{"s":{"type":"string"}}}}}},"CreationDateTime":{"type":"string"},"ConsentId":{"type":"string"},"Status":{"type":"object","properties":{}},"Charges":{"type":"array","items":{"type":"object","properties":{"Type":{"type":"array","items":{"type":"object","properties":{"s":{"type":"string"}}}},"Amount":{"type":"object","properties":{"Amount":{"type":"object","properties":{}},"Currency":{"type":"string"}}},"ChargeBearer":{"type":"object","properties":{}}}}},"Authorisation":{"type":"object","properties":{"CompletionDateTime":{"type":"string"},"AuthorisationType":{"type":"object","properties":{}}}},"CutOffDateTime":{"type":"string"}}}}}},"is_featured":false,"special_instructions":"","specified_url":"/open-banking/v3.1/file-payment-consents/CONSENTID","connector_methods":[]},{"operation_id":"UKv3.1-getAccounts","implemented_by":{"version":"UKv3.1","function":"getAccounts"},"request_verb":"GET","request_url":"/open-banking/v3.1/accounts","summary":"Get Accounts","description":"Authentication is Mandatory
\nJSON response body fields:
\n","description_markdown":"Authentication is Mandatory\n\n\n**JSON response body fields:**\n\n\n","example_request_body":{"jsonString":"{}"},"success_response_body":{"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"}]}},"error_response_bodies":["OBP-20001: User not logged in. Authentication is required!","OBP-50000: Unknown Error."],"tags":["Accounts"],"typed_request_body":{"type":"object","properties":{"jsonString":{"type":"string"}}},"typed_success_response_body":{"type":"object","properties":{"type":"object","properties":{"Meta":{"type":"object","properties":{"FirstAvailableDateTime":{"type":"object","properties":{}},"TotalPages":{"type":"integer"}}},"Links":{"type":"object","properties":{"First":{"type":"string"},"Self":{"type":"string"},"Next":{"type":"string"},"Last":{"type":"string"},"Prev":{"type":"string"}}},"Data":{"type":"object","properties":{"Account":{"type":"array","items":{"type":"object","properties":{"AccountType":{"type":"string"},"Nickname":{"type":"string"},"AccountSubType":{"type":"string"},"Servicer":{"type":"object","properties":{"SchemeName":{"type":"array","items":{"type":"object","properties":{"s":{"type":"string"}}}},"Identification":{"type":"string"}}},"Currency":{"type":"string"},"Account":{"type":"array","items":{"type":"object","properties":{"SecondaryIdentification":{"type":"string"},"SchemeName":{"type":"array","items":{"type":"object","properties":{"s":{"type":"string"}}}},"Identification":{"type":"string"},"Name":{"type":"string"}}}},"Description":{"type":"string"},"AccountId":{"type":"string"}}}}}}}}},"is_featured":false,"special_instructions":"","specified_url":"/open-banking/v3.1/accounts","connector_methods":[]},{"operation_id":"UKv3.1-getInternationalScheduledPaymentConsentsConsentIdFundsConfirmation","implemented_by":{"version":"UKv3.1","function":"getInternationalScheduledPaymentConsentsConsentIdFundsConfirmation"},"request_verb":"GET","request_url":"/open-banking/v3.1/international-scheduled-payment-consents/CONSENTID/funds-confirmation","summary":"Get International Scheduled Payment Consents Funds Confirmation","description":"NOTE: This endpoint currently only returns example data.
\nAuthentication is Mandatory
\nURL Parameters:
\nCONSENTID: CONSENTID
\nJSON response body fields:
\n","description_markdown":"**NOTE: This endpoint currently only returns example data.**\n\n \n\n\nAuthentication is Mandatory\n\n\n**URL Parameters:**\n\n[CONSENTID](/glossary#): CONSENTID\n\n\n\n\n\n**JSON response body fields:**\n\n\n","example_request_body":{"jsonString":"{}"},"success_response_body":{"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}}},"error_response_bodies":["OBP-20001: User not logged in. Authentication is required!","OBP-50000: Unknown Error."],"tags":["International Scheduled Payments","Mocked-Data"],"typed_request_body":{"type":"object","properties":{"jsonString":{"type":"string"}}},"typed_success_response_body":{"type":"object","properties":{"type":"object","properties":{"Meta":{"type":"object","properties":{"FirstAvailableDateTime":{"type":"object","properties":{}},"TotalPages":{"type":"integer"}}},"Links":{"type":"object","properties":{"First":{"type":"string"},"Self":{"type":"string"},"Next":{"type":"string"},"Last":{"type":"string"},"Prev":{"type":"string"}}},"Data":{"type":"object","properties":{"SupplementaryData":{"type":"object","properties":{}},"FundsAvailableResult":{"type":"object","properties":{"FundsAvailableDateTime":{"type":"string"},"FundsAvailable":{"type":"boolean"}}}}}}}},"is_featured":false,"special_instructions":"","specified_url":"/open-banking/v3.1/international-scheduled-payment-consents/CONSENTID/funds-confirmation","connector_methods":[]},{"operation_id":"UKv3.1-createInternationalStandingOrderConsents","implemented_by":{"version":"UKv3.1","function":"createInternationalStandingOrderConsents"},"request_verb":"POST","request_url":"/open-banking/v3.1/international-standing-order-consents","summary":"Create International Standing Order Consents","description":"NOTE: This endpoint currently only returns example data.
\nAuthentication is Mandatory
\nJSON request body fields:
\nJSON response body fields:
\n","description_markdown":"**NOTE: This endpoint currently only returns example data.**\n\n \n\n\nAuthentication is Mandatory\n\n\n**JSON request body fields:**\n\n\n\n\n\n**JSON response body fields:**\n\n\n","example_request_body":{"jsonString":"{}"},"success_response_body":{"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"}}}},"error_response_bodies":["OBP-20001: User not logged in. Authentication is required!","OBP-50000: Unknown Error."],"tags":["International Standing Orders","Mocked-Data"],"typed_request_body":{"type":"object","properties":{"jsonString":{"type":"string"}}},"typed_success_response_body":{"type":"object","properties":{"type":"object","properties":{"Meta":{"type":"object","properties":{"FirstAvailableDateTime":{"type":"object","properties":{}},"TotalPages":{"type":"integer"}}},"Risk":{"type":"object","properties":{"PaymentContextCode":{"type":"object","properties":{}},"DeliveryAddress":{"type":"object","properties":{"CountrySubDivision":{"type":"array","items":{"type":"object","properties":{"s":{"type":"string"}}}},"Country":{"type":"string"},"StreetName":{"type":"string"},"BuildingNumber":{"type":"string"},"AddressLine":{"type":"array","items":{"type":"object","properties":{"s":{"type":"string"}}}},"TownName":{"type":"string"},"PostCode":{"type":"string"}}},"MerchantCategoryCode":{"type":"string"},"MerchantCustomerIdentification":{"type":"string"}}},"Links":{"type":"object","properties":{"First":{"type":"string"},"Self":{"type":"string"},"Next":{"type":"string"},"Last":{"type":"string"},"Prev":{"type":"string"}}},"Data":{"type":"object","properties":{"StatusUpdateDateTime":{"type":"string"},"CreationDateTime":{"type":"string"},"Permission":{"type":"object","properties":{}},"Initiation":{"type":"object","properties":{"CurrencyOfTransfer":{"type":"string"},"InstructedAmount":{"type":"object","properties":{"Currency":{"type":"string"}}},"CreditorAgent":{"type":"object","properties":{"PostalAddress":{"type":"object","properties":{"CountrySubDivision":{"type":"string"},"Country":{"type":"string"},"Department":{"type":"string"},"StreetName":{"type":"string"},"AddressType":{"type":"object","properties":{}},"BuildingNumber":{"type":"string"},"TownName":{"type":"string"},"SubDepartment":{"type":"string"},"PostCode":{"type":"string"},"AddressLine":{"type":"array","items":{"type":"object","properties":{"s":{"type":"string"}}}}}},"SchemeName":{"type":"array","items":{"type":"object","properties":{"s":{"type":"string"}}}},"Identification":{"type":"string"},"Name":{"type":"string"}}},"CreditorAccount":{"type":"object","properties":{"SecondaryIdentification":{"type":"string"},"SchemeName":{"type":"array","items":{"type":"object","properties":{"s":{"type":"string"}}}},"Identification":{"type":"string"},"Name":{"type":"string"}}},"NumberOfPayments":{"type":"string"},"FinalPaymentDateTime":{"type":"string"},"DebtorAccount":{"type":"object","properties":{"SecondaryIdentification":{"type":"string"},"SchemeName":{"type":"array","items":{"type":"object","properties":{"s":{"type":"string"}}}},"Identification":{"type":"string"},"Name":{"type":"string"}}},"ChargeBearer":{"type":"object","properties":{}},"FirstPaymentDateTime":{"type":"string"},"SupplementaryData":{"type":"object","properties":{}},"Purpose":{"type":"object","properties":{}},"Frequency":{"type":"string"},"Creditor":{"type":"object","properties":{"PostalAddress":{"type":"object","properties":{"CountrySubDivision":{"type":"string"},"Country":{"type":"string"},"Department":{"type":"string"},"StreetName":{"type":"string"},"AddressType":{"type":"object","properties":{}},"BuildingNumber":{"type":"string"},"TownName":{"type":"string"},"SubDepartment":{"type":"string"},"PostCode":{"type":"string"},"AddressLine":{"type":"array","items":{"type":"object","properties":{"s":{"type":"string"}}}}}},"Name":{"type":"string"}}},"Reference":{"type":"string"}}},"ConsentId":{"type":"string"},"Status":{"type":"object","properties":{}},"Charges":{"type":"array","items":{"type":"object","properties":{"Type":{"type":"array","items":{"type":"object","properties":{"s":{"type":"string"}}}},"Amount":{"type":"object","properties":{"Amount":{"type":"object","properties":{}},"Currency":{"type":"string"}}},"ChargeBearer":{"type":"object","properties":{}}}}},"Authorisation":{"type":"object","properties":{"CompletionDateTime":{"type":"string"},"AuthorisationType":{"type":"object","properties":{}}}},"CutOffDateTime":{"type":"string"}}}}}},"is_featured":false,"special_instructions":"","specified_url":"/open-banking/v3.1/international-standing-order-consents","connector_methods":[]},{"operation_id":"UKv3.1-getFilePaymentsFilePaymentIdReportFile","implemented_by":{"version":"UKv3.1","function":"getFilePaymentsFilePaymentIdReportFile"},"request_verb":"GET","request_url":"/open-banking/v3.1/file-payments/FILEPAYMENTID/report-file","summary":"Get File Payments","description":"NOTE: This endpoint currently only returns example data.
\nAuthentication is Mandatory
\nURL Parameters:
\nFILEPAYMENTID: FILEPAYMENTID
\nJSON response body fields:
\n","description_markdown":"**NOTE: This endpoint currently only returns example data.**\n\n \n\n\nAuthentication is Mandatory\n\n\n**URL Parameters:**\n\n[FILEPAYMENTID](/glossary#): FILEPAYMENTID\n\n\n\n\n\n**JSON response body fields:**\n\n\n","example_request_body":{"jsonString":"{}"},"success_response_body":{"jsonString":"{}"},"error_response_bodies":["OBP-20001: User not logged in. Authentication is required!","OBP-50000: Unknown Error."],"tags":["File Payments","Mocked-Data"],"typed_request_body":{"type":"object","properties":{"jsonString":{"type":"string"}}},"typed_success_response_body":{"type":"object","properties":{"jsonString":{"type":"string"}}},"is_featured":false,"special_instructions":"","specified_url":"/open-banking/v3.1/file-payments/FILEPAYMENTID/report-file","connector_methods":[]}]}