Mar 5, 2024

  • New Features

    • Clients can now manually execute FX conversions. With this change, you're given greater control and flexibility over how funds get converted in customer wallets and the associated settlement timeframes.

      • Pass the new ExecutionType field when making requests to the /Quote API to indicate a manual scheduled FX conversion. This field defaults to at_conversion_time if nothing is passed.
      • Manual scheduled FX conversions must be executed using the /Execute endpoint (within the ExpiryTime to transfer funds from the source currency to the destination currency within the wallet.
        • New fields:
          • ExecutionType: Set to at_conversion_time for timed conversions and manual for manual FX conversions.
          • ExpiryTime: This is a timestamp that indicates when the FX conversion expires. Manual conversions must be executed before this time.
      • We've also updated the following APIs:


  • There are no changes for this time period.

  • Enhancements

    • We've released a new version of our Fetch Supported Corridors API. This new version provides greater details about the corridor being used. Changes include:

      • Adding a mandatoryDataRequirements and supportingDocuments field.
      • Adding specifics around the transaction's limitations and turnaround time.
      For more information, see Fetch Supported Corridors V3.

    • We've added the following query parameters to the Beneficiary List V2 endpoint.

      • beneficiaryName
      • beneficiaryAccountNumber
      • destinationCurrency
      • payoutMethod

    Deprecation Notices

Feb 20, 2024

  • Enhancements

  • Enhancements

    You can now use PGP keys (also called RSA security) to transmit sensitive data.

    For more details, see PGP Prerequisites.

  • API breaking changes

    • We've removed the BEN enum from the payout#swiftFeeType field in the Transfer Money request.

Feb 6, 2024

  • New features

    • We have introduced a new feature to Nium Portal called Batch Payouts. With batch payouts, you can now effortlessly process multiple transactions in one go while ensuring all your payouts are handled seamlessly. Learn more about batch payouts from our blog.

      For details on how to create batch payouts, see Batch Payouts.

    • We've released a Postman collection for all Nium APIs. Use the collection to build your integration.

      For more information, see Postman collection

  • New feature

    We've released several new APIs related to Card Security and 3DS authentication.

    These new APIs enable you to send and receive data in more secure manner (e.g RSA encrypted). For more information, see the following from our API reference:


    We've made some improvments and fixes to our Google Pay Push Provisioning SDK to support EU and UK address verification.

    For details on our Google Pay Push Provisioning SDK, see Google Pay Push Provisioning.

  • There are no changes for this time period.

Jan 23, 2024

  • New feature

    We have introduced a new Webhook event type called CUSTOMER_COMPLIANCE_STATUS applicable for individual customers. This event is triggered when there is a change to the individual customer's compliance status. For more information, see the Customer compliance status event in our API reference.

    Prior to this change you had to configure a separate URL to receive the customer compliance status from Nium. The new event update will improve the developer experience by simplifying the number of integration steps. You can now use the same URL configured to receive all Webhook events and subscribe to the new event.

    You can also subscribe to the event type CARD_CLIENT_KYB_STATUS_WEBHOOK to receive the compliance status of corporate customers. The Callback to receive customer compliance status will continue to be supported.


    We have introduced two new fields - ClientMarkupRate and MarkupRate - to help you apply FX markup rates to your customers.

    • The ClientMarkupRate is the markup rate you negotiated with Nium.
    • The MarkupRate field details the FX markup fees configured for your customer.
    • If there are no fees configured for your customer, the MarkupRate will default to the ClientMarkupRate.

    Both fields can be found in the response body of the following APIs:

    Having these fields readily available offers a convenient way to charge FX markup fees to your customers and helps you further monetize your FX services for revenue generation.

  • There are no changes for this time period.

  • Other Changes

    Enabled local Nigerian Naira (NGN) payouts to Nigeria for person-to-person (P2P) and business-to-person (B2P) use cases.

Dec 19, 2023

  • There are no changes for this time period.

  • There are no changes for this time period.

  • New feature

    Introduced a new payment option FASTER_DIRECT_DEBITis now available as a fundingChannel in the Fund Wallet API. This option is available for eligible clients to choose between Faster Direct Debit and Standard Direct Debit in US.


    For AUD currency transactions additional details will now be visible to the beneficiary. The enhancement will provide remitter name and other narrative information to the beneficiary leading to better transparency of each transaction benefitting both the sender and the beneficiary.


    The minimum supported value for VND local transactions is updated to 2000 VND due to the restrictions put in place by Nium's bank partner.

Dec 5, 2023

  • There are no changes for this time period.

  • New feature

    Introduced Card Widget which provides embeddable html that shows Payment Card Industry Data Security Standard (PCI DSS) data in end user applications. The Nium hosted url for the embeddable html can be retrieved using the new Get card details widget API. This API is secured by JWT token authentication which is encrypted by AES RSA encryption algorithm.

  • New feature

    Introduced a new Account Verification API on Nium's payments network. This feature is also commonly referred as Confirmation Of Payee. Using this feature, customers can ensure the money reaches the intended payee or beneficiary by verifying if the payee details including account number are valid.

    Contact your Nium representative to activate this feature. Refer to the Account Verification (Confirmation Of Payee) user guide for more details.


    • Updated the Remittance lifecycle user guide under the Transfer Money category with simulation account details that will allow you to create transactions in sandbox environment. With these instructions, you will now be able to replicate PAID, SENT TO BANK, and RETURN statuses and their state transitions.

    • Introduced a new user guide on GPI tracking that offers insights into improved tracking for SWIFT wire transactions.


    Local ZAR currency payouts for P2P use cases have been temporarily deactivated due to a technical issue with our payment partner. Nium continues to support payouts for other use cases such as B2P and B2B. We are working closely with our partner to resolve this issue at the earliest.

Nov 21, 2023

  • There are no changes for this time period.

  • There are no changes for this time period.

  • New features

    • Introduced a new Proof of Payment (POP) API to generate proof for the transactions that are in PAID status. You can use this API to download the proof of payment.

      • Proof of payment is a pdf generated by Nium to provide the necessary details of the transaction such as sender details, beneficiary details, transaction date & time, paid amount, fees, and FX rate.
      • You can provide POP documents to your customers or suppliers for enhancing transparency. Your customers typically use this document, also known as transaction receipt, for reconciliatiion, and for tax verification purpose.

    • Introduced collections capability in Japan. To support this capability, a new data object, InvoiceDetails, is added to the request body of the Fund Wallet API.

      You will now be able to receive funds locally from individuals and businesses in JPY currency in real time and hold the funds in the customer wallets in JPY currency. You can also issue JPY virtual accounts to your customer wallets using the Assign Payment ID API. Contact your Nium representative to learn more about this feature.

    • Introduced the Direct Debit capability for your corporate customers in Australia (AU). AU based businesses can now fund from their AU bank account into their Nium-issued wallets using Direct Debit. For this feature, the transactionType is shown as WALLET_CREDIT_MODE_DIRECT_DEBIT in the response body of Wallet Transactions API. Contact your Nium representative to activate this capability.

      Refer to the Direct Debit AU user guide for more details on this feature.

Nov 7, 2023

  • 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.

Oct 24, 2023

  • 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.


    • 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.


    • 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.

Oct 10, 2023

  • 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.