Attributes

• METHOD TYPEReal-Time Bank Transfer
• PAYMENTS
• PAYOUTS
• REFUNDS
• RECURRING

Introduction

Multibanco is a Portuguese interbank network that enables electronic payments and money transfers.

Multibanco supports partial refunds.

Supported Countries

• Portugal

Supported Currencies

• EUR

Payment (Deposit) Flow

Follow these steps to perform a payment using Nuvei REST API integration:

1. Generate a sessionToken

Press here for details.

2. Send a /payment Request

Perform the payment by sending a /payment request with its mandatory parameters including:

• userTokenId
• amount
• currency
• paymentOption.alternativePaymentMethod class containing:
  • paymentMethod: “apmgw_MULTIBANCO“
• deviceDetails class containing: ipAddress
• billingAddress class containing: firstName, lastName, country, email
• userDetails class containing: firstName, lastName, country, email

Marketplace merchants must also include the marketplace addendum with its mandatory parameters, including subMerchantId. With certain providers, if the request includes subMerchantName, Nuvei sends it to the provider as the point of sale, up to 50 characters. Otherwise, Nuvei sends subMerchantId.

Example /payment Request

{
  "sessionToken": "<sessionToken from getSessionToken>",
  "merchantId": "<your merchantId>",
  "merchantSiteId": "<your merchantSiteId>",
  "clientRequestId": "<unique request ID in merchant system>",
  "amount": "100",
  "currency": "EUR",
  "userTokenId": "<unique customer identifier in merchant system>",
  "clientUniqueId": "<unique transaction ID in merchant system>",
  "paymentOption": {
    "alternativePaymentMethod": {
      "paymentMethod": "apmgw_MULTIBANCO"
    }
  },
  "deviceDetails": {
    "ipAddress": "<customer's IP address>"
  },
  "billingAddress": {
    "firstName": "John",
    "lastName": "Smith",
    "country": "PT",
    "email": "[email protected]"
  },
  "userDetails": {
    "firstName": "John",
    "lastName": "Smith",
    "country": "PT",
    "email": "[email protected]"
  },
  "timeStamp": "<YYYYMMDDHHmmss>",
  "checksum": "<calculated checksum>"
}

The response generates and returns a redirect URL (redirectUrl) to redirect the customer to the payment page, as well as a UPO (userPaymentOptionId) for use in future transactions.

Example /payment Response

{
  "internalRequestId": 41180901,
  "status": "SUCCESS",
  "errCode": 0,
  "reason": "",
  "merchantId": "2716997754195194041",
  "merchantSiteId": "253281",
  "version": "1.0",
  "sessionToken": "6421e51f-088e-47e4-be68-6b3be5255d25",
  "orderId": "43122671",
  "userTokenId": "RestMultibancoTest",
  "paymentOption": {
    "redirectUrl": "https://apmtest.gate2shop.com/ppp/resources/cdn/v1/sibs.html?reference=379249171&deviceType=DESKTOP&amount=353.0&currency=EUR&entity=40033&merchantName=Descriptor&expirationDate=2024-06-01T13%3A48%3A34.337%2B01%3A00",
    "userPaymentOptionId": "2153223481",
    "card": {}
  },
  "transactionStatus": "REDIRECT"
}

After the transaction is processed, Nuvei sends a Direct Merchant Notification (DMN) that includes the result of the transaction to urlDetails.notificationUrl, which Nuvei recommends including in the /payment request.

Example /payment Response containing raw data

{
  "internalRequestId": 47144011,
  "status": "SUCCESS",
  "errCode": 0,
  "reason": "",
  "merchantId": "2716997754195194041",
  "merchantSiteId": "253281",
  "version": "1.0",
  "sessionToken": "f01d66f1-3023-46c3-b0c2-507df18e9a59",
  "orderId": "44557251",
  "userTokenId": "RestMultibancoTest123",
  "paymentOption": {
    "redirectUrl": "reference=671906172;entity=40033;expirationDate=2025-01-11T09:53:52.180Z",
    "userPaymentOptionId": "2153236011",
    "card": {}
  },
  "transactionStatus": "REDIRECT"
}

