API Explorer

MXOFv1.0.0 (57 APIs)

Bank
Accounts
Views
Counterparties
Transactions

Get Accounts Direct Debits by AccountId

NOTE: This endpoint currently only returns example data.

Authentication is Mandatory

URL Parameters:

  • ACCOUNT_ID: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0

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", "First":"http://example.com/aeiou", "Self":"http://example.com/aeiou" }, "Data":{ "DirectDebit":[{ "SupplementaryData":{ }, "PreviousPaymentDateTime":{ }, "AccountId":{ }, "MandateIdentification":{ }, "DirectDebitStatusCode":{ }, "Frequency":"Frequency", "DirectDebitId":{ }, "PreviousPaymentAmount":{ "Amount":{ }, "Currency":{ } }, "Name":{ } },{ "SupplementaryData":{ }, "PreviousPaymentDateTime":{ }, "AccountId":{ }, "MandateIdentification":{ }, "DirectDebitStatusCode":{ }, "Frequency":"Frequency", "DirectDebitId":{ }, "PreviousPaymentAmount":{ "Amount":{ }, "Currency":{ } }, "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: BAHRAIN-OBFv1.0.0, function_name: by accountsAccountIdDirectDebitsGet, operation_id: BAHRAIN-OBFv1.0.0-accountsAccountIdDirectDebitsGet Tags: Direct Debits, Mocked-Data,

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", "First":"http://example.com/aeiou", "Self":"http://example.com/aeiou" }, "Data":{ "DirectDebit":[{ "SupplementaryData":{ }, "PreviousPaymentDateTime":{ }, "AccountId":{ }, "MandateIdentification":{ }, "DirectDebitStatusCode":{ }, "Frequency":"Frequency", "DirectDebitId":{ }, "PreviousPaymentAmount":{ "Amount":{ }, "Currency":{ } }, "Name":{ } },{ "SupplementaryData":{ }, "PreviousPaymentDateTime":{ }, "AccountId":{ }, "MandateIdentification":{ }, "DirectDebitStatusCode":{ }, "Frequency":"Frequency", "DirectDebitId":{ }, "PreviousPaymentAmount":{ "Amount":{ }, "Currency":{ } }, "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: BAHRAIN-OBFv1.0.0, function_name: by directDebitsGet, operation_id: BAHRAIN-OBFv1.0.0-directDebitsGet Tags: Direct Debits, Mocked-Data,