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.

Request parameters

To create a BNP Personal Finance 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.)

Request example

{
  "payment_product" : "bnpp-4xcb" ,
  "email" : "john.doe@ddress.com" ,
  "description" : "Description of the order" ,
  "orderid" : "1122334455" ,
  "amount" : "66.00" ,
  "currency" : "EUR" ,
  "gender" : "M" ,
  "firstname" : "John" ,
  "lastname" : "DOE" ,
  "streetaddress" : "2 rue Unetelle" ,
  "city" : "Paris" ,
  "zipcode" : "75012" ,
  "country" : "FR" ,
  "phone" : "0187654321" ,
  "shipto_firstname" : "Jane" ,
  "shipto_lastname" : "DOE" ,
  "shipto_streetaddress" : "12 quai Untel" ,
  "shipto_streetaddress2" : "Appt n°5" ,
  "shipto_city" : "Paris" ,
  "shipto_zipcode" : "75001" ,
  "shipto_country" : "FR"
}

Response example

Please note: The web service creates an order and returns a forward URL. This forward URL is dedicated to display a BNP Personal Finance payment page. After payment validation, HiPay will send a server-to-server notification to inform the merchant about the result of the transaction.

{
  "state" : "forwarding" ,
  "reason" : "" ,
  "forwardUrl" :
  "https://secure-gateway.hipay-tpp.com/gateway/forward/831efb769214af57e03c997a6f6e2d68" ,
  "test" : "true" ,
  "mid" : "00001234567" ,
  "attemptId" : "1" ,
  "authorizationCode" : "" ,
  "transactionReference" : "112233445566" ,
  "dateCreated" : "2017-09-06T15:14:09+0000" ,
  "dateUpdated" : "2017-09-06T15:14:23+0000" ,
  "dateAuthorized" : "" ,
  "status" : "140" ,
  "message" : "Authentication requested" ,
  "authorizedAmount" : "0.00" ,
  "capturedAmount" : "0.00" ,
  "refundedAmount" : "0.00" ,
  "creditedAmount" : "0.00" ,
  "decimals" : "2" ,
  "currency" : "EUR" ,
  "ipAddress" : "0.0.0.0" ,
  "ipCountry" : "" ,
  "deviceId" : "" ,
  "cdata1" : "" ,
  "cdata2" : "" ,
  "cdata3" : "" ,
  "cdata4" : "" ,
  "cdata5" : "" ,
  "cdata6" : "" ,
  "cdata7" : "" ,
  "cdata8" : "" ,
  "cdata9" : "" ,
  "cdata10" : "" ,
  "avsResult" : "" ,
  "cvcResult" : "" ,
  "eci" : "7" ,
  "paymentProduct" : "bnpp-4xcb" ,
  "paymentMethod" : "" ,
  "threeDSecure" : "" ,
  "fraudScreening" : {
  "scoring" : "0" ,
  "result" : "ACCEPTED" ,
  "review" : ""
 },
  "order" : {
  "id" : "1234567890" ,
  "dateCreated" : "2017-09-06T15:14:09+0000" ,
  "attempts" : "1" ,
  "amount" : "66.00" ,
  "shipping" : "0.00" ,
  "tax" : "0.00" ,
  "decimals" : "2" ,
  "currency" : "EUR" ,
  "customerId" : "" ,
  "language" : "en_US" ,
  "email" : "john.doe@ddress.com"
 },
  "debitAgreement" : {
  "id" : "" ,
  "status" : ""
 }
}

HiPay Enterprise – BNP Personal Finance

Service endpoints

Request parameters