Topup-StornoPartnerCardTopup-v2: Difference between revisions
Jump to navigation
Jump to search
| Line 77: | Line 77: | ||
<syntaxhighlight lang="json"> | <syntaxhighlight lang="json"> | ||
{ | { | ||
"IsSuccessful": true, | |||
"StornoTransactionId": "dd340248-03ae-4883-a1b7-b0f268721e2e" | |||
} | } | ||
</syntaxhighlight> | </syntaxhighlight> | ||
Revision as of 07:06, 9 August 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 |
| PartnerDataCannotBeRetrieved | The trusted partner data could not be retrieved (possibly has no rights for this endpoint) |
| AuthenticationFailed | Authentication failed for the target organization (incorrect login name or password) |
| RemoteRegisterInfoReturnedWithError | The company register service returned an error |
| RegisterInfoCannotBeRetrievedFromDb | The company register record could not be retrieved from the Barion database. Please contact the Barion support. |
| RegisterInfoCannotBeRetrievedFromRemote | The company register record could not be retrieved from the remote service. Possible causes:
|
Example
Request
{
"PartnerKey": "3275b3c5-b6e4-4460-8b8d-a4bd20105511",
"TransactionId": "1e995837-b22d-43cd-b4aa-47186cae457e"
}Response
{
"IsSuccessful": true,
"StornoTransactionId": "dd340248-03ae-4883-a1b7-b0f268721e2e"
}