API Explorer

								
									{
  "direct_debit_id":"aa0533bd-eb22-4bff-af75-d45240361b05",
  "bank_id":"gh.29.uk",
  "account_id":"8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0",
  "customer_id":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh",
  "user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1",
  "counterparty_id":"9fg8a7e4-6d02-40e3-a129-0b2bf89de8uh",
  "date_signed":"2024-11-25T22:10:24Z",
  "date_starts":"2024-11-25T22:10:24Z",
  "date_expires":"2024-11-25T22:10:24Z",
  "date_cancelled":"2024-11-25T22:10:24Z",
  "active":true
}

Request Headers:

Response Headers:

Required Roles:

Validations:

Required JSON Validation: No
Allowed Authentication Types: Not set

Possible Errors:

OBP-20001: User not logged in. Authentication is required!
OBP-30001: Bank not found. Please specify a valid value for BANK_ID.
OBP-30018: Bank Account not found. Please specify valid values for BANK_ID and ACCOUNT_ID.
OBP-30022: The current view does not have the permission:
OBP-20017: Current user does not have access to the view. Please specify a valid value for VIEW_ID.
OBP-10001: Incorrect json format.
OBP-30046: Customer not found. Please specify a valid value for CUSTOMER_ID.
OBP-20057: User not found by userId.
OBP-30017: Counterparty not found. Please specify a valid value for COUNTERPARTY_ID.
OBP-50000: Unknown Error.

Connector Methods:

Version: OBPv4.0.0, function_name: by createDirectDebit, operation_id: OBPv4.0.0-createDirectDebit Tags: Direct-Debit, Account,

Create Direct Debit (management)

Create direct debit for an account.

Authentication is Mandatory

URL Parameters:

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

BANK_ID: gh.29.uk

JSON request body fields:

counterparty_id: 9fg8a7e4-6d02-40e3-a129-0b2bf89de8uh

customer_id: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh

date_starts: 2020-01-27

user_id: 9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1

date_expires: 2021-01-27

date_signed: 2020-01-27

JSON response body fields:

account_id: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0

active: false

bank_id: gh.29.uk

counterparty_id: 9fg8a7e4-6d02-40e3-a129-0b2bf89de8uh

customer_id: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh

date_cancelled: 2020-01-27

date_expires: 2021-01-27

date_signed: 2020-01-27

date_starts: 2020-01-27

direct_debit_id:

user_id: 9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1

Typical Successful Response:

								
									{
  "direct_debit_id":"aa0533bd-eb22-4bff-af75-d45240361b05",
  "bank_id":"gh.29.uk",
  "account_id":"8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0",
  "customer_id":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh",
  "user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1",
  "counterparty_id":"9fg8a7e4-6d02-40e3-a129-0b2bf89de8uh",
  "date_signed":"2024-11-25T22:10:24Z",
  "date_starts":"2024-11-25T22:10:24Z",
  "date_expires":"2024-11-25T22:10:24Z",
  "date_cancelled":"2024-11-25T22:10:24Z",
  "active":true
}

Request Headers:

Response Headers:

Required Roles:

CanCreateDirectDebitAtOneBank - Please login to request this Role

Validations:

Required JSON Validation: No
Allowed Authentication Types: Not set

Possible Errors:

OBP-20001: User not logged in. Authentication is required!
OBP-30001: Bank not found. Please specify a valid value for BANK_ID.
OBP-30018: Bank Account not found. Please specify valid values for BANK_ID and ACCOUNT_ID.
OBP-30022: The current view does not have the permission:
OBP-10001: Incorrect json format.
OBP-30046: Customer not found. Please specify a valid value for CUSTOMER_ID.
OBP-20057: User not found by userId.
OBP-30017: Counterparty not found. Please specify a valid value for COUNTERPARTY_ID.
OBP-50000: Unknown Error.
OBP-20006: User is missing one or more roles:

Connector Methods:

Version: OBPv4.0.0, function_name: by createDirectDebitManagement, operation_id: OBPv4.0.0-createDirectDebitManagement Tags: Direct-Debit, Account,

Get documentation about the selected endpoints as:

Resource Docs JSON
Swagger 2 JSON
中文版本
Partial Functions

Note: You can list just the APIs that are implemented in a certain version by appending &native=true to the index URL.
API_Explorer Commit

Featured APIs

API Explorer

v5.1.0 (598 APIs)

Create Direct Debit

Create Direct Debit (management)