Release announcements
- For digital wallets (ApplyPay, SamsungPay & GooglePay), a user is limited to a maximum of 10 tokens per card from the respective wallet providers (Terminated tokens are excluded).
- Please be aware that transfers, load/unload, DAPI, and LEAN direct API flow will be declined if either the sender's or recipient's user status is not ACTIVE.
- Take into account that a card is temporarily blocked for 24 hours for provisioning if the user makes five consecutive invalid CVV2 or expiry attempts.
- Implemented several internal enhancements, which have no major impact on client's current implementation.
- From now on, notifications for 'near expiry'/'expired' documents will be triggered only for Onfido documents. USER_DOCUMENT_ALERT webhook is used for this. For documents added via the upload APIs, it will be handled in upcoming releases.
- Implemented several internal enhancements, which have no major impact on client's current implementation.
"token_details": {
"wallet_identifier": "APPLEPAY",
"token_number": "458965212585236",
"token_type": "01",
"device_details": {
"device_type": "MOBILE_PHONE"
}
}
- Implemented several internal enhancements, which have no major impact on client's current implementation.
- Added several new optional parameters to the 'Users' APIs, so that you can store and get this information against each user:
- new field "education_level"
- new field "nearest_place" under existing object "address"
- new field "nearest_place" under existing object "company_address"
- new field "created_by" (unique ID of the agent who will be onboarding the INDIVIDUAL user)
- Added a new field 'is_cancelled' in TRANSACTION webhook to indicate whether the auth transaction is cancelled and funds are credited back to cardholder (needed for a new payment scheme to be supported).
- Added ability to configure advanced velocity limits, which allow you to add additional configurations such as merchants (i.e. categories or identifications) in velocity limit profile, so that you can configure velocity limit profile that is applicable for specified configuration. You can find related APIs here.
- Implemented several internal enhancements, which have no major impact on client's current implementation.
- Added 2 new parameters 'charge_type' and 'ids' to 'Get list of charges' API, so now you can fetch charges list by charge type or charge IDs.
- Added new enums ‘ADDITIONAL_PAGE_1' & 'ADDITIONAL_PAGE_2' for 'file_identification_document_type’ parameter in User Identification APIs, so it can be stored and returned for uploading identification files. Note, that 'file_identification_document_type' remains optional for 'file_identification_type' : ADDITIONAL.
- Implemented several internal enhancements, which have no major impact on client's current implementation.
- DAPI direct API flow enhancement: Upon calling DAPI flow with HOLD transaction type, a proper error message is returned in case of insufficient funds in the pool account (error: Prefunded account has insufficient funds).
- Implemented several internal enhancements, which have no major impact on client's current implementation.
- Implemented several internal enhancements, which have no impact on client's current implementation.
- Implemented several internal enhancements, which have no impact on client's current implementation.
Enhancements:
- Onboarding / User Verification: Know which IDV/KYC provider is being assigned and to which category or check. For that purpose, a new API has been developed to retrieve some information related to user verification settings. See the below example:
{
"user_verification_settings": {
"KYC": [
{
"category": "all",
"provider": "worldcheck"
}
],
"IDV": [
{
"category": "NATIONAL_ID",
"provider": "onfido"
}
]
}
}
- Cards & Accounts: Introduced new "is_account_linked" parameter in Cards APIs to indicate whether the card is linked to an account or not.
- Onboarding / User Verification: Users' documents of issuing country other than that of the issuer country is being verified and accepted. That explains the purpose of the new validation being implemented. To cater to that changes, new user status reason codes [“status_reason_code”: B9, B9E, B10, B10E] are introduced. A new validation has been implemented to verify if the issuing country of the identity document matches with the issuer country (system level). If not, user will remain in PENDINGIDVERIFICATION status and will take on status_reason_code of B9 in case Onfido report is CLEAR; Otherwise, it is a B10. For more info refer to this document.
- Business User Onboarding: Introduced new 'optional' fields in Users APIs for "user_type" = BUSINESS to capture related information for compliance reasons:
"estimated_activity_through_nymcard"
"expected_number_of_cards"
"expected_use_of_ncs_services"
- Transactions / Webhooks: Added two new fields in TRANSACTION webhook for Incremental Authorization:
"incrementalTransaction"
"isPreAuth"
- Scheme Transactions: Transaction processing (authorization) is influenced by the below two settings being set to "false" at the system level. Meaning, regardless of the assigned value (true or false) at product or card level, the corresponding transaction will not be approved.
"allow_chip_fallback": false,
"allow_account_verification_without_CVV": false
- Users: Change in the length of "shareholder_list" field in Users APIs - now accepts up to 50 shareholder ids to be linked.
- Users: Change in the length of "share_controller_name" field in Users APIs - accepts up to 100 characters now.
- Account Termination: Added account termination rule: If an auth is partially reversed and its clearing is not received yet, then that particular auth is considered to be a pending auth and therefore, the account cannot be terminated. Bug-fix:
- Card status correction: The correct "status_reason_code" I3 is now reflected in Cards APIs for a card created without an account but with an embossing already generated.
- Added a new field 'title' to User Documents APIs. It is used during identification creation and the system can store 'title' and return it with identification document information.
- Introduced several new status reason codes regarding a mechanism for IDV re-verification for INDIVIDUAL users who are already verified but their documents have either expired or about to expire. For more info refer to this document.
- Introduced a new ‘type' parameter (with enums HOLD, POST & RELEASE), which gives ability to identify for which status the TRANSACTION webhook is triggered. It is added to the response of 'Get transaction details' and 'Search for transactions' APIs. Also, it will be added to Transaction webhook.
- Implemented several other internal enhancements, which have no impact on client's current implementation.
- Implemented several internal enhancements, which have no impact on client's current implementation.
- "note" field is now returned in TRANSACTION webhook for "transaction_type": "WALLET_CREDIT" & "WALLET_DEBIT". You can find webhook samples here.
- Implemented several significant enhancements regarding Fees. For more information please refer to this document.
- Added six new APIs to manage charges, namely card issuance charges, which can be applied when physical or virtual cards are issued to cardholders for the first time. For more information regarding Charges refer to this document.
- Developed four new APIs to manage external bank account details so that these details can be used to execute the external transfers:
- Added a new "messageReasonCode" field to TRANSACTION webhook (message_type = AUTHORIZATION, transaction_type = REVERSAL_ADVICE). This field explains why the acquirer is rejecting authorization.
- Added an extra validation check on date of birth (DOB): DOB retrieved from Onfido should match the DOB in the user profile. For this we added a new enum to 'status_reason_code' parameter - “B7” (Date of birth consider). Note, that B7 validation is skipped in case date of birth (DOB) is not present in the user profile.
- "sender_user_id" parameter is now returned in the response of 'Get list of transfers' & 'Get specific transfer' APIs.
- Added "sender_user_id" parameter to the response of 'Search for transactions' API when searching for WALLET_TRANSFER transactions. Also, "sender_user_id" is added as a transaction search filter.
- Implemented enhancement for MPGS - whenever a session or transacting is created via MPGS, a proper fintech name will now appear instead of“NymCard Payment LLC” as a merchant name.
- Added new enum for ‘status_reason_code’ parameter in 'Perform KYC of user' API. New enum is C1 (INCONCLUSIVE). In case you receive this reason code, it means that the user account is on hold.
- Fixed an issue with "allowed_mccs_id" parameter, which is now returned in the response of 'Update card product' API.
Also be aware, that some enhancements will be added to API catalog later, when full features will be implemented. But these changes have impact on current implementation, so please get acquainted with all details in this document.
Features and improvements:
- Implemented several vital enhancements for MCC list management. We strongly recommend to get acquainted with all details in this document.
- Added 'auth_settings' parameter to responses of the following APIs: 'Get list of cards', 'Get card details' and 'Change card status'.
- Added new 'Create account token' API, which is used to create an account token for external transactions that are initiated from third parties.
- Implemented enhancement for DAPI smart flow - now system supports 'note' field in URL parameters for transfer funds through DAPI widget so that you can pass 'note' as a customized information.
- Added possibility to change 'allowed_mccs_id' parameter on a card level using 'Update card authorization settings data' API.
Features and improvements:
- Implemented enhancement regarding webhooks - "sender_user_id" parameter is now received in TRANSACTION (for WALLET_TRANSFERS) webhook. Also, "sender_user_id" is returned in the response of "Get transaction details' API when passing the ID of a WALLET_TRANSFER transaction.
- Fixed an issue when cardholder "enc_name" was displayed on the PCI widget instead of "name_on_card".
- Fixed an issue when issuer fees were charged for the refunds transactions.
Features and improvements:
- Added a new parameter - “type” to the 'Create card product' API. This field indicates the type of card product (value should be 'PREPAID'). Also it is added to the responses of 'Get card product' and 'Get list of all card products' APIs.
Features and improvements:
- Added ability to simulate (pre-defined successful) user’s status and to proceed for completing the user verification process ( for KYC and IDV) on the test environments (DEV, Staging, Sandbox, UAT). Also you can find the respective webhook changes in this document.
- Added "source_channel" & "notes'' parameters to responses of ‘Transfers’ and ‘Transactions’ APIs in order to get some additional transaction’s information. Also these two parameters are added to the sample of "TRANSACTION" webhook.
- Added ability to search and get the balance inquiry transaction details as well in addition to the other transactions. Also you can find a "BALANCE_INQUIRY" webhook sample here.
- Fixed an issue with fees - fee in declined transactions is now returned in 'Get transaction details' and 'Search transactions' API responses and in 'TRANSACTION' webhook.
Features and improvements:
- Added a new webhook event - 'EXPIRED_AUTH',so now you can configure the webhook for expired authorizations to be aware whenever an authorization is expired by the system. Webhook sample you can find in this GSG doc. Also four new related parameters “auth_expired_by“, “auth_expired_at”, “is_reversed“ and “is_settled“ are added to Transactions APIs.
- Added ability to cancel bulk card issuance request: for this new enum "CANCELLED" is added to the 'status' parameter in 'Card Bulk Issuances' APIs. Note, that this functionality can be used only when bulk issuance card request is in status "DRAFT". If the bulk issuance request is "SUBMITTED", then it can not be modified any more.
- A new "status_reason_code" - "O1" (reason: Other) is now supported for user status change. It is used by our internal APIs to clarify user status change to SUSPENDED or TERMINATED in case the reason is other than the ones we already support in our API Catalog.
- Added a new "fee_details" parameter in 'Fund transfers' and ‘Transactions’ APIs responses, so that you can have more detailed information of all associated charged fees. Also this new "fee_details" parameter is added to TRANSACTION webhook sample.
- Added a document to the Getting started guide, where you can find examples of notifications, which you can use in SMS in 'Create template' API.
- Fixed an issue when wallet transfer was declined with max amount limit reached.
- Fixed an issue when ‘status_reason_code’ parameter was missing in TRANSACTION webhook for WALLET_TRANSFER ‘transaction_type’ for declined MPGS transaction.
- Fixed an issue when user with CLEAR report from Onfido was changed to B1 status.
- Fixed an issue when user report was not retrieved in user IDV report APIs.
Features and improvements:
- Added new ‘Get user verification by reportID’ API, which gives an opportunity to see the customer’s identification report by ‘report_id’, so that you can get the detailed report information with possible respective failure reason details.
- Added new 'Get encrypted card details' API, which helps to generate encrypted card details so that you can use encrypted card details in VISA SDK inApp provisioning flow for tokenizing the card.
- Increased file upload size from 20Mb to 128Mb for 'Upload single image of identification' and 'Upload user identification' APIs.
- Added new KYC status reason code 'T0' to 'User KYC' APIs, which informs when KYC process failed due to timeout or other technical issue on WC side. Upon receiving the T0 status for the KYC, you need to trigger perform KYC again.
- Added new tags <MERCHANT_NAME> and <TRANSACTION_AMOUNT> which you can use in SMS in 'Create template' API (along with existing tags <CARD_LAST4_DIGITS> and <OTP>).
- Fixed an issue with MPGS credit card transaction, when amount deducted from credit card was not the same amount credited to NymCard account.
- Fixed an issue when 'user_type' was missing in the 'User status change' webhook received upon changing user status from "PENDINGIDVERIFICATION "B4" to "PENDINGKYC" "I0" or "ACTIVE" "I0".
- Fixed an issue with changing user status from ACTIVE to PENDINGKYC.
- Fixed an issue with constraint violation when performing KYC.
- Fixed an issue when users were not moving to World check during performing KYC.
Features and improvements:
- Changed length of the 'name_on_card' parameter from 32 to 20 characters in Cards APIs so that same length can be matched with embossing export format.
Features and improvements:
- Added new 'Get balance limits linked to account' API, which helps to retrieve the list of balance limit ID(s) linked to the account.
- Added new 'Get user's IDV report details' API, which helps to get the detail information of customer’s identification report.
- Implemented enhancements for DAPI widget - now you can skip country and bank selection step and go straight to the credentials in case of adding/linking a new bank or to fund transfer step. For more details refer to the GSG documentation.
- Added new 'billing_amount_account', 'billing_currency_account' and 'conversion_rate_billing_account' parameters to 'Get transaction details' and 'Search for transactions' APIs, so you can fetch billing currency and amount applied on the account and understand clearly in which currency the billing amount is charged.
- Added ‘source_channel’ parameter to the Fees APIs. Possible values are MPGS, DAPI or ANY (default). It gives an opportunity to choose an appropriate channel, so that fee for every channel can be applied accordingly. This parameter is currently applicable for ‘transaction_type’ = TRANSFERS only. Also added ability to post fee on recipient account instead of sender account, so you can charge the transfer funds fee to recipient instead of sender. For more details refer to the GSG documentation.
- Fixed an issue when card ID was missing in the 'TRANSACTION' webhook for declined transactions.
- Fixed an issue when ‘CARD_STATUS_CHANGE’ webhook was not received upon changing the card status to ‘SUSPENDED’ due to max. number of pin retries attempts.
Features and improvements:
- Added ability to set balance limit on individual account by using a new API - 'Link balance limit to account'. Also you can unlink balance limit from account using another new API - 'Unlink balance limit from account'.
- Increased file upload size from 5Mb to 20Mb for 'Upload single image of identification' and 'Upload user identification' APIs.
- Implemented enhancement regarding 'Get card authorization settings data’ API: card auth settings inherited from the card product will be returned only for the newly created cards. For existing cards, after updating the auth settings at the card level and calling 'Get card authorization settings data' API, the auth settings will be returned in response.
- Added ability for system to generate export after processing the clearing file so it can be shared for reconciliation. Please contact the customer success team for details.
- Implemented enhancement regarding webhooks: from now onwards 'original_amount_billing' parameter will be forwarded only in Reversal_advice webhooks, as it is only required for partial reversal cases.
- Restricted user status change from ACTIVE to PENDINGIDVERIFICATION (B0 or B2) using 'Change user status' public/internal API.
Main features and improvements:
- Developed and implemented core enhancements to the Card Product management process. Once a Card is created, its "Auth Settings" - inherited from its Card Product - cannot be changed. For any questions or concerns, please reach out to our Support or Customer Success teams.
- Added an explanation that "company_name" parameter is required if "employment_type" = 'SALARIED", "EMPLOYED" or "BUSINESS_OWNER". It is applicable for Users APIs.
- Updated the 'pin' parameter in the “Simulate transaction" API - it is a string now. So, as an example, the format now is the following - "pin": "0190".
- Added ability for PCI widgets to support ‘proxy_number’ along with ‘card_id’. You can read more about proxy number usage here.
- Added support of proxy number when linking card to account. You can read more about proxy number usage here.
- Fixed an issue with missing fields in clearing webhooks. Now the following fields can be sent in clearing webhooks: “userid”, ”feeamount”, "ecommercesecuritylevel”, "cardentry", "posenvironment", "fallback", "pinpresent", "moto", "recurring", "installmenttransaction".
- Fixed an issue when 'status_code' was not received in the negative/declined cases of webhooks with "event": "TRANSACTION", "message_type": "API" and "transaction_type": "WALLET_TRANSFER".
Main features and improvements:
- Added ability to link IDV verification policies for parent and child users at tenant level. In terms of this feature new IDV policies APIs are added to API catalog.
- Implemented new name verification mechanism to match name fields of API and uploaded documents so that identity verification process can be smoothly completed. Also in terms of this improvement new user status reason codes were added to API catalog.
- Updated ability to terminate accounts, so now it is possible to update account status to TERMINATED if account has no balance or account has no pending authorizations.
Bug fixes:
- Minor bug fixes and performance improvements.
Main features and improvements:
- Added such new API parameters as 'soft_expiry_period' and 'card_soft_expiry', which give ability to define soft expiry of the card (the concept of soft expiry usually applies to bulk cards/gift cards).
Bug fixes:
- Fixed a lot of internal issues.
Main features and improvements:
- Added support of proxy number in 'Cards' APIs, so that you can perform card operations by providing proxy number instead of card ID.
- Introduced new user type "SHAREHOLDER_BUSINESS", which can be used in case you have business and shareholder as a single entity under business user. Also added 2 new related parameters - 'license_type' and 'license_expiry'.
- Added new parameters to ‘Search for users’ API, so now there is capability to search users based on creation and modified date.
Bug fixes:
- Fixed a lot of internal issues.
Main features and improvements:
- Added new 'allow_contactless' parameter to card product APIs, which indicates if contactless transactions are allowed or not.
- Implemented enhancements to Fees APIs - instead of “CURRENCY_MARKUP“ transaction type , two new transaction types are introduced - “PURCHASE_MULTI_CURRENCY“ and “WITHDRAWAL_MULTI_CURRENCY“.
Bug fixes:
- Fixed a lot of internal issues.
Main features and improvements:
- Added a new 'status' parameter to "Search for users" API, which helps to filter users based on their user statuses.
- Added 'PIN_CHANGE' webhook, so when the PIN change operation is completed a webhook will be generated.
- Added the "pin" parameter to the ''Simulate authorization transaction'' API, so you can simulate PIN based transactions and test scenarios like bad PIN.
Bug fixes:
- Fixed a lot of internal issues.
Main features and improvements:
Bug fixes:
- Fixed a lot of internal issues.
Main features and improvements:
- Improved ‘User Status Change’ webhook by adding new parameters 'old_status' and 'old_status_reason_code'.
Bug fixes:
- Fixed an issue when user KYC call could be performed without uploading an identification or with uploading the wrong identification type.
- Fixed an error which occurred upon changing card status.
- Fixed an issue when 'ledger_balances' parameter was empty during account creation.
Main features and improvements:
- Implemented changes to support the new industry standard – eight-digit issuing BIN.
- Improved "IDENTITY_VERIFICATION" webhook, so now the system will send this webhook notification event along with a ‘status_reason_code’ as "B1" if the user is not verified.
Bug fixes:
- Fixed the issue with duplicated BIN & PAN range during card product creation/update within the tenant.
- Fixed the issue which occurred when performing KYC for users with 'status' = PENDINGIDVERIFICATION.
- Fixed the issue with webhooks response time.
Main features and improvements:
- Updated webhook event name from “CARD_TRANSACTION“ to “TRANSACTION", as it includes both card transactions and API transactions. Note, that if you are using an old webhook event ‘CARD_TRANSACTION’, now it will have an 'events' type - ‘TRANSACTION’.
Bug fixes:
- Fixed an issue when used card PIN did not conform with PIN length defined at card product level.
- Fixed an issue when duplicate webhook notifications were received for load transactions.
- Fixed an issue with an informative error message upon trying to link a bulk card to an inactive user.
- Fixed an issue when user KYC status for secondary users could not be changed.
- Fixed an issue when invalid values were accepted for 'director_list', 'signature_list' and 'shareholder_ list' parameters in 'Users' APIs.
Main features and improvements:
- Added new 'Link cards to account' API, which is used to link multiple cards to one particular account. So when performing transactions from any of the cards, only the one linked account is debited or credited.
- Added ability to create a card without an account. It is configured on the card product level, where you have to set the 'link_account_to_card' parameter as 'false'.
- Added new parameters to 'Users' APIs, which are applicable for BUSINESS user_type. It helps to register a business user in the system and issue an account to him.
- Implemented the following enhancements to the open banking widget, which helps to transfer funds from your bank account to your NymCard card account:
- added a button to delink a bank
- implemented handling of returned error codes
- added ability to re-link the bank again in case the user has changed its banking credentials.
- Implemented Postman collection setup. So now you can run the NymCard API collection in Postman. For more info refer to the relevant section of this guide.
Bug fixes:
- Fixed the following issues with the widget, which helps to transfer funds from your bank account to your NymCard card account:
- added error message showing upon transferring funds to a suspended/terminated account
- fixed authentication error message
- fixed the issue when cool-down period icon overlapped with the text
- fixed the cool-down page draft
- updated main page draft
- fixed 'Top Up completed' page
- improved user experience when it comes to navigating back to the main page.
- Fixed issues related to PCI Widget, regarding set/change PIN functionality in particular.
- Fixed an issue when KYC status could not be updated for users with 'SECONDARY KYC' policy.
- Fixed an issue with special symbols when adding addresses in 'Create card' API. Now you can also use the following symbols: comma, semicolon, colon, apostrophe.
- Fixed an issue with declined transaction status in 'Simulate transaction' API while linking a velocity limit to the card product.
- Fixed an issue related to receiving webhook notifications with “event”: “IDENTITY_VERIFICATION” when tenant settings checks=‘FACIAL_SIMILARITY_VIDEO’.
Main features and improvements:
- NymCard offers a possibility to transfer funds from your bank account to your NymCard card account using the widget. For more information refer to the ‘Funding and transfers’ section of our Getting Started guide.
- Added ability to view and change card PIN using PCI widget, so cardholders can change or view the PIN which is required to perform cash withdrawals at the ATM or POS purchases with a physical card. For more information refer to the ‘Security’ section of our Getting Started guide.
- Now you can maintain identification file type when the user uploads any document, so that the document and its version can be identified easily.
- Added 'document_status' and 'document_status_reason' parameters to response in "User documents" APIs to capture the details of the identification lifecycle for each identification.
- Now the “company_name” parameter in “Users” APIs is required ONLY IF the user is employed (i.e. employment_type is "SALARIED", "SELF_EMPLOYED" or "BUSINESS_OWNER").
- Added such new user types as Director, Signature and Shareholder to “Users” APIs. This is part of SME Onboarding (KYB).
- Added ‘desing_code’ parameter to “Card Products” APIs and ‘extra_embossing_line’ parameters to “Cards” APIs. It gives a possibility to define in which card design a card will be printed and enables to add the company name on a corporate card. This is required by the Perso center so they can find the exact card design that they need to Print on the plastic card.
- Added “create_account_with_card” parameter to “Create card product” API. Also a new category “account_settings” is added to the “Update card product” API. These new parameters allow customers to create a card separately without auto-creating a card account and then linking this card to a preexisting account or to a newly created account. It provides the flexibility to link multiple cards to the same account.
- Mandatory fields on the NymCard dashboard are now marked accordingly.
- Conducted a reset on the NEO Admin Panel Dashboard.
Bug fixes:
- fixed an issue with change of commission fees on Asia Cell and Toters.
- Fixed BIN rerouting for several clients.
- Fixed an issue when an error occurred while linking a bulk card to a user.
- Fixed Onfido integration issues.
Last modified 17h ago