creditTransferInquire

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

Requests to retrieve the list of issuer’s bank available. This service is currently available for the payment means iDEAL.

This request provides a list of issuer’s banks. If the request is successful, you will receive in response a list of bank with their name and code. This information must be use for the initialization step (CreditTransferInitialize).

Recommended interfaceVersion: IR_WS_2.55

PROD

https://office-server.sogenactif.com/rs-services/v2/checkout/creditTransferInquire

method

POST
TEST

https://office-server-sogenactif.test.sips-services.com/rs-services/v2/checkout/creditTransferInquire

method

POST

PROD

https://office-server.sogenactif.com/services/v2/checkout?wsdl

method

POST
TEST

https://office-server-sogenactif.test.sips-services.com/services/v2/checkout?wsdl

method

POST

Request

Required

currencyCode

presence

Required

Interface version

2.0

Format

N3(restricted values / ISO4217)

Currency code for the transaction. This code is ISO 4217 compatible.

List of values

032

Argentinean Peso

036

Australian Dollar

048

Bahrain Dinar

116

Cambodian Riel

124

Canadian Dollar

144

Sri Lanka Rupee

156

China Yuan Renminbi

191

Croatia Kuna

203

Czech Republic Koruna

208

Danes crown

344

Hong Kong dollar

348

Hungary Forint

352

Iceland Rupee

356

Indian rupee

376

Israel Shekel

392

Japanese Yen

410

South Korean Won

414

Kuwait Dinar

458

Malaysia Ringgit

480

Mauritius Rupee

484

Mexican Peso

524

Nepal Rupee

554

New Zealand Dollar

578

Norwegian crown

634

Qatar Riyal

643

Russia Ruble

682

Saudi Arabia Riyal

702

Singapore Dollar

710

South Africa Rand

752

Swedish crown

756

Swiss Franc

764

Thailand Baht

784

United Arab Emirates Dirham

788

Tunisia Dinar

826

Pound

840

American Dollar

901

Taiwan Dollar

941

Serbian Dinar

946

Roumania New Leu

949

New Turkish Lira

952

CFA Franc

953

CFP Franc

975

Bulgaria Lev

978

Euro

980

Ukraine Hryvnia

985

Poland Zloty

986

Brazilian Real
interfaceVersion
presence

Required

Interface version

2.0
Format
AN20(restricted String)
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

IR_WS_

Sogenactif Paypage and Sogenactif Office Serveur (SOAP/JSON) interface.
keyVersion

presence

Required

Interface version

2.0

Format

N10

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

Format

N15

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

presence

Required

Interface version

2.0

Format

ANS20(restricted values)

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

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
seal

presence

Required

Interface version

2.0

Format

ANS128

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

Optional

customerLanguage

presence

Optional

Interface version

2.0

Format

A2(restricted values)

Language of the user, used on the payment pages.

List of values

It

Italian

Ja

Japanese

cs

Czech

da

Danish

de

German

el

Greek

en

English

es

Spanish

et

Estonian

fi

Finnish

fr

French

hu

Hungarian

ko

Korean

lt

Lithuanian

lv

Latvian

nl

Dutch

no

Norwegian

pl

Polish

pt

Portuguese

ro

Romanian

ru

Russian

sk

Slovak

sl

Slovene

sv

Swedish

tr

Turkish

uk

Ukrainian

zh

Chinese
intermediateServiceProviderId

presence

Optional

Interface version

2.12

Format

AN30

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

presence

Optional

Interface version

2.0

Format

Container

Contains the identification of the transaction (to be compliant with Sogenactif 1.0).Contains the data pair (s10TransactionId, s10TransactionIdDAte) which ensures the uniqueness of the transaction 1.0.
Contains
- s10TransactionId
  
  presence
  
  Optional
  
  Interface version
  
  2.0
  
  Format
  
  N6
  
  The merchant can choose between transactionId and transactionReference (by default) to identify his transactions.s10TransactionId is an alternative identifier for the transaction to be compliant with Sogenactif 1.0. The couple s10TransactionId/s10TransactionIdDate ensures the unicity of the transaction.
- s10TransactionIdDate
  
  presence
  
  Optional
  
  Interface version
  
  2.0
  
  Format
  
  N8(YYYYMMDD)
  
  Date of the transaction (expressed in the Sogenactif server time zone).The couple s10TransactionId/s10TransactionIdDate ensures the unicity of the transaction 1.0.The use of this couple instead of transactionReference depends on an option in the merchant configuration.
sealAlgorithm

presence

