Retrieve information about Scheduled Payments of a bank account
This method fetches the scheduled payments information of the specified account through the Account ID included in the provided 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",
"scheduledPayment": [
{
"scheduledPaymentId": "001011000000000000000107",
"scheduledPaymentDateTime": "2020-01-27T05:00:00+00:00",
"scheduledType": "KSAOB.Arrival",
"creditorReference": "reference",
"debtorReference": "debtorReference",
"instructedAmount": {
"amount": "10.00",
"currency": "SAR"
},
"creditorAgent": {
"identificationType": "KSAOB.BICFI",
"identification": "identification"
},
"creditorAccount": [
{
"identificationType": "KSAOB.IBAN",
"identification": "20304012345678"
}
]
},
{
"scheduledPaymentId": "001011000000000000000108",
"scheduledPaymentDateTime": "2020-01-28T05:00:00+00:00",
"scheduledType": "KSAOB.Arrival",
"creditorReference": "reference",
"debtorReference": "debtorReference",
"instructedAmount": {
"amount": "10.00",
"currency": "SAR"
},
"creditorAgent": {
"identificationType": "KSAOB.BICFI",
"identification": "identification"
},
"creditorAccount": [
{
"identificationType": "KSAOB.IBAN",
"identification": "20304012345678"
}
]
},
{
"scheduledPaymentId": "cf450f65-67b8-4c93-8820-bd7f3c612246",
"scheduledPaymentDateTime": "2023-02-22T22:21:09.456Z",
"scheduledType": "KSAOB.Arrival",
"creditorReference": "reference",
"debtorReference": "debtorReference",
"instructedAmount": {
"amount": "10.10",
"currency": "SAR"
},
"creditorAgent": {
"identificationType": "KSAOB.BICFI",
"identification": "identification"
},
"creditorAccount": [
{
"identificationType": "KSAOB.IBAN",
"identification": "411548018104"
}
]
}
]
},
"links": {
"self": "https://rs-ob-sb.SVMB01.com/open-banking/account-information/2022.11.01-final-errata2/accounts/100004000000000000000002/scheduled-payments"
},
"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 account and Scheduled Payments data included in the response |
accountId | Unique account identification |
scheduledPayment | Tag carrying information on Scheduled Payments of the account |
scheduledPaymentId | Unique Scheduled Payment identification |
scheduledPaymentDateTime | Date and time of the Scheduled Payment |
scheduledPaymentType | Type of the Scheduled Payment |
creditorReference | Unique creditor reference details |
debtorReference | Unique debtor reference details |
instructedAmount | Tag carrying information on the Scheduled Payment instructed amount |
amount | Transaction amount of the Scheduled Payment |
currency | Default currency in which the Scheduled Payment amount is indicated |
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 |