Incorporar en la página web

Para obtener el enlace de la incorporación, es necesario realizar una solicitud POST /checkouts con los datos deseados.

El parámetro redirects del tipo action Es obligatorio y debe contener la URL a la que se redirigirá al cliente tras procesar el pago. El parámetro id del checkout se concatena automáticamente a la URL en el momento del redireccionamiento.

{
	...

	"redirects": [
		{
			"type": "action", // <== Redireccionamento obrigatório
			"url": "https://www.url-action.dominio"
		}
	]
}

Creación del checkout con los siguientes datos:

Idioma: Português
Diseño de la página: Incorporado
Importe: 5€
Método de pago: Cartão de Crédito/Débito (CC)
Código del producto: REFPRODUTO_1
Descripción del producto: Computador
Cliente:
- Número de cliente: 1
- Nombre: José
- Apellido: Silva
- Teléfono: 351#961234567
- Correo electrónico: jose.silva@email.com
Dirección de cobro:
- País: Portugal
- Ciudad: Lisboa
- Dirección: Rua Domingos Monteiro nº 7 A,
- Código Postal: 1050-074
Redireccionamientos:
- Tras el pago: https://www.url-action.dominio

Solicitud
Respuesta

POST /checkouts

{
	"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": "embed" // <== Incorporado
	},
	"redirects": [
		{
			"type": "action", // <== Redireccionamento obrigatório
			"url": "https://www.url-action.dominio"
		}
	]
}

{
	"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=embed",
		"paymentId": "42690",
		"stateDetails": {
			"state": "PaymentReady",
			"timestamp": "2022-01-03T14:16:17+00:00"
		}
	}
}

Para crear el formulario de pago, solo hay que añadir las siguientes líneas HTML/JavaScript a la página. El {id} debe sustituirse por el id devuelto en la respuesta a la solicitud, en el ejemplo anterior sería 0uJQvNoxoloZCn4gyuGKIWR8dtU9OnAm0emxYWcb.

<form class="paymentWidgets"></form>

<script src="https://paypay.pt/paypay/checkout/v2/embed/{id}?page_layout=embed"></script>