Changelog

The NewDay Developer Portal is periodically updated when changes are made to API specifications. This changelog documents updates such as a new or deprecated endpoint, a new or changed field name or when additional information is added.

25 March 2025 Explore changes to Acquisitions 2.7

Acquisitions 2.7

Added

  • property balanceTransferOfferTermLength to schema at components/schemas/multiQuoteOfferV1/schema/properties/balanceTransferOfferTermLength
  • property purchaseOfferTermLength to schema at components/schemas/multiQuoteOfferV1/schema/properties/purchaseOfferTermLength

Replaced

  • info/version from 2.6 to 2.7 at info/version

17 March 2025 Explore changes to Acquisitions 2.6, Enhanced KYC 2.1, Core Credit 4.6, Core Credit 5.1

Acquisitions 2.6

Replaced

  • reference from #/components/schemas/createApplicationRequest to #/components/schemas/applicationCreateRequest at paths//v2/applications/post/requestBody/content/application/json/schema/$ref

Added

  • property state to schema at components/schemas/proofUploadResponse/schema/properties/state

Replaced

  • info/version from 2.5 to 2.6 at info/version

Enhanced KYC 2.1

Replaced

  • info/version from 2.0 to 2.1 at info/version

Core Credit 4.6

Added

  • optional parameter dateType at paths//accounts/{accountId}/transactions/get/parameters/dateType

Replaced

  • info/version from 4.5 to 4.6 at info/version

Updated

  • description of parameter treatmentId at paths//accounts/{accountId}/treatments/{treatmentId}/put/parameters/treatmentId

Updated

  • description of parameter treatmentId at paths//accounts/{accountId}/treatments/{treatmentId}/delete/parameters/treatmentId

Core Credit 5.1

Added

  • optional parameter dateType at paths//accounts/{accountId}/transactions/get/parameters/dateType
  • paths//accounts/{accountId}/flags
  • paths//accounts/{accountId}/flags/{flagId}

Replaced

  • info/version from 5.0 to 5.1 at info/version

Updated

  • description of parameter treatmentId at paths//accounts/{accountId}/treatments/{treatmentId}/put/parameters/treatmentId

Updated

  • description of parameter treatmentId at paths//accounts/{accountId}/treatments/{treatmentId}/delete/parameters/treatmentId

10 March 2025 Explore changes to Acquisitions 2.5

Acquisitions 2.5

Replaced

  • info/version from 2.4 to 2.5 at info/version

6 March 2025 Explore changes to Transaction 1.1, Customer Journey 2.5, Customer Journey 1.5

Transaction 1.1

Added

  • required constraint for property availableCreditPerSpendType at components/schemas/AccountOverviewResponse/properties/availableCreditPerSpendType
  • required constraint for property availableCreditPerSpendType at components/schemas/AccountOverviewResponse/properties/availableCreditPerSpendType
  • required constraint for property availableCreditPerSpendType at components/schemas/AvailableCreditResponse/properties/availableCreditPerSpendType
  • required constraint for property availableCreditPerSpendType at components/schemas/AvailableCreditResponse/properties/availableCreditPerSpendType

Removed

  • server with URL https://mtapi.dev-newdaytechnology.net/ams/transaction-service at servers/https://mtapi.dev-newdaytechnology.net/ams/transaction-service

