Incorporar em aplicação móvel

O checkout pode ser incorporado em aplicações móveis utilizando o componente "Webview" e o mecanismo "Deep linking" disponibilizado em Android e iOS.

Referências úteis:

• https://developer.android.com/training/app-links/deep-linking
• https://blog.devgenius.io/deep-linking-in-ios-f5bfa2959d0a
• https://en.yeeply.com/blog/deep-linking-android-ios-apps/

O processo funciona da seguinte forma:

1. (Back-end) Geração do link de checkout através do recurso /checkouts;
2. (Aplicação) Abrir o link obtido anteriormente em webview Android/iOS;
3. (Webview) Aguardar que o utilizador conclua o pagamento;
4. (Aplicação) Utilizador regressou à aplicação;
5. (Back-end) Consultar o estado do checkout via API;
6. (Aplicação) Apresentar a view da aplicação de acordo;

Geração do link de checkout para Webview

O parâmetro redirects do tipo action deverá conter o url "Deep link" irá invocar a aplicação após o pagamento.

Pedido

{
	"payment": {
		"amount": 500,
		"code": "REFPRODUTO_1",
		"summary": "Computador",
		"customer": {
			"customerId": "1",
			"firstName": "José",
			"lastName": "Silva",
			"phoneNumber": "351#961234567",
			"email": "jose.silva@email.com"
		},
		"billingAddress": {
			"country": "PT",
			"city": "Lisboa",
			"street1": "Rua Domingos Monteiro nº 7 A",
			"postCode": "1050-074"
		},
		"paymentMethod": {
			"code": "CC" // <== Método de pagamento
		}
	},
	"page": {
		"language": "PT",
		"layout": "default" // <== Incorporado
	},
	"redirects": [
		{
			"type": "action",
			"url": "https://www.myapp.com" // <== URL deep Link
		}
	]
}

Resposta

{
	"apiVersion": "1.0",
	"date": "2022-01-03T14:16:17+00:00",
	"success": true,
	"data": {
		"id": "0uJQvNoxoloZCn4gyuGKIWR8dtU9OnAm0emxYWcb",
		"createdAt": "2022-01-03 14:16:17",
		"checkoutUrl": "https://paypay.pt/paypay/checkout/v2/embed/0uJQvNoxoloZCn4gyuGKIWR8dtU9OnAm0emxYWcb?page_layout=default",
		"paymentId": "42690",
		"stateDetails": {
			"state": "PaymentReady",
			"timestamp": "2022-01-03T14:16:17+00:00"
		}
	}
}