Transfer-Email-v2: Difference between revisions
Jump to navigation
Jump to search
(change auth description) |
mNo edit summary |
||
| Line 13: | Line 13: | ||
* [[Creating_an_account|Creating an account in Barion]] | * [[Creating_an_account|Creating an account in Barion]] | ||
* [[Calling_the_API|Calling the Barion API]] | * [[Calling_the_API|Calling the Barion API]] | ||
<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 == | ||
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
Input properties
| Property name | Property type | Limitations and constraints | Description |
|---|---|---|---|
| SourceAccountId | GUID |
|
The identifier of the Barion wallet. This can be determined using the Accounts-Get-v2 API endpoint. |
| Amount | Money |
|
The total amount to transfer. |
| TargetEmail | string |
|
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 |
|
The comment of the money transfer. |
Output properties
| Property name | Property type | Description |
|---|---|---|
| IsTransferSuccessful | bool | Indicates wether the e-money transfer was successfuly finished. |