Hipay Multibanco

Multibanco is the main interbank network in Portugal. It offers its customers numerous services such as credit card payments, bank transfers, payment for public services, payment operations at its cashpoints, and payment for online purchases using a Multibanco reference number.

Source: https://www.multibanco.pt/

Features

Integration type

Redirection

Tokenization

No

Payment Flow

1-step payment flow : Capture (direct debit)

2-step payment flow : Authorization + Capture

3-step payment flow : Pending Authorization + Authorization + Capture (asynchronous workflow)

Additional features

Information request and CIT

MIT

Server-to-server

Data Mapping & Mandatory Fields

Below is the mapping between your Create Session request and the fields expected by this payment method.

Purse Session field	Mandatory
amount	Yes
order.redirection	Yes
order.reference	Yes
order.currency_code	Yes
order.amount	Yes
partner_data.session	Yes
customer.reference	No
customer.gender_code	No
customer.first_name	No
customer.last_name	No
customer.billing_address.address_lines	No
customer.billing_address.city	No
customer.billing_address.postal_code	No
customer.billing_address.country_code	No
customer.billing_address.email	No
shipments.shipping_address.address_lines	No
shipments.shipping_address.city	No
shipments.shipping_address.postal_code	No
shipments.shipping_address.country_code	No
shipments.item_lines.sku_reference	No
shipments.item_lines.quantity	No

Payment Labels

Label	Method	Payment type
hipay	multibanco	primary (bank transfer)

Actions

Status

