logo Sogenactif

Release 23.1

go directly to content

Search by keywords

getWalletData

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

This function allows to consult a wallet and payment means associated to it.

If the account does not exist, a 01 response code is returned. If the request works, 00 response code is returned as well as information related to the payment means.

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

Required

  • interfaceVersion
    presence
    Required
    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
  • 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).

  • merchantId
    presence
    Required
    Interface version
    2.0

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

  • merchantWalletId
    presence
    Required
    Interface version
    2.0

    Customer’s Wallet identifier.

  • 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

Request sample

            {
  "interfaceVersion": " WR_WS_2.3",
  "keyVersion": "1",
  "merchantId": "011223344550000",
  "merchantWalletId": " walId011",
  "seal": "8217a6163368bee3b5baebc47a822d40327344ce578411055f95d6e5752d00f4"
}

        
                  <urn:getWalletData>
         <urn:input>
            <urn:merchantId>011223344550000</urn:merchantId>
            <urn:interfaceVersion>WR_WS_2.2</urn:interfaceVersion>
            <urn:merchantWalletId>walId011</urn:merchantWalletId>
         </urn:input>
      </urn:getWalletData>

        

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.

  • walletCreationDateTime
    presence
    Optional
    Interface version
    2.0

    Date and time of the payment mean enrollment, in Sogenactif system at the merchant’s local time (in the merchant’s time zone)

  • walletLastActionDateTime
    presence
    Optional
    Interface version
    2.0

    Date and time of the last action on the wallet, in Sogenactif system at the merchant’s local time (in the merchant’s time zone)

  • walletPaymentMeanDataList
    presence
    Optional
    Interface version
    2.0

    List, contains specific information regarding the payment mean registered in the wallet.

    Contains
    • walletPaymentMeanData
      presence
      Optional
      Interface version
      2.0

      Contains specific information regarding the payment mean registered in the wallet.

      Contains
      • issuerWalletType
        presence
        Optional
        Interface version
        2.23

        Issuer wallet type.

        List of values
        BCMCMOBILE
        Bancontact Mobile
        MASTERPASS
        Deprecated - Masterpass
        MERCHANT_WALLET
        Wallet Sogenactif
        PAYLIB
        Paylib
        VISACHECKOUT
        Deprecated - Visa Checkout
      • paymentMeanCoBadgingBrandList
        presence
        Optional
        Interface version
        2.36

        Brand list of a card stored in a wallet.

        List of values
        1EUROCOM
        Cofidis Pay 5x10x20x paymentMeanBrandType: ONLINE_CREDIT
        3XCBCOFINOGA
        Deprecated. Cofinoga 3xCB paymentMeanBrandType: CARD
        ACCEPTGIRO
        AcceptGiro paymentMeanBrandType: CREDIT_TRANSFER
        ACCORD
        Oney card paymentMeanBrandType: CARD
        ACCORD_3X
        Facily Pay 3 X payment paymentMeanBrandType: ONLINE_CREDIT
        ACCORD_4X
        Facily Pay 4 X payment paymentMeanBrandType: ONLINE_CREDIT
        ACCORD_KDO
        Oney gift card paymentMeanBrandType: CARD
        AIRPLUS
        Airplus card paymentMeanBrandType: CARD
        AIRPLUS_LOGEE
        Airplus logee card paymentMeanBrandType: CARD
        AMEX
        American Express card paymentMeanBrandType: CARD
        AMEX_LOGEE
        American Express logee card paymentMeanBrandType: CARD
        AURORE
        CPAY card paymentMeanBrandType : CARD
        BCACB_3X
        Floa Bank CB 3 X payment paymentMeanBrandType: ONLINE_CREDIT
        BCACB_4X
        Floa Bank CB 4 X payment paymentMeanBrandType: ONLINE_CREDIT
        BCACUP
        CUP card issued by Floa Bank paymentMeanBrandType: CARD
        BCMC
        Bancontact paymentMeanBrandType: CARD
        CACF_3X
        CACF 3 X payment paymentMeanBrandType: ONLINE_CREDIT
        CACF_4X
        CACF 4 X payment 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
        Diners club international card 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
        Japan Credit Bureau card paymentMeanBrandType: CARD
        KBCONLINE
        PayButton KBC Online paymentMeanBrandType: CREDIT_TRANSFER
        LEPOTCOMMUN
        Le Pot Commun paymentMeanBrandType: CARD
        LYDIA
        Lydia paymentMeanBrandType: PROVIDER
        MAESTRO
        Carte Maestro (Mastercard) paymentMeanBrandType: CARD
        MASTERCARD
        Mastercard card paymentMeanBrandType: CARD
        MASTERPASS
        Deprecated - MasterPass electronic wallet paymentMeanBrandType: WALLET
        ONEY34X
        Oney Paiement 3 or 4 X payment paymentMeanBrandType: ONLINE_CREDIT
        PAYLIB
        Paylib electronic wallet paymentMeanBrandType: WALLET
        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
        VISA
        Visa card paymentMeanBrandType: CARD
        VISACHECKOUT
        Deprecated - Visa Checkout electronic wallet paymentMeanBrandType: WALLET
        VISA_ELECTRON
        Visa Electron card paymentMeanBrandType: CARD
        VPAY
        VPAY card (Visa) paymentMeanBrandType: CARD
      • 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
      • maskedPan
        presence
        Optional
        Interface version
        2.0

        Masked Primary Account Number. In the case of wallets, masked PAN of the payment mean registered in the wallet.

      • paymentMeanAlias
        presence
        Optional
        Interface version
        2.0

        Payment mean alias defined by the Buyer and used in the Buyer’s wallet

      • pspData
        presence
        Optional
        Interface version
        2.15

        Future use.Private data of Psp.

        Contains
      • paymentMeanId
        presence
        Optional
        Interface version
        2.0

        Payment mean rank in Sogenactif wallet.

      • mandateId
        presence
        Optional
        Interface version
        2.18

        Mandate number.

      • panExpiryDate
        presence
        Optional
        Interface version
        2.0

        Expiry date of an instrument associated with a Primary Account Number.For example, for a card, it contains the expiry date for an authorisation request operation. If the payment method does not have a validity date, this field should be empty.

      • transactionActors
        presence
        Optional
        Interface version
        2.0

        Indicates the players in the transaction.

        List of values
        BTOB
        Business to Business
        BTOC
        Business to Consumer
        BTOF
        Business to organization / association
      • issuerWalletId
        presence
        Optional
        Interface version
        2.23

        Identifier provided by issuer wallet to identify a payment mean.

  • walletResponseCode
    presence
    Optional
    Interface version
    2.0

    Sogenactif server response code for wallet Management.

    List of values
    00
    Successful operation
    03
    Invalid Merchant contract
    12
    Invalid data, verify the request
    25
    Wallet / payment mean unknown by Sogenactif
    30
    Format error
    40
    merchantId not allowed to access this wallet service
    94
    Duplicated wallet / payment mean
    99
    Temporary problem at the Sogenactif server level

