{"swagger":"2.0","info":{"title":"Open Bank Project API","description":"An Open Source API for Banks. (c) TESOBE GmbH. 2011 - 2024. Licensed under the AGPL and commercial licences.","contact":{"name":"TESOBE GmbH. / Open Bank Project","url":"https://openbankproject.com","email":"contact@tesobe.com"},"version":"v4.0.0"},"host":"apisandbox.openbankproject.com","basePath":"/","schemes":["http","https"],"securityDefinitions":{"directLogin":{"type":"apiKey","description":"https://github.com/OpenBankProject/OBP-API/wiki/Direct-Login","in":"header","name":"Authorization"},"gatewayLogin":{"type":"apiKey","description":"https://github.com/OpenBankProject/OBP-API/wiki/Gateway-Login","in":"header","name":"Authorization"}},"security":[{"directLogin":[],"gatewayLogin":[]}],"paths":{"/obp/v4.0.0/banks/{BANK_ID}/accounts/{ACCOUNT_ID}/{VIEW_ID}/standing-order":{"post":{"tags":["Standing-Order","Account"],"summary":"Create Standing Order","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"
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
","operationId":"createStandingOrder","parameters":[{"in":"body","name":"body","description":"PostStandingOrderJsonV400 object that needs to be added.","required":true,"schema":{"$ref":"#/definitions/PostStandingOrderJsonV400"}},{"in":"path","name":"VIEW_ID","description":"The view id","required":true,"type":"string"},{"in":"path","name":"ACCOUNT_ID","description":"The account id","required":true,"type":"string"},{"in":"path","name":"BANK_ID","description":"The bank id","required":true,"type":"string"}],"responses":{"201":{"description":"Success","schema":{"$ref":"#/definitions/StandingOrderJsonV400"}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorUserNotLoggedIn"}}}}},"/obp/v4.0.0/management/banks/{BANK_ID}/accounts/{ACCOUNT_ID}/standing-order":{"post":{"tags":["Standing-Order","Account"],"summary":"Create Standing Order (management)","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"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
","operationId":"createStandingOrderManagement","parameters":[{"in":"body","name":"body","description":"PostStandingOrderJsonV400 object that needs to be added.","required":true,"schema":{"$ref":"#/definitions/PostStandingOrderJsonV400"}},{"in":"path","name":"ACCOUNT_ID","description":"The account id","required":true,"type":"string"},{"in":"path","name":"BANK_ID","description":"The bank id","required":true,"type":"string"}],"responses":{"201":{"description":"Success","schema":{"$ref":"#/definitions/StandingOrderJsonV400"}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorUserNotLoggedIn"}}}}}},"definitions":{"ErrorUserNotLoggedIn":{"properties":{"message":{"type":"string","example":"OBP-20001: User not logged in. Authentication is required!"}}},"AmountOfMoneyJsonV121":{"required":["currency","amount"],"properties":{"currency":{"type":"string","example":"EUR"},"amount":{"type":"string","example":"0"}}},"PostStandingOrderJsonV400":{"required":["date_starts","customer_id","user_id","amount","counterparty_id","when"],"properties":{"date_starts":{"type":"string","format":"date","example":"1100-01-01T00:00:00Z"},"customer_id":{"type":"string","example":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh"},"date_signed":{"type":"string","format":"date","example":"1100-01-01T00:00:00Z"},"user_id":{"type":"string","example":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1"},"amount":{"$ref":"#/definitions/AmountOfMoneyJsonV121"},"date_expires":{"type":"string","format":"date","example":"1100-01-01T00:00:00Z"},"counterparty_id":{"type":"string","example":"9fg8a7e4-6d02-40e3-a129-0b2bf89de8uh"},"when":{"$ref":"#/definitions/When"}}},"StandingOrderJsonV400":{"required":["date_starts","customer_id","standing_order_id","date_cancelled","date_signed","user_id","amount","bank_id","account_id","date_expires","counterparty_id","when","active"],"properties":{"date_starts":{"type":"string","format":"date","example":"2024-03-26T11:02:48Z"},"customer_id":{"type":"string","example":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh"},"standing_order_id":{"type":"string","example":"aa0533bd-eb22-4bff-af75-d45240361b05"},"date_cancelled":{"type":"string","format":"date","example":"2024-03-26T11:02:48Z"},"date_signed":{"type":"string","format":"date","example":"2024-03-26T11:02:48Z"},"user_id":{"type":"string","example":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1"},"amount":{"$ref":"#/definitions/AmountOfMoneyJsonV121"},"bank_id":{"type":"string","example":"gh.29.uk"},"account_id":{"type":"string","example":"8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0"},"date_expires":{"type":"string","format":"date","example":"2024-03-26T11:02:48Z"},"counterparty_id":{"type":"string","example":"9fg8a7e4-6d02-40e3-a129-0b2bf89de8uh"},"when":{"$ref":"#/definitions/When"},"active":{"type":"boolean","example":"true"}}},"When":{"required":["frequency","detail"],"properties":{"frequency":{"type":"string","example":"YEARLY"},"detail":{"type":"string","example":"LAST_DAY"}}}}}