Standing Orders
Retrieve information about Standing Orders of a single or multiple accounts
Get All Accounts' Standing Orders
This method fetches the information on Standing Orders for all the accounts included in the provided Consent ID.
Endpoint details
Endpoint URL | Method | Grant type | Scope |
---|---|---|---|
/v1/api/observice/allAccountsStandingOrders | POST | The header should include: 1. signature 2. Authorization: Bearer Token | Fetch Standing Orders' 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",
"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"
}
]
}
]
},
{
"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",
"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"
}
]
}
]
},
{
"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",
"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"
}
]
}
]
}
],
"currentMonthPaid": {
"amount": 0000.000000,
"currency": "Currency",
"count": 0
}
},
"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 Standing Orders 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 |
standingOrder | Tag carrying account Standing Orders' information |
standingOrderId | Unique Standing Order identification |
frequency | Frequency of the Standing Order |
creditorReference | Unique creditor reference details |
firstPaymentDateTime | Date and time of the first standing order payment |
nextPaymentDateTime | Date and time of the upcoming standing order payment |
lastPaymentDateTime | Date and time of the previous/recent standing order payment |
finalPaymentDateTime | Date and time of the final standing order payment |
numberOfPayments | Total number of payments from first to final payments |
standingOrderStatusCode | Unique status code of the Standing Order |
firstPaymentAmount | Tag carrying information on first payment for standing order |
amount | Transaction amount of the standing order |
currency | Default currency of the account in which the standing order amount is indicated |
finalPaymentAmount | Tag carrying information on final payment of standing order |
amount | Transaction amount for the standing order |
currency | Default currency of the account in which the standing order amount is indicated |
supplementaryData | Tag carrying information on supplementary data |
supplementary | Supplementary details |
nextPaymentAmount | Tag carrying information on the upcoming standing order payment |
amount | Transaction amount of the standing order |
currency | Default currency in which the standing order amount is indicated |
purpose | Details on the purpose of standing order |
lastPaymentAmount | Tag carrying information on the previous recent standing order payment |
amount | Transaction amount of the standing order |
currency | Default currency in which the standing order amount is indicated |
standingOrderType | Type of the standing order |
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 standing order payments made in the current month |
currency | Default currency in which the standing order amount is indicated |
count | Total count of the standing orders made in the current month |
links | Redirect link |
self | Own link/URL details |
meta | Meta tag |
totalPages | Information displayed in terms of pages |
Get Standing Orders by Account ID
This method fetches Standing Orders of a particular account specified through Account ID and its corresponding Consent ID.
Endpoint details
Endpoint URL | Method | Grant type | Scope |
---|---|---|---|
/v1/api/observice/standingOrdersById | POST | The header should include: 1. signature 2. Authorization: Bearer Token | Fetch Standing Orders' 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",
"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 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 Standing Orders data included in the response |
accountId | Unique account identification |
standingOrder | Tag carrying account's Standing Orders' information |
standingOrderId | Unique Standing Order identification |
frequency | Frequency of the Standing Order |
creditorReference | Unique creditor reference details |
firstPaymentDateTime | Date and time of the first standing order payment |
nextPaymentDateTime | Date and time of the upcoming standing order payment |
lastPaymentDateTime | Date and time of the previous/recent standing order payment |
finalPaymentDateTime | Date and time of the final standing order payment |
numberOfPayments | Total number of payments from first to final payments |
standingOrderStatusCode | Unique status code of the Standing Order |
firstPaymentAmount | Tag carrying information on first payment for standing order |
amount | Transaction amount of the standing order |
currency | Default currency of the account in which the standing order amount is indicated |
finalPaymentAmount | Tag carrying information on final payment of standing order |
amount | Transaction amount for the standing order |
currency | Default currency of the account in which the standing order amount is indicated |
supplementaryData | Tag carrying information on supplementary data |
supplementary | Supplementary details |
nextPaymentAmount | Tag carrying information on the upcoming standing order payment |
amount | Transaction amount of the standing order |
currency | Default currency in which the standing order amount is indicated |
purpose | Details on the purpose of standing order |
lastPaymentAmount | Tag carrying information on the previous recent standing order payment |
amount | Transaction amount of the standing order |
currency | Default currency in which the standing order amount is indicated |
standingOrderType | Type of the standing order |
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