Retrieve information about Standing Orders of a single or multiple accounts
This method fetches Standing Orders of a particular account specified through the Account ID and its corresponding Consent ID.
Endpoint URL | Method | Authentication requirements |
|---|---|---|
| POST |
|
{
"dateTimeStamp": "2024-12-31T10:40:00+02:00",
"requestID": "df797efb-b588-4234-8ae1-5cb748559830",
"merchantId": "APIS-300505",
"banks": [
{
"code": "SVMB01",
"consentId":"urn:SVMB01:kac-5a166b7d-8cdb-443a-a67a-80ad7a5b95b3",
"accountId": "100004000000000000000002"
}
]
}JSON Tag | Requirement | Description | Data type |
|---|---|---|---|
DateTimeStamp | Mandatory | Stamp denoting the date and time of the request | Date |
RequestID | Mandatory | Unique request identification | Alphanumeric |
merchantId | Mandatory | Unique merchant identification | Alphanumeric |
banks | Mandatory | Array of banks and consents | Object |
code | Mandatory | Unique bank identification code | Alphanumeric |
consentId | Mandatory | Unique consent identification | String |
accountId | Mandatory | Unique account identification as per the consent | String |
{
"success": true,
"payload": [
{
"code": "SVMB01",
"data": {
"accountId": "100004000000000000000002",
"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.BetweenMyAccounts",
"creditorAgent": {
"identificationType": "KSAOB.BICFI",
"identification": "1bAl9aFPqOoBs5"
},
"creditorAccount": [
{
"identificationType": "KSAOB.IBAN",
"identification": "GB04INDR90872921098674"
}
]
},
{
"standingOrderId": "001010000000000000000114",
"frequency": "IntrvlMnthDay:12:-05",
"creditorReference": "Tim 920111011",
"firstPaymentDateTime": "2015-02-17T00:00:00.000Z",
"nextPaymentDateTime": "2018-01-17T00:00:00.000Z",
"lastPaymentDateTime": "2012-01-10T00:00:00.000Z",
"finalPaymentDateTime": "2022-02-17T00:00:00.000Z",
"numberOfPayments": "3",
"standingOrderStatusCode": "KSAOB.Active",
"firstPaymentAmount": {
"amount": "92.10",
"currency": "SAR"
},
"finalPaymentAmount": {
"amount": "100.00",
"currency": "SAR"
},
"supplementaryData": {
"supplementary": "data"
},
"nextPaymentAmount": {
"amount": "92.10",
"currency": "SAR"
},
"purpose": "Bills and expenses",
"lastPaymentAmount": {
"amount": "10.20",
"currency": "SAR"
},
"standingOrderType": "KSAOB.LocalBankTransfer",
"creditorAgent": {
"identificationType": "KSAOB.BICFI",
"identification": "USq9mf7APqZ3c4"
},
"creditorAccount": [
{
"identificationType": "KSAOB.IBAN",
"identification": "GB14GHTT10010289048910"
}
]
},
{
"standingOrderId": "13174af1-caf3-4119-ac73-665cc6f8ec83",
"frequency": "EvryDay",
"creditorReference": "Allowance",
"firstPaymentDateTime": "2023-02-22T22:21:09.458Z",
"nextPaymentDateTime": "2023-02-22T22:21:09.458Z",
"lastPaymentDateTime": "2024-01-23T22:21:09.458Z",
"finalPaymentDateTime": "2024-01-23T22:21:09.458Z",
"numberOfPayments": "8",
"standingOrderStatusCode": "KSAOB.Active",
"firstPaymentAmount": {
"amount": "46.36",
"currency": "SAR"
},
"finalPaymentAmount": {
"amount": "7.35",
"currency": "SAR"
},
"supplementaryData": {
"supplementary": "data"
},
"nextPaymentAmount": {
"amount": "95.71",
"currency": "SAR"
},
"purpose": "Bills and expenses",
"lastPaymentAmount": {
"amount": "25.82",
"currency": "SAR"
},
"standingOrderType": "KSAOB.BetweenMyAccounts",
"creditorAgent": {
"identificationType": "KSAOB.BICFI",
"identification": "WwGWj7HFctGMWz"
},
"creditorAccount": [
{
"identificationType": "KSAOB.IBAN",
"identification": "273547544750"
}
]
}
]
},
"links": {
"self": "https://rs-ob-sb.SVMB01.com/open-banking/account-information/2022.11.01-final-errata2/accounts/100004000000000000000002/standing-orders"
},
"meta": {
"totalPages": 1
}
}
]
}JSON Tag | 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 |