Transfer-Send-v1: Difference between revisions
Jump to navigation
Jump to search
mNo edit summary |
m (Added new version of API endpoint in deprecation notice.) |
||
| Line 10: | Line 10: | ||
The <code>/transfer/send</code> API endpoint is used to send e-money between Barion users or outside Barion. | The <code>/transfer/send</code> API endpoint is used to send e-money between Barion users or outside Barion. | ||
{{NotificationBox|title=WARNING|text=This API endpoint is deprecated.|color=#FF7A3D}} | {{NotificationBox|title=WARNING|text=This API endpoint is deprecated. Use [[Transfer-Email-v2]] instead.|color=#FF7A3D}} | ||
Prerequisites before use: | Prerequisites before use: | ||
Revision as of 13:18, 12 December 2023
Barion API: send money instantly
| POST | /v1/Transfer/Send |
|---|
The /transfer/send API endpoint is used to send e-money between Barion users or outside Barion.
WARNING
This API endpoint is deprecated. Use Transfer-Email-v2 instead.
Prerequisites before use:
v1 This API endpoint is available in API v1 only.
Authentication
Input properties
| Property name | Property type | Limitations and constraints | Description |
|---|---|---|---|
| Currency | string |
|
The currency of the money transfer.
Note: Barion does not do currency rate conversion. The caller must have an active account with the selected currency. If the recipient does not have an active account with the selected currecy, the system automatically creates one for them. |
| Amount | decimal |
|
The total amount to transfer. |
| Recipient | 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 |
|---|---|---|
| TransactionId | Guid | The unique identifier of the transfer, generated by the Barion system. |
| Currency | string | The currency of the money transfer. |
| Amount | decimal | The total amount transferred. |
| FromBalance | decimal | The remaining balance of the sender. |
| FromName | string | The name of the sender of the transfer. |
| ToName | string | The name of the recipient of the transfer. |
| Comment | string | The comment of the bank transfer. |
| TransactionType | TransactionType | The type of the transaction in the Barion system. |
| Direction | int | The direction of the transfer.
|