API Explorer

Account

2.0

Exposes information relating to customer account state & servicing, authorisations, transactions and billing periods.

GetAccount

Returns standard account details including open date, credit limits, status etc.

get

/accounts/{accountId}

CreateAccount

Creates or onboards a new account.

post

/accounts

GetAccountAvailableLimits

Returns available credit limits (account and cash).

get

/accounts/{accountId}/available-limits

GetAuthorisations

Lists the authorisations for an account.

get

/accounts/{accountId}/authorisations

GetAccountBalances

Returns balance details including any pending debit or credit movements.

get

/accounts/{accountId}/balances

GetAccountSpendTypes

Retrieve detailed breakdown of all spend types and their balances and rates for the account at subledger level.

get

/accounts/{accountId}/balances/spend-types

GetBillingPeriods

Lists the billing periods for the given account.

get

/accounts/{accountId}/billing-periods

GetBillingPeriodBalances

Shows balances for the given billing period.

get

/accounts/{accountId}/billing-periods/{billingPeriodId}/balances

GetBillingPeriodSpendTypes

Shows billing period breakdown per spend type.

get

/accounts/{accountId}/billing-periods/{billingPeriodId}/spend-types

GetTransactionsForCurrentBillingPeriod

Lists the transactions for the current billing period.

get

/accounts/{accountId}/billing-periods/current/transactions

GetBillingPeriodTransactions

Lists the transactions for the given billing period.

get

/accounts/{accountId}/billing-periods/{billingPeriodId}/transactions

GetBillingPeriodDetails

Shows billing period details (balances and balance type breakdown).

get

/accounts/{accountId}/billing-periods/{billingPeriodId}

GetAccountPositions

Composite resource to return standard account details along with available limits, balances and dues.

get

/accounts/{accountId}/positions

GetTransactionActivities

Returns auths and transactions in a single response.

get

/accounts/{accountId}/transaction-activities

GetAccountDues

Returns any dues on the account including current due, requested payment, recommended extra payment, total arrears etc.

get

/accounts/{accountId}/dues

GetAccountArrears

Retrieve detailed breakdown of arrears information on the account.

get

/accounts/{accountId}/dues/arrears

GetAccountInterestRates

Returns account level interest rates.

get

/accounts/{accountId}/interest-rates

CreatePayment

Post a real time payment on the given account.

post

/accounts/{accountId}/payments

TransactionsSearch

Searches transactions for the given account.

get

/accounts/{accountId}/transactions

InterestTransactionAdjustment

Apply interest adjustment for the given transaction.

put

/accounts/{accountId}/transactions/{transactionId}/interests/adjustment

FeeTransactionAdjustment

Apply fee adjustment for the given transaction.

put

/accounts/{accountId}/transactions/{transactionId}/fees/adjustment

TransactionsAdjustmentsFees

Search fees transactions on given account.

get

/accounts/{accountId}/transactions/fees

GetTransactionsAdjustmentsInterests

Searches interest transactions for the given account.

get

/accounts/{accountId}/transactions/interests

GetAdjustmentReasons

Returns adjustment reasons.

get

/accounts/{accountId}/adjustments/reasons

AccountTransactionAdjustments

Apply adjustment to the account with any entry type (debit or credit).

put

/accounts/{accountId}/adjustments

GetAvailableTreatments

Provides list of available treatments that can be applied on to a given account.

get

/accounts/{accountId}/available-treatments

AddTreatment

Adds a treatment to an account

post

/accounts/{accountId}/treatments

RemoveTreatment

Removes a treatment from an account

delete

/accounts/{accountId}/treatments/{treatmentId}

Models

Account Arrears Breakdown

Account Credit Limit

Account Balances

Account Dues

Account Spend Type

Account Status

AccountStatusType
string enum

Account Transaction Adjustment Request

Account Treatment

Instrument

Represents a request to add a treatment

Address of the merchant

AdjustmentReason

Amount

Authorisation

Instrument

Merchant

Details of an available child treatment

Available Credit Limits

Details of an available treatment

Billing Period (Statement date)

Boosted payment amount

Represents a request to create a new account.

CreatePaymentRequest

Created
object

Created Response

An Microsoft.AspNetCore.Mvc.ActionResult that returns a Created (201) response with a Location header.

Credit Limit

Credit Limit Increase Preference Indicator

CreditReleaseType
string enum

Credit Release Type

Current rates for the account

Customer

Cycle balances for the account

Account Delinquency Status and Level

Additional Enrichment Data for the authorisation (logo, geo location, receipt etc.)