There are no changes for this time period.

Enhancement

Introduced a new field called referenceCode in the Cards 3DS OTP Webhook.

referenceCode is a unique value generated with each new OTP value. In the instance where the consumer can receive multiple OTPs for the same transaction, this can be leveraged to show the consumer which OTP is expected to be entered. This value should be sent in the SMS or Email along with the OTP and then displayed on the consumer screen.

Enhancement

We have added two new parameters in the gpi object to enhance the gpi details shared with you in Fetch Remittance Life Cycle Status API and Remit Transaction Sent to Bank webhook.

• forwardBankCode: Bank identification code (BIC) of the next participant bank to which the payment has been forwarded.
• remarks: Detailed description of the reasonCode. This interpretation is provided by Nium.

New features

• We have added several new features to the Nium portal in sandbox environment including, global wallets view, reports for payout transactions, configure webhook events, invite new users to your sandbox, and transparency with chronometer in the transaction details. Read the announcement blog for more details.

API breaking changes

• Document details are required when onboarding in EU

  Nium must report the "documentNumber" associated with the individual stakeholder positions of corporate customers to regulatory authorities through various reports. Until now, clients were not obligated to provide stakeholderDetails.documentDetails in the eKYB process. However, starting January 1, 2024, stakeholderDetails.documentDetails will become a mandatory field for both the eKYB and Manual KYB procedures when the position corresponds to UBO, TRUSTEE, or PARTNER.

  Additionally, stakeholderDetails.kycMode, and stakeholderDetails.documentDetails.document will continue to be optional in the eKYB process when a searchID is provided, but they will be required fields when searchID is not provided for the manual KYB flow.

  See EU required Parameters and EU required documents for more details.

New features

• If you are using the delegated model, we have improved the settlement report file to offer more comprehensive information for transaction matching. The new settlement file includes additional fields and is formatted with the pipe symbol as a delimiter, making it simpler to parse and handle. We're delivering the updated V2 version of the file to the same SFTP location where V1 was previously shared. Clients can take advantage of this enhanced file to improve their settlement processing. Detailed information on the format of the file is available in the Client settlement report guide.

Enhancements

• Ability to update name on card for corporate cards. We have enhanced Update Card Details V2 API which will allow customers or cardholders to update card data at individual card level including the name on card.
• We have included new delivery options for EU & UK. In Add Card V2 API the issuanceMode field has two new options international_delivery_track, and international_delivery_track_sign.

New feature

• Introduced a new API to retreive Account Ownership Certificate (AOC) for your customers. To download the account ownership certificate you can call the Account Ownership Certificate API.
  • Account Ownership certificate is a pdf generated by Nium to provide the details of the virtual account(s) assigned to the name of the underlying customer.
  • AOC are usually required by online market places or payment gateways for registration.
  • AOC document can be used by your underlying customers for providing account details for collections across different payment platforms.
  • Additionally, AOC are required for loan applications or when dealing with government agencies.

Enhancement

• Added transparency about timing of the interbank FX rate. In order to ensure that you know the exact time at which we obtained the last traded interbank FX rate being used in an FX quote, a new field called rateCaptureTime was added in the API response for creating a quote and fetching an existing quote. The rateCaptureTime field has the timestamp at which we got it from our rate service provider.

Enhancements

• Corporate customer onboarding enhancements

  • Added a new status field in Client KYB Status webhook to enhance corporate customer onboarding.
    At present, the Client KYB Status webhook only provides access to the complianceStatus parameter, and you proceed with the transaction upon receiving a complianceStatus value of COMPLETED. Although infrequent, certain transactions may not succeed because transactions are only allowed when the status is Clear

    To address this issue and prevent transaction failures, we have now included the status field in the webhook, which is already available in the Customer Details API. We strongly recommend that clients utilize both complianceStatus and status to ensure the successful execution of transactions.

    Note that the complianceStatus being COMPLETED does not signify a terminal state, as there is still a possibility of receiving Requests for Information (RFIs) even after this webhook has been received. In rare instances, RFIs may still be raised even after the status has reached Clear due to post-approval due diligence. However, transactions will not be blocked in such situations.

  • Amendment to attestation for US Clients.
    For US clients, it is necessary to update the applicant declaration or attestation in your onboarding process to incorporate the UBO (Ultimate Beneficial Owner) declaration. Use the following amended attestation:

    “I certify that I am the authorized representative of the customer; all information provided and documents submitted are complete and correct. I confirm that I have provided all the UBOs present. I have read and accepted the Nium Terms and Conditions.“

