Transfer-Email-v2: Difference between revisions
Jump to navigation
Jump to search
(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...") |
mNo edit summary |
||
| (2 intermediate revisions by 2 users not shown) | |||
| Line 8: | Line 8: | ||
}} | }} | ||
The <code>/transfer/email</code> API endpoint is used to send | The <code>/transfer/email</code> API endpoint is used to send money to another Barion Wallet. | ||
Prerequisites before use: | Prerequisites before use: | ||
| 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}} | ||
|- | |- | ||
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. |