Loans

The public unique identifier of the basket to retrieve loan information for.

The merchant-defined identifier of the order linked to the basket (optional).

The requested API version. The parameter is optional. Default value: 2.0.

The ID of the application making the request. This header parameter is required for authentication and identification purposes.

A unique identifier related to the registered merchant in the API environment, available within the application's details.

A boolean indicating whether the Pay Later loan retrieval request was successful.

Detailed information related to the BNPL loan, containing:

• basket (object): The full basket associated with the loan, including:
  • id (integer): The internal numeric identifier of the basket.
  • publicBasketId (string): The public identifier of the basket.
  • dateCreated (string): The date and time when the basket was created (ISO 8601 format).
  • basketValue (number): The total monetary value of the basket.
  • merchantId (integer): The internal identifier of the merchant.
  • merchantName (string): The display name of the merchant.
  • requestId (string): The unique request identifier (UUID format).
  • orderIdentifier (string): The merchant-defined order identifier.
  • bnplAmount (number): The amount approved or requested for BNPL financing.
  • basketProducts (array): The list of products in the basket. Each product includes:
    • Product Number (string): The merchant-assigned SKU or product reference code (e.g., "SKU-00123").
    • name (string): The display name of the product (e.g., "Wireless Headphones").
    • quantity (number): The number of units of this product in the basket (e.g., 2).
    • Quantity Units (string): The unit of measurement for the quantity (e.g., "pcs", "kg").
    • Unit Price (number): The price per single unit before tax and discounts (e.g., 49.99).
    • Tax Rate (number): The applicable tax rate as a percentage (e.g., 24.00 for 24% VAT).
    • Total Amount (number): The total line amount for this product, calculated as quantity multiplied by unit price (e.g., 99.98).
    • Total Discount Amount (number): The total discount applied to this product line (e.g., 10.00). Returns 0 if no discount is applied.
    • Total Tax Amount (number): The total tax amount calculated for this product line (e.g., 17.41).
    • Product URL (string): The URL of the product's webpage on the merchant's site.
    • Product Image URL (string): The URL of the product's image.
  • Merchant Data (string): Additional merchant-specific data attached to the basket.
  • phoneNumber (string): The phone number of the customer.
  • email (string): The email address of the customer.
  • merchantCode (string): The unique code identifying the merchant.
  • merchantApplication (object): The merchant application context linked to the basket, including:
    • applicationId (string): The unique identifier of the merchant application in UUID format.
    • successCallbackUrl (string): The server-to-server callback URL that receives a notification when the BNPL process completes successfully.
    • failCallbackUrl (string): The server-to-server callback URL that receives a notification when the BNPL process fails or is declined.
    • created (string): The date and time the application was created, in ISO 8601 format.
    • successRedirectURI (string): The client-side URI the customer is redirected to after a successful BNPL approval.
    • failureRedirectURI (string): The client-side URI the customer is redirected to after a failed or declined BNPL request.
  • expirationDate (string): The basket expiration date and time (ISO 8601 format).
  • qrCodeData (string): The data encoded in the QR code (byte-encoded).
  • qrCodeDataLink (string): A URL link to the QR code image.
• payLaterInformation (object): The BNPL loan status details, including:
  • bnplRequestId (string): The unique identifier of the BNPL loan request.
  • status (string): The current status of the loan (e.g., pending, approved, rejected).
  • approvedLoanAmount (number): The loan amount that has been approved.

A descriptive message providing additional context about the loan request status.

An array of error objects detailing any issues encountered during the Pay Later loan retrieval process, including:

• code (string): A machine-readable code representing the error type.
• message (string): A human-readable message providing additional information about the loan request status or outcome.

A key-value object containing additional information related to the Pay Later loan request, typically used for internal tracking or integration purposes.

The type or category of the error response, indicating its nature or classification.

A brief, descriptive title summarizing the error response message.

The HTTP status code of the response, indicating the success or failure of the request.

A detailed description or explanation of the error, providing additional context.

The specific instance or occurrence to which the response pertains, providing a unique identifier or reference.