• Individual customer onboarding enhancements

  • Enhancement in Unified Add Customer API by adding a new optional field isTncAccepted to support both onboarding and the terms and conditions (T&C) acceptance in a single API call.

    isTncAccepted is a boolean field and the default value is false. With this change, customer's initial consent to the T&Cs can be recorded during the onboarding flow.

  • Introduced shortened enum values for intendedUseOfAccount and estimatedMonthlyFunding fields in Unified Add Customer API. The shortened values and their corresponding descriptions are available in the enum values description guide. This enhancement will make the API easier to use and reduce the chance of getting validation errors.

  • Regenerate KYC URL API now supports individual customers in addition to corporate customers.

There are no changes for this time period.

Enhancements

• Extended Get Card Widget API to support UnionPay.
  This improvement expands the Nium card widget's support to include UnionPay China cards alongside the currently supported Visa Cards. This update will facilitate payments to UnionPay cardholders in China for those who do not meet Payment Card Industry Data Security Standard (PCI DSS) compliance requirements.

  If you are not compliant with PCI DSS, you need to integrate with Get Card Widget API to get the recipient’s encrypted card token number. You then pass the token number in the field encryptedBeneficiaryCardToken when you add a beneficiary to make a payout to a card.

  Steps to make payouts to UnionPay Cards will remain same as existing Visa card payouts.

• GPI Details for SWIFT Wires SWIFT GPI (Gpi stands Global Payments Innovation) was developed in 2017 to improve the experience of making a payment via the SWIFT network.

  With this enhancement, we are utilizing the information received from our SWIFT partner banks to offer end-to-end visibility into the status of a transaction, starting from the moment it's initiated to the moment it's deposited to the beneficiary account. In essence, we're enabling the tracking of SWIFT wire transactions.

  The GPI details can be obtained using the Fetch Remittance Life Cycle Status API which now includes a new object gpi with four parameters in the API response:

  • reasonCode: GPI code shared by the SWIFT partner bank
  • statusDescription: Description of the GPI reason code
  • timestamp: Date and time of the last status change
  • forwardBankName: Name of the next participant bank to which the payment has been forwarded

  Remit Transaction Sent to Bank Webhook will have the following enhancements:

  • The gpi object with the above described four parameters will also be available in the webhook response.
  • We will send a new event notification whenever there is a change in reasonCode or forwardBankName.

There are no changes for this time period.

There are no changes for this time period.

New feature

Introduced the new Fetch Aggregated Exchange Rates endpoint that allows you to track and monitor historic market trends for any currency pair.

After you specify the required sourceCurrencyCode and destinationCurrencyCode fields, this API returns the aggregated daily FX data for the past ninety days.

You can also specify the following optional fields:

• start and end dates that need to be within the the last ninety days.
• window to specify whether the results should be grouped by hour or day.

For both the hourly and daily window views, the following are displayed for the specified currency pair during the selected time window:

• min - The minimum FX rate captured.
• max - The maximum FX rate captured.
• average - The average FX rate calculated.
• time - The starting timestamp of the FX rate aggregation.

For additional information, refer to the FX overview guide.

New feature

Added a new RFI template called otherData for corporate onboarding.

Currently the RFIs requiring additional data are limited to businessName, transactionCountries, and intendedUseOfAccount. Prior to this change, when additional information was required, an RFI was raised using an email or with the otherDocument RFI template. Since the otherData RFI handles non-document requests, any type of information can now be collected without the need to add any new RFI templates in the future.

