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 |
|
|
Production |
Request parameters
To create a Bancontact QR code transaction on the HiPay Enterprise Payment Gateway, you must send these mandatory/complementary parameters in your transaction creation call.
Please note: this payment method does not allow cancellation or refund operations.
(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 |
|
| payment_product | AN | M | bancontactqrcode |
| description | AN | M | Description of the order |
| currency | A | E.g.: EUR | |
| amount | R | M | Use decimal point as separator |
| cid | AN | Customer ID | |
| language | AN | E.g.: fr_FR | |
| AN | Customer's email address | ||
| phone | N |
Customer's phone number E.g.: 330102030405 |
|
| birthdate | AN | Customer's birthdate (YYYYMMDD) | |
| gender | A |
Gender of the customer (M = male, F = female, U = unknown) |
|
| firstname | AN | Customer's first name | |
| lastname | AN | Customer's last name | |
| streetaddress | AN | Customer's billing address | |
| streetaddress2 | AN | Additional information for the customer's billing address (e.g.: building, floor, flat, etc.) |
|
| city |
A |
City of the customer's billing address | |
| state | A | State of the customer's billing address (e.g.: France) | |
| 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). E.g.: FR |
|
| msisdn | N | Customer's mobile phone number | |
| ipaddrr | AN | Customer's IP address | |
| shipto_firstname | AN | First name of the order's recipient | |
| shipto_lastname | AN | Last name of the order's recipient | |
| shipto_gender | A |
Gender of the order's recipient (M = male, F = female, U = unknown) |
|
| shipto_phone | N | Recipient's phone number |
|
| shipto_msisdn | N | Recipient's mobile phone number |
|
| shipto_streetaddress | AN | Recipient's shipping address | |
| shipto_streetaddress2 | AN | Additional information for the recipient's shipping address (e.g.: building, floor, flat, etc.) | |
| 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
{
“currency” : “EUR”,
“payment_product” : “bancontactqrcode”,
“orderid” : “123abc0def456”,
“amount” : “10”,
“description” : “QR code”,
“country” : “FR”,
“eci” : “7”,
“firstname” : “John”,
“lastname” : “Doe”,
“streetaddress” : “11 rue de la République”,
“city” : “Paris”,
“state” : “France”,
“zipcode” : “75000”,
“decline_url” : “http://decline.testage.com/”,
“pending_url” : “http://pending.testage.com/”,
“exception_url” : “http://exception.testage.com/”,
“cancel_url” : “http://cancel.testage.com/”,
“accept_url” : “http://accept.testage.com/”,
“operation” : “sale”,
“shipping” : “1.3”,
“tax” : “1.1”,
“tax_rate” : “1”,
“cid” : “Customer1234”,
“language” : “fr_FR”,
“custom_data” : “{“internal_reference”:”BA1234”}”,
“email” : “jdoe@email.com”,
“phone” : “330102030405”,
“birthdate” : “19890523”,
“gender” : “M”,
}
API response
This service creates an order and returns a forward URL. This forward URL is dedicated to display the generated QR code. After payment validation, the checkout is processed and the user is returned to the accept_url or the merchant’s URL.
(For further details, please refer to the technical documentation.)
Response example
<response>
<state>forwarding</state>
<reason/>
<forward_url>https://stage-secure-gateway.hipay-tpp.com/gateway/forward/ab98cd19697c4cabb3180f3d3fbbd2bf</forward_url>
<test>true</test>
<mid>00001122330</mid>
<attempt_id>1</attempt_id>
<authorization_code/>
<transaction_reference>112233445566</transaction_reference>
<date_created>2018-08-14T12:15:56+0000</date_created>
<date_updated>2018-08-14T14:15:58+0200</date_updated>
<date_authorized/>
<status>140</status>
<message>Authentication requested</message>
<authorized_amount>0.00</authorized_amount>
<captured_amount>0.00</captured_amount>
<refunded_amount>0.00</refunded_amount>
<credited_amount>0.00</credited_amount>
<decimals>2</decimals>
<currency>EUR</currency>
<ip_address>0.0.0.0</ip_address>
<ip_country/>
<device_id/>
<cdata1>
<![CDATA[]]>
</cdata1>
<cdata2>
<![CDATA[]]>
</cdata2>
<cdata3>
<![CDATA[]]>
</cdata3>
<cdata4>
<![CDATA[]]>
</cdata4>
<cdata5>
<![CDATA[]]>
</cdata5>
<cdata6>
<![CDATA[]]>
</cdata6>
<cdata7>
<![CDATA[]]>
</cdata7>
<cdata8>
<![CDATA[]]>
</cdata8>
<cdata9>
<![CDATA[]]>
</cdata9>
<cdata10>
<![CDATA[]]>
</cdata10>
<avs_result/>
<cvc_result/>
<eci>7</eci>
<payment_product>bancontactqrcode</payment_product>
<payment_method/>
<three_d_secure/>
<fraud_screening>
<scoring>0</scoring>
<result>ACCEPTED</result>
<review/>
</fraud_screening>
<order>
<id>
<![CDATA[1234567890]]>
</id>
<date_created>
<![CDATA[2018-08-14T12:15:56+0000]]>
</date_created>
<attempts>
<![CDATA[1]]>
</attempts>
<amount>
<![CDATA[1.00]]>
</amount>
<shipping>
<![CDATA[1.30]]>
</shipping>
<tax>
<![CDATA[1.10]]>
</tax>
<decimals>
<![CDATA[2]]>
</decimals>
<currency>
<![CDATA[EUR]]>
</currency>
<customer_id>
<![CDATA[Customer1234]]>
</customer_id>
<language>
<![CDATA[fr_FR]]>
</language>
<email>
<![CDATA[jdoe@email.com]]>
</email>
</order>
<debit_agreement>
<id/>
<status/>
</debit_agreement>
</response>
Comments
0 comments
Article is closed for comments.