All notable changes to the API definition will be recorded here.
The format is based on Keep a Changelog, and this project adheres to Semantic Versioning
- Add
dependentRequired
field to the Schema component for Payment Constraint GET endpoint.
- Add x-beta field to the Yapily Constraints endpoints and define enum types explicitly
- Add public endpoints to use Yapily Constraints
- Included the
hostedPaymentId
andconsentId
fields on the Yapily Hosted Pages GET endpoint
- Fixed POST/consent-auth-code example
- Added endpoints to use Yapily Hosted Pages
- Removed outdated references to CBI Globe
- Fixed Get Payment Details example
- Modified descriptions for Authorisation endpoints
- Update
titles
for all the fields associated withPaymentRequest
- Updated
paymentScheme
description with new payment scheme of typeTRANSFER
- Included missing
count
field in themeta
property of theApiListResponseOfRealTimeTransaction
object
- Added additional fields to
selectedScaMethod
to showinformation
anddata
useful to PSU when authenticating embedded consents
- Added get all refunds endpoint
- Included
x-yapily-features
for endpoints - Included optional headers for
/pre-auth-requests
and/payment-pre-auth-requests
endpoint - Included raw response for VRP endpoints
- Modified response for
/pre-auth-requests
and/payment-pre-auth-requests
endpoint - Modified endpoint path from
/users/{userUuid}/profile
to/users/{userUuid}/profile/transaction-groups
- Modified description, examples, typos for various endpoints and attributes
- Included
complianceData
object in the VRP consents endpoints
- Create refund and get refund by id
- Get client by id and delete beneficiary
- Virtual account error response examples
- Payer name isn't required but the field was marked as mandatory in its description. This change updates the field description.
- ApplicationUser domain alreay has a column createdAt which is not used in OAS models. This change updates the models of applicationuser to use createdAt in request and response
- Add Realtime transactions endpoint
- Fix regex pattern causing sdk issue
- Updated schema and examples for consent endpoints
- Add originalPaymentId to VirtualAccountPayment body
- Add Create Virtual Account Client and Get Virtual Account Clients endpoints
- Add consent extend endpoint
- Update schema for Financial Profile balance prediction endpoint
- Update schema for Financial Profile endpoints
- Updated VRP GET payment details payment ID path parameter to non-UUID format
- Use new error block in variable recurring payments and virtual accounts endpoints
- Add TransactionMutability to Transaction response
- Add variable recurring payments endpoints for beta
- Remove VirtualAccountIdentification and VirtualAccountIdentificationType.
- Reuse AccountIdentification and AccountIdentification for virtual accounts services.
- Add virtual accounts endpoints for private beta
- Publishing new notifications endpoints for private beta
- Miscellaneous updates to improve documentations
- New end point POST /payment-pre-auth-requests was added to support CBI Globe's pre-authorisation process
- The Feature enum was extended to include INITIATE_ONETIME_PRE_AUTHORISATION_PAYMENTS
- The financial profile API's response, was enhanced to include arrays for newly introduced recentlyTerminatedIncomeStreams and recentlyTerminatedExpenditureStreams. See GET /users/{userUuid}/profile
- A default value of OTHER to paymentContextType
- All occurrences of account identifiers in existing definitions for Account, Payee, Payer and RefundAccount updated to an array of unique items matching the platform's implementation.
- Unnecessary enumeration representing http status codes from the ApiError definition.
- The first published OpenAPI Specification used to drive Yapily's contract first development approach.