logo Sogenactif

Release 23.1

go directly to content

Search by keywords

paymentTokenGenerate

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

Generate a payment token fro a hosted fields payment

  • PROD
    https://office-server.sogenactif.com/rs-services/v2/token/paymentTokenGenerate
    method
    POST
  • TEST
    https://office-server-sogenactif.test.sips-services.com/rs-services/v2/token/paymentTokenGenerate
    method
    POST
  • PROD
    https://office-server.sogenactif.com/services/v2/token?wsdl
    method
    POST
  • TEST
    https://office-server-sogenactif.test.sips-services.com/services/v2/token?wsdl
    method
    POST

Required

  • keyVersion
    presence
    Required
    Interface version
    2.0

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

  • seal
    presence
    Required
    Interface version
    2.0

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

Optional

  • cardCSCValue
    presence
    Optional
    Interface version
    2.0

    Visual card security code on the bank card transmitted in the authorisation request (CSC, Card Security Code, referred to as CVV for Visa, CVC for Mastercard and 4DBC for American Express).

  • cardExpiryDate
    presence
    Optional
    Interface version
    2.0

    Card expiry date. If the card does not have any expiry date, this field is empty.

  • cardNumber
    presence
    Optional
    Interface version
    2.0

    Card number (format N19 unless the card number is a Token, and in this case, the format is ANS128).

  • interfaceVersion
    presence
    Optional
    Interface version
    2.0

    Version value and number of the interface used.

    List of values
    AR_WS_2.
    Obsolete
    AUT_WS_2.
    AUT_WS: Sogenactif Office Serveur (SOAP/JSON) interface for the Sogenactif authentication services.2.x: version referenced in the documentation of the function used by the merchant
    CPR_WS_2.
    Obsolete
    CR_WS_2.
    CR_WS: Sogenactif Office Serveur (SOAP/JSON) interface for Cash Management functions. 2.x: connector version used by the merchant
    DR_WS_2.
    DR_WS: Sogenactif Office Serveur (SOAP/JSON) interface for Diagnostic functions. 2.x: connector version used by the merchant
    FR_WS_2.
    FR_WS: Sogenactif Office Serveur (SOAP) interface for Fraud functions. 2.x: connector version used by the merchant
    HP_x.x
    HP: Sogenactif Paypage (POST) interface. x.x: connector version used by the merchant
    IR_MB_
    IR_MB: Sogenactif In-App (JSON) interface for Sogenactif In-App functions. 1.x: connector version used by the merchant
    IR_WS_
    IR_WS: Sogenactif Paypage (SOAP/JSON) interface. x.x: connector version used by the merchant
    IR_WS_2.
    IR_WS: Sogenactif Office Serveur (SOAP/JSON) interface for payment request functions. 2.x: connector version used by the merchant
    MR_WS_2.
    MR_WS: Sogenactif Office Serveur (SOAP/JSON) interface for mandate management. 2.x: connector version used by the merchant
    OR_WS_1.0
    OR_WS: Sogenactif Office Serveur (SOAP) interface for Sogenactif Office Serveur functions. 1.0: connector version used by the merchant
    PMR_WS_2.
    PMR_WS: Sogenactif Office Serveur (SOAP/JSON) interface for payment method repository information request functions. 2.x: connector version used by the merchant
    POR_WS_2.
    Obsolete
    TR_WS_2.
    TR_WS: Sogenactif Office Serveur (SOAP) interface for Token functions. 2.x: connector version used by the merchant
    WMR_WS_2.
    WMR_WS: Sogenactif Walletpage interface 2.x: connector version used by the merchant
    WR_WS_2.
    WR_WS: Sogenactif Office Serveur (SOAP/JSON) interface for Wallet functions. 2.x: connector version used by the merchant
  • intermediateServiceProviderId
    presence
    Optional
    Interface version
    2.0

    Identifier of the Service used by the merchant for the exchanges with the Sogenactif platform.

  • merchantId
    presence
    Optional
    Interface version
    2.0

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

  • paymentMeanBrand
    presence
    Optional
    Interface version
    2.0

    Name of the payment method that is used. It is related to one paymentMeanType.

    List of values
    1EUROCOM
    Cofidis Pay 5x10x20x Acquisition contract: ONLINE_CREDIT
    3XCBCOFINOGA
    Depreciated. Cofinoga 3xCB paymentMeanBrandType: CARD
    ACCEPTGIRO
    AcceptGiro paymentMeanBrandType: CREDIT_TRANSFER
    ACCORD
    Oney card paymentMeanBrandType: CARD
    ACCORD_3X
    Payment in 3 times with Facily Pay paymentMeanBrandType: ONLINE_CREDIT
    ACCORD_4X
    Payment in 4 times with Facily Pay paymentMeanBrandType: ONLINE_CREDIT
    ACCORD_KDO
    Carte Cadeau Oney paymentMeanBrandType: CARD
    AIRPLUS
    Airplus card paymentMeanBrandType: CARD
    AIRPLUS_LOGEE
    Airplus card paymentMeanBrandType: CARD
    AMEX
    American Express card paymentMeanBrandType: CARD
    AMEX_LOGEE
    American Express card paymentMeanBrandType: CARD
    AURORE
    CPAY card paymentMeanBrandType: CARD
    BCACB_3X
    Payment in 3 times with Floa Bank CB paymentMeanBrandType: ONLINE_CREDIT
    BCACB_4X
    Payment in 4 times with Floa Bank CB paymentMeanBrandType: ONLINE_CREDIT
    BCACUP
    CUP card of Floa Bank paymentMeanBrandType: CARD
    BCMC
    Bancontact card paymentMeanBrandType: CARD
    CACF_3X
    Payment in 3 times with CACF paymentMeanBrandType: ONLINE_CREDIT
    CACF_4X
    Payment in 4 times with CACF paymentMeanBrandType: ONLINE_CREDIT
    CADHOC
    Cadhoc paymentMeanBrandType: CARD
    CADOCARTE
    Cado Carte paymentMeanBrandType: CARD
    CB
    Carte Bancaire paymentMeanBrandType: CARD
    CBCONLINE
    PayButton CBC Online paymentMeanBrandType: CREDIT_TRANSFER
    CETELEM_3X
    Cetelem 3xCB paymentMeanBrandType: ONLINE_CREDIT
    CETELEM_4X
    Cetelem 4xCB paymentMeanBrandType: ONLINE_CREDIT
    COFIDIS_3X
    Cofidis 3xCB paymentMeanBrandType: ONLINE_CREDIT
    COFIDIS_4X
    Cofidis 4xCB paymentMeanBrandType: ONLINE_CREDIT
    CONECS
    Titres Restaurants Dématérialisés Conecs paymentMeanBrandType: VOUCHER
    CUP
    China UnionPay card paymentMeanBrandType: CARD
    CVA
    Visa Aurore card paymentMeanBrandType: CARD
    CVCO
    Chèque-Vacances Connect paymentMeanBrandType: VOUCHER
    DINERS
    Carte Diners club international paymentMeanBrandType: CARD
    ELV
    Elektronisches LastschriftVerfahren paymentMeanBrandType: DIRECT_DEBIT
    FIVORY
    Lyf Pay paymentMeanBrandType: WALLET
    FRANFINANCE_3X
    Franfinance 3xCB paymentMeanBrandType: ONLINE_CREDIT
    FRANFINANCE_4X
    Franfinance 4xCB paymentMeanBrandType: ONLINE_CREDIT
    GIROPAY
    Giropay paymentMeanBrandType: CREDIT_TRANSFER
    IDEAL
    iDeal paymentMeanBrandType: CREDIT_TRANSFER
    ILLICADO
    Illicado paymentMeanBrandType: CARD
    INCASSO
    Incasso paymentMeanBrandType: DIRECT_DEBIT
    INGHOMEPAY
    PayButton ING Home’Pay paymentMeanBrandType: CREDIT_TRANSFER
    JCB
    Carte Japan Credit Bureau paymentMeanBrandType: CARD
    KBCONLINE
    PayButton KBC Online paymentMeanBrandType: CREDIT_TRANSFER
    LEPOTCOMMUN
    Le Pot Commun paymentMeanBrandType: CARD
    LYDIA
    Lydia paymentMeanBrandType: PROVIDER
    MAESTRO
    Maestro card (Mastercard) paymentMeanBrandType: CARD
    MASTERCARD
    Mastercard card paymentMeanBrandType: CARD
    MASTERPASS
    Deprecated - MasterPass paymentMeanBrandType:
    ONEY34X
    Payment in 3 or 4 times with Oney paymentMeanBrandType: ONLINE_CREDIT
    PAYLIB
    Paylib paymentMeanBrandType:
    PAYPAL
    Paypal paymentMeanBrandType: WALLET
    PAYTRAIL
    Paytrail paymentMeanBrandType: CREDIT_TRANSFER
    PAY_BY_BANK
    SEPA credit transfer paymentMeanBrandType: CREDIT_TRANSFER
    PRESTO
    Presto Plus paymentMeanBrandType: ONLINE_CREDIT
    SEPA_DIRECT_DEBIT
    SDD (SEPA Direct Debit) paymentMeanBrandType: DIRECT_DEBIT
    SOFINCO
    Sofinco card paymentMeanBrandType: CARD
    SOFORTUBERWEISUNG
    Sofortüberweisung (Sofort Banking) paymentMeanBrandType: CREDIT_TRANSFER
    UNKNOWN
    Unknown payment mean (this value can be returned by Sogenactif but must not be used in a request)
    VISA
    Visa card paymentMeanBrandType: CARD
    VISACHECKOUT
    Deprecated - Visa Checkout wallet paymentMeanBrandType: WALLET
    VISA_ELECTRON
    Carte Visa Electron paymentMeanBrandType: CARD
    VPAY
    VPAY card (Visa) paymentMeanBrandType: CARD
  • paymentMeanBrandSelectionStatus
    presence
    Optional
    Interface version
    2.0

    Status of the processing of the brand application selection on paypage.

    List of values
    APPLIED_DEFAULT
    The cardholder accepted the default merchant choice
    APPLIED_HOLDER
    The cardholder selected a card brand different from the default merchant choice
    Empty
    Transaction not processed according to the payment mean brand selection rules
    NOT_APPLICABLE
    Card number filled is not a cobadged card
  • paymentTokenConsumerMerchantId
    presence
    Optional
    Interface version
    2.0

    Identifier of the merchant who is authorized to consume the payment token on the services supporting it.

  • sealAlgorithm
    presence
    Optional
    Interface version
    2.0

    Algorithm applied to calculate the seal encryption.

    List of values
    HMAC-SHA-256
    The encryption algorithm applied is HMAC-SHA-256
    HMAC-SHA-512
    The encryption algorithm applied is HMAC-SHA-512
    SHA-256
    The encryption algorithm applied is SHA-256