Replaced

  • description for server with URL https://mtapi.stg-newdaytechnology.net/ams/transaction-service from "stg" to "Staging" at servers/https://mtapi.stg-newdaytechnology.net/ams/transaction-service/description
  • error response 422 at paths//account/{accountId}/auth/post/responses/422
  • error response 422 at paths//account/{accountId}/auth/{authorizationId}/reverse/post/responses/422
  • error response 422 at paths//heartbeat/get/responses/422
  • error response 422 at paths//healthcheck/get/responses/422
  • error response 422 at paths//account/{accountId}/transaction/post/responses/422
  • error response 422 at paths//account/{accountId}/interest/post/responses/422
  • error response 422 at paths//account/{accountId}/fee/post/responses/422
  • error response 422 at paths//account/{accountId}/refund/post/responses/422
  • error response 429 at paths//account/{accountId}/refund/post/responses/429
  • error response 422 at paths//account/{accountId}/adjustment/post/responses/422
  • error response 429 at paths//account/{accountId}/adjustment/post/responses/429
  • error response 422 at paths//account/{accountId}/transaction/{transactionId}/reverse/post/responses/422
  • error response 429 at paths//account/{accountId}/transaction/{transactionId}/reverse/post/responses/429
  • error response 422 at paths//account/{accountId}/transaction/{transactionId}/release/post/responses/422
  • error response 422 at paths//account/{accountId}/transaction/{transactionId}/status/put/responses/422
  • enum values from [Adjustment, CreditAdjustment, CreditRebalance, DebitAdjustment, Fee, FeeReversal, Interest, InterestCredit, InterestReversal, Payment, PaymentReversal, Purchase, Refund] to [Adjustment, CreditAdjustment, CreditReallocation, CreditRebalance, DebitAdjustment, Fee, FeeReversal, Interest, InterestCredit, InterestReversal, OpeningBalance, Payment, PaymentReversal, Purchase, Refund] at components/schemas/BalanceMovementType/enum
  • enum values from [ConfirmedFraud, NoStatus, ReportedFraud, SuspectedFraud] to [ConfirmedFraud, ConfirmedFraudChargeOff, ConfirmedFraudChargeback, ConfirmedFraudPartialChargeback, NoStatus, ReportedFraud, SuspectedFraud] at components/schemas/TransactionStatus/enum

Added

  • server with URL https://mtapi.newdaytechnology.net/ams/transaction-service at servers/https://mtapi.newdaytechnology.net/ams/transaction-service
  • content type text/plain at paths//account/{accountId}/refund/post/responses/429/content/text/plain
  • content type application/json at paths//account/{accountId}/refund/post/responses/429/content/application/json
  • content type text/json at paths//account/{accountId}/refund/post/responses/429/content/text/json
  • content type text/plain at paths//account/{accountId}/adjustment/post/responses/429/content/text/plain
  • content type application/json at paths//account/{accountId}/adjustment/post/responses/429/content/application/json
  • content type text/json at paths//account/{accountId}/adjustment/post/responses/429/content/text/json
  • content type text/plain at paths//account/{accountId}/transaction/{transactionId}/reverse/post/responses/429/content/text/plain
  • content type application/json at paths//account/{accountId}/transaction/{transactionId}/reverse/post/responses/429/content/application/json
  • content type text/json at paths//account/{accountId}/transaction/{transactionId}/reverse/post/responses/429/content/text/json
  • paths//reconciliation/{messageScope}
  • paths//support/account/{accountId}
  • paths//support/account/{accountId}/available-credit
  • paths//support/product/{productId}
  • paths//support/account/{accountId}/transaction/{transactionId}/delayed-payment-fix
  • property externalId to schema at components/schemas/CreateTransactionRequest/schema/properties/externalId
  • property reason to schema at components/schemas/CreateTransactionRequest/schema/properties/reason
  • property businessDate to schema at components/schemas/CreateTransactionReversalRequest/schema/properties/businessDate
  • property reason to schema at components/schemas/CreateTransactionReversalRequest/schema/properties/reason
  • property businessDate to schema at components/schemas/FeeRequest/schema/properties/businessDate
  • property reason to schema at components/schemas/FeeRequest/schema/properties/reason
  • property businessDate to schema at components/schemas/InterestRequest/schema/properties/businessDate
  • property reason to schema at components/schemas/InterestRequest/schema/properties/reason
  • property reason to schema at components/schemas/RefundRequest/schema/properties/reason

Replaced

  • info/version from 1.0 to 1.1 at info/version

Customer Journey 2.5

Added

  • property purchaseSimpleAnnualRate to schema at components/schemas/AccountV2/schema/properties/purchaseSimpleAnnualRate

Replaced

  • info/version from 2.4 to 2.5 at info/version

Customer Journey 1.5

Added

  • property purchaseSimpleAnnualRate to schema at components/schemas/Account/schema/properties/purchaseSimpleAnnualRate

Replaced

  • info/version from 1.4 to 1.5 at info/version

28 February 2025 Explore changes to Customer Journey 2.4

Customer Journey 2.4

Added

  • property id to schema at components/schemas/Customer/schema/properties/id

Replaced

  • info/version from 2.3 to 2.4 at info/version

26 February 2025 Explore changes to Core Credit 5.0

Core Credit 5.0

  • 🚀 A new major version was released

