ATM

POST /checkouts

Creation of the checkout with the following data:

• Language: Portuguese
• Page Layout: web
• Amount: 5 euros
• Payment method: Multibanco (MB)
• Product code: REFPRODUCT_1
• Description of product: Computer

Request

{
	"payment": {
		"amount": 500,
		"code": "REFPRODUTO_1",
		"summary": "Computador",
		"paymentMethod": {
			"code": "MB" // <== Método de pagamento
		}
	},
	"page": {
		"language": "PT",
		"layout": "web"
	}
}

Response

{
	"apiVersion": "1.0",
	"date": "2022-01-03T14:16:17+00:00",
	"success": true,
	"data": {
		"id": "pyKP1B9IaK9J47wTSNB4mUnv2h4DJW8HzomddMp1",
		"createdAt": "2022-01-03 14:16:17",
		"checkoutUrl": "https://paypay.pt/paypay/referencia/referencia_c/pay/a9017d05790c0d076388750a12cd0a1f536cea71/paypay/uJUsP8LTEuRjt0Ar32tWMzuhVLP1oVLgqoXRJofu",
		"paymentId": "42696",
		"stateDetails": {
			"state": "PaymentReady",
			"timestamp": "2022-01-03T14:16:17+00:00"
		}
	}
}

The response returns the id which identifies the checkout to the API. The checkoutUrl is the link to access the page and make the payment. The paymentId is the id that identifies the payment.

Accessing the checkoutUrl displays the following page: