DreamPay API - Integração Web

Integre a DreamPay no seu website para começar a aceitar pagamentos online dos seus clientes titulares de cartões de crédito brasileiros.

O nosso checkout padrão fornece todas as funcionalidades essenciais para integrar o DreamPay Checkout no lado cliente da sua aplicação. Disponível apenas para integrações web.

1. Pré-requisitos

Para utilizar a API DreamPay para integração web precisa de ter uma conta de parceiro. Se ainda não tem uma, registe-se em https://linkgenerator.dreampay.com.br

2. URL's da API

• A API DreamPay está disponível em https://api.dreampay.com.br/
• A documentação Open Api da DreamPay está disponível em https://api.dreampay.com.br/docs/

3. Autenticação da API

A autenticação é feita enviando no header de todos os pedidos a chave "ApiKey" cujo valor se encontra na página de perfil da sua conta.

4. Passos do fluxo

a. Gerar link de pagamento

Como primeiro passo para integrar os pagamentos DreamPay no seu fluxo de checkout, precisa de gerar um link de pagamento fazendo um pedido POST para /api/PaymentLinks

{
  "establishmentID": 1001,
  "customerName": "Your customer name",
  "customerEmail": "customer-email@gmail.com",
  "customerPhoneNumber": "+351919191919 - optional",
  "orderNumber": "136",
  "value": 29.99,
  "currencyCode": "EUR",
  "observations": "Some description - optional",
  "callbackUrl": "https://callbackurl.pt/endpoint - optional",
  "returnUrl": "https://return.url - optional"
}

O establishmentID é o número de 4 dígitos que pode ser encontrado no seu contrato, consultando os Termos e Condições na página de perfil.

b. Enviar cliente para a página de pagamento

Como segundo passo, deve redirecionar o seu cliente para o link de pagamento recebido no passo anterior. Pode abri-lo numa janela modal, num iframe ou numa nova janela.

c. Exibir resultado do pagamento

O resultado do pagamento é exibido na página de pagamento DreamPay. Pode fornecer uma returnUrl para redirecionar o cliente para uma página de "Obrigado" ou "Minha conta" para uma melhor experiência.

• Pode verificar o status do pagamento fazendo um pedido GET para /api/PaymentLinks/{id}
• Pode fornecer uma callbackUrl para receber a confirmação do pagamento.

interface CallbackMessage {
  apiKey: string;
  paymentLink: string;
  status: string;
  message: string;
  integrationId: string;
}

Pode obter a lista de todos os links de pagamento gerados fazendo um pedido GET para /api/PaymentLinks/establishment/{establishmentId}

5. Outros métodos disponíveis

a. Lista de links de pagamento

Pode obter a lista de todos os links de pagamento gerados fazendo um pedido GET para /api/PaymentLinks/establishment/{establishmentId}

b. Verificar status do link de pagamento

Pode verificar o status do pagamento fazendo um pedido GET para /api/PaymentLinks/{id}

6. Testes e Sandbox

• O ambiente de testes da API DreamPay está disponível em https://dev-api.dreampay.com.br
• A documentação Open Api do ambiente de testes está disponível em https://dev-api.dreampay.com.br/docs/
• O Linkgenerator do ambiente de testes está disponível em https://dev-linkgenerator.dreampay.com.br

Antes de aceitar pagamentos reais, pode utilizar os seguintes números de cartão de teste para testar a sua integração.

Estes números de cartão são válidos apenas na nossa plataforma de testes e não resultarão numa transação real ou transferência de fundos.

Cartões de Teste Tokenizados

Cartões de Teste 3DS

Para simular códigos de erro, basta enviar transações com os valores correspondentes aos códigos de erro, conforme a tabela abaixo:

Mensagem de Retorno

A tabela seguinte mostra os Status das Transações, definidos pelo NÚMERO FINAL de cada cartão, e o ReturnCode:

O cartão de teste 4110.1100.4359.7521, por exemplo, simulará "Payment made successfully".