Upgrade to Contis API V2 from API V1
This page is dedicated to help Contis clients who are currently using the older version of Contis APIs (V1), upgrade to the new standard offering RESTful APIs (V2).
History of API V1
Contis APIs V1 were launched back in 2013 with an aim to enable Contis clients to use APIs for self-serve portals and applications. These APIs were developed using XML based SOAP technology protocol and until the launch of V2, they served all client needs. There were 240+ methods supported, and they powered various actions on the Contis platform.
Introduction of API V2
Contis APIs V2 were launched in 2018 and they support more than 350+ methods, covering various functionalities and scenarios on the Contis platform. Contis API V2 is a RESTful API and a JSON based data format to communicate between client and Contis servers. V2 was developed with the latest authentication method of OAuth 2.0, which is an open standard for authorisation commonly used as a way for Internet users to log in to third party website accounts without exposing their password.
What are the advantages of API V2?
Contis V2 APIs are open to access via VPN and certified PKI security. In the PKI based version Payload will be covered with an end-to-end security on public networks. This is the same for VPN Payload, which will be routed via a secure tunnel communication between the Contis and client servers. Contis V2 APIs allows you to develop a mobile App without developing a wrapper between the App and Contis API. Contis API V2 calls can be cached and data can be marked as cacheable, which can be reused by the browser later without having to initiate another request back to the server. This saves time and resources.
A comparison between V1 and V2 APIs
| V1 API | V2 API |
| Word based offline document | HTML based online document |
| Protocol | Architecture |
| SOAP Based | RESTful |
| XML | JSON |
| WS-Security | HTTP and HTTPs |
| MD5 and 3DES Hashing (with some support on strong enc/hashing in 1.1) | SHA256 and AES256 |
| Slower | Faster |
| Complex and Consolidated | Simpler and Controlled |
| Non-PKI based | PKI Based |
| VPN | VPN |
Mapping of API V1 methods to API V2 methods
We have analysed and consolidate commonly used methods, which are currently being used by API V1 clients most frequently. The list below will assist API V1 clients to map method usage to respective method(s) of API V2.
| API V1 Methods | API V2 Methods | ||
|---|---|---|---|
| Method Name | Controller | MethodName | Description |
| Login | Security | Login | Login API client to contis platform. |
| Logout | Security | Logout | Logout the API client from Contis platform. |
| CardHolder_Create | Consumer | AddConsumer | Create/Register a primary consumer account and returns Account Number and unique ConsumerId. |
| CardHolder_GetInfo | Consumer | Returns personal and account related information of a specific consumer. Returns primary and secondary consumers personal and account information details. |
|
| CardHolder_Lookup_GetInfo | |||
| CardHolder_Update | Consumer | Update particular consumer’s personal information like Name,Date of birth,Language,Nationality etc., for given consumerId in the request. Update particular consumer’s contact information like Mobile Number, EmailAddress, Address detail etc., |
|
| CardHolder_AddressUpdate | |||
| CardHolder_ContactUpdate | |||
| Card_RetrivePIN | Card | ViewPin | Returns encrypted PIN of the card. |
| Card_Activate | Card | ActivateCard | Activate the card for a new or inactive card |
| Card_Lookup_GetInfo | Card | Returns card details like Name, Status, Issue Date, Expiry Date, Activation Date etc. Returns list of cards for account number provided in request. |
|
| Card_ChangeStatus | Card | Set the card status as block for given card Id and consumer Id. Set card status as damaged and requests to issue replaced card. Set the card status as lost. Set the card status as lost and requests for replacement of the card. Set the card status as normal to get the card back in use again after being blocked. |
|
| Card_Request | Card | RequestNewCard | Request a new card that is to be issued to the consumer provided in request. |
| Card_Personalize | Card | LinkPreissuedCard | Pre-Issued card link up with the consumer given in the request. |
| Card_GetActivationCode |
|
||
| Account_GetInfo | Account | GetSpecificAccount | Returns latest account information like status,type,friendly name, account balance etc., for an account number provided in request. |
| Account_GetBalance | Account | GetBalance | Returns the latest account balance for an account number provided in request. |
| Account_GetStatement | Card | ListTransactions Note : For CardAPI Client |
Returns list of transactions between the specified start and end date with details like date, amount, type of transaction, sender account details etc., for an account number provided in request. |
| Account | ListTransactions Note : For AccountAPI Client |
Returns list of transactions between the specified start and end date with details like date, amount, type of transaction, sender account details etc., for an account number provided in request. |
|
| Account_LoadMoney | Account | LoadConsumerAccount | Load or credit fund to consumer’s account from the scheme funding account. |
| Account_TransferMoney | P2P | Transfer | Transfer the fund between 2 contis consumer accounts. |
| Account_WithdrawMoney | Account | UnloadConsumerAccount | Debit fund from consumer’s account and gets credited to the scheme funding account. |
| Account_SetupBank | Transfer | AddRecipient | Add recipient/beneficiary and link recipient bank account to consumer account for fund transfer. (UK/SEPA/International) |
| Account_BankWithdraw | Transfer | BankTransfer | Transfer the fund from consumer account to recipient account. (UK/SEPA/International) |
| Account_Chargefee | Account | ChargeFee | Debit the relevant fee from the specified account and credits it to the scheme’s charge holding account. |
| Account_GetPendingTransactions | Card | ListPendingCardAuthorizations | Returns list of pending transactions for a specified card. |
| Account_GetBankAccounts | Transfer | ListRecipients | Get detail list of all recipients bank account linked to the consumer provided in request. |
| Account_DeleteBankAccount | Transfer | DeleteRecipient | Unlink the recipient account linked with consumer account and stops further fund transfer. |
| Account_UploadBulkPaymentFile | Transfer | UploadPaymentFile | Upload bulk payment file for transfer of funds to multiple beneficiary accounts. |
| Agreement_GetAgreement | Consumer | ListTerms | Returns list of terms and conditions of the account as per agreement. |
| SO_Get_Rejected_Payments | StandingOrder | ListFailedSO | Returns list of declined or failed Standing orders. |
| AUTHORIZE | Security | Authorize | To perform 2nd factor authentication of consumer depending upon SCA type of a consumer set at scheme settings. |
| SDK_PostLoginDetails | Security | PostLoginDetails | PostLoginDetails method saves scheme client login details. |
Note: The above method comparison only showcases the most frequently used methods. If you are using any specific method that is not listed above, kindly contact the API support team for further information.
How to begin with migration activity?
- List all V1 methods that you are using.
- Create mapping of V2 methods against your V1 methods.
- Create copy of your source project code and start using V2 APIs in development environment.
- Ensure your system supports toggle between V1 and V2 (On/OFF configuration based behavior).
- Test V2 APIs in your new source code and ensure they are working perfectly.
- Do Sandbox testing (Beta environment).
- Do Pre-Production testing (Staging environment).
- Inform Contis your go-live plans/schedules.
- Contact Contis API support when required during the whole process.
Migration Assistance Support
The Contis API Support Team will be happy to assist you with any questions around the migration process. The following contact channels are available:
- Email : api.support@contis.com
- Slack Chat : A dedicated Slack channel will be setup by the API Support Team for instant messaging and support.
- Contis Online Ticketing System :You can raise your query directly to the API support team in the Contis ticket system PMTools https://pmtool.contisgroup.com
Note : Please note that support times are working days, 08:30 to 17:30 GMT