Withdraw-BankTransfer-v2: Difference between revisions

From Barion Documentation
Jump to navigation Jump to search
Line 21: Line 21:
{{api_input_table_header}}
{{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 ||  
| Currency || string ||  
* Required
* Required

Revision as of 11:48, 6 February 2017

Barion API: Initiate a bank transfer

POST /v2/Withdraw/BankTransfer

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

Prerequisites before use:


v2 This API endpoint is available in API v2 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
The currency of the bank transfer.

Note: Barion does not do currency rate conversion. The caller must have an active account with the selected currency, and must ensure that the target bank accepts the selected currency.

Amount decimal
  • Required
  • Must be greater than zero
The total amount to withdraw, excluding fees.
RecipientName string
  • Required
The name of the recipient of the bank transfer.
Comment string
  • Optional
  • Maximum length: 90 characters
The comment of the bank transfer.
BankAccount BankAccount
  • Required
Information about the recipient's bank account.

Output properties

Property name Property type Description
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.