The otherData RFI is available in preprod for testing now and will be available in production starting October 10, 2023.

Examples for usage of otherData:

• Template in the response of the Fetch RFI Details API
• Request body for the Respond to RFI API

There are no changes for this time period.

There are no changes for this time period.

Enhancements

For security and to inform customers of any account takeover, notifications are sent in two ways.

1. Notification by Email

• The new email template CUSTOMER_UPDATE_EMAIL has been introduced to send email notifications to the customers whenever there is any update in the email address or mobile number of the customer.
• For any change in the email address, notifications are sent to both the previous and updated email address.
• For any change in the mobile number, the notification is sent to the current email address.
• Currently, this is applicable only for individual customers whose kycStatus is Clear.

2. Notification by Webhook

• To send the contact information of the customer prior to the update, three new key-value pairs have been included in the fields parameter:
  • previousCountryCode
  • previousMobile
  • previousEmail
• The CARD_CUSTOMER_UPDATE_WEBHOOK parameter notifies about the customer’s previous and newly updated contact information to you.
• Example of the updated field in the request body of the webkook template:
  "fields": {
"countryCode": "SG",
"mobile": "67543800",
"email": "[email protected]",
"previousCountryCode": "US",
"previousMobile": "123456789",
"previousEmail": "[email protected]"},

New feature

The new OOB Callback v2 API simplifies the request payload for providing Nium with the result of 3DS out-of-band authentication.

• After you perform authentication using Biometrics or other means, you can provide the success or failure to Nium against the Transaction ID.
• OOB Callback v1 API will be deprecated and becomes unsupported on March 31, 2024.

There are no changes for this time period.

Enhancements

• EU Corporate Customer Onboarding allows an application to be submitted without the collection of the REGISTER_OF_DIRECTORS and REGISTER_OF_SHAREHOLDERS documents for Public and Private companies when not required.

  • Starting August 14, businessDetails.additionalInfo.businessExtractCoveredStakeholder is no longer validated, allowing an application to be submitted without these two documents.
  • There are no longer any notes related to these documents in the remarks field in the response object of the Onboard Corporate Customer API.
  • An RFI will be raised if either of these documents is required. Typically, when the BUSINESS_REGISTRATION_DOC does not contain the details of directors and shareholders based on customer input.

  See here for the complete list of required business documents for EU corporate customers.

• EU, SG, and UK Individual Customer Onboarding has three additional parameters in the KYC redirect URL to help you better understand the status of a customer’s verification: errorCode, errorMessage, and isSuccess.

  • This is applicable for the eDocument verification flow in EU, UK, and SG and applicable for the eKYC flow in SG.
  • The isSuccess field is returned as true or false depending on the customer’s completion status of the verification flow with the vendor.
  • The errorCode and errorMessage fields are populated whenever isSuccess is false.

• All new US corporate customers registered in Delaware and New Jersey require a CERTIFICATE_OF_GOOD_STANDING document. If not provided, this document appears in the remarks field in the response of the Onboard Corporate Customer API as shown below and the application stays in the IN_PROGRESS status until the document is provided.

   {
      "clientId": "NIM1691559286485",
      "caseId": "e4f6f7be-8e75-4cbc-9db4-5032a8b0da9c",
      "status": "IN_PROGRESS",
      "remarks": "BUSINESS -> Certificate of Good Standing is expected for business entity Soylent Corporation6s3323, Please upload expected document.|KYC : SCREENING COMPLETED, ALIAS_KYC : SCREENING COMPLETED|VERIFIED",
      "customerHashId": "d08c856a-9dcf-46bb-be24-125d352459ba",
      "walletHashId": "337ffc84-dc5d-48fb-8471-2bd7cac3fd94",
      "redirectUrl": "",
      "errors": []
  }  

  Impact:

  • The enum value CERTIFICATE_OF_GOOD_STANDING has been added to the enum list of the businessDetails.documentDetails.documentType field in the Onboard Corporate Customer API.
  • The CERTIFICATE_OF_GOOD_STANDING is a required document when the address.registeredAddress.state field is DE or NJ, and the application stays in the IN_PROGRESS state until submitted.

  See here for the complete list of required documents for US corporate customers.

  Items available for testing in the sandbox environment:

  • The enums list added CERTIFICATE_OF_GOOD_STANDING, and the remarks field is available for missing documents for both eKYB and Manual KYB clients.
  • By August 22, Manual KYB clients can use the remarks field for CERTIFICATE_OF_GOOD_STANDING documents.

