Skip to content

Multibanco

Last updated: 13th January 2022

Accept payments using Multibanco, a popular payment method in Portugal.

To start accepting Multibanco payments, please contact your Customer Success Manager.

Model

Collecting

Payment flow

Cash

Payment method type

Voucher

One-step payment

Authorization

Capture

Refund

Partial refund

Chargeback

Recurring payment


Overview

Multibanco payments follow a two-step process:


Request a payment

Use the details below to set up your request.

Endpoints

You can find the full list, as well as complete request and response examples, in our API reference.

    post

    https://api.checkout.com/payments

    Request example

    1
    2
    3
    4
    5
    6
    7
    8
    9
    10
    {
    "amount": 100,
    "currency": "EUR",
    "source": {
    "type": "multibanco",
    "payment_country": "PT",
    "account_holder_name": "Bruce Wayne",
    "billing_descriptor": "Multibanco Demo Payment"
    }
    }

    Response example

    If you receive a 202 Success response with a status field set to Pending, your request was successful.

    1
    2
    3
    4
    5
    6
    7
    8
    9
    10
    11
    12
    13
    14
    15
    {
    "id": "pay_cdv64cky2neeljlss37yjpofzu",
    "status": "Pending",
    "customer": {
    "id": "cus_ezuq5ju3ln4udgaz6joebp3p44"
    },
    "_links": {
    "self": {
    "href": "https://api.sandbox.checkout.com/payments/pay_cdv64cky2neeljlss37yjpofzu"
    },
    "multibanco:static-reference-page": {
    "href": "https://r.girogate.de/ti/simmultibanco?tx=512308296&rs=y5XBJFK6UF0R7gcn4lcQlbtc5wD2ppQ1&cs=058d2f4cecebaf97933ac9fb465a517ab84395eca459900105526a823460a90a"
    }
    }
    }

    Redirect the customer

    Redirect your customer to the multibanco:static-reference-page link’s href in the response. The customer will be redirected to a Multibanco page where they can authorize the payment, before being transferred to your predefined success or failure URL.


    Get details about a payment

    You can use the payment_id found in the payment response, or the cko-session-id from the success/failure URL (e.g., https://www.checkout.com/order/succeeded?cko-session-id=sid_vii64oquze5u3h2x6hh4rurc4y) to retrieve details about the payment.

    The cko-session-id expires 15 minutes after being created.

    Use the details below to set up your request.

    Endpoints

    You can find the full list, as well as complete request and response examples, in our API reference.

      get

      https://api.checkout.com/payments/{payment_id}

      Response example

      1
      2
      3
      4
      5
      6
      7
      8
      9
      10
      11
      12
      13
      14
      15
      16
      17
      18
      19
      20
      21
      22
      23
      24
      25
      26
      27
      28
      29
      30
      31
      32
      33
      34
      35
      36
      37
      38
      39
      {
      "id": "pay_cdv64cky2neeljlss37yjpofzu",
      "requested_on": "2019-09-25T06:05:22Z",
      "source": {
      "type": "multibanco",
      "service_supplier_id": "11854",
      "payment_reference": "999999919"
      },
      "amount": 100,
      "currency": "EUR",
      "payment_type": "Regular",
      "status": "Captured",
      "approved": true,
      "risk": {
      "flagged": false
      },
      "customer": {
      "id": "cus_ezuq5ju3ln4udgaz6joebp3p44"
      },
      "actions": [
      {
      "id": "act_n7qvjkcqgvlutongpq7vxshauy",
      "type": "Capture",
      "response_code": "10000",
      "response_summary": "Approved"
      }
      ],
      "_links": {
      "self": {
      "href": "https://api.sandbox.checkout.com/payments/pay_cdv64cky2neeljlss37yjpofzu"
      },
      "actions": {
      "href": "https://api.sandbox.checkout.com/payments/pay_cdv64cky2neeljlss37yjpofzu/actions"
      },
      "refund": {
      "href": "https://api.sandbox.checkout.com/payments/pay_cdv64cky2neeljlss37yjpofzu/refunds"
      }
      }
      }

      Testing Multibanco

      To start testing, you'll need to:

      • create a test account, and
      • contact your Customer Success Manager or Integrations engineer to activate Multibanco payments in the sandbox environment.
      1. Create a Multibanco transaction as above, following the redirect link in the response to Multibanco's website.
      2. Select Multibanco.
      3. Select Pay now. You will be redirected to the Multibanco Simulator.
      4. Leave the Pin field blank and select Make Payment.
      5. Select Back to where you came from to be redirected to your predefined success URL.