b1 (5 APIs)
API Host: https://obp-apisandbox.xsquare.sa
Bank
Accounts
Views
Counterparties
Transactions
Create Template
Typical Successful Response:
{
"id":"11231231312",
"author":"Chinua Achebe",
"pages":209,
"points":1.3
}
Validations:
- Required JSON Validation: No
- Allowed Authentication Types: Not set
Possible Errors:
- OBP-50000: Unknown Error.
Connector Methods:
Version: API-BUILDERb1,
function_name: by createTemplate, operation_id: API-BUILDERb1-createTemplate
Tags: API-Builder,
Delete Template
Delete One Template
Authentication is Mandatory
URL Parameters:
TEMPLATE_ID: TEMPLATE_ID
JSON response body fields:
Typical Successful Response:
{
"jsonString":"true"
}
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: API-BUILDERb1,
function_name: by deleteTemplate, operation_id: API-BUILDERb1-deleteTemplate
Tags: API-Builder,
Get Template
Return One Template By Id
Authentication is Mandatory
URL Parameters:
TEMPLATE_ID: TEMPLATE_ID
JSON response body fields:
author: author
id: d8839721-ad8f-45dd-9f78-2080414b93f9
pages: pages
points: points
Typical Successful Response:
{
"id":"11231231312",
"author":"Chinua Achebe",
"pages":209,
"points":1.3
}
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: API-BUILDERb1,
function_name: by getTemplate, operation_id: API-BUILDERb1-getTemplate
Tags: API-Builder,
Get Templates
Typical Successful Response:
[{
"id":"11231231312",
"author":"Chinua Achebe",
"pages":209,
"points":1.3
}]
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: API-BUILDERb1,
function_name: by getTemplates, operation_id: API-BUILDERb1-getTemplates
Tags: API-Builder,