logo Sogenactif

Release 24.1

go directly to content

Search by keywords

creditHolder

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

This function allows the merchant who has the banking data of their clients to credit their account without any prior transaction.

Recommended interfaceVersion: CR_WS_2.53

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

Required

  • amount
    presence
    Required
    Interface version
    2.0

    Transaction amount. The amount must be transmitted in the smallest currency unit.For example in euros: an amount of EUR 10.50 must be transmitted in the form 1050.

  • currencyCode
    presence
    Required
    Interface version
    2.0

    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

    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
    CR_WS_2.
    Sogenactif Office Serveur (SOAP/JSON) interface for Cash Management functions.
  • 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.

  • 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

            {
  "amount": "1000",
  "cardExpiryDate": "201602",
  "cardNumber": "1234123412341234",
  "currencyCode": "978",
  "keyVersion": "1",
  "interfaceVersion": "CR_WS_2.9",
  "merchantId": "011223344550000",
  "orderChannel": "INTERNET",
  "orderId": "1234",
  "transactionReference": "TREFEXA2015",
  "seal": "607083393a51b4b23261270df83c28a61e06f74928bc1e868c0abb9325dde2f2"
}

        
                  <urn:creditHolder>
         <urn:input>
            <urn:amount>1000</urn:amount>
            <urn:cardExpiryDate>201612</urn:cardExpiryDate>
            <urn:cardNumber>1234123412341234</urn:cardNumber>
            <urn:currencyCode>978</urn:currencyCode>
            <urn:customerEmail>customer@email.com</urn:customerEmail>
            <urn:customerId>654321</urn:customerId>
            <urn:customerIpAddress>127.0.0.1</urn:customerIpAddress>
            <urn:interfaceVersion>CR_WS_2.0</urn:interfaceVersion>
            <urn:merchantId>011223344550000</urn:merchantId>
            <urn:orderChannel>INTERNET</urn:orderChannel>
            <urn:orderId>123456</urn:orderId>
            <urn:returnContext>ReturnContext</urn:returnContext>
            <urn:transactionReference>TREFEXA20121</urn:transactionReference>
            <urn:transactionOrigin>SO_WS2</urn:transactionOrigin>
         </urn:input>
      </urn:creditHolder>

        

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

  • acquirerResponseCode
    presence
    Optional
    Interface version
    2.0

    Response code returned by the acquirer during an authorisation request.

    List of values
    00
    Transaction approved or processed successfully
    02
    Contact payment mean issuer
    03
    Invalid acceptor
    04
    Keep the payment mean
    05
    Do not honour
    07
    Keep the payment mean, special conditions
    08
    Approve after identification
    12
    Invalid transaction
    13
    Invalid amount
    14
    Invalid PAN
    15
    Unknown payment mean issuer
    17
    Payment aborted by the buyer
    20
    Invalid response (error in server domain)
    24
    Operation not authorised
    25
    Transaction not found
    30
    Format error
    31
    Id of the acquiring organisation unknown
    33
    payment mean expired (Paypal / Cofidis)
    34
    Fraud suspicion
    40
    Function not supported
    41
    Payment mean lost
    43
    Payment mean stolen
    51
    Insufficient or exceeded credit
    54
    Payment mean expired (CB / Visa / MC / WLAcq / BCMC)
    55
    Wrong PIN
    56
    Payment mean missing from the file
    57
    Transaction unauthorised for this payment mean holder
    58
    Transaction forbidden to the terminal
    59
    Fraud suspicion
    60
    The payment mean acceptor must contact the acquirer
    61
    Exceeds the amount limit
    62
    Transaction awaiting payment confirmation
    63
    Security rules not complied with
    65
    Allowed number of daily transactions has been exceeded
    68
    Response not received or received too late
    75
    Exceeded number of PAN attempts
    87
    Terminal unknown
    90
    System temporarily stopped
    91
    Payment mean issuer inaccessible
    92
    The transaction does not contain enough information to be routed to the authorizing agency
    93
    Transaction cannot be completed: violation of law
    94
    Duplicated transaction
    96
    System malfunction
    97
    Request time-out; transaction refused
    98
    Server unavailable; network routing requested again
    99
    Incident with initiator domain
    A1
    Transaction refused because the 3-D Secure authentication data is missing
    A4
    Transaction refused because the 3-D Secure authentication exemption is misused
    R1
    the cardholder (or his bank) has revoked recurring payments made at a merchant
    R3
    the cardholder (or his bank) has revoked all recurring payments
  • authorMessageReference
    presence
    Optional
    Interface version
    2.35

    Identifier shared with the acquirer during the authorisation process.For example, this reference data could be sent by the acquirer in the authorisation response, then sent (unchanged) in a subsequent authorisation reversal message, to the extent that the acquirer is able to match a reversal message to the associated response message.

  • authorisationId
    presence
    Optional
    Interface version
    2.0

    Authorisation ID returned by the acquirer if the authorisation request is accepted.

  • cardData
    presence
    Optional
    Interface version
    2.35

    Contains specific information regarding a card

    Contains
    • cardBrand
      presence
      Optional
      Interface version
      2.35

      Please see “paymentMeanBrand”.

    • cardCorporateIndicator
      presence
      Optional
      Interface version
      2.35

      Indicates whether the card is an Enterprise / Commercial card or not.

      List of values
      Empty
      Unknown
      N
      The card is not a corporate card
      Y
      The card is a corporate card
    • cardEffectiveDateIndicator
      presence
      Optional
      Interface version
      2.35

      Indicator of existence of a card effective date (Y/N/Empty)

    • cardProductCode
      presence
      Optional
      Interface version
      2.35

      Product code of the card.

    • cardProductName
      presence
      Optional
      Interface version
      2.35

      Product name of the card.

    • cardProductProfile
      presence
      Optional
      Interface version
      2.35

      Profile code of the card.

      List of values
      C
      Credit (pay after)
      D
      Debit (pay now)
      Empty
      Unknown
      H
      Charge card (UK specific)
      N
      Non-Mastercard
      P
      Prepaid
      R
      Deffered debit
      U
      Universal
    • cardProductUsageLabel
      presence
      Optional
      Interface version
      2.45

      Profile name of the card which is displayed on payment electronic ticket in accordance with MPADS requirements.

      List of values
      COMMERCIAL
      Business card
      CREDIT
      Credit card
      DEBIT
      Debit card
      PREPAID
      Prepaid card
    • cardScheme
      presence
      Optional
      Interface version
      2.35

      Network name associated with the card.

      List of values
      ACCORD
      Accord scheme
      AMEX
      American Express scheme
      BCMC
      Bancontact scheme
      CB
      Bank Card scheme
      MASTERCARD
      Mastercard scheme (Example of cards on the Mastercard scheme: Mastercard, Maestro)
      SOFINCO
      Sofinco scheme
      VISA
      Visa scheme (Example of cards on the Visa scheme: Visa, Vpay, Visa Electron)
    • cardSeqNumberIndicator
      presence
      Optional
      Interface version
      2.35

      Indicator of existence of an issue number

      List of values
      1
      Card issue number of length 1
      2
      Card issue number of length 2
      3
      Card issue number of length 3
      Empty
      Unknown
      N
      No card issue number
    • issuerCode
      presence
      Optional
      Interface version
      2.35

      Issuer code of the card. This data is called cardIssuerCode in the reports.

    • issuerCountryCode
      presence
      Optional
      Interface version
      2.35

      Country code of the card issuer. This data is called cardIssuerCountryCode in the reports.

      List of values
      ABW
      ARUBA
      AFG
      AFGHANISTAN
      AGO
      ANGOLA
      AIA
      ANGUILLA
      ALA
      ÅLAND ISLANDS
      ALB
      ALBANIA
      AND
      ANDORRA
      ARE
      UNITED ARAB EMIRATES
      ARG
      ARGENTINA
      ARM
      ARMENIA
      ASM
      AMERICAN SAMOA
      ATA
      ANTARCTICA
      ATF
      FRENCH SOUTHERN TERRITORIES
      ATG
      ANTIGUA AND BARBUDA
      AUS
      AUSTRALIA
      AUT
      AUSTRIA
      AZE
      AZERBAIJAN
      BDI
      BURUNDI
      BEL
      BELGIUM
      BEN
      BENIN
      BES
      BONAIRE, SINT EUSTATIUS AND SABA
      BFA
      BURKINA FASO
      BGD
      BANGLADESH
      BGR
      BULGARIA
      BHR
      BAHRAIN
      BHS
      BAHAMAS
      BIH
      BOSNIA AND HERZEGOVINA
      BLM
      SAINT KITTS AND NEVIS
      BLR
      BELARUS
      BLZ
      BELIZE
      BMU
      BERMUDA
      BOL
      BOLIVIA, PLURINATIONAL STATE OF
      BRA
      BRAZIL
      BRB
      BARBADOS
      BRN
      BRUNEI DARUSSALAM
      BTN
      BHUTAN
      BVT
      BOUVET ISLAND
      BWA
      BOTSWANA
      CAF
      CENTRAL AFRICAN REPUBLIC
      CAN
      CANADA
      CCK
      COCOS (KEELING) ISLANDS
      CHE
      SWITZERLAND
      CHL
      CHILE
      CHN
      CHINA
      CIV
      CÔTE D’IVOIRE
      CMR
      CAMEROON
      COD
      CONGO, THE DEMOCRATIC REPUBLIC OF THE
      COG
      CONGO
      COK
      COOK ISLANDS
      COL
      COLOMBIA
      COM
      COMOROS
      CPV
      CAPE VERDE
      CRI
      COSTA RICA
      CUB
      CUBA
      CUW
      CURAÇAO
      CXR
      CHRISTMAS ISLAND
      CYM
      CAYMAN ISLANDS
      CYP
      CYPRUS
      CZE
      CZECH REPUBLIC
      DEU
      GERMANY
      DJI
      DJIBOUTI
      DMA
      DOMINICA
      DNK
      DENMARK
      DOM
      DOMINICAN REPUBLIC
      DZA
      ALGERIA
      ECU
      ECUADOR
      EGY
      EGYPT
      ERI
      ERITREA
      ESH
      WESTERN SAHARA
      ESP
      SPAIN
      EST
      ESTONIA
      ETH
      ETHIOPIA
      FIN
      FINLAND
      FJI
      FIJI
      FLK
      FALKLAND ISLANDS (MALVINAS)
      FRA
      FRANCE
      FRO
      FAROE ISLANDS
      FSM
      MICRONESIA, FEDERATED STATES OF
      GAB
      GABON
      GBR
      UNITED KINGDOM
      GEO
      GEORGIA
      GGY
      GUERNSEY
      GHA
      GHANA
      GIB
      GIBRALTAR
      GIN
      GUINEA
      GLP
      GUADELOUPE
      GMB
      GAMBIA
      GNB
      GUINEA-BISSAU
      GNQ
      EQUATORIAL GUINEA
      GRC
      GREECE
      GRD
      GRENADA
      GRL
      GREENLAND
      GTM
      GUATEMALA
      GUF
      FRENCH GUIANA
      GUM
      GUAM
      GUY
      GUYANA
      HKG
      HONG KONG
      HMD
      HEARD ISLAND AND MCDONALD ISLANDS
      HND
      HONDURAS
      HRV
      CROATIA
      HTI
      HAITI
      HUN
      HUNGARY
      IDN
      INDONESIA
      IMN
      ISLE OF MAN
      IND
      INDIA
      IOT
      BRITISH INDIAN OCEAN TERRITORY
      IRL
      IRELAND
      IRN
      IRAN, ISLAMIC REPUBLIC OF
      IRQ
      IRAQ
      ISL
      ICELAND
      ISR
      ISRAEL
      ITA
      ITALY
      JAM
      JAMAICA
      JEY
      JERSEY
      JOR
      JORDAN
      JPN
      JAPAN
      KAZ
      KAZAKHSTAN
      KEN
      KENYA
      KGZ
      KYRGYZSTAN
      KHM
      CAMBODIA
      KIR
      KIRIBATI
      KNA
      SAINT BARTHÉLEMY
      KOR
      KOREA, REPUBLIC OF
      KWT
      KUWAIT
      LAO
      LAO PEOPLE’S DEMOCRATIC REPUBLIC
      LBN
      LEBANON
      LBR
      LIBERIA
      LBY
      LIBYA
      LCA
      SAINT HELENA, ASCENSION AND TRISTAN DA CUNHA
      LIE
      LIECHTENSTEIN
      LKA
      SRI LANKA
      LSO
      LESOTHO
      LTU
      LITHUANIA
      LUX
      LUXEMBOURG
      LVA
      LATVIA
      MAC
      MACAO
      MAF
      SAINT MARTIN (FRENCH PART)
      MAR
      MOROCCO
      MCO
      MONACO
      MDA
      MOLDOVA, REPUBLIC OF
      MDG
      MADAGASCAR
      MDV
      MALDIVES
      MEX
      MEXICO
      MHL
      MARSHALL ISLANDS
      MKD
      MACEDONIA, THE FORMER YUGOSLAV REPUBLIC OF
      MLI
      MALI
      MLT
      MALTA
      MMR
      MYANMAR
      MNE
      MONTENEGRO
      MNG
      MONGOLIA
      MNP
      NORTHERN MARIANA ISLANDS
      MOZ
      MOZAMBIQUE
      MRT
      MAURITANIA
      MSR
      MONTSERRAT
      MTQ
      MARTINIQUE
      MUS
      MAURITIUS
      MWI
      MALAWI
      MYS
      MALAYSIA
      MYT
      MAYOTTE
      NAM
      NAMIBIA
      NCL
      NEW CALEDONIA
      NER
      NIGER
      NFK
      NORFOLK ISLAND
      NGA
      NIGERIA
      NIC
      NICARAGUA
      NIU
      NIUE
      NLD
      NETHERLANDS
      NOR
      NORWAY
      NPL
      NEPAL
      NRU
      NAURU
      NZL
      NEW ZEALAND
      OMN
      OMAN
      PAK
      PAKISTAN
      PAN
      PANAMA
      PCN
      PITCAIRN
      PER
      PERU
      PHL
      PHILIPPINES
      PLW
      PALAU
      PNG
      PAPUA NEW GUINEA
      POL
      POLAND
      PRI
      PUERTO RICO
      PRK
      KOREA, DEMOCRATIC PEOPLE’S REPUBLIC OF
      PRT
      PORTUGAL
      PRY
      PARAGUAY
      PSE
      PALESTINIAN TERRITORY, OCCUPIED
      PYF
      FRENCH POLYNESIA
      QAT
      QATAR
      REU
      RÉUNION
      ROU
      ROMANIA
      RUS
      RUSSIAN FEDERATION
      RWA
      RWANDA
      SAU
      SAUDI ARABIA
      SDN
      SUDAN
      SEN
      SENEGAL
      SGP
      SINGAPORE
      SGS
      SOUTH GEORGIA AND THE SOUTH SANDWICH ISLANDS
      SHN
      SAN MARINO
      SJM
      SVALBARD AND JAN MAYEN
      SLB
      SOLOMON ISLANDS
      SLE
      SIERRA LEONE
      SLV
      EL SALVADOR
      SMR
      SINT MAARTEN (DUTCH PART)
      SOM
      SOMALIA
      SPM
      HOLY SEE (VATICAN CITY STATE)
      SRB
      SERBIA
      SSD
      SOUTH SUDAN
      STP
      SAO TOME AND PRINCIPE
      SUR
      SURINAME
      SVK
      SLOVAKIA
      SVN
      SLOVENIA
      SWE
      SWEDEN
      SWZ
      SWAZILAND
      SXM
      SAINT PIERRE AND MIQUELON
      SYC
      SEYCHELLES
      SYR
      SYRIAN ARAB REPUBLIC
      TCA
      TURKS AND CAICOS ISLANDS
      TCD
      CHAD
      TGO
      TOGO
      THA
      THAILAND
      TJK
      TAJIKISTAN
      TKL
      TOKELAU
      TKM
      TURKMENISTAN
      TLS
      TIMOR-LESTE
      TON
      TONGA
      TTO
      TRINIDAD AND TOBAGO
      TUN
      TUNISIA
      TUR
      TURKEY
      TUV
      TUVALU
      TWN
      TAIWAN, PROVINCE OF CHINA
      TZA
      TANZANIA, UNITED REPUBLIC OF
      UGA
      UGANDA
      UKR
      UKRAINE
      UMI
      UNITED STATES MINOR OUTLYING ISLANDS
      URY
      URUGUAY
      USA
      UNITED STATES
      UZB
      UZBEKISTAN
      VAT
      SAINT VINCENT AND THE GRENADINES
      VCT
      SAINT LUCIA
      VEN
      VENEZUELA, BOLIVARIAN REPUBLIC OF
      VGB
      VIRGIN ISLANDS, BRITISH
      VIR
      VIRGIN ISLANDS, U.S.
      VNM
      VIET NAM
      VUT
      VANUATU
      WLF
      WALLIS AND FUTUNA
      WSM
      SAMOA
      YEM
      YEMEN
      ZAF
      SOUTH AFRICA
      ZMB
      ZAMBIA
      ZWE
      ZIMBABWE
    • issuerName
      presence
      Optional
      Interface version
      2.35

      Issuer name of the card. This data is called cardIssuerName in the reports.

    • issuerRegionCode
      presence
      Optional
      Interface version
      2.35

      region code of the card issuer

      List of values
      1
      USA: California, Hawaii, Nevada
      2
      USA: West except California, Hawaii, Nevada
      3
      USA: Central North
      4
      USA: Central South
      5
      USA: Great Lakes states
      6
      USA: South East
      7
      USA: Extreme North East
      8
      USA: North East
      9
      USA: Florida and Georgia
      A
      Canada
      B
      South America
      C
      Oceania Asia
      D
      Europe
      E
      Africa and middle east
      Empty
      Unknown
    • issuingCountryCode
      presence
      Optional
      Interface version
      2.44

      Country code in which the card has been issued. This data is called cardIssuingCountryCode in the reports.

      List of values
      ABW
      ARUBA
      AFG
      AFGHANISTAN
      AGO
      ANGOLA
      AIA
      ANGUILLA
      ALA
      ÅLAND ISLANDS
      ALB
      ALBANIA
      AND
      ANDORRA
      ARE
      UNITED ARAB EMIRATES
      ARG
      ARGENTINA
      ARM
      ARMENIA
      ASM
      AMERICAN SAMOA
      ATA
      ANTARCTICA
      ATF
      FRENCH SOUTHERN TERRITORIES
      ATG
      ANTIGUA AND BARBUDA
      AUS
      AUSTRALIA
      AUT
      AUSTRIA
      AZE
      AZERBAIJAN
      BDI
      BURUNDI
      BEL
      BELGIUM
      BEN
      BENIN
      BES
      BONAIRE, SINT EUSTATIUS AND SABA
      BFA
      BURKINA FASO
      BGD
      BANGLADESH
      BGR
      BULGARIA
      BHR
      BAHRAIN
      BHS
      BAHAMAS
      BIH
      BOSNIA AND HERZEGOVINA
      BLM
      SAINT KITTS AND NEVIS
      BLR
      BELARUS
      BLZ
      BELIZE
      BMU
      BERMUDA
      BOL
      BOLIVIA, PLURINATIONAL STATE OF
      BRA
      BRAZIL
      BRB
      BARBADOS
      BRN
      BRUNEI DARUSSALAM
      BTN
      BHUTAN
      BVT
      BOUVET ISLAND
      BWA
      BOTSWANA
      CAF
      CENTRAL AFRICAN REPUBLIC
      CAN
      CANADA
      CCK
      COCOS (KEELING) ISLANDS
      CHE
      SWITZERLAND
      CHL
      CHILE
      CHN
      CHINA
      CIV
      CÔTE D’IVOIRE
      CMR
      CAMEROON
      COD
      CONGO, THE DEMOCRATIC REPUBLIC OF THE
      COG
      CONGO
      COK
      COOK ISLANDS
      COL
      COLOMBIA
      COM
      COMOROS
      CPV
      CAPE VERDE
      CRI
      COSTA RICA
      CUB
      CUBA
      CUW
      CURAÇAO
      CXR
      CHRISTMAS ISLAND
      CYM
      CAYMAN ISLANDS
      CYP
      CYPRUS
      CZE
      CZECH REPUBLIC
      DEU
      GERMANY
      DJI
      DJIBOUTI
      DMA
      DOMINICA
      DNK
      DENMARK
      DOM
      DOMINICAN REPUBLIC
      DZA
      ALGERIA
      ECU
      ECUADOR
      EGY
      EGYPT
      ERI
      ERITREA
      ESH
      WESTERN SAHARA
      ESP
      SPAIN
      EST
      ESTONIA
      ETH
      ETHIOPIA
      FIN
      FINLAND
      FJI
      FIJI
      FLK
      FALKLAND ISLANDS (MALVINAS)
      FRA
      FRANCE
      FRO
      FAROE ISLANDS
      FSM
      MICRONESIA, FEDERATED STATES OF
      GAB
      GABON
      GBR
      UNITED KINGDOM
      GEO
      GEORGIA
      GGY
      GUERNSEY
      GHA
      GHANA
      GIB
      GIBRALTAR
      GIN
      GUINEA
      GLP
      GUADELOUPE
      GMB
      GAMBIA
      GNB
      GUINEA-BISSAU
      GNQ
      EQUATORIAL GUINEA
      GRC
      GREECE
      GRD
      GRENADA
      GRL
      GREENLAND
      GTM
      GUATEMALA
      GUF
      FRENCH GUIANA
      GUM
      GUAM
      GUY
      GUYANA
      HKG
      HONG KONG
      HMD
      HEARD ISLAND AND MCDONALD ISLANDS
      HND
      HONDURAS
      HRV
      CROATIA
      HTI
      HAITI
      HUN
      HUNGARY
      IDN
      INDONESIA
      IMN
      ISLE OF MAN
      IND
      INDIA
      IOT
      BRITISH INDIAN OCEAN TERRITORY
      IRL
      IRELAND
      IRN
      IRAN, ISLAMIC REPUBLIC OF
      IRQ
      IRAQ
      ISL
      ICELAND
      ISR
      ISRAEL
      ITA
      ITALY
      JAM
      JAMAICA
      JEY
      JERSEY
      JOR
      JORDAN
      JPN
      JAPAN
      KAZ
      KAZAKHSTAN
      KEN
      KENYA
      KGZ
      KYRGYZSTAN
      KHM
      CAMBODIA
      KIR
      KIRIBATI
      KNA
      SAINT BARTHÉLEMY
      KOR
      KOREA, REPUBLIC OF
      KWT
      KUWAIT
      LAO
      LAO PEOPLE’S DEMOCRATIC REPUBLIC
      LBN
      LEBANON
      LBR
      LIBERIA
      LBY
      LIBYA
      LCA
      SAINT HELENA, ASCENSION AND TRISTAN DA CUNHA
      LIE
      LIECHTENSTEIN
      LKA
      SRI LANKA
      LSO
      LESOTHO
      LTU
      LITHUANIA
      LUX
      LUXEMBOURG
      LVA
      LATVIA
      MAC
      MACAO
      MAF
      SAINT MARTIN (FRENCH PART)
      MAR
      MOROCCO
      MCO
      MONACO
      MDA
      MOLDOVA, REPUBLIC OF
      MDG
      MADAGASCAR
      MDV
      MALDIVES
      MEX
      MEXICO
      MHL
      MARSHALL ISLANDS
      MKD
      MACEDONIA, THE FORMER YUGOSLAV REPUBLIC OF
      MLI
      MALI
      MLT
      MALTA
      MMR
      MYANMAR
      MNE
      MONTENEGRO
      MNG
      MONGOLIA
      MNP
      NORTHERN MARIANA ISLANDS
      MOZ
      MOZAMBIQUE
      MRT
      MAURITANIA
      MSR
      MONTSERRAT
      MTQ
      MARTINIQUE
      MUS
      MAURITIUS
      MWI
      MALAWI
      MYS
      MALAYSIA
      MYT
      MAYOTTE
      NAM
      NAMIBIA
      NCL
      NEW CALEDONIA
      NER
      NIGER
      NFK
      NORFOLK ISLAND
      NGA
      NIGERIA
      NIC
      NICARAGUA
      NIU
      NIUE
      NLD
      NETHERLANDS
      NOR
      NORWAY
      NPL
      NEPAL
      NRU
      NAURU
      NZL
      NEW ZEALAND
      OMN
      OMAN
      PAK
      PAKISTAN
      PAN
      PANAMA
      PCN
      PITCAIRN
      PER
      PERU
      PHL
      PHILIPPINES
      PLW
      PALAU
      PNG
      PAPUA NEW GUINEA
      POL
      POLAND
      PRI
      PUERTO RICO
      PRK
      KOREA, DEMOCRATIC PEOPLE’S REPUBLIC OF
      PRT
      PORTUGAL
      PRY
      PARAGUAY
      PSE
      PALESTINIAN TERRITORY, OCCUPIED
      PYF
      FRENCH POLYNESIA
      QAT
      QATAR
      REU
      RÉUNION
      ROU
      ROMANIA
      RUS
      RUSSIAN FEDERATION
      RWA
      RWANDA
      SAU
      SAUDI ARABIA
      SDN
      SUDAN
      SEN
      SENEGAL
      SGP
      SINGAPORE
      SGS
      SOUTH GEORGIA AND THE SOUTH SANDWICH ISLANDS
      SHN
      SAN MARINO
      SJM
      SVALBARD AND JAN MAYEN
      SLB
      SOLOMON ISLANDS
      SLE
      SIERRA LEONE
      SLV
      EL SALVADOR
      SMR
      SINT MAARTEN (DUTCH PART)
      SOM
      SOMALIA
      SPM
      HOLY SEE (VATICAN CITY STATE)
      SRB
      SERBIA
      SSD
      SOUTH SUDAN
      STP
      SAO TOME AND PRINCIPE
      SUR
      SURINAME
      SVK
      SLOVAKIA
      SVN
      SLOVENIA
      SWE
      SWEDEN
      SWZ
      SWAZILAND
      SXM
      SAINT PIERRE AND MIQUELON
      SYC
      SEYCHELLES
      SYR
      SYRIAN ARAB REPUBLIC
      TCA
      TURKS AND CAICOS ISLANDS
      TCD
      CHAD
      TGO
      TOGO
      THA
      THAILAND
      TJK
      TAJIKISTAN
      TKL
      TOKELAU
      TKM
      TURKMENISTAN
      TLS
      TIMOR-LESTE
      TON
      TONGA
      TTO
      TRINIDAD AND TOBAGO
      TUN
      TUNISIA
      TUR
      TURKEY
      TUV
      TUVALU
      TWN
      TAIWAN, PROVINCE OF CHINA
      TZA
      TANZANIA, UNITED REPUBLIC OF
      UGA
      UGANDA
      UKR
      UKRAINE
      UMI
      UNITED STATES MINOR OUTLYING ISLANDS
      URY
      URUGUAY
      USA
      UNITED STATES
      UZB
      UZBEKISTAN
      VAT
      SAINT VINCENT AND THE GRENADINES
      VCT
      SAINT LUCIA
      VEN
      VENEZUELA, BOLIVARIAN REPUBLIC OF
      VGB
      VIRGIN ISLANDS, BRITISH
      VIR
      VIRGIN ISLANDS, U.S.
      VNM
      VIET NAM
      VUT
      VANUATU
      WLF
      WALLIS AND FUTUNA
      WSM
      SAMOA
      YEM
      YEMEN
      ZAF
      SOUTH AFRICA
      ZMB
      ZAMBIA
      ZWE
      ZIMBABWE
    • panCheckAlgorithm
      presence
      Optional
      Interface version
      2.35

      Control algorithm applied on the PAN (L/V/N/Empty)

      List of values
      Empty
      Unknown PAN control algorithm
      L
      PAN control with Lühn Key algorithm
      N
      No PAN control algorithm
      V
      PAN control with Visa Modulus 10 algorithm
    • panLengthMax
      presence
      Optional
      Interface version
      2.35

      Maximum length of the PAN

    • panLengthMin
      presence
      Optional
      Interface version
      2.35

      Minimal length of the PAN

    • virtualCardIndicator
      presence
      Optional
      Interface version
      2.35

      Indicates whether the card is a virtual card

      List of values
      Empty
      Unknown
      N
      The card is not a virtual card
      Y
      The card is a virtual card
  • errorFieldName
    presence
    Optional
    Interface version
    2.21

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

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

  • newStatus
    presence
    Optional
    Interface version
    2.0

    Status of the transaction updated after a checkout operation. The status of a transaction is described by different keywords which change during the operations it undergoes.

    List of values
    ABORTED
    Transaction totally aborted
    CANCELLED
    Transaction totally cancelled
    CAPTURED
    Transaction sent to the bank
    CAPTURE_REFUSED
    Capture refused
    CREDITED
    Transaction totally refund
    ENDED
    Transaction ended
    EXPIRED
    Transaction expired
    PENDING
    Transaction waiting for the authorisation request response
    PREPROD
    Transaction of a merchant which is in the pre-production mode. It cannot be settled.
    REFUSED
    Transaction refused
    TO_AUTHORIZE
    Transaction waiting for the authorisation request
    TO_CAPTURE
    Transaction to send to the bank to debit the user
    TO_CHALLENGE
    Transaction with a fraud suspicion
    TO_CONFIRM_AUTHOR
    Transaction waiting for confirmation of authorization.
    TO_CONFIRM_CAPTURE
    Transaction waiting for confirmation of settlement
    TO_CONFIRM_CREDIT
    TO_CREDIT
    Transaction to send to the bank to credit the user
    TO_REPLAY
    Transaction waiting for a validation with authorization request
    TO_VALIDATE
    Transaction waiting for a validation
    UNDEFINED
    Transaction status not defined
    WAITING_AUTHOR
    Technical status for transaction in a temporarily state waiting for a authorisation batch response
  • operationDateTime
    presence
    Optional
    Interface version
    2.0

    Date and time calculated by Sogenactif on which the transaction has been completed.

  • 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
  • s10TransactionReference
    presence
    Optional
    Interface version
    2.6

    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
  • settlementArchivingReference
    presence
    Optional
    Interface version
    2.49

    Data provided to the acquirer for processing settlements and reconciliations. By default generated by the Sogenactif platform. Its supply by the merchant is subject to strong constraints. Contact Sogenactif to use this data in requests.

  • transactionPlatform
    presence
    Optional
    Interface version
    2.17

    Platform where the transaction has been executed.

    List of values
    PRE-PROD
    Pre-production transaction not sent to remittance
    PROD
    Production transaction
    SIMU
    Simulated transaction
    UAT
    User acceptance test transaction
  • transactionReference
    presence
    Optional
    Interface version
    2.6

    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.

