Skip to content
Guides
Overview

Overview

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

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

  • Split payment - Divide and send funds from your account to your vendors’ accounts.
  • 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).

3256

  • The account 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 account.
  • Make sure to implement account webhooks so you will get notified about your vendors activity

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

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

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

Parameter

Type

Description

vendor_id

String

Defined only for vendor’s accounts

ewallet_id

String

Unique id of an account

currency

Enum

Account 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

ewallet_transaction_id

String

Unique id of an account transaction

ewallet_id

String

Unique id of an account

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