|
|
| (7 intermediate revisions by 4 users not shown) |
| Line 8: |
Line 8: |
| }} | | }} |
|
| |
|
| == Use cases == | | {{NotificationBox|title=WARNING|text=This API endpoint has been removed.|color=#FF0000}} |
| | | __NOTOC__ |
| This endpoint can transfer e-money from one wallet to another (identified by the card). Read more about it [[PartnerCard_Payment#TopUp_process|here]]
| |
| | |
| <span class="api-ver">v2</span> This API endpoint is available in '''API v2''' only.
| |
| | |
| == Input properties ==
| |
| | |
| {{api_input_table_header}}
| |
| |-
| |
| | PartnerKey || Guid ||
| |
| * Required
| |
| || The secret API key of the partner, generated by Barion.
| |
| | |
| |-
| |
| | SourceWalletLoginName || string||
| |
| * Required
| |
| || The Barion login name (e-mail address) of the facilitator. This is the source wallet for the transfer. The specified amount will be transferred from here to the wallet identified by the card. If topup fees are applicable for the transaction they will be charged here as well.
| |
| |-
| |
| | PrivateCardKey || string || - || The private key of the card.
| |
| |-
| |
| | CardPin|| string ||
| |
| * Required
| |
| * Min 4 Max 8 length alphanumeric string
| |
| || The PIN code associated with the card.
| |
| |-
| |
| | Amount || decimal || - || The amount that should be topped up to the wallet.
| |
| |-
| |
| | Currency || decimal ||
| |
| * Required
| |
| * Required length: 3 characters
| |
| * Accepted values:
| |
| ** "HUF" (Hungarian Forint)
| |
| ** "EUR" (Euro)
| |
| **"USD" (U.S. Dollar)
| |
| || The currency of the transaction
| |
| |-
| |
| | Agent || [[TopUpAgent]] || - || The agent that processes the topup
| |
| |-
| |
| |}
| |
| | |
| == Output properties == | |
| | |
| {{api_output_table_header}}
| |
| |-
| |
| | WasTopUpSuccessful || bool || True, if the process was successful.
| |
| |-
| |
| | TopUpTransactionId || string || The Id of the topup
| |
| |-
| |
| |}
| |
| | |
| == Possible error responses ==
| |
| {| class="wikitable api-table"
| |
| ! Error code || Description
| |
| |-
| |
| | InvalidCardKey|| The card key provided either doesn't belong to a card or the card is already issued.
| |
| |-
| |
| | UserCantMakeOutgoingTransaction || The source of the transfer, the facilitator user is not allowed to make outgoing transactions. Probably suspended.
| |
| |-
| |
| | InvalidUser || Something is seriously broken with an account in the transaction.
| |
| |-
| |
| | TopUpFailed || The topup process failed because of a system error.
| |
| |-
| |
| |}
| |