Scheduled Payments

Retrieve information about Scheduled Payments of a bank account

Get Scheduled Payments by Account ID

This method fetches the scheduled payments information of the specified account through the Account ID included in the provided Consent ID.

Endpoint details

Endpoint URL

Method

Authentication requirements

/v1/api/observice/scheduledPaymentsById

POST

1. clientId
2. clientCode
3. signature
4. Authorization Bearer: Token

Sample request

{
  "dateTimeStamp": "2024-12-31T10:40:00+02:00",
  "requestID": "df797efb-b588-4234-8ae1-5cb748559830",
  "merchantId": "APIS-300505",
  "banks": [
    {
      "code": "SAMA",
      "consentId":"urn:SAMA:kac-5a166b7d-8cdb-443a-a67a-80ad7a5b95b3",
      "accountId": "100004000000000000000002"
    }
  ]
}

Request description

JSON Tag

Description

Data type

DateTimeStamp Mandatory

Stamp denoting the date and time of the request
ISO 8601 format - YYYY-MM-DDTHH:MM:SS

Date

RequestID
Mandatory

Unique request identification
UUID format

Alphanumeric

merchantId
Mandatory

Unique merchant identification
UUID format

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

Sample response

{
  "success": true,
  "payload": [
    {
      "code": "ALINMA",
      "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.alinma.com/open-banking/account-information/2022.11.01-final-errata2/accounts/100004000000000000000002/scheduled-payments"
      },
      "meta": {
        "totalPages": 1
      }
    }
  ]
}

Response description

JSON TagDescription
successProcess success status represented as True or False
payloadPayload tag carrying response information
codeUnique bank code identification
dataTag carrying account and Scheduled Payments data included in the response
accountIdUnique account identification
scheduledPaymentTag carrying information on Scheduled Payments of the account
scheduledPaymentIdUnique Scheduled Payment identification
scheduledPaymentDateTimeDate and time of the Scheduled Payment
scheduledPaymentTypeType of the Scheduled Payment
creditorReferenceUnique creditor reference details
debtorReferenceUnique debtor reference details
instructedAmountTag carrying information on the Scheduled Payment instructed amount
amountTransaction amount of the Scheduled Payment
currencyDefault currency in which the Scheduled Payment amount is indicated
creditorAgentTag carrying information about creditor agent
identificationTypeType of identification of the creditor
identificationUnique creditor identification details
creditorAccountTag carrying information about creditor account
identificationTypeType of identification of the creditor account
identificationUnique creditor account identification details
linksRedirect link
selfOwn link/URL details
metaMeta tag
totalPagesInformation displayed in terms of pages