Transfer-Send-v1: Difference between revisions

From Barion Documentation
Jump to navigation Jump to search
No edit summary
Line 18: Line 18:


'''Important:''' API v1 calls are authenticated with your Barion username and password.
'''Important:''' API v1 calls are authenticated with your Barion username and password.
{{NotificationBox|title=Important|text=API v1 calls are authenticated with your Barion username and password.}}


= Input properties =
= Input properties =

Revision as of 11:54, 6 February 2017

Barion API: send money instantly inside Barion

POST /v1/Transfer/Send

The /transfer/send API endpoint is used to send money out of the Barion system via bank (wire) transfer.

Prerequisites before use:


v1 This API endpoint is available in API v1 only.

Important: API v1 calls are authenticated with your Barion username and password.

Important
API v1 calls are authenticated with your Barion username and password.

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
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

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