Payment Services API release notes 2022 Q4

Payment Services API collection

Released to production

API

 

Version

 

 

Change Type

 

 

Feature

 

 

Details

 

 

Released to Production

 

Initiate Payment API

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

Authorize Payment API

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

Payment Details API

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

Payment Status API

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

Get Payment Rails API

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

Initiate Payment API

2; 3

non-breaking change, new feature

paymentRails parameter becomes optional in the request

paymentRails parameter added into the response

In the request paymentRails parameter becomes optional instead of mandatory.
If not populated with specific value (see ConnectPay APIs), then ConnectPay calculates the best payment rail option and routes the payment.

In the response body, paymentRails parameter is added in all cases even if it was left empty in the request by the API user.

Nov 22, 2022

Payment Details API

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

Initiate Payment API

2; 3

non-breaking change, new feature

Internal payments supported using Initiate Payment API

Initiate Payment API starts to support internal payments.
IF paymentRails parameter’s value is “INTERNAL”, then it will be attempted to process the payment only as Internal.

IF paymentRails parameter is empty and ConnectPay calculates the payment rail to be Internal, then it will be attempted to process the payment as Internal.

Please note that Internal payments are supported in version=3 & version=2

Nov 22, 2022

Initiate Payment API

3

non-breaking change, new feature

SWIFT payments supported using Initiate Payment API

Initiate Payment API starts to support SWIFT payments.
IF paymentRails parameter’s value is “SWIFT”, then it will be attempted to process the payment only as SWIFT.

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.

Please note that SWIFT payments are supported only in version=3 and additional parameters are required (see ConnectPay APIs )

Dec 20, 2022

Initiate Payment API

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.
This parameter is used in uniqueness validation to ensure no duplicate payments are initiated.
If externalReference is populated, then the value provided must be unique per each payment.

Nov 8, 2022

Payment Details API

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

Get Currency Exchange Rate API

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.

Please note that currency exchange rates provided in this API are ConnectPay used rates. Also, provided rates can differ from the rates when actual currency exchange payment is initiated due to fluctuations in the FX market.

Jan 10, 2023

 

Planned for development

API

Version

Change Type

Feature

Details

Released to Stage

Released to Production

Initiate Payment API

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

Initiate Payment API

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

Authorize Payment API

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

Payment Details API

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

Payment Status API

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

 

Undefined