Transfer-Send-v1: Difference between revisions

From Barion Documentation
Jump to navigation Jump to search
No edit summary
 
(16 intermediate revisions by 4 users not shown)
Line 1: Line 1:
{{PageTitle|title=Barion API: send money instantly inside Barion}}
{{PageTitle|title=Barion API: send money instantly}}


{{TableOfContents}}
{{TableOfContents}}
Line 8: Line 8:
}}
}}


The <code>/transfer/send</code> API endpoint is used to send money out of the Barion system via bank (wire) transfer.
{{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.
 
'''Important:''' API v1 calls are authenticated with your Barion username and password.
 
= 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
|| 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.
 
|-
 
| 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 bank transfer, generated by the Barion system.
 
|-
 
| Currency || string || The currency of the bank transfer.
 
|-
 
| Amount || decimal || The total amount transferred.
 
|-
 
| RecipientName || string || The name of the recipient of the transfer.
 
|-
 
| Comment || string || The comment of the bank transfer
 
|-
 
| BankAccount|| [[BankAccount]] || The bank account data.
 
|}

Latest revision as of 13:48, 12 December 2023

Barion API: send money instantly

POST /v1/Transfer/Send
WARNING
This API endpoint has been removed. Use Transfer-Email-v2 instead.