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.

New features

Note: We have identified that a few critical improvements are required to the below announced FX conversions APIs. As a result, we have reverted the feature effective immediately and will be re-launching the revised APIs shortly. Stay tuned for an updated announcement.

We are introducing 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 source amount required for the FX conversion.

Enhancements

• cardProductId parameter, that is required request body parameter in the Add Card V2 API, has been changed from a 3-digit number to UUID format. This change is only applicable to new clients. Clients that are setup previously with a 3-digit cardProductId can continue to use it.
• addressLine1 and addressLine2 parameters in the Address object of all card lifecycle APIs, Add Card V1 & V2, Update Card Details V2, Block and Replace Card, and Renew Card, have additional validation. As per the new validation rules, only chars in the below regex pattern are allowed.
  Regex: [a-zA-Z0-9.'-#@%&,:/ ]+

• Revised posting logic on transaction settlements for all Wallet based Clients. Previously, A separate transaction was posted for Settlement Debit and Settlement Credit depending on if the fluctuation was higher or lower respectively. In the revised logic, fluctuations are accounted for by reversing the original transaction including relevant fees that were charged and posting a new transaction as Settlement Direct Debit for the new amount (higher or lower) and recalculate all relevant fees and markups.

  There is no impact to wallet clients as the amount being debited or credited has not changed, only the methodology has been updated.
  This change is not applicable to clients on Delegated Mode (RHA).

  Following are example scenarios where this change is applicable:

  • FX Rates have fluctuated in the time period between authorization and settlement.
    Example: The FX rates have fluctuated between SGD (billing Currency) and USD (authorization currency i.e., the receiving wallet).
    Fluctuated higher-
    • FX rate between SGD and USD was 1.33510 at the time of authorization.
      FX rate between SGD and USD has become 1.34100 at the time of clearing.
    Fluctuated lower-
    • FX rate between SGD and USD was 1.33510 at the time of authorization.
      FX rate between SGD and USD has become 1.33100 at the time of clearing.
  • FX Rates have fluctuated between the transaction currency and the billing currency in the time period between authorization and settlement.
    Example: The transaction was performed in PHP (Philippine Peso) and the billing currency is SGD (Singapore Dollar).
    Fluctuated higher-
    • FX Rate between PHP and SGD was 0.02410 at the time of authorization.
      FX Rate between PHP and SGD has become 0.02490 at the time of clearing.
    Fluctuated lower-
    • FX Rate between PHP and SGD was 0.02410 at the time of authorization.
      FX Rate between PHP and SGD has become 0.02380 at the time of clearing.
  • There has been a change in the transaction amount between authorization and clearing.
    Example: The cardholder has left a tip in a restaurant due to which the transaction amount during clearing is higher than the transaction amount at the time of authorization.

Enhancement

The responses for the Confirm Funding Instrument API, the Get Funding Instrument List API, and the Get Funding Instrument Details API responses are enhanced to include the new bankName field in the funding instrument linked for direct debit.

API breaking change

This is a reminder notice about the breaking changes to beneficiary APIs that are enhanced with two new fields, beneficiaryContactName and beneficiaryEntityType. The fields are required to make a local payout to a business in South Africa with the South African rand (ZAR) currency. Details on the changes are available in an earlier communication in the May 9, 2023 changelog.
The changes will become effective on June 15, 2023.

New feature

Card Activation V2 API is a new operation that features the concept of an activation code to help cardholders activate their cards using it. The activation code is provided in the card kit cardholders receive with the physical copy of the card.

• The platform generates an activation code for all PHY-type cards using the Add Card V2 API only. This feature is not available if the Add Card V1 API is used when creating cards. The activation code is sent in the embossing file to the personalization vendor and printed on the letter accompanying the card.

• The API structure mirrors the structure of all other Card V2 APIs with logical tags. The API includes the activation code as a required field to activate the physical card. This prevents cards from being activated immediately upon creation.

Deprecation notice

Activate Card V1 API is deprecated and becomes unsupported on December 31, 2023.
Activate Card V2 is the latest version of this API.

Enhancement

Search and filter transactions in the Transaction Report of the client portal, with additional filter options using a card hash ID, transaction status, or settlement status. The transaction status and settlement status now support searching with multiple values.

New features

• Link a corporate customer to an individual customer is a new feature for Spend Management and Payroll Management use cases. You can now link an individual customer, or employee, to their corporate customer and create that hierarchy in the system.

  Note: For details on how to link a corporate customer to an individual customer or the Spend and Payroll Management feature, refer to the Platform tab.

  • Spend Management: assigns a card to an employee linked to a corporate account. You can issue cards using the Add Card V2 API to provide the customer details as mentioned below:

    • customerHashId: the customerHashId of the corporate customer
    • walletHashId: the unique walletHashId of the corporate customer
    • childCustomerHashId: the customerHashId of the individual customer

    The card is issued to a corporate customer and is linked to an individual customer.

    You can fetch the childCustomerHashId with the Card Details V2 and Card List APIs. The query parameters are enhanced to include the clientHashId, customerHashId, walletHashId, and childCustomerHashId to help filter the results.

  • Payroll Management: assigns a card to an employee for their own account. You can issue cards using the Add Card V2 API to provide the customer details as mentioned below:

    • customerHashId: the customerHashId of the corporate customer
    • walletHashId: the unique walletHashId of the corporate customer
    • childCustomerHashId: NULL

    The card is issued to an individual customer.

• Card List V2 API retrieves a list of all cards issued to a wallet using the walletHashId and the customerHashId path parameters.

  • The API structure mirrors the structure of all other Card V2 APIs with logical tags.
  • The API shows the delivery address on file, the address where the card is delivered, and its embossing details.
  • Card List V1 API is deprecated and becomes unsupported on December 31, 2023.

• A transaction is declined if the Know Your Customer (KYC) verification process is in the pending status. This change is in accordance with compliance regulations. All cards associated with the customer and their wallet are also temporarily blocked until the status changes to verified.

Enhancements

• Search and filter cards in the client portal using a new Search and Filter feature entering a card number, a card hash ID, and a card proxy number, on the customer details screen. The functions help find a card among multiple ones attached to a wallet.
• Card Details V1 and V2, and Card List V1 and V2 APIs provide device details for Mastercard. Before, device details were only available for Visa cards.

New features

• Spend and Payroll management:

  • Link a corporate customer to an individual customer is a new feature for Spend Management and Payroll Management use cases. You can now link an individual customer, or employee, to their corporate customer and create that hierarchy in the system. Only an individual customer can be linked to a corporate customer. The opposite isn’t true.

    To establish a connection or relationship between the individual customer and the corporate customer, you need to configure the relationship with the childMustHaveParent parameter set to true. If this flag is false, you have the option to establish the connection, but the hierarchy is not enforced by the system.

    • Spend Management clients need to be configured with the billingAddressAsCorporate parameter set to true. This parameter allows the billing address of an Individual customer to be the same as the business address of a corporate customer.
    • Payroll Management clients need to be configured with the billingAddressAsCorporate parameter set to false.

    To setup the hierarchy, you need to onboard the corporate customer first and then onboard the individual customer using the Unified Add Customer API. The fields below have been impacted:

    • parentCustomerHashId: A new required parameter has been added if the childMustHaveParent flag is set to true.
    • kycMode: accepts MANUAL_KYC value if the billingAddressAsCorporate parameter is set to true.
    • billingAddress: details are optional if the billingAddressAsCorporate parameter is set to true.

    You can fetch the parentCustomerHashId for an individual customer with the following enhanced APIs:

    • Customer List V3 API: allows all individual customers to have the parentCustomerHashId parameter value available. You can fetch all the Individual customers linked to a corporate customer by providing the parentCustomerHashId parameter as a part of the query parameter.
    • Customer Details V2 API: the parentCustomerHashId parameter, in the individual customer details section, provides the customerHashId of a corporate customer to which the individual customer is linked.

  • Transaction management is enhanced with the update of the following APIs to include the transactions that individual customers make on the cards issued to corporate accounts:

    • Transactions API: The childCustomerHashId parameter is added for all the transactions. The value includes the customerHashId of the individual customer for the applicable transactions. The childCustomerHashId can be used as a query parameter in this API.
    • Client Transactions API: The childCustomerHashId parameter is added for all the transactions. The value includes the customerHashIdof the individual customer for the applicable transactions. The childCustomerHashId can be used as a query parameter in this API.

• Electronic document verification, or E_DOC_VERIFY, is now available as an option in kycMode for Know Your Customer (KYC) applicants in all regions. Corporate customers in Australia (AU), Singapore (SG), and the United States (US) previously completed the applicant KYC verification process via MANUAL_KYC, which delays the approval process. Using E_DOC_VERIFY, customers can now complete the KYC verification process for non-resident applicants following the redirect URL of Nium's KYC vendor and uploading documents on the vendors' UI resulting in real-time approvals. E_DOC_VERIFY is also available for Electronic Know Your Business (eKYB) and manual KYB. E_DOC_VERIFY is also available for European Union (EU) and United Kingdom (UK) applicants.

  Enable E_DOC_VERIFY by passing the businessDetails.applicantDetails.kycMode=E_DOC_VERIFY object in the Onboard Corporate Customer API. Refer to Region-specific KYB requirements to see the available applicant and stakeholder KYC modes. Refer to the applicant KYC information on the following pages to learn how to integrate: AU, SG, US

• Customer account statement generates a statement that gives a list of all transactions your customer makes on the platform, including deposits, withdrawals, spending, fees, payments, and refunds. You can give your customers an account statement periodically or based on their specific requests to help them keep the information for their records or to reconcile their transactions. You can now generate an account statement for your customers via the Account Statement API as a PDF or a CSV document. Contact your Nium representative to use this feature.

Enhancements

• Customer List V3 API features a new query parameter, named customerType, so you can fetch your customer list based on your customer type. The accepted values are INDIVIDUAL or CORPORATE.

• Unified Add Customer API makes the new customer onboarding delivery address parameters listed below optional. You can now choose to use the fields but they’re not required.

  • deliveryAddress
  • deliveryAddress2
  • deliveryCity
  • deliveryCountry
  • deliveryLandmark
  • deliveryState
  • deliveryZipCode