logo Mercanet

Release 24.3

go directly to content

Search by keywords

getPaymentMeanData

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

This function allows to consult a wallet and one of these payment means information.

If the account or payment mean 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 mean.

Recommended interfaceVersion: WR_WS_2.55

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

Required

Optional

Request sample

            {
  "interfaceVersion": "WR_WS_2.3",
  "keyVersion": "1",
  "merchantId": "011223344550000",
  "merchantWalletId": " walId011",
  "paymentMeanId": "14",
  "seal": "7ba62b5dc8583a636fa35ec8399025e67d5a6335de4e04e25e99d21209e0bd4e"
}

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

        

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.

  • 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 Mercanet
      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_3X
      Facily Pay 3 X payment paymentMeanBrandType: ONLINE_CREDIT
      ACCORD_4X
      Facily Pay 4 X payment paymentMeanBrandType: ONLINE_CREDIT
      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
      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
      FRANFINANCE_3X
      Franfinance 3xCB paymentMeanBrandType: ONLINE_CREDIT
      FRANFINANCE_4X
      Franfinance 4xCB paymentMeanBrandType: ONLINE_CREDIT
      GIROPAY
      Giropay 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
      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
      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
      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
      CACF payment in 3 installments paymentMeanBrandType: ONLINE_CREDIT
      CACF_3XSANSFRAIS
      CACF payment in 3 installments free of charge paymentMeanBrandType: ONLINE_CREDIT
      CACF_4X
      CACF payment in 4 installments paymentMeanBrandType: ONLINE_CREDIT
      CACF_4XSANSFRAIS
      CACF payment in 4 installments free of charge paymentMeanBrandType: ONLINE_CREDIT
      CADHOC
      Cadhoc paymentMeanBrandType: CARD
      CADOCARTE
      Cado Carte paymentMeanBrandType: CARD
      CB
      Carte Bancaire paymentMeanBrandType: CARD
      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
      FRANFINANCE_3X
      Franfinance 3xCB paymentMeanBrandType: ONLINE_CREDIT
      FRANFINANCE_4X
      Franfinance 4xCB paymentMeanBrandType: ONLINE_CREDIT
      GIROPAY
      Giropay 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
      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
      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 Mercanet 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.

      Attention: use this free field only for the intended purpose, and therefore do not insert any personal data, especially cardholder data

      As a subcontractor, BNP Paribas processes personal data in accordance with the Data Processing Agreement (DPA), appended to all contracts.

      Thus:

      • The personal data specified in the DPA must only be transmitted to BNP Paribas via the fields provided for this purpose (see data dictionary).
      • All other personal data not listed in the DPA must not be transmitted to BNP Paribas.
    • 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 Mercanet 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

    Mercanet 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 Mercanet
    30
    Format error
    40
    merchantId not allowed to access this wallet service
    94
    Duplicated wallet / payment mean
    99
    Temporary problem at the Mercanet server level

Response sample

            {
  "walletResponseCode": "00",
  "walletPaymentMeanData": {
    "paymentMeanId": "14",
    "maskedPan": "4977##########02",
    "paymentMeanBrand": "SEPA_DIRECT_DEBIT"
  },
  "seal": "17f797e25668662aa51d59dbbd51c7094410f46326d15568f73f27621380c34a"
}

        
                  <getPaymentMeanDataResponse xmlns="urn:sips:cn:contract:office:wallet:v2">
         <output>
            <walletResponseCode>00</walletResponseCode>
            <walletPaymentMeanData>
                <paymentMeanId>2</paymentMeanId>
                <maskedPan>5219##########00</maskedPan>
                <paymentMeanAlias>ma carte visa</paymentMeanAlias>
                <panExpiryDate>201306</panExpiryDate>
                <paymenMeanBrand>VISA</paymenMeanBrand>
            </walletPaymentMeanData>
         </output>
      </getPaymentMeanDataResponse>

        

Changelog


Interface version Data Attendance Container
2.12 intermediateServiceProviderId Request
2.12 sealAlgorithm Request
2.0 interfaceVersion Request
2.0 keyVersion Request
2.0 merchantId Request
2.0 merchantWalletId Request
2.0 paymentMeanId Request/Response
2.0 seal Request/Response
2.0 errorFieldName Response
2.0 walletPaymentMeanData Response
2.23 issuerWalletType Container
  • walletPaymentMeanData
  • 2.36 paymentMeanCoBadgingBrandList Container
  • walletPaymentMeanData
  • 2.0 paymentMeanBrand Container
  • walletPaymentMeanData
  • 2.0 maskedPan Container
  • walletPaymentMeanData
  • 2.0 paymentMeanAlias Container
  • walletPaymentMeanData
  • 2.15 pspData Container
  • walletPaymentMeanData
  • 2.15 pspData1 Container
  • pspData
  • 2.18 mandateId Container
  • walletPaymentMeanData
  • 2.0 panExpiryDate Container
  • walletPaymentMeanData
  • 2.0 transactionActors Container
  • walletPaymentMeanData
  • 2.23 issuerWalletId Container
  • walletPaymentMeanData
  • 2.0 walletResponseCode Response