Request sample

            {
  "cardCSCValue": "123",
  "cardExpiryDate": "202212",
  "cardNumber": "1234123412341234",
  "interfaceVersion": "TR_WS_2.41",
  "keyVersion": "1",
  "merchantId": "001112233440000",
  "paymentMeanBrand": "VISA",
  "seal": "3f1d96361442af3ed0df832bf655d4de7349e9451b973a335514ab9f670d26ea"
}

        
                  <urn:paymentTokenGenerate>
         <urn:input>
            <urn:merchantId>001112233440000</urn:merchantId>
            <urn:interfaceVersion>TR_WS_2.41</urn:interfaceVersion>
            <urn:cardNumber>1234123412341234</urn:cardNumber>
            <urn:cardExpiryDate>202212</urn:cardExpiryDate>
            <urn:cardCSCValue>123</urn:cardCSCValue>
            <urn:paymentMeanBrand>VISA</urn:paymentMeanBrand>
         </urn:input>
      </urn:paymentTokenGenerate>

        

Required

  • seal
    presence
    Required
    Interface version
    2.0

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

Optional

  • errorFieldName
    presence
    Optional
    Interface version
    2.0

    Error field name of the incoming request.Present when responseCode = 12 or 30.

  • paymentToken
    presence
    Optional
    Interface version
    2.0

    Hosted Fields payment token to be sent when making calls to Sogenactif Office Serveur and allowing you to find card payment information for classic or 3-D Secure payment, by wallet or not.

  • responseCode
    presence
    Optional
    Interface version
    2.0

    Sogenactif server response code.

    List of values
    00
    Operation accepted
    01
    For panToToken and tokenToPan methods, partial success
    02
    Request of authorized on via telephone with the issuer because of exceeding the card authorization threshold
    03
    Invalid merchant contract
    05
    Refused authorization
    11
    Used for differed check. The PAN is blocked
    12
    Invalid transaction. Please check the request parameters
    14
    Invalid PAN or payment mean data check is failed (e.g. card number or the visual cryptogram of the card or AVS address)
    17
    Customer cancellation
    24
    • In response to a cash management operation: operation not authorized. The operation you wish to perform is not compliant with the transaction status or another operation is in progress at the same time
    • In response to a payment creation: operation rejected, request already carried out with the same data and the same parameters
    25
    Transaction unknown by Sogenactif
    30
    Format error
    34
    Fraud suspicion (seal erroneous)
    40
    Function not supported: the operation that you wish to perform is not part of the operation type for which you are authorized
    51
    Amount too high
    54
    Payment mean expiry date is past
    55
    Merchant doesn’t accept prepaid cards
    57
    Refund operation refused because the original transaction was subject of an unpaid
    60
    Transaction pending
    62
    Waiting the confirmation for the transaction (used by PayPal 1.0)
    63
    Security rules not observed, transaction stopped
    75
    Number of attempts to enter the data of the payment mean from Sogenactif Paypage is exceeded
    90
    Service temporarily not available
    94
    Duplicated transaction: the transactionReference has been used previously
    97
    Session expired (no action from the user during 15 minutes), transaction refused
    99
    Temporarily problem with the payment server