Replaced

  • info/version from 4.3 to 5.0 at info/version
  • parameter channel to Channel at all endpoints
  • parameter sub to Sub at all endpoints
  • parameter obo to Obo at all endpoints
  • parameter context-channel to Context-Channel at all endpoints
  • parameter context-sub to Context-Sub at all endpoints
  • parameter context-obo to Context-Obo at all endpoints
  • parameter api-version with changes from {"name":"api-version","in":"header","description":"Api Version","schema":{"type":"string"},"examples":{"Latest value":{"value":"5.0"}}} to {"name":"api-version","in":"header","description":"Api Version","required":true,"schema":{"type":"string"},"examples":{"Latest value":{"value":"5.0"}}} at paths//accounts/{accountId}/get/parameters/api-version
  • parameter api-version with changes from {"name":"api-version","in":"header","description":"Api Version","schema":{"type":"string"},"examples":{"Latest value":{"value":"5.0"}}} to {"name":"api-version","in":"header","description":"Api Version","required":true,"schema":{"type":"string"},"examples":{"Latest value":{"value":"5.0"}}} at paths//accounts/{accountId}/spend-types/get/parameters/api-version
  • behavior of property default from undefined to false at components/schemas/AddTreatmentRequest/properties/ignoreConflict/default
  • behavior of property default from undefined to false at components/schemas/UpdateTreatmentRequest/properties/ignoreConflict/default

Added

  • paths//accounts/{accountId}/positions

24 February 2025 Explore changes to Core Credit 4.3

Core Credit 4.3

Removed

  • paths//accounts/{accountId}/billing-periods/{billingPeriodId}
  • paths//accounts/{accountId}/positions

Added

  • paths//accounts/{accountId}/available-flags

21 February 2025 Explore changes to Order Processing Internal 1.2

Order Processing Internal 1.2

  • Renamed

Order Processing to Order Processing Internal.

Added

  • paths//account/{accountId}/spend-options
  • paths//account/{accountId}/transaction/{transactionId}/spend-option
  • paths//account/{accountId}/authorisation
  • paths//account/{accountId}/authorisation/{authorisationId}/reverse
  • paths//account/{accountId}/authorisation/{authorisationId}/settle
  • paths//account/{accountId}/transaction/refund
  • paths//account/{accountId}/transaction/{transactionId}/refund
  • paths//admin/account/{accountId}/spend-options
  • paths//admin/account/{accountId}/transaction/{transactionId}/spend-option
  • paths//account/{accountId}/chargeback
  • paths//debug/organisationUnit/{organisationUnitId}/configuration
  • paths//debug/accounts/{accountId}
  • paths//debug/accounts/{accountId}/stream
  • paths//debug/external-accounts/{accountExternalId}
  • paths//debug/accounts
  • paths//debug/fiserv/account/{accountNumber}
  • paths//debug/fiserv/authorisation/{authorisationId}
  • paths//debug/fiserv/product/{logo}
  • paths//debug/customers/search/{customerRef}
  • paths//debug/fraud/{customerRef}/orchestrations/{orchestrationId}/device-profile
  • paths//debug/externalConfiguration/{code}
  • paths//debug/applications/{applicationId}
  • paths//debug/merchants/{merchantId}/rate-card-association
  • paths//heartbeat
  • paths//healthcheck
  • paths//advanced-healthcheck
  • paths//merchant/{customerRef}/authorisation/{authorisationId}/upward-adjustment
  • paths//support/products/{productId}
  • paths//support/merchants/{merchantId}
  • paths//support/merchants/{merchantId}/reconciliation/{settlementDate}
  • paths//support/merchants/{merchantId}/rate-card

20 February 2025 Explore changes to Offer 1.4, Order Processing 1.2

Offer 1.4

Removed

  • required property riskBands at components/schemas/GetOfferItem/required

Replaced

  • info/version from 1.3 to 1.4 at info/version

Order Processing 1.2

Added

  • paths//merchant/{customerRef}/authorisation/{authorisationId}/upward-adjustment

12 February 2025 Explore changes to Order Processing 1.2

Order Processing 1.2

Replaced
  • error response 429 at paths//merchant/{customerRef}/transaction/{transactionId}/refund/post/responses/429
Replaced
  • info/version from 1.1 to 1.2 at info/version

11 February 2025 Explore changes to Offer 1.3

Offer 1.3

Added

  • property riskBands to schema at components/schemas/GetOfferItem/schema/properties/riskBands

