Overview

An eWallet is a virtual location where funds are collected and stored.

Accepted payments go into an eWallet. You can withdraw or transfer funds from one eWallet to another.

What you can do with the eWallet

  • Split payment - Divide and send funds from your eWallets to your vendors' eWallets.
  • Real-time Balance - See in real-time the amount of funds you and your vendors have.
  • Bank transfers - Send money to bank accounts (Using Payout Object).

Before You Begin

  • The eWallet Object collects and stores money from shoppers' PayIn. Please make sure that you have already completed the Payin integration.
  • Please make sure you have the identity of the entity you want to attach to the eWallet.
  • Make sure to implement eWallet webhooks so you will get notified about your vendors activity

📘

eWallets (both platform's and platform vendors) are unique per vendor, per currency.
For example: Only one USD eWallet can be created for a platform. Multiple USD eWallets can be created for platform's vendors. As a platform, you can create a USD eWallet for each vendor (but you can't created 2 USD eWallets for a specific vendor).

The eWallet Object

eWallet Owner

An eWallet is always linked to an eWallet owner: a platform or a platform's vendor.
In the eWallet object, vendorId will be defined when you're dealing with your vendor's eWallets. Otherwise (when vendorId doesn't exist), it's your (platform) eWallet.

eWallet Currency

eWallet currency is one of the following: GBP, USD, EUR.

eWallet Balances

In order to provide visibility into all of your (and your vendors) funds in real time, the eWallet contain multiple balance types: pending, payable, and reserve.

eWallet properties

Parameter

Type

Description

vendor_id

String

Defined only for vendor's eWallets

ewallet_id

String

Unique id of the eWallet

currency

Enum

eWallet currency: USD, EUR, GBP

pending_balance

Number

Funds that have been collected but have not yet been settled

payable_balance

Number

Available funds for immediate use

reserve_balance

Number

Required balance to cover chargebacks, returns, and other fees

The eWallet Transaction Object

ewallet_transaction_id

String

Unique id of the eWallet transaction

ewallet_id

String

Unique id of the eWallet

pending_amount

Number

Funds that have been collected but have not yet been settled

payable_amount

Number

Available funds for immediate use

reserve_amount

Number

Required balance to cover chargebacks, returns, and other fees