Exposes information relating to customer account state & servicing, authorisations, transactions and billing periods.
Endpoints
GetAccount
Returns standard account details including open date, credit limits, status etc.
/accounts/{accountId}
CreateAccount
Creates or onboards a new account.
/accounts
GetAccountAvailableLimits
Returns available credit limits (account and cash).
/accounts/{accountId}/available-limits
GetAccountBalances
Returns balance details including any pending debit or credit movements.
/accounts/{accountId}/balances
GetAccountSpendTypes
Retrieve detailed breakdown of all spend types and their balances and rates for the account at subledger level.
/accounts/{accountId}/balances/spend-types
GetBillingPeriods
Lists the billing periods for the given account.
/accounts/{accountId}/billing-periods
GetBillingPeriodBalances
Shows balances for the given billing period.
/accounts/{accountId}/billing-periods/{billingPeriodId}/balances
GetBillingPeriodSpendTypes
Shows billing period breakdown per spend type.
/accounts/{accountId}/billing-periods/{billingPeriodId}/spend-types
GetTransactionsForCurrentBillingPeriod
Lists the transactions for the current billing period.
/accounts/{accountId}/billing-periods/current/transactions
GetBillingPeriodTransactions
Lists the transactions for the given billing period.
/accounts/{accountId}/billing-periods/{billingPeriodId}/transactions
GetBillingPeriodDetails
Shows billing period details (balances and balance type breakdown).
/accounts/{accountId}/billing-periods/{billingPeriodId}
GetAccountPositions
Composite resource to return standard account details along with available limits, balances and dues.
/accounts/{accountId}/positions
GetTransactionActivities
Returns auths and transactions in a single response.
/accounts/{accountId}/transaction-activities
GetAccountDues
Returns any dues on the account including current due, requested payment, recommended extra payment, total arrears etc.
/accounts/{accountId}/dues
GetAccountArrears
Retrieve detailed breakdown of arrears information on the account.
/accounts/{accountId}/dues/arrears
GetAccountInterestRates
Returns account level interest rates.
/accounts/{accountId}/interest-rates
CreatePayment
Post a real time payment on the given account.
/accounts/{accountId}/payments
TransactionsSearch
Searches transactions for the given account.
/accounts/{accountId}/transactions
InterestTransactionAdjustment
Apply interest adjustment for the given transaction.
/accounts/{accountId}/transactions/{transactionId}/interests/adjustment
FeeTransactionAdjustment
Apply fee adjustment for the given transaction.
/accounts/{accountId}/transactions/{transactionId}/fees/adjustment
TransactionsAdjustmentsFees
Search fees transactions on given account.
/accounts/{accountId}/transactions/fees
GetTransactionsAdjustmentsInterests
Searches interest transactions for the given account.
/accounts/{accountId}/transactions/interests
GetAdjustmentReasons
Returns adjustment reasons.
/accounts/{accountId}/adjustments/reasons
AccountTransactionAdjustments
Apply adjustment to the account with any entry type (debit or credit).
/accounts/{accountId}/adjustments
GetAvailableTreatments
Provides list of available treatments that can be applied on to a given account.
/accounts/{accountId}/available-treatments
AddTreatment
Adds a treatment to an account
/accounts/{accountId}/treatments
RemoveTreatment
Removes a treatment from an account
/accounts/{accountId}/treatments/{treatmentId}
Models
Was this page helpful?