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..." |
No edit summary |
||
| (3 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}} | ||
|- | |- | ||
| Line 68: | Line 60: | ||
| IsTransferSuccessful || bool || Indicates wether the e-money transfer was successfuly finished. | | IsTransferSuccessful || bool || Indicates wether the e-money transfer was successfuly finished. | ||
|} | |||
== Possible error responses == | |||
{| class="wikitable api-table" | |||
! Error code || Description | |||
|- | |||
| UserDoesNotHaveAccountInRequiredCurrency|| The caller wallet does not have an account in the specified currency. | |||
|- | |||
| ModelValidationError || One or more fields contain an invalid value. See the error description for details. | |||
|- | |||
| InvalidAccount || The specified account does not exists. | |||
|- | |||
| UserIsSuspended || The user is suspended and cannot send money. | |||
|- | |||
| PayerDoesNotHaveEnoughMoney || The user doesn't have enough available balance to complete the transaction. | |||
|- | |||
| ExceedsBalanceLimit || The transaction exceeds the user's limit. | |||
|- | |||
| TransferToEmailFailed || The money transfer failed due to a system error. | |||
|- | |||
| SourceAccountDeleted || The sender account was deleted. | |||
|- | |||
| TargetAccountDeleted || The target account was deleted. | |||
|- | |||
|} | |} | ||
Latest revision as of 08:59, 12 October 2026
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. |
Possible error responses
| Error code | Description |
|---|---|
| UserDoesNotHaveAccountInRequiredCurrency | The caller wallet does not have an account in the specified currency. |
| ModelValidationError | One or more fields contain an invalid value. See the error description for details. |
| InvalidAccount | The specified account does not exists. |
| UserIsSuspended | The user is suspended and cannot send money. |
| PayerDoesNotHaveEnoughMoney | The user doesn't have enough available balance to complete the transaction. |
| ExceedsBalanceLimit | The transaction exceeds the user's limit. |
| TransferToEmailFailed | The money transfer failed due to a system error. |
| SourceAccountDeleted | The sender account was deleted. |
| TargetAccountDeleted | The target account was deleted. |