Topup-StornoPartnerCardTopup-v2: Difference between revisions

From Barion Documentation
Jump to navigation Jump to search
VisualWikitext
(Created page with "{{PageTitle|title=Barion API: Storno/reverse a previously completed partner card topup}} {{TableOfContents}} {{api_callmethod |method=POST |uri=/v2/Topup/StornoPartnerCardTo...")
 
 
(6 intermediate revisions by one other user not shown)
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
|}
|}


Line 46: Line 48:
| NoIdentifiedPartnerFound || The given partner key was not valid
| NoIdentifiedPartnerFound || The given partner key was not valid
|-
|-
| PartnerDataCannotBeRetrieved || The trusted partner data could not be retrieved (possibly has no rights for this endpoint)
| NotExistingTransactionId || The given topup transaction was not found in the database
|-
|-
| AuthenticationFailed || Authentication failed for the target organization (incorrect login name or password)
| SourceAccountNotAllowedForPartner || The originally specified source Barion wallet was not connected to the trusted partner
|-
|-
| RemoteRegisterInfoReturnedWithError || The company register service returned an error
| StornoTopupFailed || The topup process could not be completed due to an unknown error (contact the developer support)
|-
|-
| RegisterInfoCannotBeRetrievedFromDb || The company register record could not be retrieved from the Barion database. Please contact the Barion support.
| MultipleStornoNotAllowed || The storno stransaction is illegeal because the original topup was already rolled back.  
|-  
| 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
|-
|-
|}
|}
Line 63: Line 61:


'''Request'''
'''Request'''
<syntaxhighlight lang="html">https://api.barion.com/v2/identification/information?PartnerKey=630ee026-3e19-469f-8325-afc9bd1ae6a6&[email protected]&Password=5tr0Ng_Pa55w0rD</syntaxhighlight>
 
<syntaxhighlight lang="json">
{
    "PartnerKey": "3275b3c5-b6e4-4460-8b8d-a4bd20105511",
    "TransactionId": "1e995837-b22d-43cd-b4aa-47186cae457e"
}
</syntaxhighlight>


'''Response'''
'''Response'''
Line 69: Line 73:
<syntaxhighlight lang="json">
<syntaxhighlight lang="json">
{
{
     "CompanyRegisterInfo": {
     "IsSuccessful": true,
        "RegistrationNumber": "12345678-1234",
    "StornoTransactionId": "dd340248-03ae-4883-a1b7-b0f268721e2e"
        "OrganizationName": "Barion Payment Zrt.",
        "OrganizationShortName": "Barion Payment Zrt.",
        "HeadQuarter": {
            "Address": "1117 Budapest, Infopark sétány 1. I épület",
            "Country": "Magyarország",
            "CountryCode": "HU",
            "Zip": "1117",
            "City": "Budapest",
            "Street": "Infopark sétány",
            "Housenumber": "1. I épület 5. emelet"
        },
        "PostalAddress": {
            "Address": "1117 Budapest, Infopark sétány 1. I épület",
            "Country": "Magyarország",
            "CountryCode": "HU",
            "Zip": "1117",
            "City": "Budapest",
            "Street": "Infopark sétány",
            "Housenumber": "1. I épület 5. emelet"
        },
        "MainActivity": "Egyéb szoftverkiadás",
        "MainActivityCodde": "5829",
        "TaxNumber": "00112233",
        "Branch": "00112233",
        "Ownership": "Zártkörűen működő részvénytársaság",
        "RegisteredAt": "2015-09-01T00:00:00",
        "DeletedAt": "0001-01-01T00:00:00",
        "DeletionMode": null,
        "Note": null,
        "Representatives": [
            {
                "RepresentationMode": "Meghatalmazott",
                "CanSign": true,
                "Office": "végelszámoló",
                "Email": "[email protected]",
                "Person": {
                    "FullName": "Teszt Tibor",
                    "LastName": "Teszt",
                    "FirstName": "Tibor",
                    "BirthDate": "1978-05-23T00:00:00.000",
                    "MothersName": "Teszt Teréz",
                    "MothersLastName": "Teszt",
                    "MothersFirstName": "Teréz",
                    "TaxNumber": "9955884466",
                    "Address": {
                        "Address": "1134 Budapest, Szilágyi utca 2.",
                        "Country": "Magyarország",
                        "CountryCode": "HU",
                        "Zip": "1134",
                        "City": "Budapest",
                        "Street": "Szilágyi utca",
                        "Housenumber": "2."
                    },
                    "AddressString": "1134 Budapest, Szilágyi utca 2."
                }
            }
        ],
        "Members": [
            {
                "Person": {
                    "FullName": "Példa Péter",
                    "LastName": "Példa",
                    "FirstName": "Péter",
                    "BirthDate": "1980-12-03T00:00:00.000",
                    "MothersName": "Péda Panna",
                    "MothersLastName": "Példa",
                    "MothersFirstName": "Panna",
                    "TaxNumber": "001122889977",
                    "Address": {
                        "Address": "1152 Budapest, Kossuth utca 35.",
                        "Country": "Magyarország",
                        "CountryCode": "HU",
                        "Zip": "1152",
                        "City": "Budapest",
                        "Street": "Kossuth utca",
                        "Housenumber": "35."
                    },
                    "AddressString": "1152 Budapest, Kossuth utca 35."
                }
            }
        ]
    }
}
}
</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
  • 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
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"
}
Retrieved from "https://docs.barion.com/index.php?title=Topup-StornoPartnerCardTopup-v2&oldid=1090"