Métodos de pago

El recurso Checkouts admite los siguientes métodos de pago, que pueden especificarse de forma individual o simultánea al crear un checkout.

Código	Método de pago	Descripción
`CC`	Tarjeta de Crédito/Débito	Pago con tarjeta de crédito o débito.
`MB`	Cajero Automático - MULTIBANCO	Generación de referencia MULTIBANCO pagadera en cajeros automáticos o a través de la banca online.
`MW`	MB WAY	Pago mediante número de teléfono móvil a través de la aplicación MB WAY.
`AP`	Apple Pay	Pago mediante Apple Pay en dispositivos Apple compatibles.
`GP`	Google Pay	Pago a través de Google Pay en dispositivos Android y navegadores compatibles.

Especificar un único método de pago

Para dirigir al cliente a un método de pago específico, utilice el campo paymentMethod.code en el texto de la solicitud.

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"
    },
    "shippingAddress": {
      "country": "PT",
      "city": "Lisboa",
      "street1": "Rua Domingos Monteiro nº 7 A",
      "postCode": "1050-074"
      },
    "paymentMethod": {
      "code": "CC"
    }
  },
  "page": {
    "language": "PT",
    "layout": "web"
  },
  "redirects": [
    { "type": "success", "url": "https://www.url-after-success.dominio" },
    { "type": "cancel",  "url": "https://www.url-after-cancel.dominio" },
    { "type": "back",    "url": "https://www.url-back.dominio" }
  ]
}

Especificar varios métodos de pago

Para permitir al cliente elegir el método de pago, utilice el campo availableMethods con la lista de códigos deseados. De este modo, el cliente elige el método directamente en la página de pago.

información

CuandoavailableMethodsse utiliza, el campopaymentMethodno debe especificarse. Si no se rellenan ninguno de los dos campos, se crea el checkout con los métodos de pago disponibles en la integración.

Solicitud
Respuesta

POST /checkouts

{
  "payment": {
    "amount": 500,
    "code": "REFPRODUTO_1",
    "summary": "Computador",
    "availableMethods": [
      { "code": "CC" },
      { "code": "MB" },
      { "code": "MW" },
      { "code": "AP" },
      { "code": "GP" }
    ]
  },
  "page": {
    "language": "PT",
    "layout": "web"
  },
  "redirects": [
    { "type": "success", "url": "https://www.url-after-success.dominio" },
    { "type": "cancel",  "url": "https://www.url-after-cancel.dominio" },
    { "type": "back",    "url": "https://www.url-back.dominio" }
  ]
}

{
  "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/4d0757e6d4db52fae248e1a2e9f10a1e8cdb0a25/paypay/pyKP1B9IaK9J47wTSNB4mUnv2h4DJW8HzomddMp1",
    "paymentId": "42690",
    "stateDetails": {
      "state": "PaymentReady",
      "timestamp": "2022-01-03T14:16:17+00:00"
    }
  }
}

En la respuesta se devuelve el id que identifica el checkout ante la API.
El checkoutUrl es el enlace para acceder a la página y realizar el pago.
El paymentId es el ID que identifica el pago.

Notas por método

CC — Tarjeta de Crédito/Débito

Disponible en todos los diseños: web, embed y inApp.
Admite redireccionamientos success, cancel y back. El redireccionamiento action es el único que se acepta en el diseño embed.

MB — Cajero Automático - MULTIBANCO

Disponible en los diseños: web y inApp.
No admite redireccionamientos — tras crear el checkout, se genera una referencia MULTIBANCO a la que se puede acceder inmediatamente a través de checkoutUrl.

MW — MB WAY

Disponible en todos los diseños: web y inApp.
Admite redireccionamientos success, cancel y back.

AP — Apple Pay

Disponible en los diseños: web y inApp.
Admite redireccionamientos success, cancel y back.
Requiere que el usuario utilice un dispositivo Apple compatible (iPhone, iPad, Mac) con Apple Pay configurado.

GP — Google Pay

Disponible en todos los diseños: web y inApp.
Admite redireccionamientos success, cancel y back.
Requiere que el usuario tenga Google Pay configurado en un dispositivo Android o en un navegador compatible.

Especificar un único método de pago​

Especificar varios métodos de pago​

Notas por método​

CC — Tarjeta de Crédito/Débito​

MB — Cajero Automático - MULTIBANCO​

MW — MB WAY​

AP — Apple Pay​

GP — Google Pay​