Difference between revisions of "Identification-Information-v2"

From Barion Documentation
Jump to navigation Jump to search
(Output properties)
Line 42: Line 42:
  
 
|}
 
|}
 +
 +
== Example ==
 +
 +
'''Request'''
 +
<syntaxhighlight lang="json">
 +
{
 +
    "PartnerKey": "630ee026-3e19-469f-8325-afc9bd1ae6a6",
 +
    "Email": "[email protected]"
 +
}
 +
</syntaxhighlight>
 +
 +
'''Response'''
 +
 +
<syntaxhighlight lang="json">
 +
{
 +
    "POSKey": "630ee026-3e19-469f-8325-afc9bd1ae6a6",
 +
    "PaymentType": "Immediate",
 +
    "PaymentRequestId": "EXMPLSHOP-PM-001",
 +
    "FundingSources": ["All"],
 +
    "Currency": "EUR",
 +
    "Transactions": [
 +
        {
 +
            "POSTransactionId": "EXMPLSHOP-PM-001/TR001",
 +
            "Payee": "[email protected]",
 +
            "Total": 37.2,
 +
            "Comment": "A brief description of the transaction",
 +
            "Items": [
 +
                {
 +
                    "Name": "iPhone 7 smart case",
 +
                    "Description": "Durable elegant phone case / matte black",
 +
                    "Quantity": 1,
 +
                    "Unit": "piece",
 +
                    "UnitPrice": 25.2,
 +
                    "ItemTotal": 25.2,
 +
                    "SKU": "EXMPLSHOP/SKU/PHC-01"
 +
                },
 +
                {
 +
                    "Name": "Fast delivery",
 +
                    "Description": "Next day delivery",
 +
                    "Quantity": 1,
 +
                    "Unit": "piece",
 +
                    "UnitPrice": 12,
 +
                    "ItemTotal": 12,
 +
                    "SKU": "EXMPLSHOP/SKU/PHC-01"
 +
                }
 +
            ]
 +
        }
 +
    ]
 +
}
 +
</syntaxhighlight>

Revision as of 09:23, 16 June 2017

Barion API: Fetch information about an organization

GET /v2/Identification/Information

The /identification/information API endpoint is used to fetch information about an organization for the remote identification process.

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.
Email string
  • Required
The e-mail address of an existing organization in Barion

Output properties

Property name Property type Description
CompanyRegisterInfo CompanyRegisterInfo A bundle object containing the detailed information about the organization

Example

Request

{
    "PartnerKey": "630ee026-3e19-469f-8325-afc9bd1ae6a6",
    "Email": "[email protected]"
}

Response

{
    "POSKey": "630ee026-3e19-469f-8325-afc9bd1ae6a6",
    "PaymentType": "Immediate",
    "PaymentRequestId": "EXMPLSHOP-PM-001",
    "FundingSources": ["All"],
    "Currency": "EUR",
    "Transactions": [
        {
            "POSTransactionId": "EXMPLSHOP-PM-001/TR001",
            "Payee": "[email protected]",
            "Total": 37.2,
            "Comment": "A brief description of the transaction",
            "Items": [
                {
                    "Name": "iPhone 7 smart case",
                    "Description": "Durable elegant phone case / matte black",
                    "Quantity": 1,
                    "Unit": "piece",
                    "UnitPrice": 25.2,
                    "ItemTotal": 25.2,
                    "SKU": "EXMPLSHOP/SKU/PHC-01"
                },
                {
                    "Name": "Fast delivery",
                    "Description": "Next day delivery",
                    "Quantity": 1,
                    "Unit": "piece",
                    "UnitPrice": 12,
                    "ItemTotal": 12,
                    "SKU": "EXMPLSHOP/SKU/PHC-01"
                }
            ]
        }
    ]
}