searchMandate

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

This operation allows to search the exising mandates of a client. The mandates are related to a given client only if the customerId field was provided in the initializeMandate request parameters.

interfaceVersion recommandée : MR_WS_2.55

PROD

https://office-server.sogenactif.com/rs-services/v2/mandate/searchMandate

method

POST
TEST

https://office-server-sogenactif.test.sips-services.com/rs-services/v2/mandate/searchMandate

method

POST

PROD

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

method

POST
TEST

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

method

POST

Request

Required

customerId
presence

Required

Interface version

2.0
Format
AN19(restricted String)
Customer identifier

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

As a subcontractor, SG 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 SG via the fields provided for this purpose (see data dictionary).
- All other personal data not listed in the DPA must not be transmitted to SG.
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

MR_WS_2.

Sogenactif Office Serveur (SOAP/JSON) interface for mandate management.
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.
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

intermediateServiceProviderId

presence

Optional

Interface version

2.0

Format

AN30

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

presence

Optional

Interface version

2.0

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

Request sample

json
soap

            {
  "customerId": "test123",
  "interfaceVersion": "MR_WS_2.20",
  "keyVersion": "1",
  "merchantId": "011223344550000",
  "seal": "df97074b81e534d70cccbff5446b71d36c4d4de6d995fe630c8077d6fa85c0a3"
}

                  <urn:searchMandate>
         <urn:input>
            <urn:interfaceVersion>MR_WS_2.18</urn:interfaceVersion>
            <urn:merchantId>011223344550000</urn:merchantId>
            <urn:customerId>test123</urn:customerId>
            <urn:keyVersion>1</urn:keyVersion>
            <urn:seal>4528716bcc78a6e47ae49b1a5dd3dc5ad7a36732f59d3a8c7f0c00a4d3aba79c</urn:seal>
         </urn:input>
      </urn:searchMandate>

Response

Required

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

acquirerResponseCode

presence

Optional

Interface version

2.0

Format

AN2(restricted values)

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
errorFieldName

presence

Optional

Interface version

2.21

Format

ANS50

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

presence

Optional

Interface version

2.0

Format

Composite list

List of the merchant mandates.
Contains
- mandate
  
  presence
  
  Optional
  
  Interface version
  
  2.0
  
  Format
  
  Container
  
  All information characterizing a mandate of the merchant.
  Contains
  - iban
    
    presence
    
    Optional
    
    Interface version
    
    2.0
    
    Format
    
    AN34
    
    International Bank Account Number (IBAN) identifying a bank account in conformity with ISO 13616.
  - bic
    
    presence
    
    Optional
    
    Interface version
    
    2.0
    
    Format
    
    AN11
    
    Business Identifier Code (BIC) as described in ISO 9362. It identifies the institution code, its country and its location (on 8 characters), and the institution’s branch (on 11 characters).
  - mandateCreationDate
    
    presence
    
    Optional
    
    Interface version
    
    2.0
    
    Format
    
    N8(YYYYMMDD)
    
    Creation date of mandate.
  - mandateId
    
    presence
    
    Optional
    
    Interface version
    
    2.0
    
    Format
    
    AN35
    
    Mandate number.
  - mandateLastUpdateDate
    
    presence
    
    Optional
    
    Interface version
    
    2.0
    
    Format
    
    N8(YYYYMMDD)
    
    Last updated date of mandate.
  - mandateSecureReference
    
    presence
    
    Optional
    
    Interface version
    
    2.29
    
    Format
    
    ANS10
    
    Debtor identifier by the SSP (Score and Secure Payment) regarding a SDD payment.
  - mandateSignatureDate
    
    presence
    
    Optional
    
    Interface version
    
    2.0
    
    Format
    
    N8(YYYYMMDD)
    
    Signature date of mandate.
  - mandateStatus
    
    presence
    
    Optional
    
    Interface version
    
    2.0
    
    Format
    
    ANS30(restricted values)
    
    Mandate status.
    
    List of values
    
    ACTIVE
    
    Active
    
    CANCELED
    
    Cancelled
    
    DELETED
    
    Deleted
    
    FINALIZED
    
    Finalized
    
    INACTIVE
    
    Inactive
    
    OBSOLETE
    
    Obsolete
    
    PENDING
    
    In pending
    
    REVOKED
    
    Revoked
    
    SENT_TO_DEBTOR
    
    Sent to debtor
    
    SUSPENDED
    
    Suspended
    
    WAITING_FOR_VALIDATION
    
    Waiting for validation
    
    WAITING_REACHABILITY
    
    Waiting for reachability (connexion check to the bank establishment).
  - mandateUsage
    
    presence
    
    Optional
    
    Interface version
    
    2.0
    
    Format
    
    ANS20(restricted values)
    
    Type of mandate used.
    
    List of values
    
    ONE_OFF
    
    Single use mandate
    
    RECURRENT
    
    Recurring use mandate
  - riskyMandate
    
    presence
    
    Optional
    
    Interface version
    
    2.29
    
    Format
    
    A1 (restricted values)
    
    As part of option SDD Safe Debit, it indicates whether the SSP (Score and Secure Payment) evaluates that the SDD mandate may involve a risk.
    
    List of values
    
    N
    
    SDD mandate is risk free
    
    Y
    
    SDD mandate is risky
  - transactionActors
    
    presence
    
    Optional
    
    Interface version
    
    2.0
    
    Format
    
    A4(restricted values)
    
    Indicates the players in the transaction.
    
    List of values
    
    BTOB
    
    Business to Business
    
    BTOC
    
    Business to Consumer
    
    BTOF
    
    Business to organization / association
