---
title: "Multibanco"
method: POST
path: "/multibanco/create"
---

# Multibanco

`POST /multibanco/create`

Creates Multibanco payment references:
- with or without payment deadline
- define an amount or an interval with max/min amounts to receive the payment
- may choose if the references allow only 1 or more that 1 payment

## Request body

- object
  - `chave` string, required — API Key
  - `valor` number, float, required — Amount
  - `id` string — Identifier
  - `data_inicio` string, date — Reference starts to allow payments on this day (YYYY-MM-DD)
  - `data_fim` string, date — Payment deadline (YYYY-MM-DD)
  - `valor_maximo` number, float — Maximum amount (only for references that allow payments in an interval of amounts)
  - `valor_minimo` number, float — Minimum amount (only for references that allow payments in an interval of amounts)
  - `per_dup` integer, required — Defines if the reference allows 1 payment or more that 1 payment (1 = allows multiple payments | 0 = allows only 1 payment)
  - `campos_extra` object[] — Use this object to assign extra fields. Note that extra fields must be first setted up on your account channel.
    - `id` integer, required — Number of your extra field
    - `valor` string, required — Value that should be assigned to this extra field for this reference.
  - `failOver` '0' | '1' — Send a reminder to your customer that their payment has expired (Only available on references with deadline).
  - `email` string — User email to receive the reminder notification (Only if failover = 1).
  - `contacto` string — User phone number to receive the reminder notification (Only if failover = 1).
  - `userID` string — User identifier parameter. (Mandatory for some clients)

## Response `200`

200

- union
  - object
    - `sucesso` boolean
    - `estado` integer
    - `resposta` string
    - `referencia` string
    - `valor` string
    - `entidade` string
    - `valor_minimo` string
    - `valor_maximo` string
    - `data_inicio` string
    - `data_fim` string
  - object
    - `sucesso` boolean
    - `estado` integer
    - `resposta` string
  - object
    - `sucesso` boolean
    - `estado` integer
    - `resposta` string

---

[API](https://skmtc.net/eupago/apis/intro-and-oauth.md) · [All operations](https://skmtc.net/eupago/apis/intro-and-oauth/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/eupago/intro-and-oauth/versions/778475fa98e9/schema)