Example /payment DMN with Status=APPROVED

...'ppp_status=OK&Status=APPROVED&ExErrCode=0&ErrCode=0&errApmCode=0&errApmDescription=&errScCode=0&errScDescription=&Reason=&ReasonCode=0&PPP_TransactionID=43122671&userid=RestMultibancoTest&merchant_unique_id=&customData=&productId=&first_name=&last_name=&email=test%40test.com&currency=EUR&customField1=&customField2=&customField3=&customField4=&customField5=&customField6=&customField7=&customField8=&customField9=&customField10=&customField11=&customField12=&customField13=&customField14=&customField15=&invoice_id=&address1=&address2=&country=Portugal&state=&city=&zip=&phone1=&phone2=&phone3=&client_ip=&nameOnCard=&cardNumber=&bin=&noCVV=&acquirerId=&acquirerBank=SIBS-MB-PI&expMonth=&expYear=&Token=&tokenId=&AuthCode=&AvsCode=&Cvv2Reply=&shippingCountry=&shippingState=&shippingCity=&shippingAddress=&shippingZip=&shippingFirstName=&shippingLastName=&shippingPhone=&shippingCell=&shippingMail=&total_discount=0.00&total_handling=0.00&total_shipping=0.00&total_tax=0.00&buyButtonProductBundleId=&merchant_site_id=253281&merchant_status=&action=&requestVersion=&message=APPROVED&merchantLocale=&unknownParameters=&payment_method=apmgw_MULTIBANCO&ID=&merchant_id=2716997754195194041&responseTimeStamp=2024-05-28.14%3A57%3A31&buyButtonProductId=&webMasterId=&appliedPromotions=&uniqueCC=&transactionType=Sale&externalEmail=&cardCompany=&eci=&user_token_id=RestMultibancoTest&userPaymentOptionId=2153223481&TransactionID=2610000000000029600&externalTransactionId=s2Ek8yiCtXf840fmbGyp&APMReferenceID=8DA5CA474EE8A2AC8624A5671559D894&orderTransactionId=24493041&totalAmount=353.00&dynamicDescriptor=QA+Test+site&item_name_1=NA&item_number_1=&item_amount_1=123.00&item_quantity_1=1&item_discount_1=0.00&item_handling_1=0.00&item_shipping_1=0.00&feeAmount=&amountWithoutFee=&houseNumber=&customCurrency=&externalToken_blockedCard=&externalToken_cardAcquirerId=&externalToken_cardAcquirerName=&externalToken_cardBin=&externalToken_cardBrandId=&externalToken_cardBrandName=&externalToken_cardExpiration=&externalToken_cardLength=&externalToken_cardMask=&externalToken_cardName=&externalToken_cardTypeId=&externalToken_cardTypeName=&externalToken_clubName=&externalToken_creditCompanyId=&externalToken_creditCompanyName=&externalToken_extendedCardType=&externalToken_Indication=&externalToken_tokenValue=&externalToken_tokenProvider=&ECIRaw=&cryptogram=&maskedNetworkTokenNumber=&upoRegistrationDate=20240528&type=DEPOSIT&clientRequestId=&relatedTransactionId=&sessionId=f3ec09715334a782b448682f3eed&responsechecksum=f6a64ea79919e0590e4477fc0528dde0&advanceResponseChecksum=9d5c0bdfe005cd6981e5a4c437ddd17e',

User Experience

1. The user is redirected to a page on which a reference number appears.
   
2. The user can print the page and return to the merchant’s website.
3. Using online banking or at an ATM, the user makes the payment using the reference number.
4. The user receives a notification that the payment was made.

Testing

Test credentials and testing scenarios can be provided by Nuvei if necessary. You can contact Nuvei support for assistance.