There are no changes for this time period.

There are no changes for this time period.

New features

• You can now use a new method to link a bank account for Debit ACH US through a micro-deposit. This option is especially beneficial in cases where instant verification is not supported. Your customer now has the flexibility to choose between two verification options: instant or micro-deposit. To support the micro-deposit option, you need to implement the Confirm Funding Instrument API. Once the micro-deposit is successfully delivered, a new webhook, DIRECT_DEBIT_MICRODEPOSIT_SUCCESSFUL is sent by Nium to notify you of the successful transaction. These enhancements aim to provide you and your customers with broader coverage and improved options for bank account verification.

• Philippine peso(PHP) currency support is now enabled for collections and funding. You now have the option to call the Assign Payment ID API with the parameter bankName set as NETBANK_PH_PHP and the currencyCode set as PHP. This configuration allows your customers to generate a PHP virtual account, facilitating expanded payment processing and management.

New feature

Introduced a new feature, Wallet to Wallet Transfers that enables fund transfers between Nium customers' wallets using the new Wallet to Wallet Transfer API. With this functionality, customers can easily transfer funds to another Nium onboarded customer. The sender and receiver of the funds can belong to the same client setup or different client setups onboarded with Nium, depending on their geographic presence.

• This enhancement benefits global clients with multiple client setups on the platform. It allows customers across these client setups to conduct wallet-to-wallet transfers seamlessly, enhancing the overall user experience and facilitating smoother financial transactions.
• Transferring funds between customers of the same client setup does not require any configuration changes within the client setup. However, for funds transfer between customers of different client setups, you need to contact your Nium representative. They can help you enable this feature, allowing your customers to utilize it seamlessly.

Enhancement

Added a new enum value called "Travel related spending" in the parameter intendedUseOfAccount within the Unified Add Customer API. The new value will support individual customers' travel-related use cases. This addition better supports and accommodates various financial transactions related to travel expenses for our customers.

Deprecation notices

• In the Client Details API, the multiCurrencySupported field is being removed from the API's response object as it is an unused field and is set to false by default. This field was giving misleading information that the client does not have support for multiple currencies. Clients will see the currencies enabled for their setup in the currencies field of the response.
• In the Unified Add Customer, Customer Details V2, and Customer List V3 APIs, the preferredName field has been changed from required to optional, meaning it is no longer required for customer onboarding purposes. You now have the flexibility to provide this information if needed, but it is not required when using the API for customer registration.
• The P2P Transfer API is deprecated and becomes unsupported on January 31, 2023.

New features

• Introduced a new Transaction Prescreening capability for scheduled transactions. This functionality enables payroll clients to send transactions to Nium for compliance or risk-related checks before the scheduled date of the transactions. It’s recommended to initiate a scheduled payout five to seven days in advance if the client wants to prescreen the transaction. A new preScreening boolean field, with a value as true/false, is introduced in the payout object of the Transfer Money API. New transaction types are introduced for prescreening transactions Remittance_Debit_External_Prescreening and Remittance_Debit_Prescreening (self-payment).

