Payment Services API release notes 2022 Q4
Payment Services API collection
Released to production
API |
Version
|
Change Type
|
Feature
|
Details
|
Released to Production
|
3 |
breaking change, improvement |
paymentOrderID retirement |
Parameter paymentID is populated with paymentOrderID value in version=2. In order to be aligned to global ConnectPay terminology, paymentOrderID will be retired and therefore a new version, version=3 is created. In version=3, we use paymentOrderNo value as unique payment identification, which is passed to paymentID parameter in the response body. version=2 where paymentID is populated with paymentOrderID value is supported until 17th April 2023. After this date, only version=3 will be available. |
Jul 5, 2022 |
|
4 |
breaking change, improvement |
paymentOrderID retirement |
Parameter paymentID is populated with paymentOrderID value in version=3. In order to be aligned to global ConnectPay terminology, paymentOrderID will be retired and therefore a new version, version=4 is created. In version=4, we use paymentOrderNo value as unique payment identification, which is passed to paymentID parameter. version=3 where paymentID is populated with paymentOrderID value is supported until 17th April 2023. After this date, only version=4 will be available. |
Jul 5, 2022 |
|
3 |
breaking change, improvement |
paymentOrderID retirement |
Parameter paymentID is populated with paymentOrderID value in version=3. In order to be aligned to global ConnectPay terminology, paymentOrderID will be retired and therefore a new version, version=4 is created. In version=4, we use paymentOrderNo value as unique payment identification, which is passed to paymentID parameter. version=3 where paymentID is populated with paymentOrderID value is supported until 17th April 2023. After this date, only version=4 will be available. |
Jul 5, 2022 |
|
3 |
breaking change, improvement |
paymentOrderID retirement |
Parameter paymentID is populated with paymentOrderID value in version=2. In order to be aligned to global ConnectPay terminology, paymentOrderID will be retired and therefore a new version, version=3 is created. In version=3, we use paymentOrderNo value as unique payment identification, which is passed to paymentID parameter. version=2 where paymentID is populated with paymentOrderID value is supported until 17th April 2023. After this date, only version=3 will be available. |
Jul 5, 2022 |
|
1 |
non-breaking change, new feature |
New API to receive best payment rail options |
This is a new API which could be used to receive the best payment rail option calculated by ConnectPay. Best payment rail is calculated based on payment’s eligibility for certain payment rails and fastest routing option. |
Nov 22, 2022 |
|
2; 3 |
non-breaking change, new feature |
paymentRails parameter becomes optional in the request |
In the request paymentRails parameter becomes optional instead of mandatory. |
Nov 22, 2022 |
|
2; 3 |
non-breaking change, new feature |
paymentRails parameter added into the response |
paymentRails parameter is added in the response body to show which payment rail was used to process the payment |
Jan 10, 2023 |
|
2; 3 |
non-breaking change, new feature |
Internal payments supported using Initiate Payment API |
Initiate Payment API starts to support internal payments. |
Nov 22, 2022 |
|
3 |
non-breaking change, new feature |
SWIFT payments supported using Initiate Payment API |
Initiate Payment API starts to support SWIFT payments. IF paymentRails parameter is empty and ConnectPay calculates the payment rail to be SWIFT, then it will be attempted to process the payment as SWIFT. |
Dec 20, 2022 |
|
2; 3 |
non-breaking change, improvement |
externalReference optional parameter added in the request |
externalReference is optional parameter which allows API user to provide an external reference to each initiated payment. |
Nov 8, 2022 |
|
2; 3 |
non-breaking change, improvement |
externalReference optional parameter added in the response |
If externalReference is provided in Initiate Payment API, then this parameter is shown in the response body of Payment Details API and Get Transactions API |
Nov 8, 2022 |
|
1 |
non-breaking change, new feature |
New API to receive currency exchange rates for specified currency pairs |
This is a new API which provides currency exchange rates for specified currency pairs. |
Jan 10, 2023 |
Planned for development
API |
Version |
Change Type |
Feature |
Details |
Released to Stage |
Released to Production |
3 |
breaking change, improvement |
address and country parameters renamed for SWIFT payments |
address parameter renamed to addressLine1 and country parameter renamed to countryCode for SWIFT payments. |
Jan 31, 2023 |
Feb 7, 2023 |
|
Post Currency Exchange Payment |
1 |
non-breaking change, new feature |
New API to initiate currency exchange payments |
This is a new API which supports currency exchange payments. API user can buy or sell specified amount of currency that is supported by ConnectPay. |
Jan 31, 2023 |
Feb 7, 2023 |
Authorize Currency Exchange Payment API |
1 |
non-breaking change, new feature |
New API to authorize currency exchange payments |
This is a new API which is used to authorize initiated currency exchange payments without SCA. |
Jan 31, 2023 |
Feb 7, 2023 |
Currency Exchange Payment Details API |
1 |
non-breaking change, new feature |
New API to get currency exchange payment details |
This is a new API which is used to receive currency exchange payment details |
Jan 31, 2023 |
Feb 7, 2023 |
3 |
breaking change, improvement |
paymentID parameter renamed to paymentOrderNo |
In order to be aligned with global ConnectPay terminology, paymentID parameter renamed to paymentOrderNo |
Jan 31, 2023 |
Feb 7, 2023 |
|
4 |
breaking change, improvement |
paymentID parameter renamed to paymentOrderNo |
In order to be aligned with global ConnectPay terminology, paymentID parameter renamed to paymentOrderNo |
Jan 31, 2023 |
Feb 7, 2023 |
|
3 |
breaking change, improvement |
paymentID parameter renamed to paymentOrderNo |
In order to be aligned with global ConnectPay terminology, paymentID parameter renamed to paymentOrderNo |
Jan 31, 2023 |
Feb 7, 2023 |
|
3 |
breaking change, improvement |
paymentID parameter renamed to paymentOrderNo |
In order to be aligned with global ConnectPay terminology, paymentID parameter renamed to paymentOrderNo |
Jan 31, 2023 |
Feb 7, 2023 |