Transactions
Get transaction details of a bank account
Get Account Transactions by Account ID
This method retrieves transaction information for a specified period of time of the specific account using the Account ID.
Endpoint details
| Endpoint URL | Method | Authentication requirements |
|---|---|---|
/v1/api/observice/transactionsById | 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",
"fromDate": "YYYY-MM-DDTHH:MM:SS.SSSZ",
"toDate": "YYYY-MM-DDTHH:MM:SS.SSSZ",
"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 |
| fromDate Mandatory | Initial date of the transaction period | String |
| toDate Mandatory | Final date of the transaction period | 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 | String |
Sample response
{
"success": true,
"payload": [
{
"code": "Bank_Code",
"data": {
"accountId": "Account_Id",
"transactions": [
{
"transactionId": "Transaction_Id",
"transactionDateTime": "YYYY-MM-DDTHH:MM:SS.SSSZ",
"transactionReference": "Transaction_Reference",
"transactionType": "Transaction_Type",
"subTransactionType": "Transaction_Sub_Type",
"paymentModes": "Payment_Modes",
"creditDebitIndicator": "Credit_Debit_Indicator",
"status": "Status",
"transactionMutability": "Transaction_Mutability",
"bookingDateTime": "YYYY-MM-DDTHH:MM:SS.SSSZ",
"valueDateTime": "YYYY-MM-DDTHH:MM:SS.SSSZ",
"amount": {
"amount": "0.00",
"currency": "Currency"
},
"chargeAmount": {
"amount": "0.00",
"currency": "Currency",
"chargeIncluded": true or false
},
"balance": {
"creditDebitIndicator": "Credit_Debit_Indicator",
"type": "Type",
"amount": {
"amount": "00.00",
"currency": "Currency"
}
},
"merchantDetails": {
"merchantName": "Merchant_Name",
"merchantCategoryCode": "Merchant_Category_Code",
"merchantId": Merchant_Id
},
"localTimeZone": "XXX+HH:MM",
"terminalId": terminal_Id,
"chargeAmountVat": {
"amount": "00.0000",
"currency": "Currency"
},
"flags": [
"Flag_Details"
],
"cardInstrument": {
"cardSchemeName": "Card_Scheme_Name",
"instrumentType": "Instrument_Type",
"name": "Name",
"identification": "Identification_Details"
},
"creditorAccount": [
{}
],
"debtorAccount": {
"identificationType": "Debit_Account",
"identification": "Identification_Details",
"name": "Name"
},
"transactionInformation": "Transaction_Info",
"bankTransactionCode": {
"domain": "Domain",
"domainCode": "Domain_Code",
"family": "Family",
"familyCode": "Family_Code",
"subFamily": "Sub_Family",
"subFamilyCode": "Sub_Family_Code"
},
"proprietaryBankTransactionCode": {
"code": "Code",
"issuer": "Issuer"
},
"creditorAgent": {
"identificationType": "Identification_Type",
"identification": "Identification",
"postalAddress": {
"addressType": "Address_Type",
"streetName": "Street_Name",
"buildingNumber": "Building_Number",
"postalCode": "Postal_Code",
"city": "City_Name",
"country": "Country",
"shortAddress": "Short_Address",
"unitNumber": Unit_Number,
"secondaryNumber": "Secondary_Number",
"district": "District"
},
"name": "Name"
},
"debtorAgent": {
"identificationType": "Identification_Type",
"identification": "Identification",
"postalAddress": {
"addressType": "Address_Type",
"streetName": "Street_Name",
"buildingNumber": "Building_Number",
"postalCode": "Postal_Code",
"city": "City_Name",
"country": "Country",
"shortAddress": "Short_Address",
"unitNumber": Unit_Number,
"secondaryNumber": "Secondary_Number",
"district": "District"
},
"name": "Name"
},
"billDetails": {
"billerId": Biller_Id,
"billNumber": "Bill_Number",
"billPaymentType": "Bill_Payment_Type"
}
},
{
"transactionId": "Transaction_Id",
"transactionDateTime": "YYYY-MM-DDTHH:MM:SS.SSSZ",
"transactionReference": "Transaction_Reference",
"transactionType": "Transaction_Type",
"subTransactionType": "Transaction_Sub_Type",
"paymentModes": "Payment_Modes",
"creditDebitIndicator": "Credit_Debit_Indicator",
"status": "Status",
"transactionMutability": "Transaction_Mutability",
"bookingDateTime": "YYYY-MM-DDTHH:MM:SS.SSSZ",
"valueDateTime": "YYYY-MM-DDTHH:MM:SS.SSSZ",
"amount": {
"amount": "0.00",
"currency": "Currency"
},
"chargeAmount": {
"amount": "0.00",
"currency": "Currency",
"chargeIncluded": true or false
},
"balance": {
"creditDebitIndicator": "Credit_Debit_Indicator",
"type": "Type",
"amount": {
"amount": "00.00",
"currency": "Currency"
}
},
"merchantDetails": {
"merchantName": "Merchant_Name",
"merchantCategoryCode": "Merchant_Category_Code",
"merchantId": Merchant_Id
},
"localTimeZone": "XXX+HH:MM",
"terminalId": terminal_Id,
"chargeAmountVat": {
"amount": "00.0000",
"currency": "Currency"
},
"flags": [
"Flag_Details"
],
"cardInstrument": {
"cardSchemeName": "Card_Scheme_Name",
"instrumentType": "Instrument_Type",
"name": "Name",
"identification": "Identification_Details"
},
"creditorAccount": [
{}
],
"debtorAccount": {
"identificationType": "Debit_Account",
"identification": "Identification_Details",
"name": "Name"
},
"transactionInformation": "Transaction_Info",
"bankTransactionCode": {
"domain": "Domain",
"domainCode": "Domain_Code",
"family": "Family",
"familyCode": "Family_Code",
"subFamily": "Sub_Family",
"subFamilyCode": "Sub_Family_Code"
},
"proprietaryBankTransactionCode": {
"code": "Code",
"issuer": "Issuer"
},
"creditorAgent": {
"identificationType": "Identification_Type",
"identification": "Identification",
"postalAddress": {
"addressType": "Address_Type",
"streetName": "Street_Name",
"buildingNumber": "Building_Number",
"postalCode": "Postal_Code",
"city": "City_Name",
"country": "Country",
"shortAddress": "Short_Address",
"unitNumber": Unit_Number,
"secondaryNumber": "Secondary_Number",
"district": "District"
},
"name": "Name"
},
"debtorAgent": {
"identificationType": "Identification_Type",
"identification": "Identification",
"postalAddress": {
"addressType": "Address_Type",
"streetName": "Street_Name",
"buildingNumber": "Building_Number",
"postalCode": "Postal_Code",
"city": "City_Name",
"country": "Country",
"shortAddress": "Short_Address",
"unitNumber": Unit_Number,
"secondaryNumber": "Secondary_Number",
"district": "District"
},
"name": "Name"
},
"billDetails": {
"billerId": Biller_Id,
"billNumber": "Bill_Number",
"billPaymentType": "Bill_Payment_Type"
}
},
{
"transactionId": "Transaction_Id",
"transactionDateTime": "YYYY-MM-DDTHH:MM:SS.SSSZ",
"transactionReference": "Transaction_Reference",
"transactionType": "Transaction_Type",
"subTransactionType": "Transaction_Sub_Type",
"paymentModes": "Payment_Modes",
"creditDebitIndicator": "Credit_Debit_Indicator",
"status": "Status",
"transactionMutability": "Transaction_Mutability",
"bookingDateTime": "YYYY-MM-DDTHH:MM:SS.SSSZ",
"valueDateTime": "YYYY-MM-DDTHH:MM:SS.SSSZ",
"amount": {
"amount": "0.00",
"currency": "Currency"
},
"chargeAmount": {
"amount": "0.00",
"currency": "Currency",
"chargeIncluded": true or false
},
"balance": {
"creditDebitIndicator": "Credit_Debit_Indicator",
"type": "Type",
"amount": {
"amount": "00.00",
"currency": "Currency"
}
},
"merchantDetails": {
"merchantName": "Merchant_Name",
"merchantCategoryCode": "Merchant_Category_Code",
"merchantId": Merchant_Id
},
"localTimeZone": "XXX+HH:MM",
"terminalId": terminal_Id,
"chargeAmountVat": {
"amount": "00.0000",
"currency": "Currency"
},
"flags": [
"Flag_Details"
],
"cardInstrument": {
"cardSchemeName": "Card_Scheme_Name",
"instrumentType": "Instrument_Type",
"name": "Name",
"identification": "Identification_Details"
},
"creditorAccount": [
{}
],
"debtorAccount": {
"identificationType": "Debit_Account",
"identification": "Identification_Details",
"name": "Name"
},
"transactionInformation": "Transaction_Info",
"bankTransactionCode": {
"domain": "Domain",
"domainCode": "Domain_Code",
"family": "Family",
"familyCode": "Family_Code",
"subFamily": "Sub_Family",
"subFamilyCode": "Sub_Family_Code"
},
"proprietaryBankTransactionCode": {
"code": "Code",
"issuer": "Issuer"
},
"creditorAgent": {
"identificationType": "Identification_Type",
"identification": "Identification",
"postalAddress": {
"addressType": "Address_Type",
"streetName": "Street_Name",
"buildingNumber": "Building_Number",
"postalCode": "Postal_Code",
"city": "City_Name",
"country": "Country",
"shortAddress": "Short_Address",
"unitNumber": Unit_Number,
"secondaryNumber": "Secondary_Number",
"district": "District"
},
"name": "Name"
},
"debtorAgent": {
"identificationType": "Identification_Type",
"identification": "Identification",
"postalAddress": {
"addressType": "Address_Type",
"streetName": "Street_Name",
"buildingNumber": "Building_Number",
"postalCode": "Postal_Code",
"city": "City_Name",
"country": "Country",
"shortAddress": "Short_Address",
"unitNumber": Unit_Number,
"secondaryNumber": "Secondary_Number",
"district": "District"
},
"name": "Name"
},
"billDetails": {
"billerId": Biller_Id,
"billNumber": "Bill_Number",
"billPaymentType": "Bill_Payment_Type"
}
},
{
"transactionId": "Transaction_Id",
"transactionDateTime": "YYYY-MM-DDTHH:MM:SS.SSSZ",
"transactionReference": "Transaction_Reference",
"transactionType": "Transaction_Type",
"subTransactionType": "Transaction_Sub_Type",
"paymentModes": "Payment_Modes",
"creditDebitIndicator": "Credit_Debit_Indicator",
"status": "Status",
"transactionMutability": "Transaction_Mutability",
"bookingDateTime": "YYYY-MM-DDTHH:MM:SS.SSSZ",
"valueDateTime": "YYYY-MM-DDTHH:MM:SS.SSSZ",
"amount": {
"amount": "0.00",
"currency": "Currency"
},
"chargeAmount": {
"amount": "0.00",
"currency": "Currency",
"chargeIncluded": true or false
},
"balance": {
"creditDebitIndicator": "Credit_Debit_Indicator",
"type": "Type",
"amount": {
"amount": "00.00",
"currency": "Currency"
}
},
"merchantDetails": {
"merchantName": "Merchant_Name",
"merchantCategoryCode": "Merchant_Category_Code",
"merchantId": Merchant_Id
},
"localTimeZone": "XXX+HH:MM",
"terminalId": terminal_Id,
"chargeAmountVat": {
"amount": "00.0000",
"currency": "Currency"
},
"flags": [
"Flag_Details"
],
"cardInstrument": {
"cardSchemeName": "Card_Scheme_Name",
"instrumentType": "Instrument_Type",
"name": "Name",
"identification": "Identification_Details"
},
"creditorAccount": [
{}
],
"debtorAccount": {
"identificationType": "Debit_Account",
"identification": "Identification_Details",
"name": "Name"
},
"transactionInformation": "Transaction_Info",
"bankTransactionCode": {
"domain": "Domain",
"domainCode": "Domain_Code",
"family": "Family",
"familyCode": "Family_Code",
"subFamily": "Sub_Family",
"subFamilyCode": "Sub_Family_Code"
},
"proprietaryBankTransactionCode": {
"code": "Code",
"issuer": "Issuer"
},
"creditorAgent": {
"identificationType": "Identification_Type",
"identification": "Identification",
"postalAddress": {
"addressType": "Address_Type",
"streetName": "Street_Name",
"buildingNumber": "Building_Number",
"postalCode": "Postal_Code",
"city": "City_Name",
"country": "Country",
"shortAddress": "Short_Address",
"unitNumber": Unit_Number,
"secondaryNumber": "Secondary_Number",
"district": "District"
},
"name": "Name"
},
"debtorAgent": {
"identificationType": "Identification_Type",
"identification": "Identification",
"postalAddress": {
"addressType": "Address_Type",
"streetName": "Street_Name",
"buildingNumber": "Building_Number",
"postalCode": "Postal_Code",
"city": "City_Name",
"country": "Country",
"shortAddress": "Short_Address",
"unitNumber": Unit_Number,
"secondaryNumber": "Secondary_Number",
"district": "District"
},
"name": "Name"
},
"billDetails": {
"billerId": Biller_Id,
"billNumber": "Bill_Number",
"billPaymentType": "Bill_Payment_Type"
}
},
{
"transactionId": "Transaction_Id",
"transactionDateTime": "YYYY-MM-DDTHH:MM:SS.SSSZ",
"transactionReference": "Transaction_Reference",
"transactionType": "Transaction_Type",
"subTransactionType": "Transaction_Sub_Type",
"paymentModes": "Payment_Modes",
"creditDebitIndicator": "Credit_Debit_Indicator",
"status": "Status",
"transactionMutability": "Transaction_Mutability",
"bookingDateTime": "YYYY-MM-DDTHH:MM:SS.SSSZ",
"valueDateTime": "YYYY-MM-DDTHH:MM:SS.SSSZ",
"amount": {
"amount": "0.00",
"currency": "Currency"
},
"chargeAmount": {
"amount": "0.00",
"currency": "Currency",
"chargeIncluded": true or false
},
"balance": {
"creditDebitIndicator": "Credit_Debit_Indicator",
"type": "Type",
"amount": {
"amount": "00.00",
"currency": "Currency"
}
},
"merchantDetails": {
"merchantName": "Merchant_Name",
"merchantCategoryCode": "Merchant_Category_Code",
"merchantId": Merchant_Id
},
"localTimeZone": "XXX+HH:MM",
"terminalId": terminal_Id,
"chargeAmountVat": {
"amount": "00.0000",
"currency": "Currency"
},
"flags": [
"Flag_Details"
],
"cardInstrument": {
"cardSchemeName": "Card_Scheme_Name",
"instrumentType": "Instrument_Type",
"name": "Name",
"identification": "Identification_Details"
},
"creditorAccount": [
{}
],
"debtorAccount": {
"identificationType": "Debit_Account",
"identification": "Identification_Details",
"name": "Name"
},
"transactionInformation": "Transaction_Info",
"bankTransactionCode": {
"domain": "Domain",
"domainCode": "Domain_Code",
"family": "Family",
"familyCode": "Family_Code",
"subFamily": "Sub_Family",
"subFamilyCode": "Sub_Family_Code"
},
"proprietaryBankTransactionCode": {
"code": "Code",
"issuer": "Issuer"
},
"creditorAgent": {
"identificationType": "Identification_Type",
"identification": "Identification",
"postalAddress": {
"addressType": "Address_Type",
"streetName": "Street_Name",
"buildingNumber": "Building_Number",
"postalCode": "Postal_Code",
"city": "City_Name",
"country": "Country",
"shortAddress": "Short_Address",
"unitNumber": Unit_Number,
"secondaryNumber": "Secondary_Number",
"district": "District"
},
"name": "Name"
},
"debtorAgent": {
"identificationType": "Identification_Type",
"identification": "Identification",
"postalAddress": {
"addressType": "Address_Type",
"streetName": "Street_Name",
"buildingNumber": "Building_Number",
"postalCode": "Postal_Code",
"city": "City_Name",
"country": "Country",
"shortAddress": "Short_Address",
"unitNumber": Unit_Number,
"secondaryNumber": "Secondary_Number",
"district": "District"
},
"name": "Name"
},
"billDetails": {
"billerId": Biller_Id,
"billNumber": "Bill_Number",
"billPaymentType": "Bill_Payment_Type"
}
},
{
"transactionId": "Transaction_Id",
"transactionDateTime": "YYYY-MM-DDTHH:MM:SS.SSSZ",
"transactionReference": "Transaction_Reference",
"transactionType": "Transaction_Type",
"subTransactionType": "Transaction_Sub_Type",
"paymentModes": "Payment_Modes",
"creditDebitIndicator": "Credit_Debit_Indicator",
"status": "Status",
"transactionMutability": "Transaction_Mutability",
"bookingDateTime": "YYYY-MM-DDTHH:MM:SS.SSSZ",
"valueDateTime": "YYYY-MM-DDTHH:MM:SS.SSSZ",
"amount": {
"amount": "0.00",
"currency": "Currency"
},
"chargeAmount": {
"amount": "0.00",
"currency": "Currency",
"chargeIncluded": true or false
},
"balance": {
"creditDebitIndicator": "Credit_Debit_Indicator",
"type": "Type",
"amount": {
"amount": "00.00",
"currency": "Currency"
}
},
"merchantDetails": {
"merchantName": "Merchant_Name",
"merchantCategoryCode": "Merchant_Category_Code",
"merchantId": Merchant_Id
},
"localTimeZone": "XXX+HH:MM",
"terminalId": terminal_Id,
"chargeAmountVat": {
"amount": "00.0000",
"currency": "Currency"
},
"flags": [
"Flag_Details"
],
"cardInstrument": {
"cardSchemeName": "Card_Scheme_Name",
"instrumentType": "Instrument_Type",
"name": "Name",
"identification": "Identification_Details"
},
"creditorAccount": [
{}
],
"debtorAccount": {
"identificationType": "Debit_Account",
"identification": "Identification_Details",
"name": "Name"
},
"transactionInformation": "Transaction_Info",
"bankTransactionCode": {
"domain": "Domain",
"domainCode": "Domain_Code",
"family": "Family",
"familyCode": "Family_Code",
"subFamily": "Sub_Family",
"subFamilyCode": "Sub_Family_Code"
},
"proprietaryBankTransactionCode": {
"code": "Code",
"issuer": "Issuer"
},
"creditorAgent": {
"identificationType": "Identification_Type",
"identification": "Identification",
"postalAddress": {
"addressType": "Address_Type",
"streetName": "Street_Name",
"buildingNumber": "Building_Number",
"postalCode": "Postal_Code",
"city": "City_Name",
"country": "Country",
"shortAddress": "Short_Address",
"unitNumber": Unit_Number,
"secondaryNumber": "Secondary_Number",
"district": "District"
},
"name": "Name"
},
"debtorAgent": {
"identificationType": "Identification_Type",
"identification": "Identification",
"postalAddress": {
"addressType": "Address_Type",
"streetName": "Street_Name",
"buildingNumber": "Building_Number",
"postalCode": "Postal_Code",
"city": "City_Name",
"country": "Country",
"shortAddress": "Short_Address",
"unitNumber": Unit_Number,
"secondaryNumber": "Secondary_Number",
"district": "District"
},
"name": "Name"
},
"billDetails": {
"billerId": Biller_Id,
"billNumber": "Bill_Number",
"billPaymentType": "Bill_Payment_Type"
}
},
{
"transactionId": "Transaction_Id",
"transactionDateTime": "YYYY-MM-DDTHH:MM:SS.SSSZ",
"transactionReference": "Transaction_Reference",
"transactionType": "Transaction_Type",
"subTransactionType": "Transaction_Sub_Type",
"paymentModes": "Payment_Modes",
"creditDebitIndicator": "Credit_Debit_Indicator",
"status": "Status",
"transactionMutability": "Transaction_Mutability",
"bookingDateTime": "YYYY-MM-DDTHH:MM:SS.SSSZ",
"valueDateTime": "YYYY-MM-DDTHH:MM:SS.SSSZ",
"amount": {
"amount": "0.00",
"currency": "Currency"
},
"chargeAmount": {
"amount": "0.00",
"currency": "Currency",
"chargeIncluded": true or false
},
"balance": {
"creditDebitIndicator": "Credit_Debit_Indicator",
"type": "Type",
"amount": {
"amount": "00.00",
"currency": "Currency"
}
},
"merchantDetails": {
"merchantName": "Merchant_Name",
"merchantCategoryCode": "Merchant_Category_Code",
"merchantId": Merchant_Id
},
"localTimeZone": "XXX+HH:MM",
"terminalId": terminal_Id,
"chargeAmountVat": {
"amount": "00.0000",
"currency": "Currency"
},
"flags": [
"Flag_Details"
],
"cardInstrument": {
"cardSchemeName": "Card_Scheme_Name",
"instrumentType": "Instrument_Type",
"name": "Name",
"identification": "Identification_Details"
},
"creditorAccount": [
{}
],
"debtorAccount": {
"identificationType": "Debit_Account",
"identification": "Identification_Details",
"name": "Name"
},
"transactionInformation": "Transaction_Info",
"bankTransactionCode": {
"domain": "Domain",
"domainCode": "Domain_Code",
"family": "Family",
"familyCode": "Family_Code",
"subFamily": "Sub_Family",
"subFamilyCode": "Sub_Family_Code"
},
"proprietaryBankTransactionCode": {
"code": "Code",
"issuer": "Issuer"
},
"creditorAgent": {
"identificationType": "Identification_Type",
"identification": "Identification",
"postalAddress": {
"addressType": "Address_Type",
"streetName": "Street_Name",
"buildingNumber": "Building_Number",
"postalCode": "Postal_Code",
"city": "City_Name",
"country": "Country",
"shortAddress": "Short_Address",
"unitNumber": Unit_Number,
"secondaryNumber": "Secondary_Number",
"district": "District"
},
"name": "Name"
},
"debtorAgent": {
"identificationType": "Identification_Type",
"identification": "Identification",
"postalAddress": {
"addressType": "Address_Type",
"streetName": "Street_Name",
"buildingNumber": "Building_Number",
"postalCode": "Postal_Code",
"city": "City_Name",
"country": "Country",
"shortAddress": "Short_Address",
"unitNumber": Unit_Number,
"secondaryNumber": "Secondary_Number",
"district": "District"
},
"name": "Name"
},
"billDetails": {
"billerId": Biller_Id,
"billNumber": "Bill_Number",
"billPaymentType": "Bill_Payment_Type"
}
},
{
"transactionId": "Transaction_Id",
"transactionDateTime": "YYYY-MM-DDTHH:MM:SS.SSSZ",
"transactionReference": "Transaction_Reference",
"transactionType": "Transaction_Type",
"subTransactionType": "Transaction_Sub_Type",
"paymentModes": "Payment_Modes",
"creditDebitIndicator": "Credit_Debit_Indicator",
"status": "Status",
"transactionMutability": "Transaction_Mutability",
"bookingDateTime": "YYYY-MM-DDTHH:MM:SS.SSSZ",
"valueDateTime": "YYYY-MM-DDTHH:MM:SS.SSSZ",
"amount": {
"amount": "0.00",
"currency": "Currency"
},
"chargeAmount": {
"amount": "0.00",
"currency": "Currency",
"chargeIncluded": true or false
},
"balance": {
"creditDebitIndicator": "Credit_Debit_Indicator",
"type": "Type",
"amount": {
"amount": "00.00",
"currency": "Currency"
}
},
"merchantDetails": {
"merchantName": "Merchant_Name",
"merchantCategoryCode": "Merchant_Category_Code",
"merchantId": Merchant_Id
},
"localTimeZone": "XXX+HH:MM",
"terminalId": terminal_Id,
"chargeAmountVat": {
"amount": "00.0000",
"currency": "Currency"
},
"flags": [
"Flag_Details"
],
"cardInstrument": {
"cardSchemeName": "Card_Scheme_Name",
"instrumentType": "Instrument_Type",
"name": "Name",
"identification": "Identification_Details"
},
"creditorAccount": [
{}
],
"debtorAccount": {
"identificationType": "Debit_Account",
"identification": "Identification_Details",
"name": "Name"
},
"transactionInformation": "Transaction_Info",
"bankTransactionCode": {
"domain": "Domain",
"domainCode": "Domain_Code",
"family": "Family",
"familyCode": "Family_Code",
"subFamily": "Sub_Family",
"subFamilyCode": "Sub_Family_Code"
},
"proprietaryBankTransactionCode": {
"code": "Code",
"issuer": "Issuer"
},
"creditorAgent": {
"identificationType": "Identification_Type",
"identification": "Identification",
"postalAddress": {
"addressType": "Address_Type",
"streetName": "Street_Name",
"buildingNumber": "Building_Number",
"postalCode": "Postal_Code",
"city": "City_Name",
"country": "Country",
"shortAddress": "Short_Address",
"unitNumber": Unit_Number,
"secondaryNumber": "Secondary_Number",
"district": "District"
},
"name": "Name"
},
"debtorAgent": {
"identificationType": "Identification_Type",
"identification": "Identification",
"postalAddress": {
"addressType": "Address_Type",
"streetName": "Street_Name",
"buildingNumber": "Building_Number",
"postalCode": "Postal_Code",
"city": "City_Name",
"country": "Country",
"shortAddress": "Short_Address",
"unitNumber": Unit_Number,
"secondaryNumber": "Secondary_Number",
"district": "District"
},
"name": "Name"
},
"billDetails": {
"billerId": Biller_Id,
"billNumber": "Bill_Number",
"billPaymentType": "Bill_Payment_Type"
}
},
{
"transactionId": "Transaction_Id",
"transactionDateTime": "YYYY-MM-DDTHH:MM:SS.SSSZ",
"transactionReference": "Transaction_Reference",
"transactionType": "Transaction_Type",
"subTransactionType": "Transaction_Sub_Type",
"paymentModes": "Payment_Modes",
"creditDebitIndicator": "Credit_Debit_Indicator",
"status": "Status",
"transactionMutability": "Transaction_Mutability",
"bookingDateTime": "YYYY-MM-DDTHH:MM:SS.SSSZ",
"valueDateTime": "YYYY-MM-DDTHH:MM:SS.SSSZ",
"amount": {
"amount": "0.00",
"currency": "Currency"
},
"chargeAmount": {
"amount": "0.00",
"currency": "Currency",
"chargeIncluded": true or false
},
"balance": {
"creditDebitIndicator": "Credit_Debit_Indicator",
"type": "Type",
"amount": {
"amount": "00.00",
"currency": "Currency"
}
},
"merchantDetails": {
"merchantName": "Merchant_Name",
"merchantCategoryCode": "Merchant_Category_Code",
"merchantId": Merchant_Id
},
"localTimeZone": "XXX+HH:MM",
"terminalId": terminal_Id,
"chargeAmountVat": {
"amount": "00.0000",
"currency": "Currency"
},
"flags": [
"Flag_Details"
],
"cardInstrument": {
"cardSchemeName": "Card_Scheme_Name",
"instrumentType": "Instrument_Type",
"name": "Name",
"identification": "Identification_Details"
},
"creditorAccount": [
{}
],
"debtorAccount": {
"identificationType": "Debit_Account",
"identification": "Identification_Details",
"name": "Name"
},
"transactionInformation": "Transaction_Info",
"bankTransactionCode": {
"domain": "Domain",
"domainCode": "Domain_Code",
"family": "Family",
"familyCode": "Family_Code",
"subFamily": "Sub_Family",
"subFamilyCode": "Sub_Family_Code"
},
"proprietaryBankTransactionCode": {
"code": "Code",
"issuer": "Issuer"
},
"creditorAgent": {
"identificationType": "Identification_Type",
"identification": "Identification",
"postalAddress": {
"addressType": "Address_Type",
"streetName": "Street_Name",
"buildingNumber": "Building_Number",
"postalCode": "Postal_Code",
"city": "City_Name",
"country": "Country",
"shortAddress": "Short_Address",
"unitNumber": Unit_Number,
"secondaryNumber": "Secondary_Number",
"district": "District"
},
"name": "Name"
},
"debtorAgent": {
"identificationType": "Identification_Type",
"identification": "Identification",
"postalAddress": {
"addressType": "Address_Type",
"streetName": "Street_Name",
"buildingNumber": "Building_Number",
"postalCode": "Postal_Code",
"city": "City_Name",
"country": "Country",
"shortAddress": "Short_Address",
"unitNumber": Unit_Number,
"secondaryNumber": "Secondary_Number",
"district": "District"
},
"name": "Name"
},
"billDetails": {
"billerId": Biller_Id,
"billNumber": "Bill_Number",
"billPaymentType": "Bill_Payment_Type"
}
},
"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 transactions data included in the response |
| accountId | Unique account identification |
| transactions | Tag carrying account transactions information |
| transactionId | Unique transaction identification |
| transactionDateTime | Time and date of the transaction executed |
| transactionReference | Unique transaction reference details |
| transactionType | Type of transaction |
| subTransactionType | Sub-type of the transaction |
| paymentModes | Mode of the payment |
| creditDebitIndicator | Credit or debit indicator for the transaction |
| status | Status of the transaction |
| transactionMutability | Mutability factor of the transaction |
| bookingDateTime | Date and time of booking the transaction |
| valueDateTime | Date and time of transaction value |
| amount | Tag carrying transaction amount information |
| amount | Transaction amount |
| currency | Default currency of the account in which the transaction amount is indicated |
| chargeAmount | Tag carrying transaction charges information |
| amount | Total amount charged for the transaction |
| currency | Default currency of account in which the transaction charge amount is indicated |
| chargeIncluded | Indicates if the charge amount is included in transaction amount as true or false |
| balance | Balance info after the transaction |
| creditDebitIndicator | Indicates whether the balance is a credit or a debit balance |
| type | Indicator type details |
| amount | Tag carrying balance amount information |
| amount | Available amount balance |
| currency | Currency in which the balance is indicated |
| merchantDetails | Tag carrying merchant details |
| merchantName | Name of the merchant |
| merchantCategoryCode | Assigned merchant category code |
| merchantId | Unique merchant identification |
| localTimeZone | Local time zone information |
| terminalId | Unique terminal identification |
| chargeAmountVat | Tag carrying VAT amount charges and details |
| amount | VAT amount charged |
| currency | Currency of VAT amount charged indicated |
| flags | Tag carrying flags as array of strings |
| cardInstrument | Tag carrying card details |
| cardSchemeName | Scheme name description of the card |
| instrumentType | Type of instrument used for the card payment |
| name | Name on the card |
| identification | Unique card identification |
| creditorAccount | Tag carrying creditor account information |
| debtorAccount | Tag carrying debtor account information |
| identificationType | Type of identification of the account |
| identification | Account identification details |
| name | Name of the account holder |
| transactionInformation | Details of the transaction information |
| bankTransactionCode | Tag carrying transaction bank codes |
| domain | Domain details |
| domainCode | Domain code |
| family | Domain family details |
| familyCode | Domain family code |
| subFamily | Domain sub-family details |
| subFamilyCode | Domain sub-family code |
| proprietaryBankTransactionCode | Tag representing proprietary bank transaction code and details |
| code | Unique proprietary transaction code |
| issuer | Name of the issuer of the code |
| creditorAgent | Tag carrying creditor agent information |
| debtorAgent | Tag carrying debtor agent information |
| identificationType | Type of identification of the creditor/debtor account |
| identification | Unique identification details of the creditor/debtor account |
| postalAddress | Postal address of the creditor/debtor account |
| addressType | Address type on the creditor/debtor account |
| streetName | Street name on the creditor/debtor account |
| buildingNumber | Building number of the creditor/debtor account |
| postalCode | Postal code on the creditor/debtor |
| city | City of the creditor/debtor |
| country | Country of the creditor/debtor |
| shortAddress | Short address of the creditor/debtor |
| unitNumber | Unit number of the creditor/debtor |
| secondaryNumber | Secondary number of the creditor/debtor |
| district | District of the creditor/debtor |
| name | Name of the creditor/debtor |
| billDetails | Tag carrying bill details |
| billerId | Unique biller identification |
| billNumber | Bill number |
| billPaymentType | Payment type for the bill |
| links | Redirect link |
| self | Own link/URL details |
| meta | Meta tag |
| totalPages | Information displayed in terms of pages |
Updated 6 months ago