This changelog lists all additions and updates to the Xflow API, in chronological order. The changelog has two levels; the first level lists the actual API version. This first level almost always refers to breaking-API changes. The second level lists out the dates on which non-breaking changes to the API version were made.
live_fx
, on the AccountSettings object to enhance the flexibility of payouts processing. This boolean parameter lets you control whether payouts are processed immediately for all connected users (platforms) or for you (direct users). When set to true
, payouts are processed instantly. When set to false
, payouts adhere to the configured payout schedule in the AccountSettings object.v1/accounts/activate_address
and v1/accounts/deactivate_address
. These endpoints were part of our legacy modeling and since then, we've substituted the functionality provided by these endpoints by providing more finer grained control to our users through explicit address creation. While technically this is a breaking change, we've ensured that before unshipping, no one was using these endpoints and consequently, there was no user impact.AUD
, HKD
, SGD
, AED
, CHF
, CZK
, DKK
, NOK
, PLN
and SEK
. This is in addition to the already existing supported currencies USD
, EUR
and GBP
. You can now use the POST v1/addresses
endpoint to the spin up Virtual Bank Account Numbers (VBANs) at the platform, user, connected user and partner levelBalance
object to support balances across the above currencies. We've also added support for these currencies in FeePlans
to allow you to configure fees at a granular levelXflow-Account
header parameter and ensured that nothing breaks for existing Xflow users :)mid_market
or inter_bank
. This can be set for direct users, platforms and connected users. This capability should especially provide more flexibility for platforms to set competitive pricing for their connected users.partnership
, sole_proprietor
and individual
! This is in addition to the already supported company
and limited_liability_partnership
account.fees.payouts.minimum[]
POST v1/transfers
to move funds between partners, users and platforms!transfer.description
when you create or update a transferxflow_fee_advance
. We've also added balance.fee_advance
to show this new balance compartmentaccount.fees.payout.variable
and account.fees.payout.fixed[]
at the same time!xflow_receive
. In other words, Xflow will enable funds acceptance through Virtual Bank Account Numbers (VBANs) at the platform, user and connected user levelaccount.payouts.reason_code_not_enabled
parameter to the account object which tracks why an Xflow account has its payouts on holdGET v1/balance/aggregate
endpoint which returns aggregated partner pending balancebalance.pending[]
at a user-level is now exclusive of all partner-level pending balancesbalance.payout_processing[]
. This tracks funds that are being processed for payoutsaccount.address
parameter to the account object which tracks when an address of category xflow_receive
has been activatedaccount.address.activated
which is occurs when the above account.address
parameter moves to activated
GET v1/quotes
. Using this, you can pull indicative FX rates for the buy or sell currency and amountaddress.created
, address.status.activated
and address.status.deactivated
partner
, user
and platform
file_request_body_invalid
to return a 400 if an invalid multipart request body is used to upload a fileaddress.wallet.provider
as a list parameter on the address objectaddress_global_wire_not_supported
to return a 400 if an invalid Business Identifier Code (BIC) is associated with an address.bank_account.number