Passer au contenu
Français - France
Plus de support
Contact
  • Il n'y a aucune suggestion car le champ de recherche est vide.

HiPay Enterprise – iDEAL

ideal_80x71.png

Service endpoints

There are two endpoints (base URLs) to which you can make your API calls:

  • Stage, if you are testing your integration,
  • and Production, when you have finished testing and want your application to go live.
Environment
Endpoint
Stage
https://stage-secure-gateway.hipay-tpp.com/rest/v1/order https://stage-secure-gateway.hipay-tpp.com/rest/v1/hpayment
Production
https://secure-gateway.hipay-tpp.com/rest/v1/order https://secure-gateway.hipay-tpp.com/rest/v1/hpayment

 

Request parameters

To create an iDEAL transaction on the HiPay Enterprise Payment Gateway, you must send these mandatory/complementary parameters in your transaction creation call.

(For further details, please refer to the technical documentation.)

 

Format abbreviation
Description
A
Alphabetic characters only (a-z, A-Z)
AN
Alphanumeric characters (a-z, A-Z, 0-9)
N
Numeric characters only
R
Decimal number with explicit decimal point, signed

 

Field name
Format
Req.
Description
orderid
AN
M
Order ID
operation
A
M
sale
payment_product
AN
M
iDEAL
issuer_bank_id
AN
This is the Business Identifier Code (BIC) of the customer’s issuer bank. More details here: https://developer.hipay.com/
description
AN
M
Description of the order
long_description
AN
Detailed description of the order
currency
A
M
Required value: EUR
amount
R
M
Use decimal point as separator
email
AN
Customer’s email address
phone
N
Customer’s phone number E.g.: 3xx xxxxxxx
birthdate
AN
Customer’s birthdate (YYYYMMDD)
firstname
AN
M
Customer’s first name
lastname
AN
M
Customer’s last name
streetaddress
AN
Customer’s billing address
city
A
City of the customer’s billing address
zipcode
N
Postal code of the customer’s billing address
country
A
Country code of the customer’s billing address This two-letter country code complies with ISO 3166-1 (alpha 2). Required value: IT
shipto_firstname
AN
First name of the order’s recipient
shipto_lastname
AN
Last name of the order’s recipient
shipto_phone
N
Recipient’s phone number
shipto_streetaddress
AN
Recipient’s shipping address
shipto_city
AN
City of the recipient’s shipping address
shipto_zipcode
N
Postal code of the recipient’s shipping address
shipto_country
AN
Country code of the recipient’s shipping address This two-letter country code complies with ISO 3166-1 (alpha 2).
eci
N
7: E-commerce with SSL/TLS Encryption
accept_url
AN
M
Mandatory if not configured in the back office
decline_url
AN
M
Mandatory if not configured in the back office
exception_url
AN
M
Mandatory if not configured in the back office
cancel_url
AN
M
Mandatory if not configured in the back office

 

Request example 

{
“orderid” : “123abc0cba321”,
“operation” : “sale”,
“payment_product” : “ideal”,
“issuer_bank_id” : “ABNANL2A”,
“description” : “Description of the order”,
“long_description” : “Detailed description of the order”, 
“currency” : “EUR”,
“amount” : “100”,
“accept_url” : “http://www.mysite.com/accept”,
“decline_url” : “http://www.mysite.com/decline”,
“pending_url” : ”http://www.mysite.com/pending”,
“exception_url” : “http://www.mysite.com/exception”,
“cancel_url” : “http://www.mysite.com/cancel”,
“firstname” : “Mario”,
“lastname” : “ROSSI”,
“streetaddress” : “Westermarkt 20”,
“streetaddress2” : ””,
“city” : “Amsterdam”,
“state” : “Amsterdam”,
“zipcode” : “1016 GV”,
“country” : “NL”,
“shipto_firstname” : “Maria”,
“shipto_lastname” : “Bianchi”,
“shipto_streetaddress” : “Westermarkt 20”,
“shipto_streetaddress2” : “”,
“shipto_city” : “Amsterdam”,
“shipto_state” : “Amsterdam”,
“shipto_zipcode” : “1016 GV”,
“shipto_country” : “NL”,
“eci” : “7”
}

 

API response

This service returns a forward URL, where customers are redirected.

(For further details, please refer to the technical documentation.) 

Response example 


  

  
   
 
   
    forwarding
   
   
 
   
   

   
    https://stage-secure-gateway.hipay-tpp.com/gateway/forward/987654321a123b0b1fabcd98a7654321
   
   
 
   
    true
   
   
 
   
    00001234455
   
   
 
   
    1
   
   
 
   
   
 
   
    800000112233
   
   
 
   
    2018-11-05T17:45:17+0000
   
   
 
   
    2018-11-05T18:45:18+0100
   
   
 
   
   
 
   
    140
   
   
 
   
    Authentication requested
   
   
 
   
    0.00
   
   
 
   
    0.00
   
   
 
   
    0.00
   
   
 
   
    0.00
   
   
 
   
    2
   
   
 
   
    EUR
   
   
 
   
    0.0.0.0
   
   
 
   
   
 
   
   
 
   
    
.
    
.
    
.
    
 
    
 
    
    
 
    
    
 
    
     7
    
    
 
    
     ideal
    
    
 
    
    
 
    
    
 
    
     
 
     
      0
     
     
 
     
      ACCEPTED
     
     
 
     
     
 
    
    
 
    
     
 
     
      
 1231230123
      
 
     
     
 
     
      
 2018-11-05T17:45:17+0000
      
 
     
     
 
     
      
 1
      
 
     
     
 
     
      
 100.00
      
 
     
     
 
     
      
 0.00
      
 
     
     
 
     
      
 0.00
      
 
     
     
 
     
      
 2
      
 
     
     
 
     
      
 EUR
      
 
     
     
 
     
      
 
      
 
     
     
 
     
      
 en_US

 

Server-to-server notifications

The server-to-server notifications related to this payment method will include all the basic information (detailed here) plus the following specific information related to the iDEAL transaction:


   
   
    NL63BARC200XXXXXXXXXXX
    
   
    CRLYFRPPXXX
    
   
    Mario ROSSI

Please note that to receive these fields in your server-to-server notifications, you must activate them in HiPay Console under: Integration -> Notifications -> Fields -> payment_method

 

Transaction consultation

The transaction consultation method related to a transaction paid through this payment method will include all the basic information (detailed here) plus the following specific information related to the iDEAL payment method used:


   
   
    NL63BARC200XXXXXXXXXXX
    
   
    CRLYFRPPXXX
    
   
    Mario ROSSI