Replaced

  • info/version from 1.2 to 1.3 at info/version

6 February 2025 Explore changes to Core Credit 3.9, Customer Journey 2.3

Core Credit 3.9

Added

  • property purchaseSimpleAnnualRate to schema at components/schemas/GetAccountInterestRatesResponse/schema/properties/purchaseSimpleAnnualRate
  • property cashSimpleAnnualRate to schema at components/schemas/GetAccountInterestRatesResponse/schema/properties/cashSimpleAnnualRate
  • server with URL https://api.uat-newdaycards.com/core-credit at servers/https://api.uat-newdaycards.com/core-credit
  • server with URL https://api.newdaycards.com/core-credit at servers/https://api.newdaycards.com/core-credit

Replaced

  • info/version from 3.8 to 3.9 at info/version

Customer Journey 2.3

Replaced

  • error response 500 at paths//customer-journey-details/get/responses/500
  • error response 500 at paths//customer-journey-details/{customerRef}/get/responses/500

Added

  • property apr to schema at components/schemas/AccountV2/schema/properties/apr

Replaced

  • info/version from 2.2 to 2.3 at info/version

5 February 2025 Explore changes to Customer 1.0

Customer 1.0

Replaced

  • error response 400 at paths//customers/{customerId}/get/responses/400
  • error response 500 at paths//customers/{customerId}/get/responses/500
  • error response 400 at paths//customers/get/responses/400
  • error response 500 at paths//customers/get/responses/500
  • error response 400 at paths//customers/search/post/responses/400
  • error response 500 at paths//customers/search/post/responses/500
  • error response 503 at paths//customers/search/post/responses/503
  • error response 400 at paths//customers/supported-formats/email-address/post/responses/400
  • error response 500 at paths//customers/supported-formats/email-address/post/responses/500
  • error response 400 at paths//customers/supported-formats/phone-number/post/responses/400
  • error response 500 at paths//customers/supported-formats/phone-number/post/responses/500

Added

  • property id to schema at components/schemas/Address/schema/properties/id
  • property flatNumber to schema at components/schemas/AddressComponents/schema/properties/flatNumber
  • property street to schema at components/schemas/AddressComponents/schema/properties/street
  • property locality to schema at components/schemas/AddressComponents/schema/properties/locality
  • property hasVulnerabilities to schema at components/schemas/Customer/schema/properties/hasVulnerabilities
  • property hasSupportNeeds to schema at components/schemas/Customer/schema/properties/hasSupportNeeds

3 February 2025 Explore changes to Rate Card 3.0

Rate Card 3.0

Removed

paths//merchants/{merchantId}/rate-cards/{rateCardId}/association/put

Replaced

  • info/version from 2.3 to 3.0 at info/version

27 January 2025 Explore changes to Customer Journey 2.2

Customer Journey 2.2

Replaced

  • server with URL to https://dapi.stg-newdaytechnology.net/customerjourney
  • server with URL to https://api.uat-newdaycards.com/customerjourney
  • server with URL to https://dapi.newdaytechnology.net/customerjourney
  • server with URL to https://api.newdaycards.com/customerjourney
  • info/version from 2.1 to 2.2 at info/version

Added

  • property accountNumber to schema at components/schemas/AccountV2/schema/properties/accountNumber

24 January 2025 Explore changes to Rate Card 2.3

Rate Card 2.3

Removed

  • property spendDetailsId from schema at components/schemas/GetRateCardResponseItem/schema/properties/spendDetailsId
  • property transactionDetailsId from schema at components/schemas/GetRateCardResponseItem/schema/properties/transactionDetailsId

Replaced

  • info/version from 2.2 to 2.3 at info/version

17 January 2025 Explore changes to Offer 1.2, Rate Card 2.2, Order Processing 1.0

Offer 1.2

Removed

  • required property rate at components/schemas/CreateOfferRequest/required updated to nullable
  • required property rateType at components/schemas/GetOfferItem/required updated to nullable

Replaced

  • enum values from [Instalment] to [BNPL, Instalment] at components/schemas/OfferType/enum

Added

  • optional parameter offerType at paths//offer/get/parameters/offerType

Replaced

  • info/version from 1.1 to 1.2 at info/version

Rate Card 2.2

Replaced

  • enum values from [Instalment, Purchase] to [BNPL, Instalment, Purchase] at components/schemas/SpendType/enum