PSP status	State	Code	Description
105	ERROR	FAILED	The card issuer is unable to complete the authentication request.
108	ERROR	FAILED	The card issuer is not able to complete the authentication request.
109	ERROR	FAILED	Authentication Failed -- The cardholder’s authentication failed. The authorization request should not be submitted. An authentication failure may be a possible indication of a fraudulent user.
110	ERROR	REJECTED_BY_RISK_CHECKS	Blocked -- The transaction has been rejected for reasons of suspected fraud.
111	ERROR	REJECTED_BY_RISK_CHECKS	Denied -- The merchant denied the payment attempt. After reviewing the fraud screening result, the merchant decided to decline the payment.
112	WAITING	WAITING_PARTNER_RESPONSE	Authorized and Pending -- The payment has been challenged by the fraud rule set and is pending.
113	ERROR	FAILED	Refused -- The financial institution refused to authorize the payment. The refusal reasons can be: an exceeded credit limit, an incorrect expiry date or insufficient balance, or many others, depending on the selected payment method.
114	ERROR	EXPIRED_AUTHORIZATION	Expired -- The validity period of the payment authorization has expired. This happens when no capture request is submitted for an authorized payment typically within 7 days after authorization. Note: Depending on the customer’s issuing bank, the authorization validity period may last from 1 to 5 days for a debit card and up to 30 days for a credit card.
115	SUCCESS	SUCCEEDED	Cancelled -- The merchant has canceled the payment attempt. Only payments with status “Authorized” that have not yet reached the status “Captured” can be canceled. In case of a credit card payment, canceling the transaction consists of voiding the authorization.
116	SUCCESS	SUCCEEDED	Authorized -- The financial institution has approved the payment. In the case of a credit card payment, funds are “held” and deducted from the customer’s credit limit (or bank balance, in the case of a debit card), but are not yet transferred to the merchant. In the case of bank transfers and some other payment methods, the payment immediately reaches the “Captured” status after being set to “Authorized”.
117	WAITING	WAITING_PARTNER_RESPONSE	Capture Requested -- A capture request has been sent to the financial institution.
118	SUCCESS	SUCCEEDED	Captured -- The financial institution has processed the payment. The funds will be transferred to HiPay Enterprise before being settled to your bank account. Authorized payments can be captured as long as the authorization has not expired. Some payment methods, like bank transfers or direct debits, reach the “Captured” status straight away after being authorized.
119	SUCCESS	SUCCEEDED	Partially Captured -- The financial institution has processed part of the payment. If only part of the order can be shipped, it is allowed to capture an amount equal to the shipped part of the order. This is called a partial capture. Please note: As dictated by all credit card companies, it is not allowed for a merchant to capture a payment before shipping has been completed. Merchants should start shipping the order once the status “Authorized” has been reached!
120	SUCCESS	SUCCEEDED	The funds have been made available for remittance to the merchant.A payment with the “Collected” status is ready to be paid out. HiPay Enterprise will either transfer the amount to your bank account within the next few days (depending on your settlement frequency), or the amount has already been transferred to your bank account.
121	SUCCESS	SUCCEEDED	A part of the transaction has been collected.
122	SUCCESS	SUCCEEDED	The financial operations linked to this transaction are closed. Funds have been debited or credited from your HiPay merchant account.
123	SUCCESS	SUCCEEDED	A part of the financial operations linked to this transaction is closed.
124	WAITING	WAITING_PARTNER_RESPONSE	Refund Requested -- A refund request has been sent to the financial institution.
125	SUCCESS	SUCCEEDED	Refunded -- The payment was refunded. A payment reaches the “Refunded” status when the financial institution has processed the refund and the amount has been transferred to the customer’s account. The amount will be deducted from the next total amount to be paid out to the merchant.
126	SUCCESS	SUCCEEDED	Partially Refunded -- The payment was partially refunded.
129	ERROR	ABORTED_BY_CUSTOMER	Charged Back -- The payment was charged back. The cardholder has reversed a capture processed by their bank or credit card company. For instance, the cardholder has contacted their credit card company and denied having made the transaction. The credit card company has then revoked the payment already captured. Please note the legal difference between the customer (who ordered the goods) and the cardholder (who owns the credit card and ends up paying for the order). Generally, chargebacks only occur incidentally. When they do, contacting the customer can often solve the situation. Occasionally, it is an indication of credit card fraud.
134	ERROR	REJECTED_BANK	Dispute lost -- The merchant lost the chargeback dispute. The chargeback has already been applied to the transaction; it still applies and thus will not be refunded.
140	WAITING	WAITING_PARTNER_RESPONSE	Authentication Requested -- The payment method used requires authentication; authentication request has been sent and the system is waiting for an action from the customer.
141	SUCCESS	SUCCEEDED	Authenticated -- The payment method used requires authentication and it was successful.
142	WAITING	WAITING_PARTNER_RESPONSE	Authorization Requested -- The payment method used requires an authorization request; the request was sent and the system is waiting for the approval of the financial institution.
143	SUCCESS	SUCCEEDED	Authorization Cancelled -- The authorization has been canceled
144	WAITING	WAITING_PARTNER_RESPONSE	Reference rendered -- The payment reference to pay has been generated
150	WAITING	WAITING_PARTNER_RESPONSE	Acquirer Found -- The acquirer’s payment route has been found.
151	ERROR	FAILED	Acquirer not Found -- The acquirer’s payment route has not been found.
160	ERROR	FAILED	Cardholder Enrollment -- Unknown Unable to verify if the card is enrolled in the 3-D Secure program.
161	SUCCESS	SUCCEEDED	Risk Accepted -- The payment has been accepted by the fraud rule set.
163	ERROR	FAILED	Authorization Refused -- The authorization was refused by the financial institution.
165	ERROR	REJECTED_BANK	Refund Refused -- The refund operation was refused by the financial institution.
166	SUCCESS	SUCCEEDED	Debited (cardholder credit) -- The credit request was accepted and the cardholder was credited with the requested amount.
168	SUCCESS	SUCCEEDED	Debited (cardholder credit) -- The credit request was accepted and the cardholder was credited with the requested amount.
169	WAITING	WAITING_PARTNER_RESPONSE	Credit requested -- The merchant requested to directly credit the cardholder.
172	WAITING	WAITING_PARTNER_RESPONSE	In progress -- This status only applies to MixPayment master transactions. All of the master transaction’s sub-transactions are not yet authorized. Consequently, the order’s full amount has not yet been fully paid.
173	ERROR	REJECTED_BANK	Capture Refused -- The capture was refused by the financial institution.
174	WAITING	WAITING_PARTNER_RESPONSE	Awaiting Terminal -- The transaction request was sent to the payment terminal.
175	WAITING	WAITING_PARTNER_RESPONSE	Authorization cancellation requested -- The merchant requested to cancel the transaction’s authorization.
177	WAITING	WAITING_PARTNER_RESPONSE	Challenge Requested -- The payment method used requires authentication; authentication request has been sent and the system is waiting for action from the customer.
178	ERROR	FAILED	Soft declined -- The authorization was declined by the issuer because the transaction was not authenticated. You may retry the authorization after authenticating the cardholder.
200	WAITING	WAITING_PARTNER_RESPONSE	Pending Payment -- The transaction request was submitted to the acquirer but the response is not yet available.
400	ERROR	BAD_REQUEST	The request was rejected due to a validation error.
401	ERROR	BAD_REQUEST	An authentication error occurred/invalid credentials.
403	ERROR	FAILED	Access to this resource is fordidden.
404	ERROR	FAILED	Transaction was not found.
500	ERROR	FAILED	Failed operation
1000001	ERROR	FAILED	[1000001]Incorrect Credentials -- Incorrect username and/or password
1000002	ERROR	FAILED	[1000002]Incorrect Signature -- The signature that was sent does not match the requested format.
1000003	ERROR	FAILED	[1000003]Account Not Active -- The account is inactive.
1000004	ERROR	FAILED	[1000004]Account Locked -- The account is locked.
1000005	ERROR	FAILED	[1000005]Insufficient Permissions -- You do not have permission to make this API call.
1000006	ERROR	FAILED	[1000006]Forbidden Access -- The API access is disabled for this account.
1000007	ERROR	FAILED	[1000007]Unsupported Version -- The API version is not supported.
1000008	ERROR	FAILED	[1000008]Temporarily Unavailable -- The gateway is temporarily unavailable.
1000009	ERROR	FAILED	[1000009]Not Allowed -- The request was rejected due to IP restriction.
1010001	ERROR	FAILED	[1010001]Method Not Allowed -- The specified HTTP method is not allowed for this API call.
1010101	ERROR	FAILED	[1010101]Required Parameter Missing -- A required parameter is missing.
1010201	ERROR	FAILED	[1010201]Invalid Parameter -- A parameter is in an invalid format.
1010202	ERROR	FAILED	[1010202]Invalid Parameter -- A parameter value exceeds the maximum number of characters allowed.
1010203	ERROR	FAILED	[1010203]Invalid Parameter -- A parameter contains non-alphabetic characters.
1010204	ERROR	FAILED	[1010204]Invalid Parameter -- A parameter contains non-numeric characters.
1010205	ERROR	FAILED	[1010205]Invalid Parameter -- The specified parameter is expected to be in decimal format, but does not appear to be a valid decimal value.
1010206	ERROR	FAILED	[1010206]Invalid Date -- The specified parameter does not seem to be a valid date.
1010207	ERROR	FAILED	[1010207]Invalid Time -- The specified parameter does not seem to be a valid time.
1010208	ERROR	FAILED	[1010208]Invalid IP Address -- The merchant entered an IP address that was in an invalid format. The IP address must be in a format such as 123.456.123.456.
1010209	ERROR	FAILED	[1010209]Invalid Email Address -- The merchant entered an email address that was in an invalid format.
1010301	ERROR	FAILED	[1010301]Invalid Soft Descriptor -- The soft descriptor contains invalid characters.
1010401	ERROR	FAILED	[1010401]UTF-8 Encoding error -- The merchant sent parameters which are not UTF-8 encoded.
1010503	ERROR	BAD_REQUEST	The total amount does not match the sum of the items.
1020001	ERROR	FAILED	[1020001]No route to acquirer -- The requested payment product is not configured for your account.
1020002	ERROR	FAILED	[1020002]Unsupported ECI -- The specified ECI is not supported by the gateway.
1020003	ERROR	FAILED	[1020003]:The Payment product specified in the payment_product field does not exist or is not activated.
3000001	ERROR	FAILED	[3000001]Unknown Order -- The order was not found.
3000002	ERROR	FAILED	[3000002]Unknown Transaction -- The transaction was not found.
3000003	ERROR	FAILED	[3000003]Unknown Merchant -- The merchant account does not exist.
3000101	ERROR	FAILED	[3000101]Unsupported Operation -- The operation is not supported.
3000102	ERROR	FAILED	[3000102]Unknown IP Address -- The IP address cannot be detected. The transaction cannot be processed without a valid IP address.
3000201	ERROR	FAILED	[3000201]Suspicion of fraud -- The transaction has been rejected by the financial institution due to suspected fraud.
3010001	ERROR	FAILED	[3010001]Unsupported Currency -- The currency is not supported.
3010002	ERROR	FAILED	[3010002]Amount Limit Exceeded -- The amount exceeds the maximum amount allowed for a single transaction.
3010003	ERROR	FAILED	[3010003]Max Attempts Exceeded -- You have exceeded the maximum number of payment attempts for this order.
3010004	ERROR	FAILED	[3010004]Duplicate Order -- The order has already been processed.
3010005	ERROR	FAILED	[3010005]Checkout Session Expired -- This session has expired. The order is no longer valid.
3010006	ERROR	FAILED	[3010006]Order Completed -- The order has already been completed.
3010007	ERROR	FAILED	[3010007]Order Expired -- The order has expired.
3010008	ERROR	FAILED	[3010008]Order Voided -- The order has been voided.
3020001	ERROR	FAILED	[3020001]Authorization Expired -- The authorization has expired.
3020002	ERROR	FAILED	[3020002]Amount Limit Exceeded -- The amount specified exceeds the allowable limit.
3020101	ERROR	FAILED	[3020101]Not Enabled -- The Capture feature is not enabled for the merchant.
3020102	ERROR	FAILED	[3020102]Not Allowed -- You cannot capture this type of transaction.
3020103	ERROR	FAILED	[3020103]Not Allowed -- You cannot partially capture this type of transaction.
3020104	ERROR	FAILED	[3020104]Permission Denied -- You do not have permission to capture this transaction
3020105	ERROR	FAILED	[3020105]Currency Mismatch -- The currency must be the same for Capture and Authorization.
3020106	ERROR	FAILED	[3020106]Authorization Completed -- The authorization has already been completed.
3020107	ERROR	FAILED	[3020107]No More -- The maximum number of allowable captures has been reached.No more capture for the authorization.
3020108	ERROR	FAILED	[3020108]Invalid Amount -- The capture amount must be positive.
3020109	ERROR	FAILED	[3020109]Amount Limit Exceeded -- The capture amount must be less than or equal to the original transaction amount.
3020110	ERROR	FAILED	[3020110]Amount Limit Exceeded -- The partial capture amount must be less than or equal to the remaining amount.
3020111	ERROR	FAILED	[3020111]Operation Not Permitted -- The transaction is closed.
3020112	ERROR	FAILED	[3020112]Operation Not Permitted -- Transaction Declined (Transaction not permitted)
3020201	ERROR	FAILED	[3020201]Not Enabled -- The Refund feature is not enabled for the merchant.
3020202	ERROR	FAILED	[3020202]Not Allowed -- You cannot refund this type of transaction.
3020203	ERROR	FAILED	[3020203]Not Allowed -- You cannot partially refund this type of transaction.
3020204	ERROR	FAILED	[3020204]Permission Denied -- You do not have permission to refund this transaction.
3020205	ERROR	FAILED	[3020205]Currency Mismatch -- The refund must be in the same currency as the original transaction.
3020206	ERROR	FAILED	[3020206]Already Refunded -- This transaction has already been fully refunded.
3020207	ERROR	FAILED	[3020207]No More -- The maximum number of allowable refunds has been reached. No more refund for the transaction.
3020208	ERROR	FAILED	[3020208]Invalid Amount -- The refund amount must be positive.
3020209	ERROR	FAILED	[3020209]Amount Limit Exceeded -- The refund amount must be less than or equal to the original transaction amount.
3020210	ERROR	FAILED	[3020210]Amount Limit Exceeded -- The partial refund amount must be less than or equal to the remaining amount.
3020211	ERROR	FAILED	[3020211]Operation Not Permitted -- The transaction is closed.
3020212	ERROR	FAILED	[3020212]Too Late -- You are over the time limit to perform a refund on this transaction.
3020301	ERROR	FAILED	[3020301]Not Enabled -- The re-authorization feature is not enabled for the merchant.
3020302	ERROR	FAILED	[3020302]Not Allowed -- Re-authorization is not allowed for this type of transaction.
3020303	ERROR	FAILED	[3020303]Cannot Reauthorize -- You can only re-authorize the original authorization, not a re-authorization.
3020304	ERROR	FAILED	[3020304]Max Limit Exceeded -- The maximum number of re-authorizations allowed for the authorization has been reached.
3020401	ERROR	FAILED	[3020401]Not Allowed -- You cannot void this type of transaction.
3020402	ERROR	FAILED	[3020402]Cannot Void -- You can only void the original authorization, not a re-authorization.
3020403	ERROR	FAILED	[3020403]Authorization Voided -- The authorization has already been voided.
3030001	ERROR	FAILED	[3030001]Fraud Suspicion -- The transaction has been rejected by HiPay due to suspected fraud.
3040001	ERROR	FAILED	[3040001]Unknown Token -- The specified token was not found in the Secure Vault.
4000001	ERROR	FAILED	[4000001]Declined -- The transaction has been declined by the acquirer.
4000002	ERROR	FAILED	[4000002]Declined -- The payment has been refused by the financial institution.
4000003	ERROR	FAILED	[4000003]Insufficient Funds -- The customer’s account does not have sufficient funds.
4000004	ERROR	FAILED	[4000004]Technical Problem -- There was a problem processing this transaction.
4000005	ERROR	FAILED	[4000005]Communication Failure -- This transaction cannot be processed.
4000006	ERROR	FAILED	[4000006]Acquirer Unavailable -- This transaction cannot be processed because the acquirer is temporarily unavailable.
4000007	ERROR	FAILED	[4000007]Duplicate Transaction -- The transaction has already been processed.
4000008	ERROR	FAILED	[4000008]Payment cancelled by the customer -- The transaction has been cancelled by the customer.
4000009	ERROR	FAILED	[4000009]Invalid transaction -- The transaction type is not valid.
4000010	ERROR	FAILED	[4000010]Please call the acquirer support call number -- An issue occurred with the acquirer: please contact your HiPay account manager.
4000011	ERROR	FAILED	[4000011]Authentication failed. Please retry or cancel. -- The authentication requested by the payment method has failed.
4000012	ERROR	FAILED	[4000012]No UID configured for this operation -- The payment method used for this transaction is not supported on current account configuration.
4010101	ERROR	FAILED	[4010101]Refusal (No Explicit Reason) -- The transaction has been declined by the card issuer with no given explanation.
4010102	ERROR	FAILED	[4010102]Issuer Not Available -- The authorization centre of the card issuer is not operational at this time.
4010103	ERROR	FAILED	[4010103]Insufficient Funds -- The cardholder does not have enough funds to make this payment.
4010201	ERROR	FAILED	[4010201]Transaction Not Permitted -- The transaction is not permitted for this type of card.
4010202	ERROR	FAILED	[4010202]Invalid Card Number -- The transaction failed due to an invalid credit card number.
4010203	ERROR	FAILED	[4010203]Unsupported Card -- The type of card is not supported or is unknown.
4010204	ERROR	FAILED	[4010204]Card Expired -- The transaction has been declined because the expiry date on the card used for payment has already passed.
4010205	ERROR	FAILED	[4010205]Expiry Date Incorrect -- The transaction has been declined because the expiry date entered for the card used for payment is incorrect.
4010206	ERROR	FAILED	[4010206]CVC Required -- The transaction cannot be processed because no Card Verification Code was provided.
4010207	ERROR	FAILED	[4010207]CVC Error -- The transaction has been declined because the CVC entered does not match the credit card.
4010301	ERROR	FAILED	[4010301]AVS Failed -- The transaction has been refused because the AVS response returned an “N” value and the merchant account is not able to accept such transactions.
4010302	ERROR	FAILED	[4010302]Retain Card -- The bank put a hold on purchases due to an issue with the cardholder’s account.
4010303	ERROR	FAILED	[4010303]Lost or Stolen Card -- The card has been blocked by the card issuer because the cardholder reported it as being lost or stolen (potential fraud).
4010304	ERROR	FAILED	[4010304]Restricted Card -- The credit card is blacklisted by the card association.
4010305	ERROR	FAILED	[4010305]Card Limit Exceeded -- The transaction would exceed the monthly limit of the card.
4010306	ERROR	FAILED	[4010306]Card Blacklisted -- The card has been rejected by the bank’s fraud system.
4010307	ERROR	FAILED	[4010307]Unauthorized IP address country -- The IP address country used is not authorized.
4010309	ERROR	FAILED	[4010309]Card not in authorizer’s database -- The credit card number is not in an authorized cards database.
4010310	ERROR	FAILED	[4010310]3DS required but not used -- The transaction requires 3DS authentication but the credit card is not enrolled.
4010312	ERROR	FAILED	[4010312]Soft Declined -- The authorization was declined by the issuer because the transaction was not authenticated
SESSION_DATA_NOT_OK	SUCCESS	BAD_REQUEST	Session data doesn't meet the partner's requirements
AUTH_ERROR	ERROR	FAILED	Problem with authentication
SUCCESS	SUCCESS	SUCCEEDED	The operation run with success
ACCESS_FORBIDDEN	ERROR	FAILED	Access to this resource is fordidden.
ERROR	ERROR	FAILED	Failed operation
forwarding	WAITING	WAITING_PARTNER_RESPONSE	Redirection Requested -- The redirection has been requested
400_INVALID_CARD_TOKEN	ERROR	FAILED	Invalid cardToken (or missing)
404_CARD_TOKEN	ERROR	FAILED	Card token not found
200_CARD_TOKEN	SUCCESS	SUCCEEDED	Card token deleted with success