API
Pular para o conteúdo principal

Pagamento com MULTIBANCO

Para iniciar um pagamento com MB apenas necessita do gerar uma referência de 9 dígitos e disponibilizar ao consumidor.

O processo funciona da seguinte forma:

  1. Geração de referência Multibanco;
  2. O utilizador paga a referência no Multibanco/Homebanking;
  3. A SIBS comunica à PayPay a confirmação;
  4. A PayPay notifica o estado do pagamento;

O fluxo seguinte ilustra o funcionamento do pagamento por Multibanco:

MB flow

1. Gerar referência Multibanco​

POST /payments/references

{
	"type": "payment",
	"amount": 100,
	"callbackUrl": "https://teste.pt", // Opcional se usar webhooks
	"availableMethods": [
		{
			"code": "MB",
			"type": "NORMAL" // Ou REALTIME
		}
	],
	"validDate": {
		"start": "2022-04-01T14:45:56+00:00",
		"end": "2022-04-30T23:59:59+01:00"
	}
}

2. O utilizador paga a referência​

Caso tenha especificado um URL de callback ou Webhook será enviada uma notificação.

3. Consultar do estado do pagamento​

GET ​/payments/{id} 

{
	"apiVersion": "1.4.0",
	"date": "2022-03-09T14:45:56+00:00",
	"success": true,
	"data": {
		"id": "50438",
		"type": "payment",
		"referenceDetails": {
			"entity": "12797",
			"reference": "002492617"
		},
		"stateDetails": {
			"state": "confirmed",
			"createdAt": "2021-10-07T18:07:46+01:00"
		},
		"amount": 100,
		"createdAt": "2022-03-09T14:45:56+00:00",
		"updatedAt": "2022-03-09T14:45:56+00:00",
		"validDate": {
			"start": "2022-04-01T14:45:56+00:00",
			"end": "2022-04-30T23:59:59+01:00"
		},
		"availableMethods": [
			{
				"code": "MB",
				"type": "NORMAL",
				"name": "Multibanco"
			}
		]
	}
}