|
|
| (4 intermediate revisions by 3 users not shown) |
| Line 8: |
Line 8: |
| }} | | }} |
|
| |
|
| 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 has been removed. Use [[Transfer-Email-v2]] instead.|color=#FF0000}} |
| | |
| Prerequisites before use:
| |
| * [[Creating_an_account|Creating an account in Barion]]
| |
| * [[Calling_the_API|Calling the Barion API]]
| |
| | |
| | |
| <span class="api-ver">v1</span> This API endpoint is available in '''API v1''' only.
| |
| | |
| == Input properties ==
| |
| | |
| {{api_input_table_header}}
| |
| |-
| |
| | |
| | UserName || string ||
| |
| * Required
| |
| || Your e-mail address in the Barion system.
| |
| | |
| |-
| |
| | |
| | Password || string ||
| |
| * Required
| |
| || Your password in the Barion system.
| |
| | |
| |-
| |
| | |
| | Currency || string ||
| |
| * Required
| |
| * Required length: 3 characters
| |
| * Accepted values:
| |
| ** "CZK" (Czech crown)
| |
| ** "EUR" (Euro)
| |
| ** "HUF" (Hungarian forint)
| |
| ** "USD" (U.S. dollar)
| |
| || 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 ||
| |
| * Required
| |
| * Must be greater than zero
| |
| || The total amount to transfer.
| |
| | |
| |-
| |
| | |
| | Recipient || 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 ==
| |
| | |
| {{api_output_table_header}}
| |
| |-
| |
| | |
| | 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.
| |
| * 1 = incoming
| |
| * 0 = outgoing
| |
| | |
| |}
| |