Optional

Interface version

2.12

Format

ANS20(restricted values)

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
transactionReference

presence

Optional

Interface version

2.0

Format

AN35

The merchant can choose of referencing his transactions by a transactionId or a transactionReference.transactionReference uniquely identifies a transaction throughout the life of the shop.

Request sample

json
soap

            {
  "currencyCode": "978",
  "customerLanguage": "fr",
  "interfaceVersion": "IR_WS_2.9",
  "keyVersion": "1",
  "merchantId": "011223344550000",
  "paymentMeanBrand": "IDEAL",
  "transactionReference": " TREFEXA2015",
  "seal": "ec7be3e2a0086a86f66f74bb6e10f244e51e4e648c7dbbf7c89ce9aa78a569cf"
}

                  <urn:creditTransferInquire>
         <urn:input>
            <urn:merchantId>011223344550000</urn:merchantId>
            <urn:transactionReference>TREFEXA2015</urn:transactionReference>
            <urn:interfaceVersion>IR_WS_2.6</urn:interfaceVersion>
            <urn:currencyCode>978</urn:currencyCode>
            <urn:customerLanguage>fr</urn:customerLanguage>
            <urn:paymentMeanBrand>IDEAL</urn:paymentMeanBrand>
         </urn:input>
      </urn:creditTransferInquire>

Response

Required

responseCode

presence

Required

Interface version

2.0

Format

N2(restricted values)

Sogenactif server response code.

List of values

00

Operation accepted

03

Invalid merchant contract

12

Invalid transaction. Please check the request 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

99

Temporarily problem with the payment server
seal

presence

Required

Interface version

2.0

Format

ANS128

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

Optional

customerBankList

presence

Optional

Interface version

2.0

Format

composite list

liste des banques du client
Contains
- customerBankCode
  
  presence
  
  Optional
  
  Interface version
  
  2.0
  
  Format
  
  AN11
  
  Bank code of the customer either in national, or international or specific codification. The format is specified in the field customerBankAccountType (eg BIC …).
- customerBankName
  
  presence
  
  Optional
  
  Interface version
  
  2.0
  
  Format
  
  ANS150
  
  Bank name of the customer.
errorFieldName

presence

Optional

Interface version

2.0

Format

ANS50

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

Response sample

json
soap

            {
  "customerBankList": [
    {
      "customerBankCode": "RABONL2U",
      "customerBankName": "BANK - RABO"
    },
    {
      "customerBankCode": "INGBNL2A",
      "customerBankName": "BANK - ING"
    }
  ],
  "responseCode": "00",
  "seal": "c46465d780517ce593b4bd5afe789fe58d2bc972937aaa35707ec8668265e6dc"
}

                  <creditTransferInquireResponse xmlns="urn:sips:cn:contract:office:checkout:v2">
         <output>
            <responseCode>00</responseCode>
            <customerBankList>
               <customerBankCode>RABONL2U</customerBankCode>
               <customerBankName>BANK - RABO</customerBankName>
            </customerBankList>
         </output>
      </creditTransferInquireResponse>

Changelog

Filter

Interface version	Data	Attendance	Container
2.0	`customerLanguage`	Request
2.12	`intermediateServiceProviderId`	Request
2.0	`s10TransactionReference`	Request
2.0	`s10TransactionId`	Container	`s10TransactionReference`
2.0	`s10TransactionIdDate`	Container	`s10TransactionReference`
2.12	`sealAlgorithm`	Request
2.0	`transactionReference`	Request
2.0	`currencyCode`	Request
2.0	`interfaceVersion`	Request
2.0	`keyVersion`	Request
2.0	`merchantId`	Request
2.0	`paymentMeanBrand`	Request
2.0	`seal`	Request/Response
2.0	`customerBankList`	Response
2.0	`customerBankCode`	Container	`customerBankList`
2.0	`customerBankName`	Container	`customerBankList`
2.0	`errorFieldName`	Response
2.0	`responseCode`	Response

creditTransferInquire

Endpoints

Request

Required

`currencyCode`

`interfaceVersion`

`keyVersion`

`merchantId`

`paymentMeanBrand`

`seal`

Optional

`customerLanguage`

`intermediateServiceProviderId`

`s10TransactionReference`

`s10TransactionId`

`s10TransactionIdDate`

`sealAlgorithm`

`transactionReference`

Request sample

Response

Required

`responseCode`

`seal`

Optional

`customerBankList`

`customerBankCode`

`customerBankName`

`errorFieldName`

Response sample

Changelog

Need help?