• Note: The reverted FX conversion feature is improved by changing the URL names of the Conversion APIs listed below to clearly distinguish between a conversion within a customer’s wallet and a transfer from one customer’s wallet to another customer’s wallet.

  Introduced the capability to perform FX conversions within a customer’s wallet using locked FX rates as well as scheduled settlement. This service helps you convert your funds from any of the supported Nium payin currencies into any of the Nium payout currencies at transparent and guaranteed FX rates. The converted amount can then be used to send payouts or spend through a card.

  • You can choose from a range of lock periods (up to 24 hours) for the FX quote so that you have time to confirm the rate with your customers or internal users and initiate the FX conversion.
  • You can also choose from a range of conversion schedules (up to two business days) so that you get the necessary time to fund with the source amount required for the FX conversion.

  Refer to the FX Overview guide for more information on this capability.
  The following new APIs are introduced to support this capability:

  • Create Quote API: Creates an FX quote for a pair of currencies based on a lock period and conversion schedule.
  • Fetch Quote by ID API: Fetches the details of an FX quote using the quoteId.
  • Create Conversion API: Converts funds within a customer's wallet from a source currency to a destination currency at either a market FX rate or a locked FX rate obtained using the Create Quote API.
  • Fetch Conversion by Id API: Fetches the details of an FX conversion using the conversionId.
  • Cancel Conversion API: Cancels an FX conversion that’s yet to be settled.

Enhancements

• Direct Debit

  1. Introduced an option for faster settlement time for Direct Debit ACH in the US. Reach out to your Nium sales representative for more information.

  2. Introduced additional webhooks when there’s a change in the status of your funding instrument:

  • DIRECT_DEBIT_FUNDING_INSTRUMENT_APPROVED — when the status of your fundingInstrument changes from Pending to Approved. After this, you can call the Fund Wallet API to initiate a debit from your bank account.
  • DIRECT_DEBIT_FUNDING_INSTRUMENT_FAILED — when the status of your fundingInstrument changes from Pending to Failed. After this, you can call the Get Funding Instrument Details API to know the reason for the failure and act accordingly.
  • DIRECT_DEBIT_FUNDING_INSTRUMENT_CANCELLED — when the status of your fundingInstrument status changes from Approved to Cancelled. You receive this as an acknowledgement that the customer has cancelled the mandate via their bank.

• Enhanced the ability for a client to embed the card widget within the client’s domain. A new clientDomain field is introduced in the request body of the Get Card Widget API. This field contains the domain name where the widget needs to be embedded.

New feature

We have introduced a new Unblock PIN API that allows you to unblock a card’s personal identification number (PIN) when an invalid PIN number is entered more than four times. You can query the PIN status using the Fetch PIN Status API. This API is applicable for Physical cards only and available for clients in the APAC region.

API breaking changes

We've identified that the previously announced FX conversions APIs require a few critical improvements. As a result, we're reverting the feature effective immediately and plan to relaunch the revised APIs shortly. Stay tuned for an updated announcement.

New features

We've introduced a beta version of AI-powered docs. OpenAI now backs our docs to provide human-like interaction with the Ask a question search field. You can find this feature in the header section of all documentation pages.

Enhancements

We've made enhancements to the daily downloadable Client Account Fees Report by adding the following new fields:

• Fee Source: This field indicates the source of the fee levied by the system, the default fee setup or the client charge fee API.
• Fee Type: This field applies only to fees levied by the system and indicates whether the fee was set up as a percentage or a flat fee.
• Fee Value: This field applies only to fees levied by the system and contains the defined value of the fee in the client setup.
• Fee Value Currency: This field applies only to flat fee types and indicates the currency in which the fee value was defined.
• Additional Fee Type: This field applies only to fees where clients have opted for additional fees as part of the payout request. It shows the fee type chosen by the client, either fixed or percentage.
• Additional Fee Value: This field applies only to fees where clients have opted for additional fees as part of the payout request. It contains the amount value that was added to the fee.

Deprecation notice

The designation parameter in Unified Add Customer, Customer List V3, and Customer Details V2 APIs, is deprecated and becomes unsupported on December 16, 2023.