Métodos de pagamento

O recurso Checkouts suporta os seguintes métodos de pagamento, que podem ser especificados individualmente ou em simultâneo na criação de um checkout.

Código	Método de pagamento	Descrição
`CC`	Cartão de Crédito/Débito	Pagamento com cartão de crédito ou débito.
`MB`	Multibanco	Geração de referência Multibanco pagável em terminais ATM ou homebanking.
`MW`	MB WAY	Pagamento via número de telemóvel através da aplicação MB WAY.
`AP`	Apple Pay	Pagamento através de Apple Pay em dispositivos Apple compatíveis.
`GP`	Google Pay	Pagamento através de Google Pay em dispositivos Android e browsers compatíveis.

Especificar um único método de pagamento

Para direcionar o cliente para um método de pagamento específico, utilize o campo paymentMethod.code no corpo do pedido.

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 múltiplos métodos de pagamento

Para disponibilizar ao cliente a escolha do método de pagamento, utilize o campo availableMethods com a lista de códigos pretendidos. Desta forma o cliente escolhe o método diretamente na página de pagamento.

informação

QuandoavailableMethodsé utilizado, o campopaymentMethodnão deve ser especificado. Na ausência de ambos os campos, é criado o checkout com os métodos de pagamentos existentes na integração.

Pedido
Resposta

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"
    }
  }
}

Na resposta é devolvido o id que identifica o checkout perante a API.
O checkoutUrl é o link para aceder à página e realizar o pagamento.
O paymentId é o id que identifica o pagamento.

Notas por método

CC — Cartão de Crédito/Débito

Disponível em todos os layouts: web, embed e inApp.
Suporta os redirecionamentos success, cancel e back. O redirecionamento action é o único aceite no layout embed.

MB — Multibanco

Disponível nos layouts: web e inApp.
Não suporta redirecionamentos — após a criação do checkout é gerada uma referência Multibanco imediatamente acessível via checkoutUrl.

MW — MB WAY

Disponível em todos os layouts: web e inApp.
Suporta os redirecionamentos success, cancel e back.

AP — Apple Pay

Disponível nos layouts: web e inApp.
Suporta os redirecionamentos success, cancel e back.
Requer que o utilizador esteja num dispositivo Apple compatível (iPhone, iPad, Mac) com Apple Pay configurado.

GP — Google Pay

Disponível nos layouts: web e inApp.
Suporta os redirecionamentos success, cancel e back.
Requer que o utilizador tenha Google Pay configurado num dispositivo Android ou browser compatível.

Especificar um único método de pagamento​

Especificar múltiplos métodos de pagamento​

Notas por método​

CC — Cartão de Crédito/Débito​

MB — Multibanco​

MW — MB WAY​

AP — Apple Pay​

GP — Google Pay​