Added

  • property riskBands to schema at components/schemas/RateCardRecord/schema/properties/riskBands

Replaced

  • info/version from 2.1 to 2.2 at info/version

Order Processing 1.0

Replaced

  • enum values from [Instalment, Purchase] to [BNPL, Instalment, Purchase] at components/schemas/SpendType/enum

  • info/version from 1.0 to 1.1 at info/version

13 January 2025 Explore changes to Core Credit 3.8, Customer Journey 2.1, Regular Payments 1.3

Core Credit 3.8

Added

  • optional parameter channel, sub and obo on all endpoints
  • property expiresAfterNumberOfBillingPeriods to schema at components/schemas/AccountTreatment/schema/properties/expiresAfterNumberOfBillingPeriods

Replaced

  • info/version from 3.7 to 3.8 at info/version

Customer Journey 2.1

Added

  • optional parameter channel, sub and obo on all endpoints

Replaced

  • info/version from 2.0 to 2.1 at info/version

Regular Payments 1.3

Added

  • optional parameter channel, sub and obo on all endpoints

Replaced

  • info/version from 1.2 to 1.3 at info/version

3 January 2025 Explore changes to Merchant 1.1, Rate Card 2.1

Merchant 1.1

Added

  • optional parameter includePurged at paths//merchants/get/parameters/includePurged

Replaced

  • info/version from 1.0 to 1.1 at info/version

Rate Card 2.1

Removed

  • parameter idempotency-key at paths//rate-cards/{rateCardId}/activate/put/parameters/idempotency-key

Replaced

  • enum values from [Active, Draft, Expired] to [Activating, Active, Draft, Expired] at components/schemas/RateCardStatus/enum
  • info/version from 2.0 to 2.1 at info/version

Added

  • property processingComplete to schema at components/schemas/GetRateCardResponse/schema/properties/processingComplete

16 December 2024 Explore changes to Offer 1.1

Offer 1.1

Added

  • optional parameter organisationUnitId at paths//offer/get/parameters/organisationUnitId
  • property organisationUnitId to schema at components/schemas/CreateOfferRequest/schema/properties/organisationUnitId
  • property organisationUnitId to schema at components/schemas/GetOfferItem/schema/properties/organisationUnitId
  • property organisationUnitId to schema at components/schemas/UpdateOfferRequest/schema/properties/organisationUnitId

Replaced

  • info/version from 1.0 to 1.1 at info/version

12 December 2024 Explore changes to Customer Journey 2.0

Customer Journey 2.0

Replaced

  • info/version from 1.1 to 2.0 at info/version
  • parameter api-version with changes from {"name":"api-version","in":"header","description":"Api Version","schema":{"type":"string","default":"1.0"}} to {"name":"api-version","in":"header","description":"Api Version","schema":{"type":"string","default":"2.0"}} at paths//customer-journey-details/get/parameters/api-version
  • parameter api-version with changes from {"name":"api-version","in":"header","description":"Api Version","schema":{"type":"string","default":"1.0"}} to {"name":"api-version","in":"header","description":"Api Version","schema":{"type":"string","default":"2.0"}} at paths//customer-journey-details/{customerRef}/get/parameters/api-version

21 November 2024 Explore changes to Core Credit 3.7

Core Credit: 3.7

Added

  • GetAvailableTreatments, AddTreatment, UpdateTreatment, RemoveTreatment endpoints

19 November 2024 Explore changes to Core Credit 3.6

Core Credit: 3.6

Added

  • New field to GetAccountPositions endpoint GetAccountPositionsResponse.HasRegularPayment
  • New field to GetAccount endpoint GetAccountResponse.HasRegularPayment
  • New field to GetAccountSpendTypes endpoint GetAccountSpendTypesResponse.Value.instalment.NextCycleAmount

7 November 2024 Explore changes to Regular Payments 1.2

Regular Payments: 1.2

Added

  • 202 Accepted response on SetupRegularPayment endpoint
  • New field to SetupRegularPayment endpoint SetupOrUpdateRegularPaymentResponse.CollectionDate
  • New field to SetupRegularPayment endpoint SetupOrUpdateRegularPaymentResponse.ChangeEffectiveInCycle
  • New field to SetupRegularPayment endpoint SetupOrUpdateRegularPaymentResponse.NextCycleCollectionDate
  • New field to GetRegularPayment endpoint GetRegularPaymentResponse.Projected.NextCycleCollectionDate
  • New field to GetRegularPayment endpoint GetRegularPaymentResponse.Collection.DateAdjustmentType

