WL SIPS DOCS

Release 24.1

go directly to content

Search by keywords

paymentTokenInitialize

To search in the page use Ctrl+F on your keyboard

Initialize a payment token generation kinematic with “Sips In-App”.

Recommended interfaceVersion: IR_MB_2.53

It is advised to read the following documents before

  • Recommended

    Sips In-App JSON

    Functional, technical documentation and user guides to help you to integrate WL Sips online payment solution.

    Open in new tab Sips In-App JSON

  • PROD
    https://office-server.sips-services.com/rs-services/v2/tokenInApp/paymentTokenInitialize
    method
    POST
  • TEST
    https://office-server.test.sips-services.com/rs-services/v2/tokenInApp/paymentTokenInitialize
    method
    POST

Required

  • interfaceVersion
    presence
    Required
    Interface version
    2.37

    Version of the interface used. It is composed of a prefix that varies according to the function used and a version number (e.g. IR_WS_2.47).

    Please refer to the function page for the value to use. Use the latest interface version number.

    List of values
    AR_WS_2.
    Obsolete
    AUT_WS_2.
    Sips Office (SOAP/JSON) interface for the Worldline Sips authentication services.
    AU_WS_2.
    AU_WS: Sips Office (SOAP/JSON) interface for the Worldline Sips account update services.
    CR_WS_2.
    Sips Office (SOAP/JSON) interface for Cash Management functions.
    DR_WS_2.
    Sips Office (SOAP/JSON) interface for Diagnostic functions.
    FR_WS_2.
    Sips Office (SOAP) interface for Fraud functions.
    HP_x.x
    Sips Paypage and Sips Walletpage (POST) interface.
    IR_MB_
    Sips In-App (JSON) interface for Sips In-App functions.
    IR_WS_
    Sips Paypage and Sips Office (SOAP/JSON) interface.
    MR_WS_2.
    Sips Office (SOAP/JSON) interface for mandate management.
    PMR_WS_2.
    Sips Office (SOAP/JSON) interface for payment method repository information request functions.
    TR_WS_2.
    Sips Office (SOAP) interface for Token functions.
    WMR_WS_2.
    Sips Walletpage interface (SOAP/JSON).
    WR_WS_2.
    WR_WS: Sips Office (SOAP/JSON) interface for Wallet functions.
  • keyVersion
    presence
    Required
    Interface version
    2.37

    Version of the merchant’s secret key used to calculate the imprint of the message (key stored by the merchant to verify the imprint of the automatic and manual notifications).

  • merchantId
    presence
    Required
    Interface version
    2.37

    Identifier of the shop, this value is provided to the merchant by Worldline Sips during the shop registration.

  • sdkOperationName
    presence
    Required
    Interface version
    2.37

    In the context of Sips In-App (example: mobile application), indicates at the time of the phase initialization, the name of the operation that was chosens (example: card payment).

    List of values
    ADDCARD
    Adding a card to the Wallet Worldline Sips for the initialization phase of an Sips In-App transaction
    CARDORDER
    Card payment for the initialization phase of an Sips In-App transaction
    GETWALLETDATA
    Consulting the information of a Wallet Worldline Sips for the initialization phase of a transaction Sips In-App
    PAYMENTPROVIDERORDER
    Via an external partner for the initialization phase of an Sips In-App transaction
    PAYMENTTOKENGENERATE
    Generation of token for a payment Sips In-App
    THREEDSECUREANDORDER
    Card payment for the initialization phase of an Sips In-App transaction with 3-D Secure authentication
    THREEDSECUREANDWALLETORDER
    Payment means registered in the Wallet Worldline Sips for the initialization phase of a transaction Sips In-App with 3-D Secure authentication
    WALLETORDER
    Payment with the Wallet Worldline Sips for the initialization phase of an Sips In-App transaction
  • sdkVersion
    presence
    Required
    Interface version
    2.37

    Version of the SDK used for a payment or operation Sips In-App (Eg. 2.0.4)

  • seal
    presence
    Required
    Interface version
    2.37

    Message seal used to ensure the integrity of the request and the authentication of sender / receiver of the message.

Optional

Request sample

            {
    "interfaceVersion" : "IR_MB_2.37",
    "keyVersion" : "1",
    "merchantId" : "011223344550000",
    "sdkOperationName" : "PAYMENTTOKENGENERATE",
    "sdkVersion" : "SDK100",
    "seal" : "a5fc2c68e7051671c7b81c70ba971310b8d6188360199922cb3bd57778f3ffa4"
}
        

Required

  • seal
    presence
    Required
    Interface version
    1.0

    Message seal used to ensure the integrity of the request and the authentication of sender / receiver of the message.

Optional

Response sample

            {
  "publicKeyValue":"30820122...10001",
  "redirectionStatusCode":"00",
  "redirectionStatusMessage":"Process succeeded",
  "redirectionUrl":"https://office-server.sips-services.com/rs-api/public/v2/tokenInApp/paymentTokenGenerate",
  "redirectionVersion":"IR_MB_2.37",
  "seal":"48670660a9167df5734d8f11546ee1d296557055e5861e8e2d1b85d6de7357fb"
}
        

Changelog


Interface version Data Attendance Container
2.37 customerIpAddress Request
2.37 intermediateServiceProviderId Request
2.37 sealAlgorithm Request
2.37 interfaceVersion Request
2.37 keyVersion Request
2.37 merchantId Request
2.37 sdkOperationName Request
2.37 sdkVersion Request
2.37 seal Request/Response
1.0 publicKeyValue Response
1.0 redirectionStatusCode Response
1.0 redirectionStatusMessage Response
1.0 redirectionUrl Response
1.0 redirectionVersion Response

This site uses trackers to improve your experience, perform analysis and researches on your use of WL Sips documentation website.
You have several options:
Closing this banner you refuse the use of trackers on your device.

Configuration