This site requires javascript to be enabled.

Results for

xxx

Create session for payment product

POST https://{domainname}/v1/{merchantId}/products/{paymentProductId}/sessions

Products

Products is your entry on all things related to payment products. You will be able to retrieve all relevant payment products, based on your configuration and provided filters, their associated fields and potential directories. You can retrieve all of the information in one call or do calls on individual payment products. The data returned is designed to give you all the required information to build up your interface towards your consumers in a dynamic fashion. By doing it like that you know that you will be ready for future changes and new payment products without much effort.

Request

In case you use your own payment pages and you want to host Apple Pay on the Web, Apple requires that a session is created by a valid merchant. This API allows you to retrieve an Apple Pay merchant session with the validationUrl that Apple has provided you.

PayloadCreatePaymentProductSessionRequest

Properties
Property Type Required Details
close

Description

Object containing details for creating an Apple Pay session.
  • SDK Object type
    MobilePaymentProductSession302SpecificInput
close

Description

Used as an input for the Apple Pay payment button. Provide your company name in a human readable form.
close

Description

Provide a fully qualified domain name of your own payment page that will be showing an Apple Pay button.
close

Description

Provide the validation URL that has been provided by Apple once you have started an Apple Pay session.

Request example

SDK: Java

This scenario you will probably use the most

  • MobilePaymentProductSession302SpecificInput paymentProductSession302SpecificInput = new MobilePaymentProductSession302SpecificInput();
paymentProductSession302SpecificInput.setDisplayName("Worldline");
paymentProductSession302SpecificInput.setDomainName("pay1.checkout.worldline-solutions.com");
paymentProductSession302SpecificInput.setValidationUrl("<VALIDATION URL RECEIVED FROM APPLE>");

CreatePaymentProductSessionRequest body = new CreatePaymentProductSessionRequest();
body.setPaymentProductSession302SpecificInput(paymentProductSession302SpecificInput);

CreatePaymentProductSessionResponse response = client.v1().merchant("merchantId").products().sessions(302, body);

Responses

Please find below an overview of the possible responses.

Response 200 - OKCreatePaymentProductSessionResponse

For every successfully create session resource a HTTP 200 response is returned.

Properties
Property Type Required Details
close

Description

Object containing the Apple Pay session object.
  • SDK Object type
    MobilePaymentProductSession302SpecificOutput
close

Description

Object containing an opaque merchant session object.

Response example

SDK: Java

This scenario you will probably use the most

  • {
    "paymentProductSession302SpecificOutput" : {
        "sessionObject" : "<SESSION OBJECT>"
    }
}

Response 400 - Bad requestErrorResponse

Properties
Property Type Required Details
close

Description

Unique reference, for debugging purposes, of this error response
close

Description

List of one or more errors
close

Description

Contains detailed information on one single error.
  • SDK Object type
    APIError
close

Description

Category the error belongs to. The category should give an indication of the type of error you are dealing with. Possible values:
  • CONNECT_PLATFORM_ERROR - indicating that a functional error has occurred in the Connect platform.
  • PAYMENT_PLATFORM_ERROR - indicating that a functional error has occurred in the Payment platform.
  • IO_ERROR - indicating that a technical error has occurred within the Connect platform or between Connect and any of the payment platforms or third party systems.
close

Description

Error code
close

Description

HTTP status code for this error that can be used to determine the type of error
close

Description

ID of the error. This is a short human-readable message that briefly describes the error.
close

Description

Human-readable error message that is not meant to be relayed to customer as it might tip off people who are trying to commit fraud
close

Description

Returned only if the error relates to a value that was missing or incorrect.
Contains a location path to the value as a JSonata query.
Some common examples:
  • a.b selects the value of property b of root property a,
  • a[1] selects the first element of the array in root property a,
  • a[b='some value'] selects all elements of the array in root property a that have a property b with value 'some value'.
close

Description

ID of the request that can be used for debugging purposes

Response example

SDK: Java

This scenario you will probably use the most

  • {
    "errorId" : "15eabcd5-30b3-479b-ae03-67bb351c07e6-00000092",
    "errors" : [
        {
            "code" : "20000000",
            "propertyName" : "bankAccountBban.accountNumber",
            "message" : "PARAMETER_NOT_FOUND_IN_REQUEST"
        }
    ]
}

Response 404 - Not foundErrorResponse

When no session can be created matching the input criteria a HTTP 404 response is returned.

Properties
Property Type Required Details
close

Description

Unique reference, for debugging purposes, of this error response
close

Description

List of one or more errors
close

Description

Contains detailed information on one single error.
  • SDK Object type
    APIError
close

Description

Category the error belongs to. The category should give an indication of the type of error you are dealing with. Possible values:
  • CONNECT_PLATFORM_ERROR - indicating that a functional error has occurred in the Connect platform.
  • PAYMENT_PLATFORM_ERROR - indicating that a functional error has occurred in the Payment platform.
  • IO_ERROR - indicating that a technical error has occurred within the Connect platform or between Connect and any of the payment platforms or third party systems.
close

Description

Error code
close

Description

HTTP status code for this error that can be used to determine the type of error
close

Description

ID of the error. This is a short human-readable message that briefly describes the error.
close

Description

Human-readable error message that is not meant to be relayed to customer as it might tip off people who are trying to commit fraud
close

Description

Returned only if the error relates to a value that was missing or incorrect.
Contains a location path to the value as a JSonata query.
Some common examples:
  • a.b selects the value of property b of root property a,
  • a[1] selects the first element of the array in root property a,
  • a[b='some value'] selects all elements of the array in root property a that have a property b with value 'some value'.
close

Description

ID of the request that can be used for debugging purposes

Response example

SDK: Java

This scenario you will probably use the most

  • {
    "errorId" : "3caa7750-a076-48b2-9402-3cb9eea613a6-00001532",
    "errors" : [
        {
            "code" : "1426",
            "message" : "CREATE_SESSION_NOT_AVAILABLE_FOR_PRODUCT"
        }
    ]
}