API
Pular para o conteúdo principal

Guardar MB WAY

Para guardar o método MB WAY para compras futuras basta realizar um pagamento através de MB WAY com sucesso.

O processo funciona da seguinte forma:

  1. Notificar pagamento MB WAY c/ indicação da flag createRegistration=true e o UUID do cliente;
  2. Utilizador confirma pagamento na aplicação;
  3. Consulta do pagamento ou Consultar métodos do cliente.

1. Notificação de pagamento MB WAY com registo​

POST /payments

{
	"type": "payment",
	"amount": 100,
	"customer": {
		"uuid": "e2343605-cf46-43de-b20b-9b7d1c95a9b2" // <== ID do cliente registado
	},
	"paymentMethod": {
		"code": "MW",
		"details": {
			"phoneNumber": "351#123456789",
			"createRegistration": true // <== Flag indicativa para guardar o método
		}
	}
}

2. O utilizador valida o pagamento na aplicação MB WAY​

MB WAY confirmed

3. Consulta do estado do pagamento​

GET ​/payments/{id} 

{
	"apiVersion": "1.0",
	"date": "2021-10-18T11:45:12+01:00",
	"success": true,
	"data": {
		"id": "42373",
		"referenceDetails": {
			"reference": "A0000A585"
		},
		"stateDetails": {
			"state": "confirmed",
			"createdAt": "2021-10-07T18:07:46+01:00"
		},
		"paymentMethod": {
			"uuid": "811900ea-e386-40be-bd7d-b55c009968a5", // <== UUID do método registado
			"code": "MW",
			"type": "DEFAULT",
			"details": {
				"phoneNumber": "351#961879263",
				"createRegistration": true
			}
		},
		"amount": 100,
		"createdAt": "2021-10-07T18:06:46+01:00",
		"updatedAt": "2021-10-07T18:06:46+01:00",
		"validDate": {
			"start": "2021-10-07T18:06:46+01:00",
			"end": "2021-10-07T18:36:46+01:00"
		},
		"availableMethods": [
			{
				"code": "MW",
				"type": "DEFAULT",
				"name": "MB WAY"
			}
		],
		"paymentFee": {
			"netAmount": "0.27750000",
			"taxAmount": "0.04995000",
			"invoiceDetails": null
		},
		"customer": {
			"uuid": "e2343605-cf46-43de-b20b-9b7d1c95a9b2"
		}
	}
}