# Multibanco for Payment Setup API

To accept Multibanco payments, you must:

1. Create a payment setup.
2. Confirm the payment.
3. Redirect the customer to Multibanco.

---

## Create a payment setup

Call the [Create a payment setup](https://api-reference.checkout.com/tag/Payment-Setups/#operation/createAPaymentSetup) endpoint.

> **Information**
>
> Your base URL's `{prefix}` value is unique to your account and environment. To learn how to retrieve your base URLs for the sandbox and production environments, see [API endpoints](https://www.checkout.com/docs/developer-resources/api/api-endpoints.md).

**Production**

`POST` `https://{prefix}.api.checkout.com/payments/setups`

**Sandbox**

`POST` `https://{prefix}.api.sandbox.checkout.com/payments/setups`

### Request example

```json
{
  "amount": 1000,
  "currency": "EUR",
  "processing_channel_id": "pc_wzjki6hw5puepb5fnvqlizj2e4",
  "reference": "ORDER_01234",
  "customer": {
    "country": "PT"
  },
  "payment_methods": {
    "multibanco": {
      "account_holder_name": "Hannah Bret"
    }
  },
  "settings": {
    "success_url": "https://example.com/payments/success",
    "failure_url": "https://example.com/payments/failure"
  }
}
```

In the request body, provide the following:

| Field | Description |
| --- | --- |
| `amount`<br>`number` | The payment amount, in the [minor currency unit](https://www.checkout.com/docs/payments/accept-payments/format-the-amount-value). <br><br>Minimum: 1 <br><br>**Required** |
| `currency`<br>`string` | Three-letter ISO 4217 [currency code](https://www.checkout.com/docs/developer-resources/codes/currency-codes.md). Must be `EUR`. <br><br>**Required** |
| `customer.country`<br>`string` | The two-letter ISO 3166 country code of the customer. Must be `PT`. <br><br>**Required** |
| `payment_methods.multibanco.account_holder_name`<br>`string` | Account holder name (3–100 characters). <br><br>Min length: 3 <br><br>Max length: 100 <br><br>**Required** |
| `processing_channel_id`<br>`string` | The [processing channel's](https://www.checkout.com/docs/business-operations/use-the-dashboard/manage-processing-channels.md) unique identifier. <br><br>**Required** |
| `settings`<br>`object` | Settings for the payment setup. <br><br>**Required** |
| `settings.failure_url`<br>`string` | The URL to redirect the customer to if the payment fails. <br><br>Max length: 1024 <br><br>Format: URI <br><br>**Required** |
| `settings.success_url`<br>`string` | The URL to redirect the customer to after a successful payment. <br><br>Max length: 1024 <br><br>Format: URI <br><br>**Required** |
| `billing`<br>`object` | The customer's billing details. |
| `billing.address.country`<br>`string` | The two-letter ISO 3166 country code of the billing address. <br><br>Required if `billing` is provided. |
| `description`<br>`string` | A description of the payment. <br><br>Max length: 100 |
| `order.shipping.address.country`<br>`string` | The two-letter ISO 3166 country code of the shipping address. |
| `reference`<br>`string` | A reference you can use to identify the payment. For example, an order number. <br><br>Max length: 80 |

### Response example

```json
{
  "id": "set_rcmepwrchqab2wsergcafvijfy",
  "processing_channel_id": "pc_wzjki6hw5puepb5fnvqlizj2e4",
  "amount": 1000,
  "currency": "EUR",
  "payment_type": "Regular",
  "reference": "ORDER_01234",
  "description": "Multibanco payment",
  "payment_methods": {
    "multibanco": {
      "status": "ready",
      "flags": []
    }
  },
  "available_payment_methods": [
    "multibanco"
  ],
  "settings": {
    "success_url": "https://example.com/payments/success",
    "failure_url": "https://example.com/payments/failure"
  }
}
```

The response returns a `payment_methods` object, which contains the payment methods enabled on your account.

Providing all required fields sets the `payment_methods.multibanco` object to a `ready` [status](https://www.checkout.com/docs/payments/accept-payments/accept-a-payment-using-the-payment-setup-api.md#Payment_method_status).

---

## Confirm the payment

Confirm the payment by calling the [Confirm a payment setup](https://api-reference.checkout.com/tag/Payment-Setups/#operation/confirmAPaymentSetup) endpoint and provide:

- The payment setup `id` as the `{id}` path parameter.
- `multibanco` as the `{payment_method_name}` path parameter.

### Request example

**Production**

`POST` `https://{prefix}.api.checkout.com/payments/setups/{id}/confirm/multibanco`

**Sandbox**

`POST` `https://{prefix}.api.sandbox.checkout.com/payments/setups/{id}/confirm/multibanco`

### Response example

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

```json
{
  "id": "pay_cdv64cky2neeljlss37yjpofzu",
  "status": "Pending",
  "customer": {
    "id": "cus_ezuq5ju3ln4udgaz6joebp3p44"
  },
  "_links": {
    "self": {
      "href": "https://{prefix}.api.sandbox.checkout.com/payments/pay_cdv64cky2neeljlss37yjpofzu"
    },
    "redirect": {
      "href": "https://r.girogate.de/ti/simmultibanco?tx=512308296&rs=y5XBJFK6UF0R7gcn4lcQlbtc5wD2ppQ1&cs=058d2f4cecebaf97933ac9fb465a517ab84395eca459900105526a823460a90a"
    }
  }
}
```

---

## Redirect the customer

Redirect the customer to the `redirect` link's `href` from the response. The customer completes the payment on the Multibanco page and is then redirected back to your `settings.success_url` or `settings.failure_url`.