Standing Orders

Retrieve information about Standing Orders of a single or multiple accounts

Get Standing Orders by Account ID

This method fetches Standing Orders of a particular account specified through the Account ID and its corresponding Consent ID.

Endpoint details

Endpoint URLMethodAuthentication requirements
/v1/api/observice/standingOrdersByIdPOST1. clientId 2. clientCode 3. signature 4. Authorization Bearer: Token

Sample request

{
  "dateTimeStamp": "YYYY-MM-DDTHH:MM:SS",
  "requestID": "Enter_Request_Id",
  "merchantId": "Enter_Merchant_Id",
  "banks": [
    {
      "code": "Enter_Bank_Code",
      "consentId":"Enter_Consent_Id",
      "accountId": "Enter_Account_Id"
    }
  ]
}

Request description

JSON TagDescriptionData type
DateTimeStamp
Mandatory
Stamp denoting the date and time of the requestString
RequestID
Mandatory
Unique request identificationString
merchantId
Mandatory
Unique merchant identificationString
banks
Mandatory
Array of banks and consentsObject
code
Mandatory
Unique bank identification codeString
consentId
Mandatory
Unique consent identificationString
accountId
Mandatory
Unique account identification as per the consentString

Sample response

{
  "success": true,
  "payload": [
    {
      "code": "Bank_Code",
      "data": {
        "accountId": "Account_Id",
        "standingOrder": [
          {
            "standingOrderId": "Standing_Order_Id",
            "frequency": "Frequency",
            "creditorReference": "Credit_Refernece",
            "firstPaymentDateTime": "YYYY-MM-DDTHH:MM:SS.SSSZ",
            "nextPaymentDateTime": "YYYY-MM-DDTHH:MM:SS.SSSZ",
            "lastPaymentDateTime": "YYYY-MM-DDTHH:MM:SS.SSSZ",
            "finalPaymentDateTime": "YYYY-MM-DDTHH:MM:SS.SSSZ",
            "numberOfPayments": "Number",
            "standingOrderStatusCode": "Standing_Order_Status_Code",
            "firstPaymentAmount": {
              "amount": "00.00",
              "currency": "Currency"
            },
            "finalPaymentAmount": {
              "amount": "00.00",
              "currency": "Currency"
            },
            "supplementaryData": {
              "supplementary": "Data"
            },
            "nextPaymentAmount": {
              "amount": "00.00",
              "currency": "Currency"
            },
            "purpose": "Purpose_Details",
            "lastPaymentAmount": {
              "amount": "00.00",
              "currency": "Currency"
            },
            "standingOrderType": "Standing_Order_Type",
            "creditorAgent": {
              "identificationType": "Identification_Type",
              "identification": "Identification"
            },
            "creditorAccount": [
              {
                "identificationType": "Identification_Type",
                "identification": "Identification"
              }
            ]
          },
          {
            "standingOrderId": "Standing_Order_Id",
            "frequency": "Frequency",
            "creditorReference": "Credit_Refernece",
            "firstPaymentDateTime": "YYYY-MM-DDTHH:MM:SS.SSSZ",
            "nextPaymentDateTime": "YYYY-MM-DDTHH:MM:SS.SSSZ",
            "lastPaymentDateTime": "YYYY-MM-DDTHH:MM:SS.SSSZ",
            "finalPaymentDateTime": "YYYY-MM-DDTHH:MM:SS.SSSZ",
            "numberOfPayments": "Number",
            "standingOrderStatusCode": "Standing_Order_Status_Code",
            "firstPaymentAmount": {
              "amount": "00.00",
              "currency": "Currency"
            },
            "finalPaymentAmount": {
              "amount": "00.00",
              "currency": "Currency"
            },
            "supplementaryData": {
              "supplementary": "Data"
            },
            "nextPaymentAmount": {
              "amount": "00.00",
              "currency": "Currency"
            },
            "purpose": "Purpose_Details",
            "lastPaymentAmount": {
              "amount": "00.00",
              "currency": "Currency"
            },
            "standingOrderType": "Standing_Order_Type",
            "creditorAgent": {
              "identificationType": "Identification_Type",
              "identification": "Identification"
            },
            "creditorAccount": [
              {
                "identificationType": "Identification_Type",
                "identification": "Identification"
              }
            ]
          },
          {
            "standingOrderId": "Standing_Order_Id",
            "frequency": "Frequency",
            "creditorReference": "Credit_Refernece",
            "firstPaymentDateTime": "YYYY-MM-DDTHH:MM:SS.SSSZ",
            "nextPaymentDateTime": "YYYY-MM-DDTHH:MM:SS.SSSZ",
            "lastPaymentDateTime": "YYYY-MM-DDTHH:MM:SS.SSSZ",
            "finalPaymentDateTime": "YYYY-MM-DDTHH:MM:SS.SSSZ",
            "numberOfPayments": "Number",
            "standingOrderStatusCode": "Standing_Order_Status_Code",
            "firstPaymentAmount": {
              "amount": "00.00",
              "currency": "Currency"
            },
            "finalPaymentAmount": {
              "amount": "00.00",
              "currency": "Currency"
            },
            "supplementaryData": {
              "supplementary": "Data"
            },
            "nextPaymentAmount": {
              "amount": "00.00",
              "currency": "Currency"
            },
            "purpose": "Purpose_Details",
            "lastPaymentAmount": {
              "amount": "00.00",
              "currency": "Currency"
            },
            "standingOrderType": "Standing_Order_Type",
            "creditorAgent": {
              "identificationType": "Identification_Type",
              "identification": "Identification"
            },
            "creditorAccount": [
              {
                "identificationType": "Identification_Type",
                "identification": "Identification"
              }
            ]
          },
          {
            "standingOrderId": "Standing_Order_Id",
            "frequency": "Frequency",
            "creditorReference": "Credit_Refernece",
            "firstPaymentDateTime": "YYYY-MM-DDTHH:MM:SS.SSSZ",
            "nextPaymentDateTime": "YYYY-MM-DDTHH:MM:SS.SSSZ",
            "lastPaymentDateTime": "YYYY-MM-DDTHH:MM:SS.SSSZ",
            "finalPaymentDateTime": "YYYY-MM-DDTHH:MM:SS.SSSZ",
            "numberOfPayments": "Number",
            "standingOrderStatusCode": "Standing_Order_Status_Code",
            "firstPaymentAmount": {
              "amount": "00.00",
              "currency": "Currency"
            },
            "finalPaymentAmount": {
              "amount": "00.00",
              "currency": "Currency"
            },
            "supplementaryData": {
              "supplementary": "Data"
            },
            "nextPaymentAmount": {
              "amount": "00.00",
              "currency": "Currency"
            },
            "purpose": "Purpose_Details",
            "lastPaymentAmount": {
              "amount": "00.00",
              "currency": "Currency"
            },
            "standingOrderType": "Standing_Order_Type",
            "creditorAgent": {
              "identificationType": "Identification_Type",
              "identification": "Identification"
            },
            "creditorAccount": [
              {
                "identificationType": "Identification_Type",
                "identification": "Identification"
              }
            ]
          }
        ]
      },
      "links": {
        "self": "https://"
      },
      "meta": {
        "totalPages": 0
      }
    }
  ]
}

