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 URL | Method | Authentication requirements |
|---|---|---|
/v1/api/observice/standingOrdersById | POST | 1. 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 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 7 months ago