API Explorer

v3.1 (67 APIs)

Bank
Accounts
Views
Counterparties
Transactions

Get Direct Debits

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":{ "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" }] } }
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 getDirectDebits, operation_id: UKv3.1-getDirectDebits Tags: Direct Debits, Mocked-Data,

Get Direct Debits

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":{ "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" }] } }
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 getAccountsAccountIdDirectDebits, operation_id: UKv3.1-getAccountsAccountIdDirectDebits Tags: Direct Debits, Mocked-Data,