Guides

Wallet-to-Wallet Transfers

Suggest Edits

You can allow a Nium onboarded customer to transfer funds from their wallet to another Nium onboarded customer with a suite of Nium One platform fund transfer APIs, which your customer has authorized to do so.

The sender and the receiver of the funds can be an individual or a business and can belong to the same or a different client setup based on geographic regions. Global clients have multiple client setups on the platform where customers across the client setups require wallet-to-wallet transfers.

📌

IMPORTANT

To enable wallet-to-wallet fund transfers across multiple client setups, contact your Nium representative.

A diagram showing how the Wallet to Wallet Transfers API allows you to send money from one wallet to another wallet in the same or a different client setup based on geographic regions.

A diagram showing how the Wallet to Wallet Transfer API allows you to send money from one wallet to another wallet in the same or a different client setup based on geographic regions.

Prerequisites

  • There are no prerequisites to allow wallet-to-wallet transfers within the same client setup.
  • There are two requirements to allow wallet-to-wallet transfers between multiple geographic client setups:
    • The client of the sender and the receiver customer needs to have the allowInterClientWalletTransfer flag set to true.
    • At least one common currency needs to be enabled between the different client setups to enable wallet-to-wallet fund transfers.

API server URLs

Use the following host names to distinguish the API calls between the different working environments.

  • Sandbox: https://gateway.nium.com
  • Production: https://api.spend.nium.com

API endpoints

HTTP methodAPI nameAction
POSTWallet-to-Wallet TransferThis API helps you transfer funds from one Nium onboarded customer wallet to another similar wallet.
GETTransactionsThis API allows you to fetch the transaction details for a customer.
GETClient TransactionsThis API allows you to fetch transaction details at the client level. It also supports query parameters based on filtering to fetch details of the transactions for the customer.

Wallet-to-Wallet Transfer API

The Wallet-to-Wallet Transfer API allows you to transfer funds in the same currency. For example, the source and the destination currency are the same for the sender and the receiver.

The operation also lets you transfer funds between different currencies.

  • The sender can use the Create Conversion API to send money from one currency to another in the same wallet. The sender then uses the Wallet to Wallet Transfer API to send the converted currency to the receiver’s wallet.
  • The sender can use the Wallet-to-Wallet Transfer API to transfer funds to the receiver’s wallet. The receiver then uses the Create Conversion API to transfer funds from one currency to the desired currency in the same wallet.

Common error scenarios

The following are the common error scenarios in sending an API request for a wallet-to-wallet transfer.

ErrorDescription
Either sourceAmount or destinationAmount isn't provided.Either provide sourceAmount or destinationAmount.
purposeCode is invalid.The transaction isn't permitted due to an invalid purposeCode, and the Purpose of Transfer Code is provided, such as IR001.
purposeCode isn’t provided.The transaction isn't permitted because the purposeCode is required.
Receiver’s inter-client transfer flag in client configuration is not true.The receiver’s client program doesn’t have the permission to receive the funds from that client’s customer through Wallet transfer.
Sender’s inter-client transfer flag in client configuration is not true.The sender's client program doesn’t have the permission to transfer the funds to that client’s customer through Wallet transfer.
sourceCurrencyCode and destinationCurrencyCode don’t match.Cross-currency transfers are not allowed. The sourceCurrencyCode and destinationCurrencyCode need to be the same.

Updated 6 months ago