Replaced

  • Field description updated on GetRegularPayment endpoint GetRegularPaymentResponse.ProjectedRegularPayment.CollectionDate

6 November 2024 Explore changes to Acquisitions 2.4

Acquisitions: 2.4

Added

  • New subStates of customerCancel and agentCancel to the customerCreationResponse model for the CreateCustomer endpoint. Channel enums casing updated to camelCase

30 October 2024 Explore changes to Customer Journey 1.1, Regular Payments 1.1

Customer Journey: 1.1

Added

  • New property to GetCustomerJourneyDetailsUsingToken endpoint CustomerJourneyResponse.Accounts.Dues
  • New property to GetCustomerJourneyDetailsUsingToken endpoint CustomerJourneyResponse.Accounts.Dues.Arrears
  • New property to endpoint GetCustomerJourneyDetailsUsingCustomerRef CustomerJourneyResponse.Accounts.Dues
  • New property to endpoint GetCustomerJourneyDetailsUsingCustomerRef CustomerJourneyResponse.Accounts.Dues.Arrears
  • Optional header api-version

Regular Payments: 1.1

Replaced

  • Field updated on GetRegularPayment endpoint GetRegularPaymentResponse.ProjectedRegularPayment.Amount.Value from not null to nullable

23 October 2024 Explore changes to Core Credit 3.4

Core Credit: 3.4

Added

  • New field to GetAccountSpendTypes endpoint GetAccountAvailableLimitsResponse.Value.Instalment.CompletedAt

9 October 2024 Explore changes to Core Credit 3.3

Core Credit: 3.3

Added

  • New field to GetTransactionActivities endpoint GetTransactionActivitiesRequest.InstalmentEligibility
  • New field to GetTransactionsForCurrentBillingPeriod endpoint GetBillingPeriodTransactionsRequestQuery.InstalmentEligibility
  • New field to TransactionsSearch endpoint TransactionsSearchRequest.InstalmentEligibility
  • New field to GetAccountPositions endpoint GetAccountPositionsResponse.Dues.RemainingPaymentRequested
  • New field to GetAccountDues endpoint GetAccountPositionsResponse.Dues.RemainingPaymentRequested
  • New Enum value to GetAccountPositions endpoint GetAccountPositionsResponse.Flags.InstalmentStatus

4 October 2024 Explore changes to Core Credit 3.2

Core Credit: 3.2

Added

  • New field to GetAccountInterestRates endpoint GetAccountInterestRatesResponse.DefaultFeeAer

Replaced

18 September 2024 Explore changes to Rate Card 2.0

Rate Card: 2.0

Replaced

  • Updated response codes on CreateRateCardsFromRecords and CreateRateCardsFromGrid endpoints to return 202 on success

12 September 2024 Explore changes to Account 3.1

Account: 3.1

Added

  • New fields to GetAccountSpendTypes endpoint GetAccountSpendTypesResponse.CurrentRates.ExpiresAt and GetAccountSpendTypesResponse.GoToRates
  • New field to GetAccountPositions endpoint GetAccountPositionsResponse.IsPlanned
  • New endpoint added TransactionsSearchByTransactionId

Replaced

  • Updated GetAccountSpendTypes endpoint InstalmentStatus enum from Completed to Complete
  • Response codes descriptions updated on all endpoints, 200: Success to Ok, 422: Client Error to Unprocessable Content, 500: Server Error to Internal Server Error, 501: Server Error to Not Implemented

4 September 2024 Explore changes to Account 3.0, Regular Payments 1.0

Account: 3.0

Replaced

  • Updated server URLs

Regular Payments: 1.0

Added

  • Server URLs

29 August 2024 Explore changes to Account 3.0

Account: 3.0

Removed

  • CreateAccount, CancelInstalmentPlan, GetCycleDays, ChangeBillingCycleDay, GetChargeOffReasons, SetChargeOffStatus, ReverseChargeOffStatus, CreateAlternateMinimumDues, DeleteAlternateMinimumDue, CreateMemo, GetMemoCategories, GetAccountMemos, CreatePayment, CreatePaymentReversal, InterestTransactionAdjustment, FeeTransactionAdjustment, GetTransactionsAdjustmentsInterests, TransactionsAdjustmentsFees, GetAdjustmentReasons, AccountTransactionAdjustments, GetAvailableTreatments, AddTreatment, UpdateTreatment, RemoveTreatment endpoints

