Get Payment Link Details

Last changes: 07-03-2023

This API method enables retrieving the Payment Link, the linked QR code, and its related details:

The latest linked Transaction Id and its status
Order
Payment object
Consumer object and the customerAccountId (if applicable)

API Parameters

The request must have the following headers:

Content-Type: application/json

Accept-Language: en-US

Origin: { Origin }

Example

Request

Path:: GET {Base URL}/payment-links/1fae0965-1ad3-4a4e-ac12-bcda333cef2a
Header:: Content-Type: application/json
Accept-Language: en-US

The Get Payment Link Details response includes the Transaction Id linekd to the payment link, which could be used to call the Get Payment Status API, to retrieve the transaction full set of information.

Response

{
    "id": "1fae0965-1ad3-4a4e-ac12-bcda333cef2a",
    "creationDate": "2022-11-30T18:14:51.227Z",
    "expiryDate": "2022-12-03T18:14:51.138Z",
    "successUrl": "https://google.com/",
    "failureUrl": "https://yahoo.com/",
    "templateContext": {
        "templateId": "5e034b23-ab82-47fd-87a4-7c75a4b94bab",
        "templateName": "Blue Label",
        "merchantLogoURL": "https://hpp.cons.smartpay.vwfs.io/assets/359a5691-dcdd-4a12-87e6-458630e3ce46/merchantLogo"
    },
    "customerAccountId": "test6gN4aJIR7B",
    "payment": {
        "currencyCode": "EUR",
        "description": "VWFS*SMARTPAY*01BA",
        "amount": 800.2
    },
    "billingAddress": {
        "number": "244",
        "city": "Munich",
        "countryCode": "DE",
        "addressLine1": "Leopoldstrasse",
        "addressLine2": "line 2",
        "postCode": "80807",
        "addressLine3": "line 3"
    },
    "consumer": {
        "lastName": "Johny",
        "firstName": "Doe",
        "emailAddress": "test6gN4aJIR7B@mail.com",
        "dateOfBirth": "1980-10-19"
    },
    "order": {
        "externalOrderReference": "123-333",    
        "lines":[
            {
                "lineNumber": 1,
                "itemArticleId":"321456",
                "itemName":"tires A",
                "quantity":2,
                "unitPrice":125,
                "unitVatPrice":0,
                "unitGrossPrice":125,
                "vatPercent":0,
                "netAmount":250,
                "vatAmount":0,
                "grossAmount":250
            },
            {
                "lineNumber": 1,
                "itemArticleId":"321456",
                "itemName":"tires B",
                "quantity":2,
                "unitPrice":125,
                "unitVatPrice":0,
                "unitGrossPrice":125,
                "vatPercent":0,
                "netAmount":250,
                "vatAmount":0,
                "grossAmount":250
            }
        ]
    },
    "paymentUrl": "https://hpp.cons.smartpay.vwfs.io/1fae0965-1ad3-4a4e-ac12-bcda333cef2a",
    "qrCodeUrl": "https://hpp.cons.smartpay.vwfs.io/assets/359a5691-dcdd-4a12-87e6-458630e3ce46/qrCodes/1fae0965-1ad3-4a4e-ac12-bcda333cef2a.png",
    "latestTransactionId": "1c5675f8-1580-4f76-b7f5-b4f574982bbb",
    "latestTransactionStatus": "SETTLED"
}

If you receive an HTTP status other then 2xx, the request failed. Please try to interpret the response message to correct your request and contact customer support in case of further questions.

Document version 1.0 - 2022-11-30 - HPP documentation

Previous

Next