logo Sogenactif

Release 25.2

go directly to content

Search by keywords

paymentProviderGetContext

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

This request is optional and allow you to know the identity of the payer and his shipping address in order to display them before the confirmation of transaction of a PayPal transaction.

Recommended interfaceVersion: IR_WS_2.55

  • PROD
    https://office-server.sogenactif.com/rs-services/v2/checkout/paymentProviderGetContext
    method
    POST
  • TEST
    https://office-server-sogenactif.test.sips-services.com/rs-services/v2/checkout/paymentProviderGetContext
    method
    POST
  • PROD
    https://office-server.sogenactif.com/services/v2/checkout?wsd
    method
    POST
  • TEST
    https://office-server-sogenactif.test.sips-services.com/services/v2/checkout?wsd
    method
    POST

Required

Optional

Request sample

            {
  "interfaceVersion": "IR_WS_2.0",
  "keyVersion": "1",
  "merchantId": "011223344550000",
  "messageVersion": "0.1",
  "redirectionData": "RSs7cZy...L1DqsVso",
  "transactionReference": "TREFEXA2012",
  "seal": "30218c85ca303d33d5e7b60bb48222b9826fbc30b6c2ec98fff285702e445ae1"
}

        
                  <urn:paymentProviderGetContext>
         <urn:input>
            <urn:merchantId>011223344550000</urn:merchantId>
            <urn:transactionReference>TREFEXA2012</urn:transactionReference>
            <urn:interfaceVersion>IR_WS_2.2</urn:interfaceVersion>
            <urn:redirectionData>RSs7cZyL1DqsV... 9P15xVe</urn:redirectionData>
            <urn:messageVersion>0.1</urn:messageVersion>
         </urn:input>
      </urn:paymentProviderGetContext>

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

Response sample

            {
  "responseCode": "00",
  "deliveryAddress": {
    "addressAdditional1": "devliveryAdd11",
    "city": "Blois",
    "country": "FR",
    "street": "Street",
    "zipCode": "41000"
  },
  "deliveryContact": {
    "email": "team@email.com",
    "firstname": "Team",
    "lastname": "John",
    "phone": "0254440000"
  },
  "customerAddress": {
    "addressAdditional1": "devliveryAdd11",
    "city": "Blois",
    "country": "FR",
    "street": "Street",
    "zipCode": "41000"
  },
  "customerContact": {
    "firstname": "Team",
    "lastname": "BO",
    "phone": "0254440000"
  },
  "paymentMeanData": {
    "paypal": {
      "token": "EC-4S931937D5977923H",
      "deliveryAddressStatus": "Confirmed",
      "payerId": "H3G7GWRLLSBDY",
      "payerStatus": "verified",
      "paymentStatus": "PaymentActionNotInitiated"
    }
  },
  "acquirerResponseMessage": "Process succeeded",
  "acquirerResponseIdentifier": "419d14fb8a5c",
  "seal": "18509963c41e3102967ee0ebc149165032b1b53cffec29f46d29ab37d8bc1df4"
}

        
                  <paymentProviderGetcontextResponse xmlns="urn:sips:cn:contract:office:checkout:v2">
         <output>
            <deliveryAddress>
                <addressAdditional1>devliveryAdd11</addressAdditional1>
                <city>Blois</city>
                <country>FRA</country>
                <street>Street</street>
                <zipCode>41000</zipCode>
            </deliveryAddress>
            <deliveryContact>
               <email>john@email.com</email>
               <firstname>John</firstname>
               <lastname>Bush</lastname>
               <phone>0254440000</phone>
            </deliveryContact>
            <customerAddress>
               <addressAdditional1>devliveryAdd21</addressAdditional1>
               <city>Paris</city>
               <country>FRA</country>
               <street>Avenue</street>
               <zipCode>75000</zipCode>
            </customerAddress>
            <customerContact>
               <email>sue@email.com</email>
               <firstname>Sue</firstname>
               <lastname>Smith</lastname>
               <phone>0254441111</phone>
            </customerContact>
            <paymentMeanData>
               <paypal>
                  <token>EC-4S931937D5977923H</token>
                  <deliveryAddressStatus>Confirmed</deliveryAddressStatus>
                  <payerId>H3G7GWRLLSBDY</payerId>
                  <payerStatus>verified</payerStatus> 
                  <paymentStatus>PaymentActionNotInitiated</paymentStatus>
               </paypal>
            </paymentMeanData >
            <responseCode>00</responseCode>
            <acquirerResponseMessage>Process succeeded</acquirerResponseMessage>
         </output>
      </paymentProviderGetcontextResponse>

