Docs

Core Credit

3.7

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

overview

api reference

Environment URLs

EnvironmentBase URL
NDT Staginghttps://dapi.stg-newdaytechnology.net/core-credit
NDT Productionhttps://dapi.newdaytechnology.net/core-credit

Endpoints

get
/accounts/{accountId}
get
/accounts/{accountId}/available-limits
get
/accounts/{accountId}/spend-types
get
/accounts/{accountId}/authorisations
get
/accounts/{accountId}/balances
get
/accounts/{accountId}/billing-periods
get
/accounts/{accountId}/billing-periods/{billingPeriodId}/balances
get
/accounts/{accountId}/billing-periods/{billingPeriodId}/spend-types
get
/accounts/{accountId}/billing-periods/current/transactions
get
/accounts/{accountId}/billing-periods/{billingPeriodId}/transactions
get
/accounts/{accountId}/billing-periods/{billingPeriodId}
get
/accounts/{accountId}/positions
get
/accounts/{accountId}/dues
get
/accounts/{accountId}/dues/arrears
get
/accounts/{accountId}/interest-rates
get
/accounts/{accountId}/transactions
get
/accounts/{accountId}/transactions/{transactionId}
get
/accounts/{accountId}/available-treatments
post
/accounts/{accountId}/treatments
put
/accounts/{accountId}/treatments/{treatmentId}
delete
/accounts/{accountId}/treatments/{treatmentId}

GetAccount

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

get

/accounts/{accountId}

GetAccountAvailableLimits

Returns available credit limits (account and cash).

get

/accounts/{accountId}/available-limits

GetAccountSpendTypes

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

get

/accounts/{accountId}/spend-types

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

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

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

TransactionsSearch

Searches transactions for the given account.

get

/accounts/{accountId}/transactions

TransactionsSearchByTransactionId

Searches specific transactions for the given account and transaction identifier.

get

/accounts/{accountId}/transactions/{transactionId}

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

UpdateTreatment

Update an existing treatment to either change any of its applicable attributes or swap it with a different treatment given its validation criteria is successful

put

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

RemoveTreatment

Removes a treatment from an account

delete

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

Models

Account Arrears Breakdown

Account Credit Limit

AccountFlag•
string enum

An individual memo

Account Balances

Account Dues

Account Spend Types

Account Status

Account Transaction Adjustment Request

Account Treatment

Instrument

Represents a request to add a treatment

Address of the merchant

AdjustmentReason

Alternate minimum payment due details

Amount

Authorisation

Instrument

Merchant

Details of an available child treatment

Available Credit Limits

Details of an available treatment

A Billing Cycle Day/Payment Due Day pair

Billing Period (Statement date)

Boosted payment amount

Cancel Instalment Plan Request

ChangeBillingCycleDayRequest

Change Billing Cycle Day Response

ChargeOff Reason

Close account request

Closure reason

Details showing whether a transaction is eligible for conversion, i.e. to instalment plan

Represents a request to create a new account.

CreateAlternateMinimumDuesRequest

Request for creating a new instalment plan for given transactions

CreateMemoRequest

CreatePaymentRequest

Created•
object

Created Response

Credit Limit

Credit Limit Increase Preference Indicator

CreditReleaseType•
string enum

Credit Release Type

Current rates for the account

Customer

CustomerType•
string enum

Cycle Details

Cycle balances for the account

Account Delinquency Status and Level

DomainAmount•
number(double)

Eligibility status of the account

EligibilityStatusValue•
string enum

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

Foreign Currency Amount

GenerateQuoteRequest

GenerateQuoteResponse

Account Arrears Response

Available credit limits (account and cash)

GetAccountBalancesResponse

Get account closure reason response

AccountDuesBreakdown

Get Account Interest Rates

Provides list of account memo notes in order of their creation

GetAccountPersistentDebtQuoteResponse

Get Account Persistent Debt Response

Get AccountPositions Response

Get Account Response

Spend Type breakdown applicable for the given account and billing Period

Collection of reasons

Get Authorisations Response

Collection of available account treatments

Billing Period Balances Response

Billing Period Details

Get Billing Period Balance Types response

Get Billing Period Transactions Response

Collection of Billing Periods (Statement dates)

Collection of charge-off reasons

Returns all billing cycle days with its respective payment due days and eligibility status to change billing cycle date

Memo Categories

Transaction Activities

Get Transactions Adjustments Fees Response

Collection of interest transactions

Details of rates that the account will move to once the current rates expire

IOutputFormatter•
object

Details of instalments

InstalmentPlanType•
string enum

Status of the instalment plan

Last Payment details on the account

Linked Account Attributes to indicate, if the account has been upgraded

Memo Category

Merchant

Merchant category code and description associated with the merchant

Information associated with the physical location of the purchase

Merchant Object model including address, logos and location details

NoContent•
object

No Content Response

Opt Out

PartialReageRequest

Paydown Plan

PayDown Term

Pay Down Term Customer Selected

Payment Due

Pending changes from previously submitted request

Includes Digital purchase receipt URL

Quote

Recommended Extra Payment for the account

Repayment term

Result status of the Purchase Receipt criteria

Charges off an account based on provided reason

Spend Type

Status

Account Sub-Treatment

3D Secure verification attributes

Transaction

Authorisation

TransactionActivityType•
string enum

Transaction Activity Type

Transaction

Instrument

Balance

Transactions Search Response

Updates Credit Limit Increase Preference for given account

Update Credit Limit Request

Represents a request to add a treatment

Was this page helpful?