Last update 6/09/2018

2. Implementation

The information is gathered via an https request to the following page, using a form containing input parameters: https://ogone.test.v-psp.com/ncol/test/queryPM.asp

Note: Replace 'test' by 'prod' when you want to switch from test to our production environment.

2.1 Input Parameters

Name Mandatory Description
USERID Y User ID used to perform the query.
REFID N Only if PSPID is part of a group
REFKIND N If using REFID, specify the type: PSPID, MGID, (none)
PSWD Y User or PSPID Password
PSPID Y Unique identifier on our system
ORDERID Y Merchant's unique order reference
AMOUNT Y Amount of the transaction x100
CURRENCY Y ISO 3-letter code (EUR, USD, CHF, etc.)
LANGUAGE Y 2-digit language code (fr, en, etc.)
PM Y Payment method ('3XCB')
OPERATION Y "VEN" or "RES" according to PM configuration
CIVILITY Y Civility of the buyer (Mr, Mme, etc.)
ECOM_BILLTO_POSTAL_NAME_FIRST Y Customer's first name
ECOM_BILLTO_POSTAL_NAME_LAST Y Customer's last name
SHASIGN Y SHA Signature (see next chapter)
WITHROOT N defines whether the XML response should be encapsulated in one global root element

More information about these fields can be found in your account. Just log in and go to: "Support > Integration & user manuals > Technical guides > Parameter Cookbook".

In order to verify the integrity of the submitted data, our system requires each request to include a SHA signature. This signature is built by hashing the contents of the request, in the 'parameter=value' format in alphabetical order.

For more information on SHA, go to e-Commerce.

2.2 Output Parameters

The following information is included with each Query PM Response:

Field Description
NCERROR Error code (0 if all OK)
NCERRORPLUS Detailed error code (0 if all OK)
ORDERID Merchant order reference
AMOUNT Amount of the transaction
CURRENCY Currency
OPERATION Operation (VEN or RES)
PM Payment Method
AMOUNT1 First amount to be paid
AMOUNT2 Second amount to be paid
AMOUNT3 Third amount to be paid
EXECUTIONDATE1 Date of the first payment
EXECUTIONDATE2 Date of the second payment
EXECUTIONDATE3 Date of the third payment
APR Annual Percentage Rate. Also known as TAEG (Taux Annuel Effectif Global)
COST Additional cost for the transaction
CONTRACT base64 encoded contract text (in html format)
VERSION Version of the terms and conditions

More information about these fields can be found in your account. Just log in and go to: "Support > Integration & user manuals > Technical guides > Parameter Cookbook". 

Example:

<?xml version="1.0" ?>
<ncresponse
NCERROR="0"
NCERRORPLUS=""
orderID="GHJ21233"
AMOUNT="90"
CURRENCY="EUR"
OPERATION="VEN"
PM="3XCB"
AMOUNT1="31.08"
AMOUNT2="30.00"
AMOUNT3="30.00"
EXECUTIONDATE1="12/08/2011"
EXECUTIONDATE2="14/08/2011"
EXECUTIONDATE3="16/08/2011"
APR="813.56"
COST="1.08"
VERSION="V0001"
CONTRACT="…”
/>

Notes:

  • Contrary to the input parameters, the amounts in the response have a decimal separator
  • Date formats are dd/MM/yyyy

We strongly advise you to verify the data by performing a SHA-OUT check on the returned data.

In order to verify the integrity of the submitted data, our system requires each request to include a SHA signature. This signature is built by hashing the contents of the request, in the 'parameter=value' format in alphabetical order.

For more information on SHA-OUT, go to e-Commerce.

As a leading global digital payment service provider, Ingenico Payment Services provides a seamless response to the complexity of payments, whatever the channel: online, mobile and point-of-sale. Offering innovative e-commerce, multi-channel, financial, and marketing solutions, it helps merchants to manage, collect and secure their payments, prevent fraud and increase their revenues through higher conversions. Ingenico Payment Services is part of the Ingenico Group, the global leader in seamless payment.

This website uses cookies to be able to give you the best user experience. If you don't want to accept these cookies, we allow you to change the cookie settings. Click 'Accept' to allow all cookies from this website.

Cookie settings

Introduction

Functional

Functional cookies are required for the website to operate correctly. These cookies cannot be disabled.

Optimized

Optimization cookies allow us to analyze site usage so we can measure and improve our website.
This is the default level.

Personalized

Personalization cookies are used for social media and advanced personalization. They allow us to show you information related to your company.


Example functionality allowed

  • Store country preference
  • Store language preference

Example functionality not allowed

  • Saving personal data
  • Anonymous tracking via Google Analytics
  • Tracking for remarketing purposes

Example functionality allowed

  • Store country preference
  • Store language preference
  • Anonymous tracking via Google Analytics

Example functionality not allowed

  • Saving personal data
  • Tracking for remarketing purposes

Example functionality allowed

  • Store country preference
  • Store language preference
  • Anonymous tracking via Google Analytics
  • Serve content relevant to your interests
  • Serve ads relevant to your interests
  • Tracking for remarketing purposes

Example functionality not allowed

  • Saving personal data