Response sample

            {
  "walletCreationDateTime": "2013-12-23T05:17:26-12:00",
  "walletLastActionDateTime": "2014-01-19T23:16:00-12:00",
  "walletResponseCode": "00",
  "walletPaymentMeanDataList": [
    {
      "paymentMeanId": "14",
      "maskedPan": "4977##########02",
      "paymentMeanBrand": "SEPA_DIRECT_DEBIT"
    },
    {
      "paymentMeanId": "13",
      "maskedPan": "4977##########55",
      "paymentMeanAlias": "MySDD",
      "panExpiryDate": "201501",
      "paymentMeanBrand": "CB"
    }
  ],
  "seal": "4579cfc4044c29550327f9cba0be400129e95cb5b2639c6e301484930b4f9f94"
}

        
                  <getWalletDataResponse xmlns="urn:sips:cn:contract:office:wallet:v2">
         <output>
            <walletCreationDateTime>2012-10-17T23:50:44-12:00</walletActionDateTime>
            <walletLastActionDateTime>2013-10-17T23:50:44-12:00</walletLastActionDateTime>
            <walletResponseCode>00</walletResponseCode>
            < walletPaymentMeanDataList>
               <walletPaymentMeanData>
                   <paymentMeanId>2</paymentMeanId>
                   <maskedPan>5219##########00</maskedPan>
                   <paymentMeanAlias>ma carte visa</paymentMeanAlias>
                   <panExpiryDate>201306</panExpiryDate>
                   <paymenMeanBrand>VISA</paymenMeanBrand>
               </walletPaymentMeanData>
            </walletPaymentMeanDataList>
         </output>
      </getWalletDataResponse>

        

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