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 MyBank transaction on the HiPay Enterprise Payment Gateway, you must send these mandatory/complementary parameters in your transaction creation call.
Please note: MyBank is only available in Italy for transactions in euros.
(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 | mybank |
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 |
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” : “mybank”,
“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” : “via della Repubblica 2”,
“streetaddress2” : ”Scala B”,
“city” : “Roma”,
“state” : “Italia”,
“zipcode” : “00100”,
“country” : “IT”,
“shipto_firstname” : “Maria”,
“shipto_lastname” : “Bianchi”,
“shipto_streetaddress” : “via Borghi 5”,
“shipto_streetaddress2” : “Scala 5”,
“shipto_city” : “Milano”,
“shipto_state” : “Italia”,
“shipto_zipcode” : “20019”,
“shipto_country” : “IT”,
“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
<?xml version="1.0" encoding="UTF-8"?>
<response>
<state>forwarding</state>
<reason/>
<forward_url>https://stage-secure-gateway.hipay-tpp.com/gateway/forward/987654321a123b0b1fabcd98a7654321</forward_url>
<test>true</test>
<mid>00001234455</mid>
<attempt_id>1</attempt_id>
<authorization_code/>
<transaction_reference>800000112233</transaction_reference>
<date_created>2018-11-05T17:45:17+0000</date_created>
<date_updated>2018-11-05T18:45:18+0100</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>mybank</payment_product>
<payment_method/>
<three_d_secure/>
<fraud_screening>
<scoring>0</scoring>
<result>ACCEPTED</result>
<review/>
</fraud_screening>
<order>
<id>
<![CDATA[1231230123]]>
</id>
<date_created>
<![CDATA[2018-11-05T17:45:17+0000]]>
</date_created>
<attempts>
<![CDATA[1]]>
</attempts>
<amount>
<![CDATA[100.00]]>
</amount>
<shipping>
<![CDATA[0.00]]>
</shipping>
<tax>
<![CDATA[0.00]]>
</tax>
<decimals>
<![CDATA[2]]>
</decimals>
<currency>
<![CDATA[EUR]]>
</currency>
<customer_id>
<![CDATA[]]>
</customer_id>
<language>
<![CDATA[en_US]]>
</language>
<email>
<![CDATA[]]>
</email>
</order>
<debit_agreement>
<id/>
<status/>
</debit_agreement>
</response>
Comentários
0 comentário
Artigo fechado para comentários.