Retrieve recurring payment instructions established by a customer for regular transfers from a bank account
Standing Orders API provides access to recurring payment arrangements configured by a customer. Standing order information can be used to understand regular financial commitments, forecast future cash flows, analyze payment behavior, and support affordability assessments.
Standing order is a recurring payment instruction set up by a customer to automatically transfer a fixed amount to a beneficiary at regular intervals.
Standing Orders API enables you to:
Access to this API requires a valid consent that has been authorized by the customer.
consentId must refer to an active and authorized consentAuthorization: Bearer headerThis API can only be accessed using a valid and active consent. Before accessing this service, ensure that a consent has been created and authorized with the required useCaseType and permissions.
The consent must include the appropriate useCaseType and permission values that allow access to the corresponding financial data services.
If you do not already have a consent with the required configuration, you must first create one using the Create Consent API and ensure that it is successfully authorized. Once the consent becomes active, the generated consentId can be used to access this API service.
Scope | useCaseType | Permissions |
|---|---|---|
To access all AIS API services:
|
|
|
This service requires consentId and accountId to return all the standing orders of an account associated with that consent.
Endpoint URL | Method |
|---|---|
| GET |
The following headers must be included when calling the Standing Orders API.
Header parameter | Description |
|---|---|
| Access token used to authenticate the API request |
curl --request GET \
--url 'https://obsandbox.onesingleview.com/v2/api/observice/standingOrdersById?dateTimeStamp=2023-06-14T17%3A51%3A03&requestID=db35902b-806a-4141-b1e2-e93f60c82f62&merchantId=APIU-300356&bankCode=SVMOB1&consentId=urn%3ASABBSARI%3Akac-cd3b9a37-eb97-4a70-b268-38af9f2950b1&accountId=100004000000000000000001' \
--header 'accept: application/json' \
--header 'authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJkYXRhIjoiTDNyMmpxV29JS2I4MTNodDBNYVR4WGpBZU5qU1FWaTFad3B5QnlkOVpHelZXR2ZwUmFQNUZ1TTJ6NmIzbi9WVE1aK1FucERJMEZXWWN6VGJsOEc5cXhaY0VLUTZZWEFsYmZnejdkdlFpTTRXeVBNalQ2WG1NUDh5YXI4RDVWZTUwUGhYbDcwYkYxRENJeEpDaU5TVkhBKytXYnRUZkhDblVBPT0iLCJpYXQiOjE3ODE1OTAwMDksImV4cCI6MTc4MTU5MzYwOX0.MO69uVzXyHqN2UBxvxCn3sBZcOpNWYP7bsQPe-qdGsQ'Request parameters
Parameters | Requirement | Description | Data type | Data validation |
|---|---|---|---|---|
dateTimeStamp | Mandatory | Indicates the date and time when the request is created | Date | ISO 8601 format |
requestID | Mandatory | Unique identifier for the request used for tracking and traceability | Alphanumeric | UUID format |
merchantID | Mandatory | Identifier assigned to the merchant or client application initiating the request | String |
|
bankCode | Mandatory | Unique bank identifier code | Enum |
|
consentId | Mandatory | Unique identifier of the consent | String |
|
accountId | Mandatory | Unique identifier of bank account associated with the consent | String |
|
{
"success": true,
"payload": [
{
"code": "SVMOB1",
"data": {
"accountId": "100004000000000000000001",
"standingOrder": [
{
"standingOrderId": "001010000000000000000113",
"frequency": "WkInMnthDay:02:05",
"creditorReference": "GSG 10 BANK ROAD",
"firstPaymentDateTime": "2014-05-15T00:00:00.000Z",
"nextPaymentDateTime": "2018-01-15T00:00:00.000Z",
"lastPaymentDateTime": "2020-01-10T00:00:00.000Z",
"finalPaymentDateTime": "2020-01-10T00:00:00.000Z",
"numberOfPayments": "3",
"standingOrderStatusCode": "KSAOB.Active",
"firstPaymentAmount": {
"amount": "84.09",
"currency": "SAR"
},
"finalPaymentAmount": {
"amount": "2.50",
"currency": "SAR"
},
"supplementaryData": {
"supplementary": "data"
},
"nextPaymentAmount": {
"amount": "84.09",
"currency": "SAR"
},
"purpose": "Bills and expenses",
"lastPaymentAmount": {
"amount": "10.20",
"currency": "SAR"
},
"standingOrderType": "KSAOB.LocalBankTransfer",
"creditorAgent": {
"identificationType": "KSAOB.BICFI",
"identification": "INDRUK00XXX"
},
"creditorAccount": [
{
"identificationType": "KSAOB.IBAN",
"identification": "GB04INDR90872921098674"
}
]
}
],
"currentMonthPaid": {
"amount": 0,
"currency": "SAR",
"count": 0
}
},
"links": {
"self": ""
},
"meta": {
"totalPages": 1
}
}
]
}Response parameters
Parameter | Description |
|---|---|
success | Process success status represented as |
payload | Payload tag carrying response information |
code | Unique bank code identification |
data | Tag carrying accounts and Standing Orders data included in the response |
accountId | Unique account identification |
standingOrder | Tag carrying account's Standing Orders' information |
standingOrderId | Unique Standing Order identification |
frequency | Frequency of the Standing Order |
creditorReference | Unique creditor reference details |
firstPaymentDateTime | Date and time of the first standing order payment |
nextPaymentDateTime | Date and time of the upcoming standing order payment |
lastPaymentDateTime | Date and time of the previous/recent standing order payment |
finalPaymentDateTime | Date and time of the final standing order payment |
numberOfPayments | Total number of payments from first to final payments |
standingOrderStatusCode | Unique status code of the Standing Order |
firstPaymentAmount | Tag carrying information on first payment for standing order |
amount | Transaction amount of the standing order |
currency | Default currency of the account in which the standing order amount is indicated |
finalPaymentAmount | Tag carrying information on final payment of standing order |
amount | Transaction amount for the standing order |
currency | Default currency of the account in which the standing order amount is indicated |
supplementaryData | Tag carrying information on supplementary data |
supplementary | Supplementary details |
nextPaymentAmount | Tag carrying information on the upcoming standing order payment |
amount | Transaction amount of the standing order |
currency | Default currency in which the standing order amount is indicated |
purpose | Details on the purpose of standing order |
lastPaymentAmount | Tag carrying information on the previous recent standing order payment |
amount | Transaction amount of the standing order |
currency | Default currency in which the standing order amount is indicated |
standingOrderType | Type of the standing order |
creditorAgent | Tag carrying information about creditor agent |
identificationType | Type of identification of the creditor |
identification | Unique creditor identification details |
creditorAccount | Tag carrying information about creditor account |
identificationType | Type of identification of the creditor account |
identification | Unique creditor account identification details |
links | Redirect link |
self | Own link/URL details |
meta | Meta tag |
totalPages | Information displayed in terms of pages |