18 August 2024 Explore changes to Acquisitions 2.0, eKYC 2.0

Acquisitions: 2.0

Added

  • New Substate enum value verificationRequired

Replaced

  • Corrected nullability of some fields

eKYC: 2.0

Replaced

  • Updated server descriptions

27 June 2024 Explore changes to Acquisitions 2.1

Acquisitions: 2.1

Added

  • New StateMapper updates
  • Device information header

Removed

  • All references to ChosenPaymentDueDate property

Replaced

  • Corrected nullability of some fields

30 May 2024 Explore changes to Acquisitions 2.0

Acquisitions: 2.0

Added

  • New ChosenPaymentDayOfMonth property on the ApplicationCreate and ApplicationUpdate endpoints

3 May 2024 Explore changes to Account 2.0

Account: 2.0

Added

  • Instalment object to GetAccountSpendType endpoint
  • AddTreatment and RemoveTreatment endpoints

24 April 2024 Explore changes to Regular Payments 1.0, Acquisitions 2.0

Regular Payments: 1.0

Added

  • Regular Payments API

Acquisitions: 2.0

Added

  • New states to the Eligibility, Decison and CreateCustomer endpoints

Removed

  • Incorrect nullable properties from multiQuote endpoint

22 April 2024 Explore changes to Customer Journey 1.0

Customer Journey: 1.0

Added

  • isAccessBlocked and isAccessLocked fields to the Customer Journey Details (Using CustomerRef) endpoint

Replaced

  • Updated audit header names from channel, sub and obo to context-channel, context-sub and context-obo on all endpoints
  • Updated descriptions and examples on all endpoints

17 April 2024 Explore changes to Account 2.0

Account: 2.0

Added

  • Account API

9 April 2024 Explore changes to Acquisitions 2.0

Acquisitions: 2.0

Added

  • New occupation property on the Create and Update application endpoints
  • New state (QuoteSigned) to the Signature endpoint
  • Four values to the channel enum for the Create, Update and Retrieve Application endpoints

27 March 2024 Explore changes to Acquisitions 2.0, eKYC 2.0

Acquisitions: 2.0

Added

  • Problem details descriptions to all endpoints

eKYC: 2.0

Added

  • Problem details descriptions to all endpoints

Removed

  • Invalid status enum values from Application OTP and Penny Drop Initiate and Validate endpoints

Replaced

  • Improved bad request messaging on Application OTP and Penny Drop Initiate and Validate endpoints

26 March 2024 Explore changes to Order Processing 1.0, Rate Card 1.0, Offer 1.0, Merchant 1.0

Order Processing: 1.0

Replaced

  • Updated production server URL

Rate Card: 1.0

Replaced

  • Updated production server URL

Offer: 1.0

Replaced

  • Updated production server URL

Merchant: 1.0

Replaced

  • Updated production server URL

22 March 2024 Explore changes to Rate Card 1.0

Rate Card: 1.0

Added

  • New POST endpoint Create Rate Card From Records and new PUT endpoint Update Rate Card From Records, to create and update a rate card from a list of records

7 March 2024 Explore changes to Order Processing 1.0

Order Processing: 1.0

Replaced

  • Retrieve Spend Options endpoint renamed to Spend Options For CustomerRef and Retrieve Preboarding Spend Options endpoint renamed to Spend Options For Product

5 March 2024 Explore changes to Customer Journey 1.0

Customer Journey: 1.0

Replaced

  • Updated examples, descriptions, server names and error response descriptions for all endpoints

4 March 2024 Explore changes to Customer Journey 1.0

Customer Journey: 1.0

Replaced

  • Updated examples for Customer Journey Details (Using token) and Customer Journey Details (Using CustomerRef) endpoints

28 February 2024 Explore changes to Acquisitions 2.0, eKYC 2.0

Acquisitions: 2.0

Added

  • Server descriptions
  • New substate enum values creditLock and existingCust

eKYC: 2.0

Added

  • Server descriptions
  • Optional journeyId field, now it’s on all four endpoints OTP Initiate, OTP Validate, Penny Drop Initiate and Penny Drop Validate

