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 URL | Method | Grant type | Scope |
|---|---|---|---|
/v1/api/observice/allAccountsScheduledPayments | POST | The header should include: 1. signature2. 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 Tag | Description | Data type |
|---|---|---|
| DateTimeStamp Mandatory | Stamp denoting the date and time of the request | String |
| RequestID Mandatory | Unique request identification | String |
| merchantId Mandatory | Unique merchant identification | String |
| banks Mandatory | Array of banks and consents | Object |
| code Mandatory | Unique bank identification code | String |
| consentId Mandatory | Unique consent identification | String |
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 Tag | Description |
|---|---|
| success | Process success status represented as True or False |
| payload | Payload tag carrying response information |
| code | Unique bank code identification |
| data | Tag carrying accounts and Scheduled Payments data included in the response |
| account | Tag carrying response information for various accounts included in the Consent |
| accountId | Unique account identification |
| accountHolderName | Name of the account holder |
| accountHolderShortName | Short name of the account holder |
| status | Status of the account |
| currency | Default currency of the account |
| nickname | Nickname of the account |
| accountType | Details of account type |
| accountSubType | Details of account sub-type |
| accountIdentifiers | Tag carrying account identifiers details |
| identificationType | Account identification type details |
| identification | Account identification details |
| name | Name of the account identifier |
| servicer | Tag carrying account servicer details |
| identificationType | Servicer identification type details |
| identification | Servicer identification details |
| statusUpdateDateTime | Last time and date of update for account information |
| description | Description of the update |
| openingDate | Opening date of the account |
| maturityDate | Maturity date of the account |
| scheduledPayment | Tag carrying account Scheduled Payments' information |
| 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 |
| currentMonthPaid | Tag carrying information on the total payments made in the current month |
| amount | Total transaction amount for the scheduled payments made in the current month |
| currency | Default currency in which the scheduled payments amount is indicated |
| count | Total count of the scheduled payments made in the current month |
| links | Redirect link |
| self | Own link/URL details |
| meta | Meta tag |
| totalPages | Information 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 URL | Method | Grant type | Scope |
|---|---|---|---|
/v1/api/observice/scheduledPaymentsById | POST | The header should include: 1. signature2. 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 Tag | Description | Data type |
|---|---|---|
| DateTimeStamp Mandatory | Stamp denoting the date and time of the request | String |
| RequestID Mandatory | Unique request identification | String |
| merchantId Mandatory | Unique merchant identification | String |
| banks Mandatory | Array of banks and consents | Object |
| code Mandatory | Unique bank identification code | String |
| consentId Mandatory | Unique consent identification | String |
| accountId Mandatory | Unique account identification as per the consent | String |
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 Tag | Description |
|---|---|
| success | Process success status represented as True or False |
| 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 |
Updated 4 days ago