Response description

JSON TagDescription
successProcess success status represented as True or False
payloadPayload tag carrying response information
codeUnique bank code identification
dataTag carrying accounts and Standing Orders data included in the response
accountIdUnique account identification
standingOrderTag carrying account's Standing Orders' information
standingOrderIdUnique Standing Order identification
frequencyFrequency of the Standing Order
creditorReferenceUnique creditor reference details
firstPaymentDateTimeDate and time of the first standing order payment
nextPaymentDateTimeDate and time of the upcoming standing order payment
lastPaymentDateTimeDate and time of the previous/recent standing order payment
finalPaymentDateTimeDate and time of the final standing order payment
numberOfPaymentsTotal number of payments from first to final payments
standingOrderStatusCodeUnique status code of the Standing Order
firstPaymentAmountTag carrying information on first payment for standing order
amountTransaction amount of the standing order
currencyDefault currency of the account in which the standing order amount is indicated
finalPaymentAmountTag carrying information on final payment of standing order
amountTransaction amount for the standing order
currencyDefault currency of the account in which the standing order amount is indicated
supplementaryDataTag carrying information on supplementary data
supplementarySupplementary details
nextPaymentAmountTag carrying information on the upcoming standing order payment
amountTransaction amount of the standing order
currencyDefault currency in which the standing order amount is indicated
purposeDetails on the purpose of standing order
lastPaymentAmountTag carrying information on the previous recent standing order payment
amountTransaction amount of the standing order
currencyDefault currency in which the standing order amount is indicated
standingOrderTypeType of the standing order
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