Multibanco

post https://sandbox.eupago.pt/clientes/rest_api/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

🚧
This request uses Api Key authentication on its body (xxxx-xxxx-xxxx-xxxx-xxxx).

You may find your Eupago's API Key on your backoffice on Channels -> Channel Listing menu. Please check our guide if you are having trouble finding your API Key.

📘
Minimum and Maximum Amounts
Maximum amount: 99999€ | Minimum Amount: 1€

To test this request please fill the params below or load a complete example on the right clicking in Examples dropdown on the right.

Body Params

chave

string

required

API Key

valor

float

required

Amount

string

Identifier

data_inicio

date

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

data_fim

date

Payment deadline (YYYY-MM-DD)

valor_maximo

float

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

valor_minimo

float

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

per_dup

int32

required

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

campos_extra

array of objects

Use this object to assign extra fields. Note that extra fields must be first setted up on your account channel.

campos_extra

failOver

string

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

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

Language


xxxxxxxxxx
1
curl --request POST \
2
     --url https://sandbox.eupago.pt/clientes/rest_api/multibanco/create \
3
     --header 'accept: application/json' \
4
     --header 'content-type: application/json'

Click Try It! to start a request and see the response here! Or choose an example:

application/json

🚧

📘Minimum and Maximum Amounts

200200

📘
Minimum and Maximum Amounts