Response sample

            {
  "acquirerResponseCode": "00",
  "responseCode": "00",
  "authorisationId": "069308",
  "authorMessageReference": "123456",
  "maskedPan": "1234##########34",
  "newStatus": "TO_CREDIT",
  "operationDateTime": "2020-07-27T23:48:14-12:00",
  "s10TransactionReference": {
    "s10TransactionId": "34800",
    "s10TransactionIdDate": "20150506"
  },
  "transactionReference": "SIM2014012248339",
  "cardData":{
    "cardScheme": "VISA",
    "cardBrand": "VISA",
    "cardProductCode": "F",
    "cardProductName": "VISA CLASSIC",
    "cardCorporateIndicator": "N",
    "issuerCode": "10107",
    "issuerCountryCode": "FRA",
    "issuerRegionCode": "D",
    "panLengthMin": 16,
    "panLengthMax": 16,
    "panCheckAlgorithm": "L"
  },
  "transactionPlatform": "PROD",
  "seal": "ef3f3cc68a39a5d1144663162a35fa6070bfe39d5abbe672b15417ff87afc431"
}

        
                  <creditHolderResponse xmlns="urn:sips:cn:contract:office:cashmanagement:v2">
         <output>
            <acquirerResponseCode>00</acquirerResponseCode>
            <authorisationId>069308</authorisationId>
            <authorMessageReference>123456</authorMessageReference>
            <maskedPan>1234##########34</maskedPan>
            <responseCode>00</responseCode>
            <operationDateTime>2012-10-16T23:48:14-12:00</operationDateTime>
            <s10TransactionReference>
                <s10TransactionId>34793</s10TransactionId>
                <s10TransactionIdDate>20150506</s10TransactionIdDate>
            </s10TransactionReference>
            <transactionReference>TREFEXA20121</transactionReference>
            <newStatus>TO_CREDIT</newStatus>
            <cardData>
                <cardScheme>VISA</cardScheme>
                <cardBrand>VISA</cardBrand>
                <cardProductCode>F</cardProductCode>
                <cardProductName>VISA CLASSIC</cardProductName>
                <cardCorporateIndicator>N</cardCorporateIndicator>
                <cardEffectiveDateIndicator/>
                <cardSeqNumberIndicator/>
                <issuerCode>10107</issuerCode>
                <issuerName/>
                <issuerCountryCode>FRA</issuerCountryCode>
                <issuerRegionCode>D</issuerRegionCode>
                <panLengthMin>16</panLengthMin>
                <panLengthMax>16</panLengthMax>
                <panCheckAlgorithm>L</panCheckAlgorithm>
                <cardProductProfile/>
            </cardData>
         </output>
      </creditHolderResponse>

        

