API Explorer

v3.1 (67 APIs)

Bank
Accounts
Views
Counterparties
Transactions

Get Scheduled Payments

NOTE: This endpoint currently only returns example data.

Authentication is Mandatory

JSON response body fields:

Typical Successful Response:

								
									
{ "Meta":{ "FirstAvailableDateTime":{ }, "TotalPages":0 }, "Links":{ "Last":"http://example.com/aeiou", "Prev":"http://example.com/aeiou", "Next":"http://example.com/aeiou", "Self":"http://example.com/aeiou", "First":"http://example.com/aeiou" }, "Data":{ "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":{ } }] } }
Validations:
  • Required JSON Validation: No
  • Allowed Authentication Types: Not set
Possible Errors:
  • OBP-20001: User not logged in. Authentication is required!
  • OBP-50000: Unknown Error.
Connector Methods:
Version: UKv3.1, function_name: by getScheduledPayments, operation_id: UKv3.1-getScheduledPayments Tags: Scheduled Payments, Mocked-Data,

Get Scheduled Payments

NOTE: This endpoint currently only returns example data.

Authentication is Mandatory

URL Parameters:

JSON response body fields:

Typical Successful Response:

								
									
{ "Meta":{ "FirstAvailableDateTime":{ }, "TotalPages":0 }, "Links":{ "Last":"http://example.com/aeiou", "Prev":"http://example.com/aeiou", "Next":"http://example.com/aeiou", "Self":"http://example.com/aeiou", "First":"http://example.com/aeiou" }, "Data":{ "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":{ } }] } }
Validations:
  • Required JSON Validation: No
  • Allowed Authentication Types: Not set
Possible Errors:
  • OBP-20001: User not logged in. Authentication is required!
  • OBP-50000: Unknown Error.
Connector Methods:
Version: UKv3.1, function_name: by getAccountsAccountIdScheduledPayments, operation_id: UKv3.1-getAccountsAccountIdScheduledPayments Tags: Scheduled Payments, Mocked-Data,