Skip to main content

Get Payment Link Details

GET 
/payment-links/:paymentLinkId

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)

Request​

Path Parameters

    paymentLinkId stringrequired

    The unique identifier for the payment link.

Header Parameters

    Content-Type stringrequired

    Must be application/json

    Accept-Language stringrequired

    Must be be en-US

    Origin stringrequired

    The origin of the request

    User-Agent stringrequired

    The client making the request

Responses​

Successful response with payment link details.

success

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

info

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

Schema
    idstring

    The unique identifier for the payment link.

    creationDatestring<date-time>

    The date when the payment link was created.

    expiryDatestring<date-time>

    The expiration date of the payment link.

    successUrlstring<uri>

    The URL to redirect to on successful payment.

    failureUrlstring<uri>

    The URL to redirect to on failed payment.

    templateContext object

    Template context for the Hosted Payment Page. Once provided, it is used by SmartPay to render a specific HTML with customized properties.

    templateIdstring

    The ID of the template used.

    templateNamestring

    The name of the template used.

    merchantLogoURLstring<uri>

    The URL of the merchant's logo.

    customerAccountIdstring

    The customer account ID associated with the payment link.

    payment object

    The payment amount to be charged against the payment option.

    amountnumber<decimal>required
    currencyCodestringrequired

    Possible values: <= 3 characters

    descriptionstringrequired

    Possible values: <= 127 characters

    billingAddress object

    Consumer's billing address data. See Address in Data model.

    addressLine1stringrequired

    Street name.

    Possible values: <= 60 characters

    Example: Max-Planck-Straße
    addressLine2string

    Apartment, suite, unit, building, floor or other secondary address information.

    Possible values: <= 60 characters

    addressLine3string

    Specific delivery instructions, department names, or additional floor information.

    Possible values: <= 60 characters

    citystringrequired

    The city or localitly of the address.

    Possible values: <= 50 characters

    Example: Berlin
    countryCodestringrequired

    ISO-3 code of the address country (e.g., DEU for Germany).

    Possible values: >= 3 characters and <= 3 characters

    Example: DEU
    numberstring

    The house or building number corresponding to the street address.

    Possible values: <= 10 characters

    Example: 30
    postCodestringrequired

    The postal or ZIP code of the address.

    Possible values: <= 10 characters

    Example: 14473
    statestring

    3-letter code of the address state. Mandatory when countryCode corresponds to Canada or USA.

    Possible values: <= 3 characters

    consumer objectnullable

    Consumer's personal data, in case the consumer is a physical person. See consumer in Data model.

    culturestring

    Consists of ISO 639-1 language code and ISO 3166-1 alpha-2 country code separated by dash. If this value is not provided the browser culture is used. Default culture is English (e.g., en-de). This field is not case sensitive.

    Possible values: <= 5 characters

    Example: en-EN
    dateOfBirthstring<date>

    Date of birth. Format - YYYY-MM-DD. Mandatory for payment option registration flow. Minimum date allowed is 1900-01-01

    Possible values: <= 10 characters, Value must match regular expression ^\d{4}-\d{2}-\d{2}$

    Example: 1989-11-08
    emailAddressstring<email>required

    Customer email address for any notification

    Possible values: <= 255 characters

    Example: john.doe@gmail.com
    firstNamestringrequired

    Person first name

    Possible values: <= 60 characters

    Example: John
    genderstring

    Person gender

    Possible values: <= 6 characters

    Example: Mr
    homePhonestring

    Person's home phone number (including the country code)

    Possible values: <= 30 characters

    Example: 496912345678
    lastNamestringrequired

    Person last name

    Possible values: <= 60 characters

    Example: Doe
    merchantCustomerIdstring

    Consumer/Customer Account Id in the merchant system. When provided into the Create Checkout API, SmartPay will request e-wallet account creation which will have external account reference equals to the given merchantCustomerId value.

    Possible values: <= 255 characters

    Example: abcd123
    middleNamestring

    The customer's middle name

    Possible values: <= 60 characters

    Example: Robert
    mobilePhonestring

    Person's mobile phone number (including the country code)

    Possible values: <= 30 characters

    Example: 496912345678
    taxIdstring

    Person's tax identification number

    Possible values: <= 30 characters

    Example: 123456789
    timezonestring

    Preferred timezone name

    Possible values: <= 50 characters

    Example: CET
    titlestring

    Person title

    Possible values: <= 3 characters

    Example: Mr
    workPhonestring

    Person's work phone number (including the country code)

    Possible values: <= 30 characters

    Example: 496912345678
    order object

    Purchased order details.

    externalOrderReferencestringrequired

    Possible values: <= 225 characters

    lines orderLine[]required
  • Array [
    • additionalData object[]
  • Array [
    • namestring

    Possible values: <= 100 characters

    valuestring

    Possible values: <= 255 characters

  • ]
    • lines object[]

    List of purchased items associated with the order.

  • Array [
    • lineNumberintegerrequired

    Sequential line number of the item in the order.

    itemArticleIdstringrequired

    Unique identifier or SKU of the purchased item.

    Possible values: <= 64 characters

    itemNamestringrequired

    Name or description of the purchased item.

    Possible values: <= 255 characters

    quantityintegerrequired

    Quantity of the item purchased.

    unitPricenumber<decimal>required

    Unit net price (excluding VAT) of a single item.

    Possible values: >= 0

    unitVatPricenumber<decimal>

    VAT amount per unit item.

    Possible values: >= 0

    unitGrossPricenumber<decimal>required

    Unit gross price (net price + VAT) of a single item.

    Possible values: >= 0

    vatPercentnumber<decimal>required

    VAT percentage applied to the item.

    Possible values: >= 0 and <= 100

    netAmountnumber<decimal>required

    Total net amount for the line (quantity × unit net price).

    Possible values: >= 0

    vatAmountnumber<decimal>required

    Total VAT amount for the line (quantity × unit VAT price).

    Possible values: >= 0

    grossAmountnumber<decimal>required

    Total gross amount for the line (net amount + VAT amount).

    Possible values: >= 0

  • ]
  • ]
    • totals object
    grossAmountnumber<decimal>

    Total gross amount for the line (net amount + VAT amount).

    Possible values: >= 0

    netAmountnumber<decimal>

    Total net amount for the line (quantity × unit net price).

    Possible values: >= 0

    vatAmountnumber<decimal>

    Total VAT amount for the line (quantity × unit VAT price).

    Possible values: >= 0

    paymentUrlstring<uri>

    Hosted payment page URL where the customer can complete the payment.

    Possible values: <= 512 characters

    qrCodeUrlstring<uri>

    QR code image URL representing the payment link.

    Possible values: <= 512 characters

    latestTransactionIdstring<uuid>

    Unique identifier of the latest associated transaction.

    latestTransactionStatusstring

    Current status of the latest transaction (e.g., AUTHORIZED, CAPTURED, SETTLED).

    Possible values: <= 32 characters

 Imprint
|
Data protection and privacy
© 2026 J.P. Morgan Mobility Payments Systems GmbH. All rights reserved.