Topup-StornoPartnerCardTopup-v2: Difference between revisions

From Barion Documentation
Jump to navigation Jump to search
Line 37: Line 37:
{{api_output_table_header}}
{{api_output_table_header}}
|-
|-
| CompanyRegisterInfo || [[CompanyRegisterInfo]] || A bundle object containing the detailed information about the organization
| IsSuccessful || bool || Indicates wether the storno process was successful
|-
| StornoTransactionId || Guid || The identifier of the resulting storno transaction
|}
|}



Revision as of 07:01, 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
  • Required
The secret API key of the trusted partner, generated by Barion.
TransactionId Guid
  • Required
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:
  • The given company is not based in Hungary (there is no service to call)
  • The company register remote service is down

Example

Request

{

}

Response

{

}