Transfer-Email-v2: Difference between revisions

From Barion Documentation
Jump to navigation Jump to search
mNo edit summary
mNo edit summary
 
(One intermediate revision by the same user not shown)
Line 16: Line 16:


<span class="api-ver">v2</span> This API endpoint is available in '''API v2''' only.
<span class="api-ver">v2</span> This API endpoint is available in '''API v2''' only.
== Authentication ==
[[Barion Wallet Authentication]]


== Input properties ==
== Input properties ==


{{api_input_table_header}}
{{api_input_table_header}}
|-
| UserName || string ||
* Required
|| Your e-mail address in the Barion system.
|-
| Password || string ||
* Required
|| Your password in the Barion system.
|-
|-



Latest revision as of 10:53, 15 November 2022

Barion API: send money to an e-mail address

POST /v2/Transfer/Email

The /transfer/email API endpoint is used to send money to another Barion Wallet.

Prerequisites before use:


v2 This API endpoint is available in API v2 only.

Authentication

Barion Wallet Authentication

Input properties

Property name Property type Limitations and constraints Description
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.