Response sample

            {
  "paymentToken": "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzUxMiJ9.eyJkYXRhIjoiWXpjNU16RmtNekE0TVRGaE5HTTBOamd6TlRFd016WTRPVFl6TkRVMllqVT0iLCJwcm9jZXNzSWQiOiI3N2Q1NzYyMDFhOTM0YzAyYWVkNzc2MzJkMDMxMTBmNCIsInVzZVR5cGUiOiJQQVlNRU5UIiwicHJvY2Vzc0ludGVyZmFjZSI6IlNJUFNfTUFDSElORV9UT19NQUNISU5FIn0.j4DZnnMupH4SAbgMIpuk-fSOqnKgZs27H1qXXmfIBY48lwdYzhRGN1KspIFhH25c-5Q_osjHyUu_4URQMdcU_w",
  "responseCode": "00",
  "seal": "338ce205c8de01746d1b8a42aeda9460473acf3c11027f3fc22469bd2bcdfd38",
}

        
                  <paymentTokenGenerateResponse xmlns="urn:sips:cn:contract:office:token:v2">
         <output>
            <responseCode>00</responseCode>
            <paymentToken>eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzUxMiJ9.eyJkYXRhIjoiWXpjNU16RmtNekE0TVRGaE5HTTBOamd6TlRFd016WTRPVFl6TkRVMllqVT0iLCJwcm9jZXNzSWQiOiI3N2Q1NzYyMDFhOTM0YzAyYWVkNzc2MzJkMDMxMTBmNCIsInVzZVR5cGUiOiJQQVlNRU5UIiwicHJvY2Vzc0ludGVyZmFjZSI6IlNJUFNfTUFDSElORV9UT19NQUNISU5FIn0.j4DZnnMupH4SAbgMIpuk-fSOqnKgZs27H1qXXmfIBY48lwdYzhRGN1KspIFhH25c-5Q_osjHyUu_4URQMdcU_w</paymentToken>
         </output>
      </paymentTokenGenerateResponse>

        

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

Configuration