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.

tip

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

    id string

    The unique identifier for the payment link.

    creationDate date-time

    The date when the payment link was created.

    expiryDate date-time

    The expiration date of the payment link.

    successUrl uri

    The URL to redirect to on successful payment.

    failureUrl 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.

    templateId string

    The ID of the template used.

    templateName string

    The name of the template used.

    merchantLogoURL uri

    The URL of the merchant's logo.

    customerAccountId string

    The customer account ID associated with the payment link.

    payment

    object

    The payment amount to be charged against the payment option.

    amount decimalrequired
    currencyCode stringrequired

    Possible values: <= 3 characters

    description stringrequired

    Possible values: <= 127 characters

    billingAddress

    object

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

    addressLine1 stringrequired

    Possible values: <= 60 characters

    Street name.

    addressLine2 string

    Possible values: <= 60 characters

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

    addressLine3 string

    Possible values: <= 60 characters

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

    city stringrequired

    Possible values: <= 50 characters

    The city or localitly of the address.

    countryCode stringrequired

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

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

    number string

    Possible values: <= 10 characters

    The house or building number corresponding to the street address.

    postCode stringrequired

    Possible values: <= 10 characters

    The postal or ZIP code of the address.

    state string

    Possible values: <= 3 characters

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

    consumer

    object

    Consumer's personal data, in case the consumer is a physical person.
    Mandatory, unless businessConsumer is provided.
    consumer and businessConsumer objects may not be submitted together.

    culture string

    Possible values: <= 5 characters

    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.

    dateOfBirth date

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

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

    emailAddress emailrequired

    Possible values: <= 255 characters

    Customer email address for any notification

    firstName stringrequired

    Possible values: <= 60 characters

    Person first name

    gender string

    Possible values: <= 6 characters

    Person gender

    homePhone string

    Possible values: <= 30 characters

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

    lastName stringrequired

    Possible values: <= 60 characters

    Person last name

    merchantCustomerId string

    Possible values: <= 255 characters

    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.

    middleName string

    Possible values: <= 60 characters

    The customer's middle name

    mobilePhone string

    Possible values: <= 30 characters

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

    taxId string

    Possible values: <= 30 characters

    Person's tax identification number

    timezone string

    Possible values: <= 50 characters

    Preferred timezone name

    title string

    Possible values: <= 3 characters

    Person title

    workPhone string

    Possible values: <= 30 characters

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

    order

    object

    Purchased order details.

    externalOrderReference stringrequired

    Possible values: <= 225 characters

    lines

    orderLine[]

    required

  • Array [

    • additionalData

    object[]

  • Array [

    • name string

    Possible values: <= 100 characters

    value string

    Possible values: <= 255 characters

  • ]

    • lines

    object[]

    List of purchased items associated with the order.

  • Array [

    • lineNumber integerrequired

    Sequential line number of the item in the order.

    itemArticleId stringrequired

    Possible values: <= 64 characters

    Unique identifier or SKU of the purchased item.

    itemName stringrequired

    Possible values: <= 255 characters

    Name or description of the purchased item.

    quantity integerrequired

    Quantity of the item purchased.

    unitPrice decimalrequired

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

    unitVatPrice decimal

    VAT amount per unit item.

    unitGrossPrice decimalrequired

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

    vatPercent decimalrequired

    Possible values: <= 100

    VAT percentage applied to the item.

    netAmount decimalrequired

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

    vatAmount decimalrequired

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

    grossAmount decimalrequired

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

  • ]

  • ]

    • totals

    object

    grossAmount decimal

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

    netAmount decimal

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

    vatAmount decimal

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

    paymentUrl uri

    Possible values: <= 512 characters

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

    qrCodeUrl uri

    Possible values: <= 512 characters

    QR code image URL representing the payment link.

    latestTransactionId uuid

    Unique identifier of the latest associated transaction.

    latestTransactionStatus string

    Possible values: <= 32 characters

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

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