Transfer-Send-v1

From Barion Documentation
Revision as of 12:40, 23 December 2019 by Vinczei (talk | contribs)
Jump to navigation Jump to search

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.

Prerequisites before use:

v1 This API endpoint is available in API v1 only.

Input properties

Property name Property type Limitations and constraints Description
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

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.
  • 1 = incoming
  • 0 = outgoing