Scheduled Payments

Retrieve information about Scheduled Payments of a single or multiple accounts

Get All Accounts' Scheduled Payments

This method fetches the scheduled payments' details of all the accounts included in the provided Consent ID.

Endpoint details

Endpoint URLMethodGrant typeScope
/v1/api/observice/allAccountsScheduledPaymentsPOSTThe header should include:
1. signature
2. Authorization: Bearer Token
Fetch Scheduled Payments information of all the accounts included in the specified Consent ID

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"
        }
    ]
}

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

Sample response

{
    "success": true,
    "payload": [
        {
            "code": "Bank_Code",
            "data": {
                "account": [
                    {
                        "accountId": "Account_Id",
                        "accountHolderName": "Account_Holder_Name",
                        "accountHolderShortName": "Account_Holder_Short_Name",
                        "status": "Account_Status",
                        "currency": "Currency",
                        "nickname": "Account_Nickname",
                        "accountType": "Account_Type",
                        "accountSubType": "Account_Sub_Type",
                        "accountIdentifiers": [
                            {
                                "identificationType": "Identification_Type",
                                "identification": "Identification",
                                "name": "Name"
                            },
                            {
                                "identificationType": "Identification_Type",
                                "identification": "Identification",
                                "name": "Name"
                            }
                        ],
                        "servicer": {
                            "identificationType": "Identification_Type",
                            "identification": "Identification"
                        },
                        "statusUpdateDateTime": "YYYY-MM-DDTHH:MM:SS.SSSZ",
                        "description": "Account_Description",
                        "openingDate": "YYYY-MM-DDTHH:MM:SS.SSSZ",
                        "maturityDate": "YYYY-MM-DDTHH:MM:SS.SSSZ",
                        "scheduledPayment": [
                            {
                                "scheduledPaymentId": "Scheduled_Payment_Id",
                                "scheduledPaymentDateTime": "YYYY-MM-DDTHH:MM:SS.SSSZ",
                                "scheduledType": "Scheduled_Payment_Type",
                                "creditorReference": "Creditor_Reference",
                                "debtorReference": "Debtor_Reference",
                                "instructedAmount": {
                                    "amount": "00.00",
                                    "currency": "Currency"
                                },
                                "creditorAgent": {
                                    "identificationType": "Creditor_Identification_Type",
                                    "identification": "Creditor_Identification"
                                },
                                "creditorAccount": [
                                    {
                                        "identificationType": "Creditor_Account_Identification_Type",
                                        "identification": "Creditor_Account_Identification"
                                    }
                                ]
                            },
                            {
                                "scheduledPaymentId": "Scheduled_Payment_Id",
                                "scheduledPaymentDateTime": "YYYY-MM-DDTHH:MM:SS.SSSZ",
                                "scheduledType": "Scheduled_Payment_Type",
                                "creditorReference": "Creditor_Reference",
                                "debtorReference": "Debtor_Reference",
                                "instructedAmount": {
                                    "amount": "00.00",
                                    "currency": "Currency"
                                },
                                "creditorAgent": {
                                    "identificationType": "Creditor_Identification_Type",
                                    "identification": "Creditor_Identification"
                                },
                                "creditorAccount": [
                                    {
                                        "identificationType": "Creditor_Account_Identification_Type",
                                        "identification": "Creditor_Account_Identification"
                                    }
                                ]
                            },
                            {
                                "scheduledPaymentId": "Scheduled_Payment_Id",
                                "scheduledPaymentDateTime": "YYYY-MM-DDTHH:MM:SS.SSSZ",
                                "scheduledType": "Scheduled_Payment_Type",
                                "creditorReference": "Creditor_Reference",
                                "debtorReference": "Debtor_Reference",
                                "instructedAmount": {
                                    "amount": "00.00",
                                    "currency": "Currency"
                                },
                                "creditorAgent": {
                                    "identificationType": "Creditor_Identification_Type",
                                    "identification": "Creditor_Identification"
                                },
                                "creditorAccount": [
                                    {
                                        "identificationType": "Creditor_Account_Identification_Type",
                                        "identification": "Creditor_Account_Identification"
                                    }
                                ]
                            },
                            {
                                "scheduledPaymentId": "Scheduled_Payment_Id",
                                "scheduledPaymentDateTime": "YYYY-MM-DDTHH:MM:SS.SSSZ",
                                "scheduledType": "Scheduled_Payment_Type",
                                "creditorReference": "Creditor_Reference",
                                "debtorReference": "Debtor_Reference",
                                "instructedAmount": {
                                    "amount": "00.00",
                                    "currency": "Currency"
                                },
                                "creditorAgent": {
                                    "identificationType": "Creditor_Identification_Type",
                                    "identification": "Creditor_Identification"
                                },
                                "creditorAccount": [
                                    {
                                        "identificationType": "Creditor_Account_Identification_Type",
                                        "identification": "Creditor_Account_Identification"
                                    }
                                ]
                            }
                        ]
                    },
                    {
                        "accountId": "Account_Id",
                        "accountHolderName": "Account_Holder_Name",
                        "accountHolderShortName": "Account_Holder_Short_Name",
                        "status": "Account_Status",
                        "currency": "Currency",
                        "nickname": "Account_Nickname",
                        "accountType": "Account_Type",
                        "accountSubType": "Account_Sub_Type",
                        "accountIdentifiers": [
                            {
                                "identificationType": "Identification_Type",
                                "identification": "Identification",
                                "name": "Name"
                            },
                            {
                                "identificationType": "Identification_Type",
                                "identification": "Identification",
                                "name": "Name"
                            }
                        ],
                        "servicer": {
                            "identificationType": "Identification_Type",
                            "identification": "Identification"
                        },
                        "statusUpdateDateTime": "YYYY-MM-DDTHH:MM:SS.SSSZ",
                        "description": "Account_Description",
                        "openingDate": "YYYY-MM-DDTHH:MM:SS.SSSZ",
                        "maturityDate": "YYYY-MM-DDTHH:MM:SS.SSSZ",
                        "scheduledPayment": [
                            {
                                "scheduledPaymentId": "Scheduled_Payment_Id",
                                "scheduledPaymentDateTime": "YYYY-MM-DDTHH:MM:SS.SSSZ",
                                "scheduledType": "Scheduled_Payment_Type",
                                "creditorReference": "Creditor_Reference",
                                "debtorReference": "Debtor_Reference",
                                "instructedAmount": {
                                    "amount": "00.00",
                                    "currency": "Currency"
                                },
                                "creditorAgent": {
                                    "identificationType": "Creditor_Identification_Type",
                                    "identification": "Creditor_Identification"
                                },
                                "creditorAccount": [
                                    {
                                        "identificationType": "Creditor_Account_Identification_Type",
                                        "identification": "Creditor_Account_Identification"
                                    }
                                ]
                            },
                            {
                                "scheduledPaymentId": "Scheduled_Payment_Id",
                                "scheduledPaymentDateTime": "YYYY-MM-DDTHH:MM:SS.SSSZ",
                                "scheduledType": "Scheduled_Payment_Type",
                                "creditorReference": "Creditor_Reference",
                                "debtorReference": "Debtor_Reference",
                                "instructedAmount": {
                                    "amount": "00.00",
                                    "currency": "Currency"
                                },
                                "creditorAgent": {
                                    "identificationType": "Creditor_Identification_Type",
                                    "identification": "Creditor_Identification"
                                },
                                "creditorAccount": [
                                    {
                                        "identificationType": "Creditor_Account_Identification_Type",
                                        "identification": "Creditor_Account_Identification"
                                    }
                                ]
                            },
                            {
                                "scheduledPaymentId": "Scheduled_Payment_Id",
                                "scheduledPaymentDateTime": "YYYY-MM-DDTHH:MM:SS.SSSZ",
                                "scheduledType": "Scheduled_Payment_Type",
                                "creditorReference": "Creditor_Reference",
                                "debtorReference": "Debtor_Reference",
                                "instructedAmount": {
                                    "amount": "00.00",
                                    "currency": "Currency"
                                },
                                "creditorAgent": {
                                    "identificationType": "Creditor_Identification_Type",
                                    "identification": "Creditor_Identification"
                                },
                                "creditorAccount": [
                                    {
                                        "identificationType": "Creditor_Account_Identification_Type",
                                        "identification": "Creditor_Account_Identification"
                                    }
                                ]
                            },
                            {
                                "scheduledPaymentId": "Scheduled_Payment_Id",
                                "scheduledPaymentDateTime": "YYYY-MM-DDTHH:MM:SS.SSSZ",
                                "scheduledType": "Scheduled_Payment_Type",
                                "creditorReference": "Creditor_Reference",
                                "debtorReference": "Debtor_Reference",
                                "instructedAmount": {
                                    "amount": "00.00",
                                    "currency": "Currency"
                                },
                                "creditorAgent": {
                                    "identificationType": "Creditor_Identification_Type",
                                    "identification": "Creditor_Identification"
                                },
                                "creditorAccount": [
                                    {
                                        "identificationType": "Creditor_Account_Identification_Type",
                                        "identification": "Creditor_Account_Identification"
                                    }
                                ]
                            }
                        ]
                    },
                    {
                        "accountId": "Account_Id",
                        "accountHolderName": "Account_Holder_Name",
                        "accountHolderShortName": "Account_Holder_Short_Name",
                        "status": "Account_Status",
                        "currency": "Currency",
                        "nickname": "Account_Nickname",
                        "accountType": "Account_Type",
                        "accountSubType": "Account_Sub_Type",
                        "accountIdentifiers": [
                            {
                                "identificationType": "Identification_Type",
                                "identification": "Identification",
                                "name": "Name"
                            },
                            {
                                "identificationType": "Identification_Type",
                                "identification": "Identification",
                                "name": "Name"
                            }
                        ],
                        "servicer": {
                            "identificationType": "Identification_Type",
                            "identification": "Identification"
                        },
                        "statusUpdateDateTime": "YYYY-MM-DDTHH:MM:SS.SSSZ",
                        "description": "Account_Description",
                        "openingDate": "YYYY-MM-DDTHH:MM:SS.SSSZ",
                        "maturityDate": "YYYY-MM-DDTHH:MM:SS.SSSZ",
                        "scheduledPayment": [
                            {
                                "scheduledPaymentId": "Scheduled_Payment_Id",
                                "scheduledPaymentDateTime": "YYYY-MM-DDTHH:MM:SS.SSSZ",
                                "scheduledType": "Scheduled_Payment_Type",
                                "creditorReference": "Creditor_Reference",
                                "debtorReference": "Debtor_Reference",
                                "instructedAmount": {
                                    "amount": "00.00",
                                    "currency": "Currency"
                                },
                                "creditorAgent": {
                                    "identificationType": "Creditor_Identification_Type",
                                    "identification": "Creditor_Identification"
                                },
                                "creditorAccount": [
                                    {
                                        "identificationType": "Creditor_Account_Identification_Type",
                                        "identification": "Creditor_Account_Identification"
                                    }
                                ]
                            },
                            {
                                "scheduledPaymentId": "Scheduled_Payment_Id",
                                "scheduledPaymentDateTime": "YYYY-MM-DDTHH:MM:SS.SSSZ",
                                "scheduledType": "Scheduled_Payment_Type",
                                "creditorReference": "Creditor_Reference",
                                "debtorReference": "Debtor_Reference",
                                "instructedAmount": {
                                    "amount": "00.00",
                                    "currency": "Currency"
                                },
                                "creditorAgent": {
                                    "identificationType": "Creditor_Identification_Type",
                                    "identification": "Creditor_Identification"
                                },
                                "creditorAccount": [
                                    {
                                        "identificationType": "Creditor_Account_Identification_Type",
                                        "identification": "Creditor_Account_Identification"
                                    }
                                ]
                            },
                            {
                                "scheduledPaymentId": "Scheduled_Payment_Id",
                                "scheduledPaymentDateTime": "YYYY-MM-DDTHH:MM:SS.SSSZ",
                                "scheduledType": "Scheduled_Payment_Type",
                                "creditorReference": "Creditor_Reference",
                                "debtorReference": "Debtor_Reference",
                                "instructedAmount": {
                                    "amount": "00.00",
                                    "currency": "Currency"
                                },
                                "creditorAgent": {
                                    "identificationType": "Creditor_Identification_Type",
                                    "identification": "Creditor_Identification"
                                },
                                "creditorAccount": [
                                    {
                                        "identificationType": "Creditor_Account_Identification_Type",
                                        "identification": "Creditor_Account_Identification"
                                    }
                                ]
                            },
                            {
                                "scheduledPaymentId": "Scheduled_Payment_Id",
                                "scheduledPaymentDateTime": "YYYY-MM-DDTHH:MM:SS.SSSZ",
                                "scheduledType": "Scheduled_Payment_Type",
                                "creditorReference": "Creditor_Reference",
                                "debtorReference": "Debtor_Reference",
                                "instructedAmount": {
                                    "amount": "00.00",
                                    "currency": "Currency"
                                },
                                "creditorAgent": {
                                    "identificationType": "Creditor_Identification_Type",
                                    "identification": "Creditor_Identification"
                                },
                                "creditorAccount": [
                                    {
                                        "identificationType": "Creditor_Account_Identification_Type",
                                        "identification": "Creditor_Account_Identification"
                                    }
                                ]
                            }
                        ]
                    }
                ],
                "currentMonthPaid": {
                    "amount": 000.00000,
                    "currency": "Currency",
                    "count": 00
                }
            },
            "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 Scheduled Payments data included in the response
accountTag carrying response information for various accounts included in the Consent
accountIdUnique account identification
accountHolderNameName of the account holder
accountHolderShortNameShort name of the account holder
statusStatus of the account
currencyDefault currency of the account
nicknameNickname of the account
accountTypeDetails of account type
accountSubTypeDetails of account sub-type
accountIdentifiersTag carrying account identifiers details
identificationTypeAccount identification type details
identificationAccount identification details
nameName of the account identifier
servicerTag carrying account servicer details
identificationTypeServicer identification type details
identificationServicer identification details
statusUpdateDateTimeLast time and date of update for account information
descriptionDescription of the update
openingDateOpening date of the account
maturityDateMaturity date of the account
scheduledPaymentTag carrying account Scheduled Payments' information
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
currentMonthPaidTag carrying information on the total payments made in the current month
amountTotal transaction amount for the scheduled payments made in the current month
currencyDefault currency in which the scheduled payments amount is indicated
countTotal count of the scheduled payments made in the current month
linksRedirect link
selfOwn link/URL details
metaMeta tag
totalPagesInformation displayed in terms of pages

Get Scheduled Payments by Account ID

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

Endpoint details

Endpoint URLMethodGrant typeScope
/v1/api/observice/scheduledPaymentsByIdPOSTThe header should include:
1. signature
2. Authorization: Bearer Token
Fetch Scheduled Payments information of the specified account using Account ID

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",
                "scheduledPayment": [
                    {
                        "scheduledPaymentId": "Scheduled_Payment_Id",
                                "scheduledPaymentDateTime": "YYYY-MM-DDTHH:MM:SS.SSSZ",
                                "scheduledType": "Scheduled_Payment_Type",
                                "creditorReference": "Creditor_Reference",
                                "debtorReference": "Debtor_Reference",
                                "instructedAmount": {
                                    "amount": "00.00",
                                    "currency": "Currency"
                                },
                                "creditorAgent": {
                                    "identificationType": "Creditor_Identification_Type",
                                    "identification": "Creditor_Identification"
                                },
                                "creditorAccount": [
                                    {
                                        "identificationType": "Creditor_Account_Identification_Type",
                                        "identification": "Creditor_Account_Identification"
                            }
                        ]
                    },
                    {
                        "scheduledPaymentId": "Scheduled_Payment_Id",
                                "scheduledPaymentDateTime": "YYYY-MM-DDTHH:MM:SS.SSSZ",
                                "scheduledType": "Scheduled_Payment_Type",
                                "creditorReference": "Creditor_Reference",
                                "debtorReference": "Debtor_Reference",
                                "instructedAmount": {
                                    "amount": "00.00",
                                    "currency": "Currency"
                                },
                                "creditorAgent": {
                                    "identificationType": "Creditor_Identification_Type",
                                    "identification": "Creditor_Identification"
                                },
                                "creditorAccount": [
                                    {
                                        "identificationType": "Creditor_Account_Identification_Type",
                                        "identification": "Creditor_Account_Identification"
                            }
                        ]
                    },
                    {
                        "scheduledPaymentId": "Scheduled_Payment_Id",
                                "scheduledPaymentDateTime": "YYYY-MM-DDTHH:MM:SS.SSSZ",
                                "scheduledType": "Scheduled_Payment_Type",
                                "creditorReference": "Creditor_Reference",
                                "debtorReference": "Debtor_Reference",
                                "instructedAmount": {
                                    "amount": "00.00",
                                    "currency": "Currency"
                                },
                                "creditorAgent": {
                                    "identificationType": "Creditor_Identification_Type",
                                    "identification": "Creditor_Identification"
                                },
                                "creditorAccount": [
                                    {
                                        "identificationType": "Creditor_Account_Identification_Type",
                                        "identification": "Creditor_Account_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 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