API Explorer

v4.0.0 (542 APIs)

Bank
Accounts
Views
Counterparties
Transactions

Create Standing Order

Create standing order for an account.

when -> frequency = {‘YEARLY’,’MONTHLY, ‘WEEKLY’, ‘BI-WEEKLY’, DAILY’}
when -> detail = { ‘FIRST_MONDAY’, ‘FIRST_DAY’, ‘LAST_DAY’}}

Authentication is Mandatory

URL Parameters:

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

BANK_ID: gh.29.uk

VIEW_ID: owner

JSON request body fields:

amount: 10.12

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

currency: EUR

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

date_starts: 2020-01-27

detail:

frequency: DAILY

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

when: 2020-01-27

date_expires: 2021-01-27

date_signed: 2020-01-27

JSON response body fields:

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

active: true

amount: 10.12

bank_id: gh.29.uk

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

currency: EUR

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

detail:

frequency: DAILY

standing_order_id:

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

when: 2020-01-27

Typical Successful Response:

								
									
{ "standing_order_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", "amount":{ "currency":"EUR", "amount":"0" }, "when":{ "frequency":"WEEKLY", "detail":"FIRST_DAY" }, "date_signed":"2024-03-19T08:44:18Z", "date_starts":"2024-03-19T08:44:18Z", "date_expires":"2024-03-19T08:44:18Z", "date_cancelled":"2024-03-19T08:44:18Z", "active":true }
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-10002: Invalid Number. Could not convert value to a number.
  • OBP-10003: Invalid Currency Value. It should be three letters ISO Currency Code.
  • OBP-30046: Customer not found. Please specify a valid value for CUSTOMER_ID.
  • OBP-20057: User not found by userId.
  • OBP-20017: Current user does not have access to the view. Please specify a valid value for VIEW_ID.
  • OBP-50000: Unknown Error.
Connector Methods:
Version: OBPv4.0.0, function_name: by createStandingOrder, operation_id: OBPv4.0.0-createStandingOrder Tags: Standing-Order, Account,

Create Standing Order (management)

Create standing order for an account.

when -> frequency = {‘YEARLY’,’MONTHLY, ‘WEEKLY’, ‘BI-WEEKLY’, DAILY’}
when -> detail = { ‘FIRST_MONDAY’, ‘FIRST_DAY’, ‘LAST_DAY’}}

Authentication is Mandatory

URL Parameters:

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

BANK_ID: gh.29.uk

JSON request body fields:

amount: 10.12

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

currency: EUR

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

date_starts: 2020-01-27

detail:

frequency: DAILY

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

when: 2020-01-27

date_expires: 2021-01-27

date_signed: 2020-01-27

JSON response body fields:

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

active: true

amount: 10.12

bank_id: gh.29.uk

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

currency: EUR

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

detail:

frequency: DAILY

standing_order_id:

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

when: 2020-01-27

Typical Successful Response:

								
									
{ "standing_order_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", "amount":{ "currency":"EUR", "amount":"0" }, "when":{ "frequency":"WEEKLY", "detail":"FIRST_DAY" }, "date_signed":"2024-03-19T08:44:18Z", "date_starts":"2024-03-19T08:44:18Z", "date_expires":"2024-03-19T08:44:18Z", "date_cancelled":"2024-03-19T08:44:18Z", "active":true }
Required Roles:
  • CanCreateStandingOrderAtOneBank - 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-10002: Invalid Number. Could not convert value to a number.
  • OBP-10003: Invalid Currency Value. It should be three letters ISO Currency Code.
  • OBP-30046: Customer not found. Please specify a valid value for CUSTOMER_ID.
  • OBP-20057: User not found by userId.
  • OBP-50000: Unknown Error.
  • OBP-20006: User is missing one or more roles:
Connector Methods:
Version: OBPv4.0.0, function_name: by createStandingOrderManagement, operation_id: OBPv4.0.0-createStandingOrderManagement Tags: Standing-Order, Account,