Main features of Multibanco and Payshop
- One-time payment functionality with a single numerical reference.
- The “Back to website” button (“Para o site”) on the Reference display page redirects customers to the merchant’s “pending_url” (or, if empty, to the “accept_url”).
- Possibility to print (“Impressão”) the numerical reference from the Reference display page.
- For Multibanco, the payment deadline is set by merchants (please see expiration_limit in the Request parameters table below), whereas it is set to 30 days for Payshop.
- Partial captures are not possible.
- Refunds are made by IBAN bank transfers only.
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 Multibanco or Payshop 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 |
AN |
Alphanumeric characters (a-z, A-Z, 0-9) |
A |
Alphabetic characters only (a-z, A-Z) |
N |
Numeric characters only |
R | Decimal number with explicit decimal point, signed |
Field name |
Format |
Req. |
Description |
payment_product |
AN |
M |
Payment product: multibanco or payshop |
description |
AN |
M |
Description of your order |
expiration_limit |
N |
C |
Specific to Multibanco Accepted values: 3, 30, 90 (days) Default value: 3 (days) Please note: payments can be made until the end of the day of the specified deadline |
amount |
R |
M |
Transaction amount Decimal number with explicit decimal point, signed (e.g.: 66.00) |
currency |
A |
M |
Transaction base currency |
streetaddress |
AN |
M |
Customer’s street address |
zipcode |
AN |
M |
Customer’s zip/postal code |
phone |
AN |
M |
Customer’s phone number |
|
AN |
M |
Customer’s email address |
API response
This service creates an order and returns a forward URL, the reference created and the information related to this reference, as well as the expiration date. This forward URL is dedicated to display a Multibanco or Payshop payment page but merchants can also handle the display of the reference and expiration date sent.
After payment validation, HiPay will send a server-to-server notification to inform the merchant about the result of the transaction.
(For further details, please refer to the technical documentation.)
Response example
{
"forwardUrl":"https:\/\/secure-gateway.hipay-tpp.com\/payment\/web\/pay\/2x624359465x03f51x0533x9",
"test":"false",
"mid":"00001234567",
"attemptId":"1",
"authorizationCode":"",
"transactionReference":"134378580295",
"referenceToPay":{
"reference":"633 877 063",
"amount":"5.00",
"expirationDate":"2017-05-14",
"entity":"11249"
},
"dateCreated":"2017-05-11T07:58:03+0000",
"dateUpdated":"2017-05-11T07:58:06+0000",
"dateAuthorized":"",
"status":"142",
"message":"Authorization Requested",
"authorizedAmount":"0.00",
"capturedAmount":"0.00",
"refundedAmount":"0.00",
"creditedAmount":"0.00",
"decimals":"2",
"currency":"EUR",
"ipAddress":"178.32.43.102",
"ipCountry":"PT",
"deviceId":"",,
"cdata1":"My data 1",
"cdata2":"My data 2",
"cdata3":"My data 3",
"cdata4":"My data 4",
"cdata5":"",
"cdata6":"",
"cdata7":"",
"cdata8":"",
"cdata9":"",
"cdata10":"",
"avsResult":"",
"cvcResult":"",
"eci":"7",
"paymentProduct":"multibanco",
"paymentMethod":"",
"threeDSecure":"",
"fraudScreening":{
"scoring":"0",
"result":"ACCEPTED",
"review":""
},
"order":{
"id":"1494489341",
"dateCreated":"2017-05-11T07:58:03+0000",
"attempts":"1",
"amount":"5.00",
"shipping":"0.00",
"tax":"0.00",
"decimals":"2",
"currency":"EUR",
"customerId":"UID1494489483",
"language":"pt_PT",
"email":"demo@hipay.com"
},
"debitAgreement":{"id":"","status":""}}
Reference display page
Please see below the default templates for Multibanco and Payshop.
Comments
0 comments
Article is closed for comments.