Payment-Refund-v2: Difference between revisions
Jump to navigation
Jump to search
No edit summary |
|||
| Line 22: | Line 22: | ||
<span class="api-ver">v2</span> This API endpoint is available in '''API v2''' only. | <span class="api-ver">v2</span> This API endpoint is available in '''API v2''' only. | ||
= Use cases = | == Use cases == | ||
This API endpoint is designed to be used in the following scenarios: | This API endpoint is designed to be used in the following scenarios: | ||
* [[Responsive_web_payment|Responsive Web Payment]] | * [[Responsive_web_payment|Responsive Web Payment]] | ||
= Input properties = | == Input properties == | ||
{{api_input_table_header}} | {{api_input_table_header}} | ||
| Line 49: | Line 49: | ||
|} | |} | ||
= Output properties = | == Output properties == | ||
{{api_output_table_header}} | {{api_output_table_header}} | ||
Revision as of 13:25, 6 February 2017
Barion API: Execute the refund of a payment
| GET | /v2/Payment/Refund |
|---|
The /payment/refund API endpoint is used to execute a refund of an existing, completed payment.
Prerequisites before use:
- Creating an account in Barion
- Creating a shop in Barion
- Calling the Barion API
- API: /Payment/Start
- API: /Payment/GetPaymentState
v2 This API endpoint is available in API v2 only.
Use cases
This API endpoint is designed to be used in the following scenarios:
Input properties
| Property name | Property type | Limitations and constraints | Description |
|---|---|---|---|
| POSKey | Guid |
|
The secret API key of the shop, generated by Barion. This lets the shop to authenticate through the Barion API, but does not provide access to the account owning the shop itself. |
| PaymentId | Guid |
|
The identifier of the payment in the Barion system. |
| TransactionsToRefund | TransactionToRefund[] |
|
An array containing the payment transactions to refund. |
Output properties
| Property name | Property type | Description |
|---|---|---|
| PaymentId | Guid | The identifier of the payment in the Barion system. |
| RefundedTransactions | RefundedTransaction[] | An array containing information about the refunded transactions. |