Changelog


Interface version Data Attendance Container
1.2 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 interfaceVersion Request
    2.0 keyVersion Request
    2.0 merchantId Request
    2.0 messageVersion Request
    2.0 redirectionData Request
    2.0 seal Request/Response
    2.0 acquirerNativeResponseCode Response
    2.0 acquirerResponseIdentifier Response
    2.0 acquirerResponseMessage Response
    2.0 customerAddress Response
    2.0 addressAdditional3 Container
  • customerAddress
  • deliveryAddress
  • holderAddress
    • 2.0 country Container
  • customerAddress
  • deliveryAddress
  • holderAddress
    • 2.0 city Container
  • customerAddress
  • deliveryAddress
  • holderAddress
    • 2.0 company Container
  • customerAddress
  • deliveryAddress
  • holderAddress
    • 2.0 addressAdditional1 Container
  • customerAddress
  • deliveryAddress
  • holderAddress
    • 2.0 addressAdditional2 Container
  • customerAddress
  • deliveryAddress
  • holderAddress
    • 2.0 postBox Container
  • customerAddress
  • deliveryAddress
  • holderAddress
    • 2.0 state Container
  • customerAddress
  • deliveryAddress
  • holderAddress
    • 2.0 street Container
  • customerAddress
  • deliveryAddress
  • holderAddress
    • 2.0 streetNumber Container
  • customerAddress
  • deliveryAddress
  • holderAddress
    • 2.0 zipCode Container
  • customerAddress
  • deliveryAddress
  • holderAddress
    • 2.0 customerContact Response
    2.0 email Container
  • customerContact
  • deliveryContact
    • 2.0 firstname Container
  • customerContact
  • deliveryContact
    • 2.0 gender Container
  • customerContact
  • deliveryContact
    • 2.11 initials Container
  • customerContact
  • deliveryContact
    • 2.0 lastname Container
  • customerContact
  • deliveryContact
    • 2.0 mobile Container
  • customerContact
  • deliveryContact
  • paypal
    • 2.0 phone Container
  • customerContact
  • deliveryContact
    • 2.0 title Container
  • customerContact
  • deliveryContact
    • 2.23 workphone Container
  • customerContact
  • deliveryContact
    • 2.0 deliveryAddress Response
    2.0 deliveryContact Response
    2.21 errorFieldName Response
    2.0 holderAddress Response
    2.0 paymentMeanData Response
    2.21 bcmcMobile Container
  • paymentMeanData
    • 2.21 completionRedirectUrl Container
  • bcmcMobile
    • 2.21 defaultRedirectUrl Container
  • bcmcMobile
    • 2.0 cofinoga3xcb Container
  • paymentMeanData
    • 2.0 creditIndicator Container
  • cofinoga3xcb
    • 2.14 cofinoga Container
  • paymentMeanData
    • 2.14 settlementMode Container
  • cofinoga
  • bcaCup
    • 2.12 bcaCup Container
  • paymentMeanData
    • 2.38 bancontact Container
  • paymentMeanData
    • 2.38 bancontactMerchantCustomerAuthenticationMethod Container
  • bancontact
    • 2.38 initialAuthenticationCavv Container
  • bancontact
    • 2.38 payeeCardNumber Container
  • bancontact
    • 2.38 payeeHolderName Container
  • bancontact
    • 2.0 paypal Container
  • paymentMeanData
    • 2.14 orderDescription Container
  • paypal
    • 2.12 deliveryAddressStatus Container
  • paypal
    • 2.12 payerStatus Container
  • paypal
    • 2.12 payerBusiness Container
  • paypal
    • 2.0 dupDesc Container
  • paypal
    • 2.0 invoiceId Container
  • paypal
    • 2.0 addrOverride Container
  • paypal
    • 2.0 dupFlag Container
  • paypal
    • 2.12 paymentStatus Container
  • paypal
    • 2.12 payerId Container
  • paypal
    • 2.12 payerSuffix Container
  • paypal
    • 2.0 dupCustom Container
  • paypal
    • 2.0 dupType Container
  • paypal
    • 2.0 landingPage Container
  • paypal
    • 2.12 token Container
  • paypal
    • 2.0 responseCode Response
    Back to top Need help?

    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