Retrieve future-dated payments that have been scheduled for execution from an account
Scheduled Payments API provides access to payment instructions that have been set up by a customer and are scheduled to be processed at a future date. This information can be used to understand upcoming financial commitments, forecast cash flow, and support financial planning and affordability assessments.
Scheduled payment is a payment instruction created in advance and set to be executed on a specified future date.
The Scheduled Payments 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 scheduled payments of an account associated with that consent.
Endpoint URL | Method |
|---|---|
| GET |
The following headers must be included when calling the Scheduled Payments API.
Header parameter | Description |
|---|---|
| Access token used to authenticate the API request |
curl --request GET \
--url 'https://obsandbox.onesingleview.com/v2/api/observice/scheduledPaymentsById?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",
"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"
}
]
}
],
"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 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 |
links | Contains reference links related to the API response or resource |
self | Link referencing the current API resource or endpoint that returned the response |
meta | Provides additional metadata related to the API response, such as pagination information |
totalPages | Indicates the total number of pages available in the response when pagination is applied |