26 February 2024 Explore changes to Customer Journey 1.0

Customer Journey: 1.0

Added

  • Mandatory header context-tenant-id
  • Optional headers channel sub obo
  • Aer, CustomerRef, Evidence and Kyc objects to the response

Replaced

  • Updated server URLs
  • Header customerAccessToken changed to customer-access-token

19 February 2024 Explore changes to Order Processing 1.0

Order Processing: 1.0

Replaced

  • Initiate endpoint customer-access-token header updated to optional

15 February 2024 Explore changes to Order Processing 1.0

Order Processing: 1.0

Replaced

  • Spend Options endpoint now has basketAmount as optional
  • Improved error response documentation

2 February 2024 Explore changes to Rate Card 1.0, Finance Plans 1.0

Rate Card: 1.0

Added

  • New GET endpoint Retrieve All Rate Cards

Finance Plans: 1.0

Added

  • Endpoint descriptions

29 January 2023 Explore changes to Order Processing 1.0

Order Processing: 1.0

Added

  • New POST endpoint Initiate

18 January 2023 Explore changes to Order Processing 1.0, Rate Card 1.0, Offer 1.0, Merchant 1.0

Order Processing: 1.0

Replaced

  • Renamed idempotency header from request-id to idempotency-key for POST endpoints
  • Updated server URLs

Rate Card: 1.0

Replaced

  • Renamed idempotency header from request-id to idempotency-key for POST endpoints
  • Updated server URLs

Offer: 1.0

Replaced

  • Renamed Idempotency header from request-id to idempotency-key for POST endpoints
  • Updated server URLs

Merchant: 1.0

Replaced

  • Renamed Idempotency header from request-id to idempotency-key for POST endpoints
  • Updated server URLs

17 January 2023 Explore changes to Acquisitions 2.0

Acquisitions: 2.0

Added

  • Field creditLimitIncreasePreference on the Create Application endpoint
  • Field creditLimit to the Create Customer endpoint
  • Field riskScore to the Eligibility and Decision endpoints

Removed

  • unsolicitedCreditLimitIncrease on the Create Application endpoint

Replaced

  • Updated field title on shipping address to an enum

16 January 2023 Explore changes to Order Processing 1.0, Rate Card 1.0, Offer 1.0, Merchant 1.0

Order Processing: 1.0

Added

  • Idempotency header to the Authorise, Settle, Reverse and Refund endpoints

Rate Card: 1.0

Added

  • Idempotency header to the Create Ratecard Association, Remove Rate Card Association, Create Rate Card, Activate Rate Card and Expire Rate Card

Offer: 1.0

Added

  • Idempotency header to the Create Offer endpoint

Merchant: 1.0

Added

  • Idempotency header to the Create Merchant endpoint

5 January 2023 Explore changes to Customer Journey 1.0

Customer Journey: 1.0

Added

  • CustomerAccessToken header to the Customer Journey Details (using token) endpoint

Replaced

  • Updated field descriptions

13 December 2023 Explore changes to Acquisitions 2.0

Acquisitions: 2.0

Added

  • Fields balanceTransferAmount and chosenPaymentDueDate on multiQuote

8 December 2023 Explore changes to Customer Journey 1.0

Customer Journey: 1.0

Added

  • Customer Journey API

5 December 2023 Explore changes to Order Processing 1.0, Rate Card 1.0, Offer 1.0, Merchant 1.0

Order Processing: 1.0

Added

  • Error descriptions to all endpoints for error codes: 401, 403, 429, 500, 502, 503, 504

Rate Card: 1.0

Added

  • Error descriptions to all endpoints for error codes: 401, 403, 429, 500, 502, 503, 504

Offer: 1.0

Added

  • Error descriptions to all endpoints for error codes: 401, 403, 429, 500, 502, 503, 504

Merchant: 1.0

Added

  • Error descriptions to all endpoints for error codes: 401, 403, 429, 500, 502, 503, 504

Replaced

  • Various fields amended from nullable to required: organisationUnitId, IndustryType, companyRegistrationNumber, averageTransactionValue, town, contractStartdate, description, retailer
  • Various fields amended from required to nullable: name branch in bankDetails and telephone in alternateContacts
  • Other field changes made: averageTransactionValue is now in amount format, vatNumber is mandatory if VAT is applicable and field name id became merchantId