Transfer-Email-v2

From Barion Documentation
Revision as of 12:32, 23 December 2019 by Vinczei (talk | contribs) (Created page with "{{PageTitle|title=Barion API: send money to an e-mail address}} {{TableOfContents}} {{api_callmethod |method=POST |uri=/v2/Transfer/Email }} The <code>/transfer/email</code...")
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to navigation Jump to search

Barion API: send money to an e-mail address

POST /v2/Transfer/Email

The /transfer/email API endpoint is used to send e-money to a given e-mail address.

Prerequisites before use:


v2 This API endpoint is available in API v2 only.

Input properties

Property name Property type Limitations and constraints Description
UserName string
  • Required
Your e-mail address in the Barion system.
Password string
  • Required
Your password in the Barion system.
SourceAccountId GUID
  • Required
  • Must be an account of the authenticating user, in the same currency as the transfer itself
The identifier of the Barion wallet. This can be determined using the Accounts-Get-v2 API endpoint.
Amount Money
  • Required
  • Must be greater than zero
The total amount to transfer.
TargetEmail string
  • Required
The e-mail address of the recipient of the transfer. If they are an active Barion user, they receive the money instantly. If the e-mail address is not registered in Barion, they must register in 7 days in order to claim the money. If the money is not claimed, it gets transferred back to the sender.
Comment string
  • Optional
  • Maximum length: 1000 characters
The comment of the money transfer.

Output properties

Property name Property type Description
IsTransferSuccessful bool Indicates wether the e-money transfer was successfuly finished.