Changelog


Interface version Data Attendance Container
2.0 cardEffectiveDate Request
2.0 cardExpiryDate Request
2.0 cardNumber Request
2.0 cardScheme Request/Response
2.0 cardSeqNumber Request
2.39 customerContact Request
2.39 email Container
  • customerContact
  • holderContact
  • 2.39 firstname Container
  • customerContact
  • holderContact
  • 2.39 gender Container
  • customerContact
  • holderContact
  • 2.39 initials Container
  • customerContact
  • holderContact
  • 2.39 lastname Container
  • customerContact
  • holderContact
  • 2.39 mobile Container
  • customerContact
  • holderContact
  • 2.39 phone Container
  • customerContact
  • holderContact
  • 2.39 title Container
  • customerContact
  • holderContact
  • 2.0 customerEmail Request
    2.0 customerId Request
    2.0 customerIpAddress Request
    2.41 holderContact Request
    2.12 intermediateServiceProviderId Request
    2.38 invoiceReference Request
    2.48 merchantLocationId Request
    2.0 orderChannel Request
    2.38 orderContext Request
    2.38 customerBrowserType Container
  • orderContext
  • 2.38 customerANI Container
  • orderContext
  • 2.38 customerANIInformationIdentifier Container
  • orderContext
  • 2.38 merchantOrderSpecificDataList Container
  • orderContext
  • 2.38 merchantOrderSpecificData Container
  • merchantOrderSpecificDataList
  • 2.38 merchantOrderSpecificDataReference Container
  • merchantOrderSpecificData
  • 2.38 merchantOrderSpecificDataType Container
  • merchantOrderSpecificData
  • 2.38 merchantOrderSpecificDataValue Container
  • merchantOrderSpecificData
  • 2.38 customerHostName Container
  • orderContext
  • 2.0 orderId Request
    2.1 panType Request
    2.39 paymentToken Request
    2.0 returnContext Request
    2.6 s10TransactionReference Request/Response
    2.6 s10TransactionId Container
  • s10TransactionReference
  • 2.6 s10TransactionIdDate Container
  • s10TransactionReference
  • 2.12 sealAlgorithm Request
    2.33 settlementArchivingReference Request/Response
    2.33 settlementMerchantSpecificData Request
    2.38 shoppingCartDetail Request
    2.39 giftCardAmount Container
  • shoppingCartDetail
  • 2.39 giftCardCurrencyCode Container
  • shoppingCartDetail
  • 2.38 mainProduct Container
  • shoppingCartDetail
  • 2.39 giftCardCount Container
  • shoppingCartDetail
  • 2.38 shoppingCartItemList Container
  • shoppingCartDetail
  • 2.38 shoppingCartItem Container
  • shoppingCartItemList
  • 2.38 productName Container
  • shoppingCartItem
  • 2.38 productUnitTaxAmount Container
  • shoppingCartItem
  • 2.38 productDescription Container
  • shoppingCartItem
  • 2.38 productSKU Container
  • shoppingCartItem
  • 2.38 productQuantity Container
  • shoppingCartItem
  • 2.38 productTaxRate Container
  • shoppingCartItem
  • 2.38 productUnitAmount Container
  • shoppingCartItem
  • 2.38 productCode Container
  • shoppingCartItem
  • 2.38 productCategory Container
  • shoppingCartItem
  • 2.38 productTaxCategory Container
  • shoppingCartItem
  • 2.38 travelData Container
  • shoppingCartItem
  • 2.38 travelCardPeriod Container
  • travelData
  • 2.38 journeyDataList Container
  • travelData
  • 2.38 journeyData Container
  • journeyDataList
  • 2.41 journeyAmount Container
  • journeyData
  • 2.38 carrierIdentifier Container
  • journeyData
  • 2.38 classLevel Container
  • journeyData
  • 2.38 departureDateTime Container
  • journeyData
  • 2.38 arrivalLocation Container
  • journeyData
  • 2.38 destinationCountry Container
  • journeyData
  • 2.38 fareBasis Container
  • journeyData
  • 2.38 carrierName Container
  • journeyData
  • 2.38 journeyCancellableIndicator Container
  • journeyData
  • 2.38 departureLocation Container
  • journeyData
  • 2.38 journeyInsurance Container
  • journeyData
  • 2.38 journeyInsuranceIndicator Container
  • journeyData
  • 2.38 journeyModality Container
  • journeyData
  • 2.38 journeyMode Container
  • journeyData
  • 2.41 journeyNature Container
  • journeyData
  • 2.38 journeySequence Container
  • journeyData
  • 2.38 journeyStage Container
  • journeyData
  • 2.38 luggageSupplementIndicator Container
  • journeyData
  • 2.38 numberOfTickets Container
  • journeyData
  • 2.38 ticketExchangeabilityIndicator Container
  • journeyData
  • 2.38 ticketIssueCity Container
  • journeyData
  • 2.38 ticketIssueDate Container
  • journeyData
  • 2.38 ticketIssuerName Container
  • journeyData
  • 2.38 ticketReference Container
  • journeyData
  • 2.38 stayDataList Container
  • travelData
  • 2.38 stayData Container
  • stayDataList
  • 2.38 stayCategory Container
  • stayData
  • 2.38 numberOfNights Container
  • stayData
  • 2.38 stayCompany Container
  • stayData
  • 2.38 stayArrivalDateTime Container
  • stayData
  • 2.38 numberOfPeopleStaying Container
  • stayData
  • 2.38 roomServiceLevel Container
  • stayData
  • 2.38 stayDepartureDateTime Container
  • stayData
  • 2.38 stayInsurance Container
  • stayData
  • 2.38 stayInsuranceIndicator Container
  • stayData
  • 2.38 stayLocation Container
  • stayData
  • 2.38 stayNumberOfRooms Container
  • stayData
  • 2.38 stayRentalCarIndicator Container
  • stayData
  • 2.38 passportDataList Container
  • travelData
  • 2.38 passportData Container
  • passportDataList
  • 2.38 passportExpirationDate Container
  • passportData
  • 2.38 passportIssueCountry Container
  • passportData
  • 2.46 mainTravelerFirstName Container
  • travelData
  • 2.38 travelCardType Container
  • travelData
  • 2.41 bookingData Container
  • travelData
  • 2.41 bookerFirstName Container
  • bookingData
  • 2.41 bookerLastName Container
  • bookingData
  • 2.41 bookingId Container
  • bookingData
  • 2.41 bookingPlatform Container
  • bookingData
  • 2.41 bookingPlatformOrderId Container
  • bookingData
  • 2.46 mainTravelerLastName Container
  • travelData
  • 2.38 numberOfTravelers Container
  • travelData
  • 2.38 travelEndDateTime Container
  • travelData
  • 2.38 travelingPayerIndicator Container
  • travelData
  • 2.38 travelReason Container
  • travelData
  • 2.38 travelStartDateTime Container
  • travelData
  • 2.38 shoppingCartTotalAmount Container
  • shoppingCartDetail
  • 2.38 shoppingCartTotalQuantity Container
  • shoppingCartDetail
  • 2.38 shoppingCartTotalTaxAmount Container
  • shoppingCartDetail
  • 2.19 statementReference Request
    2.0 transactionOrigin Request
    2.0 transactionReference Request/Response
    2.0 amount Request
    2.0 currencyCode Request
    2.0 interfaceVersion Request
    2.0 keyVersion Request
    2.0 merchantId Request
    2.0 seal Request/Response
    2.0 acquirerResponseCode Response
    2.35 authorMessageReference Response
    2.0 authorisationId Response
    2.35 cardData Response
    2.35 cardBrand Container
  • cardData
  • 2.35 cardCorporateIndicator Container
  • cardData
  • 2.35 cardEffectiveDateIndicator Container
  • cardData
  • 2.35 cardProductCode Container
  • cardData
  • 2.35 cardProductName Container
  • cardData
  • 2.35 cardProductProfile Container
  • cardData
  • 2.45 cardProductUsageLabel Container
  • cardData
  • 2.35 cardSeqNumberIndicator Container
  • cardData
  • 2.35 issuerCode Container
  • cardData
  • 2.35 issuerCountryCode Container
  • cardData
  • 2.35 issuerName Container
  • cardData
  • 2.35 issuerRegionCode Container
  • cardData
  • 2.44 issuingCountryCode Container
  • cardData
  • 2.35 panCheckAlgorithm Container
  • cardData
  • 2.35 panLengthMax Container
  • cardData
  • 2.35 panLengthMin Container
  • cardData
  • 2.35 virtualCardIndicator Container
  • cardData
  • 2.21 errorFieldName Response
    2.0 maskedPan Response
    2.0 newStatus Response
    2.0 operationDateTime Response
    2.0 responseCode Response
    2.17 transactionPlatform Response

    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