Topup-StornoPartnerCardTopup-v2: Difference between revisions
Jump to navigation
Jump to search
| (5 intermediate revisions by one other user not shown) | |||
| Line 37: | Line 37: | ||
{{api_output_table_header}} | {{api_output_table_header}} | ||
|- | |- | ||
| | | IsSuccessful || bool || Indicates wether the storno process was successful | ||
|- | |||
| StornoTransactionId || Guid || The identifier of the resulting storno transaction | |||
|} | |} | ||
| Line 46: | Line 48: | ||
| NoIdentifiedPartnerFound || The given partner key was not valid | | NoIdentifiedPartnerFound || The given partner key was not valid | ||
|- | |- | ||
| | | NotExistingTransactionId || The given topup transaction was not found in the database | ||
|- | |||
| SourceAccountNotAllowedForPartner || The originally specified source Barion wallet was not connected to the trusted partner | |||
|- | |- | ||
| | | StornoTopupFailed || The topup process could not be completed due to an unknown error (contact the developer support) | ||
|- | |- | ||
| | | MultipleStornoNotAllowed || The storno stransaction is illegeal because the original topup was already rolled back. | ||
|- | |- | ||
|} | |} | ||
| Line 66: | Line 64: | ||
<syntaxhighlight lang="json"> | <syntaxhighlight lang="json"> | ||
{ | { | ||
"PartnerKey": "3275b3c5-b6e4-4460-8b8d-a4bd20105511", | |||
"TransactionId": "1e995837-b22d-43cd-b4aa-47186cae457e" | |||
} | } | ||
</syntaxhighlight> | </syntaxhighlight> | ||
| Line 74: | Line 73: | ||
<syntaxhighlight lang="json"> | <syntaxhighlight lang="json"> | ||
{ | { | ||
"IsSuccessful": true, | |||
"StornoTransactionId": "dd340248-03ae-4883-a1b7-b0f268721e2e" | |||
} | } | ||
</syntaxhighlight> | </syntaxhighlight> | ||
Latest revision as of 08:38, 5 September 2017
Barion API: Storno/reverse a previously completed partner card topup
| POST | /v2/Topup/StornoPartnerCardTopup |
|---|
The /topup/stornopartnercardtopup API endpoint is used to reverse the transfer previously initiated by a topup via partner card.
Prerequisites before use:
v2 This API endpoint is available in API v2 only.
partners This API endpoint is available for trusted Barion partners only.
Input properties
| Property name | Property type | Limitations and constraints | Description |
|---|---|---|---|
| PartnerKey | Guid |
|
The secret API key of the trusted partner, generated by Barion. |
| TransactionId | Guid |
|
The identifier of the topup transaction |
Output properties
| Property name | Property type | Description |
|---|---|---|
| IsSuccessful | bool | Indicates wether the storno process was successful |
| StornoTransactionId | Guid | The identifier of the resulting storno transaction |
Possible error responses
| Error code | Description |
|---|---|
| NoIdentifiedPartnerFound | The given partner key was not valid |
| NotExistingTransactionId | The given topup transaction was not found in the database |
| SourceAccountNotAllowedForPartner | The originally specified source Barion wallet was not connected to the trusted partner |
| StornoTopupFailed | The topup process could not be completed due to an unknown error (contact the developer support) |
| MultipleStornoNotAllowed | The storno stransaction is illegeal because the original topup was already rolled back. |
Example
Request
{
"PartnerKey": "3275b3c5-b6e4-4460-8b8d-a4bd20105511",
"TransactionId": "1e995837-b22d-43cd-b4aa-47186cae457e"
}Response
{
"IsSuccessful": true,
"StornoTransactionId": "dd340248-03ae-4883-a1b7-b0f268721e2e"
}