Sign in

v1

latestOpenAPI 3.1.02026-08-04370235.8 KB

Multibanco

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
post/multibanco/create

Request body

chavestring required

API Key

valornumber float required

Amount

idstring

Identifier

data_iniciostring date

Reference starts to allow payments on this day (YYYY-MM-DD)

data_fimstring date

Payment deadline (YYYY-MM-DD)

valor_maximonumber float

Maximum amount (only for references that allow payments in an interval of amounts)

valor_minimonumber float

Minimum amount (only for references that allow payments in an interval of amounts)

per_dupinteger required

Defines if the reference allows 1 payment or more that 1 payment (1 = allows multiple payments | 0 = allows only 1 payment)

failOver'0' | '1'

Send a reminder to your customer that their payment has expired (Only available on references with deadline).

emailstring

User email to receive the reminder notification (Only if failover = 1).

contactostring

User phone number to receive the reminder notification (Only if failover = 1).

userIDstring

User identifier parameter. (Mandatory for some clients)

Response

200

OR
OR

Example response

{
  "sucesso": true,
  "resposta": "OK",
  "referencia": "123456789",
  "valor": "0.00000",
  "entidade": "12345",
  "valor_minimo": "5",
  "valor_maximo": "122.5",
  "data_inicio": "2021-10-28",
  "data_fim": "2099-12-31"
}