mandateResponseCode

presence

Optional

Interface version

2.0

Format

N2

Response code returned by the mandate management service.

List of values

00

Mandate operation accepted

03

Invalid merchant contract

05

Process is refused

12

Invalid mandate, check the request parameters

17

Buyer cancellation

25

Unknown mandate

30

Format error

34

Fraud suspicion (erroneous seal)

40

Function not supported: the operation that you wish to perform is not part of the operation type for which you are authorised

99

Temporary problem at the Sogenactif server level

Response sample

json
soap

            {
  "mandateResponseCode": "00",
  "acquirerResponseCode": "00",
  "mandateList": [
    {
      "mandateId": "6768",
      "mandateStatus": "ACTIVE",
      "bic": "123456789",
      "iban": "987654321",
      "transactionActors": "B2C",
      "mandateUsage": "RECURRENT"
    },
    {
      "mandateId": "4659",
      "mandateStatus": "ACTIVE",
      "bic": "123456789",
      "iban": "987654321",
      "transactionActors": "B2C",
      "mandateUsage": "RECURRENT"
    },
    {
      "mandateId": "7083",
      "mandateStatus": "ACTIVE",
      "bic": "123456789",
      "iban": "987654321",
      "transactionActors": "B2C",
      "mandateUsage": "RECURRENT"
    }
  ],
  "seal": "10a575f493ac8a791e78d750ec7bbaa15ebec2c5a39f95dbc49d9a5f1b6ef671"
}

                  <searchMandateResponse xmlns="urn:sips:cn:contract:office:mandatemanagement:v2">
         <output>
            <responseCode>00</responseCode>
            <acquirerResponseCode>00</acquirerResponseCode>
            <mandateList>
               <mandate>
                  <mandateId>5840</mandateId>
                  <mandateStatus>ACTIVE</mandateStatus>
                  <bic>123456789</bic>
                  <iban>987654321</iban>
                  <transactionActors>B2C</transactionActors>
                  <mandateUsage>RECURRENT</mandateUsage>
               </mandate>
               <mandate>
                  <mandateId>1514</mandateId>
                  <mandateStatus>ACTIVE</mandateStatus>
                  <bic>123456789</bic>
                  <iban>987654321</iban>
                  <transactionActors>B2C</transactionActors>
                  <mandateUsage>RECURRENT</mandateUsage>
               </mandate>
               <mandate>
                  <mandateId>9500</mandateId>
                  <mandateStatus>ACTIVE</mandateStatus>
                  <bic>123456789</bic>
                  <iban>987654321</iban>
                  <transactionActors>B2C</transactionActors>
                  <mandateUsage>RECURRENT</mandateUsage>
               </mandate>
            </mandateList>
            <seal>ef7354b3881b5116ec41c10ea2685ad3a48711f629814ca2fa856fd93aa14c07</seal>
         </output>
      </searchMandateResponse>

Changelog

Filter

Interface version	Data	Attendance	Container
2.0	`intermediateServiceProviderId`	Request
2.0	`sealAlgorithm`	Request
2.0	`customerId`	Request
2.0	`interfaceVersion`	Request
2.0	`keyVersion`	Request
2.0	`merchantId`	Request
2.0	`seal`	Request/Response
2.0	`acquirerResponseCode`	Response
2.21	`errorFieldName`	Response
2.0	`mandateList`	Response
2.0	`mandate`	Container	`mandateList`
2.0	`iban`	Container	`mandate`
2.0	`bic`	Container	`mandate`
2.0	`mandateCreationDate`	Container	`mandate`
2.0	`mandateId`	Container	`mandate`
2.0	`mandateLastUpdateDate`	Container	`mandate`
2.29	`mandateSecureReference`	Container	`mandate`
2.0	`mandateSignatureDate`	Container	`mandate`
2.0	`mandateStatus`	Container	`mandate`
2.0	`mandateUsage`	Container	`mandate`
2.29	`riskyMandate`	Container	`mandate`
2.0	`transactionActors`	Container	`mandate`
2.0	`mandateResponseCode`	Response

searchMandate

Endpoints

Request

Required

`customerId`

`interfaceVersion`

`keyVersion`

`merchantId`

`seal`

Optional

`intermediateServiceProviderId`

`sealAlgorithm`

Request sample

Response

Required

`seal`

Optional

`acquirerResponseCode`

`errorFieldName`

`mandateList`

`mandate`

`iban`

`bic`

`mandateCreationDate`

`mandateId`

`mandateLastUpdateDate`

`mandateSecureReference`

`mandateSignatureDate`

`mandateStatus`

`mandateUsage`

`riskyMandate`

`transactionActors`

`mandateResponseCode`

Response sample

Changelog

Need help?